This page is part of the CARIN Blue Button Implementation Guide (v0.1.0: STU 1 Ballot 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
CapabilityStatement: carin-bb-capabilitystatement-healthplan-api
Consumer-Directed Payer Data Exchange Server CapabilityStatement
- Implementation Guide
- FHIR Version: 4.0.1
- Supported formats: xml, json
- Published: 2019-12-04
- Published by HL7 International and CARIN Alliance
This Section describes the expected capabilities of the Consumer-Directed Payer Data Exchange Server actor which is responsible for providing responses to the queries submitted by the Consumer-Directed Payer Data Exchange Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Consumer-Directed Payer Data Exchange Servers are defined.
FHIR RESTful Capabilities
The Consumer-Directed Payer Data Exchange Server SHALL:
- Support the CARIN Blue Button Patient and ExplanationOfBenefit resource profiles.
- Support additional resource profiles from the list of CARIN Blue Button Profiles.
- Implement the RESTful behavior according to the FHIR specification.
- 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.
- Support json source formats for all Consumer-Directed Payer Data Exchange interactions.
The Consumer-Directed Payer Data Exchange Server SHOULD:
- Support xml source formats for all Consumer-Directed Payer Data Exchange interactions.
- Identify the CARIN Blue Button profiles supported as part of the FHIR
meta.profile
attribute for each instance.
Security:
- See the Authorization, Authentication, and Registration section for requirements and recommendations.
- A server
SHALL reject any unauthorized requests by returning an
HTTP 401
unauthorized response code.