CapabilityStatement-c4bb

Sourcehl7.fhir.us.carin-bb#current:CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®) (v4.0.1)
resourceTypeCapabilityStatement
idc4bb
canonicalhttp://hl7.org/fhir/us/carin-bb/CapabilityStatement/c4bb
version2.0.0
statusactive
publisherHL7 Financial Management Working Group
nameCarinBbCapabilityStatement
titleC4BB CapabilityStatement
date2022-09-11
experimentalfalse
descriptionThis Section describes the expected capabilities of the C4BB Server actor which is responsible for providing responses to the queries submitted by the C4BB Requestors. The EOB Resource is the focal Consumer-Directed Payer Data Exchange (CDPDE) Resource. Several Reference Resources are defined directly/indirectly from the EOB: Coverage, Patient, Organization (Payer ID), Practioner, and Organization (Facility). The Coverage Reference Resource SHALL be returned with data that was effective as of the date of service of the claim; for example, the data will reflect the employer name in effect at that time. However, for other reference resources, payers MAY decide to provide either the data that was in effect as of the date of service or the current data. All reference resources within the EOB will have meta.lastUpdated flagged as must support. Payers SHALL provide the last time the data was updated or the date of creation in the payers system of record, whichever comes last. Apps will use the meta.lastUpdated values to determine if the reference resources are as of the current date or date of service.
jurisdictionsus
kindrequirements
fhirVersion4.0.1
formatsxml json
implementationGuideshttp://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb
Usages(none)

CarinBbCapabilityStatement

This Section describes the expected capabilities of the C4BB Server actor which is responsible for providing responses to the queries submitted by the C4BB Requestors.

The EOB Resource is the focal Consumer-Directed Payer Data Exchange (CDPDE) Resource. Several Reference Resources are defined directly/indirectly from the EOB: Coverage, Patient, Organization (Payer ID), Practioner, and Organization (Facility).

The Coverage Reference Resource SHALL be returned with data that was effective as of the date of service of the claim; for example, the data will reflect the employer name in effect at that time. However, for other reference resources, payers MAY decide to provide either the data that was in effect as of the date of service or the current data. All reference resources within the EOB will have meta.lastUpdated flagged as must support. Payers SHALL provide the last time the data was updated or the date of creation in the payers system of record, whichever comes last. Apps will use the meta.lastUpdated values to determine if the reference resources are as of the current date or date of service.

Mode SERVER
Description

The C4BB Server SHALL :

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  4. Support json source formats for all CARIN-BB interactions.
  5. Identify the CARIN-BB profiles supported as part of the FHIR meta.profile attribute for each instance.
  6. Support the searchParameters on each profile individually and in combination.

The C4BB Server SHOULD :

  1. Support xml source formats for all C4BB interactions.
Transaction
System History
System Search
Resource Type Profile Read V-Read Search Update Create
Coverage Supported profiles:
   C4BB Coverage
y y y
ExplanationOfBenefit Supported profiles:
   C4BB Explanation Of Benefit
   C4BB ExplanationOfBenefit Inpatient Institutional
   C4BB ExplanationOfBenefit Outpatient Institutional
   C4BB ExplanationOfBenefit Oral
   C4BB ExplanationOfBenefit Pharmacy
   C4BB ExplanationOfBenefit Professional NonClinician
y y y
Organization Supported profiles:
   C4BB Organization
y y y
Patient Supported profiles:
   C4BB Patient
y y y
Practitioner Supported profiles:
   C4BB Practitioner
y y y
RelatedPerson Supported profiles:
   C4BB RelatedPerson
y y y

Produced 08 Sep 2023