CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
1.0.0 - STU1

This page is part of the CARIN Blue Button Implementation Guide (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

General Guidance

Actors

The following actors are part of the CARIN IG for Blue Button®:

    • CARIN IG for Blue Button® Requestor: An application that initiates a data access request to retrieve patient data. This can be thought of as the client in a client-server interaction.
    • CARIN IG for Blue Button® Responder: A product that responds to the data access request providing patient data. This can be thought of as the server in a client-server interaction.

Conformance Verbs

The conformance verbs - SHALL, SHOULD, MAY - used in this guide are defined in FHIR Conformance Rules.

Must Support

For profiles defined in other IGs, the meaning of Must Support is established in the defining IG. Note that the Must Support requirements for this IG are modeled after the US Core implementation guide, with the requirements for CARIN Server APIs modeled on those for US Core Responders, and the requirements for CARIN Consumer Apps modeled on those for US Core Requestors.  When querying and reading CARIN IG for Blue Button® Profiles, *Must Support* on any profile data element SHALL be interpreted as follows: 

  • Health Plan API actors SHALL be capable of populating all data elements as part of the query results as specified by the CARINBlueButtonHealthPlanAPICapabilityStatement.
  • Consumer App actors SHALL be capable of processing resource instances containing the data elements without generating an error or causing the application to fail.
  • Consumer App actors SHALL be capable of displaying the data elements for human use.
  • Consumer App actors SHOULD be capable of storing the information for other purposes.
  • In situations where information on a particular data element is not present and the reason for absence is unknown, Health Plan API actors SHALL NOT include the data elements in the resource instance returned as part of the query results.
  • When querying Health Plan API actors, Consumer App actors SHALL interpret missing data elements within resource instances as data not present in the Health Plan API actors system.
  • In situations where information on a particular data element is missing and the Health Plan API actor knows the precise reason for the absence of data, Health Plan API actors SHALL send the reason for the missing information using values (such as nullFlavors) from the value set where they exist or use the dataAbsentReason extension.
  • Consumer App actors SHALL be able to process resource instances containing data elements asserting missing information.

NOTE: The above definition of *Must Support* is derived from HL7v2 concept Required but may be empty - RE described in HL7v2 V28_CH02B_Conformance.doc.

NOTE: Readers are advised to understand FHIR Terminology requirements, FHIR RESTful API based on the HTTP protocol, along with FHIR Data Types, FHIR Search and FHIR Resource formats before implementing CARIN IG for Blue Button® requirements.

Missing Data

If the source system does not have data for a *Must Support* data element with minimum cardinality = 0, the data element is omitted from the resource. If the source system does not have data for a required data element (in other words, where the minimum cardinality is > 0), follow guidance defined in the core FHIR specification and summarized in the US Core.

Conformance to US Core Profiles

Any actor acting as a Health Plan API actor in this IG SHALL:

  • Be able to populate all profile data elements that have a minimum cardinality >= 1 and/or flagged as *Must Support* as defined by that profiles StructureDefinition.
  • Conform to the US Core Server Capability Statement expectations for that profile's type.

Any actor acting a FHIR Client in this IG SHALL:

  • Be able to process and retain all profile data elements that have a minimum cardinality >= 1 and/or flagged as Must Support as defined by that profiles StructureDefinition.
  • Conform to the US Core Client Capability Statement expectations for that profiles type.

U.S. Core Data for Interoperability and 2015 Edition Common Clinical Data Set

The US Core Profiles were originally designed to meet the 2015 Edition certification criterion for Patient Selection 170.315(g)(7), and Application Access - Data Category Request 170.315(g)(8). They were created for each item in the 2015 Edition Common Clinical Data Set (CCDS). The 3.1.0 version of the US Core Profiles IG includes new requirements from the latest proposed ONC U.S. Core Data for Interoperability(USCDI) and includes all the API Resource Collection in Health (ARCH)resources.