CARIN Consumer Directed Payer Data Exchange
0.3.1 - STU1

CARIN Consumer Directed Payer Data Exchange, published by HL7 Financial Management Working Group. This is not an authorized publication; it is the continuous build for version 0.3.1). This version is based on the current content of https://github.com/HL7/carin-bb/ and changes regularly. See the Directory of published versions

: Consumer-Directed Payer Data Exchange HealthPlan API CapabilityStatement - XML Representation

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="carin-bb-capabilitystatement-healthplan-api"/>
  <meta>
    <versionId value="5"/>
    <lastUpdated value="2019-12-19T03:28:15.000+00:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Consumer-Directed Payer Data Exchange Server CapabilityStatement</h2><ul><li>Implementation Guide</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2019-12-04</li><li>Published by HL7 International and CARIN Alliance</li></ul><p><p>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.</p></p><h3 id="behavior">FHIR RESTful Capabilities</h3><p>The Consumer-Directed Payer Data Exchange Server 
                <strong>SHALL</strong>:
            </p><ol><li>Support the CARIN Blue Button Patient and ExplanationOfBenefit resource profiles.</li><li>Support additional resource profiles from the list of CARIN Blue Button Profiles.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:
      
                    <ul><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li><li>(Status 410): deleted resource.</li></ul></li><li>Support json source formats for all Consumer-Directed Payer Data Exchange interactions.</li></ol><p>The Consumer-Directed Payer Data Exchange Server 
                <strong>SHOULD</strong>:
            </p><ol><li>Support xml source formats for all Consumer-Directed Payer Data Exchange interactions.</li><li>Identify the CARIN Blue Button profiles supported as part of the FHIR 
                    <code>meta.profile</code> attribute for each instance.
                </li></ol><p id="security"><strong>Security:</strong></p><ol><li>See the 
                    <a href="Authorization,_Authentication,_and_Registration.html">Authorization, Authentication, and Registration</a> section for requirements and recommendations.
                </li><li>A server 
                    <strong>SHALL</strong> reject any unauthorized requests by returning an 
                    <code>HTTP 401</code> unauthorized response code.
                </li></ol><hr/><br/></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/carin/CapabilityStatement/carin-bb-capabilitystatement-healthplan-api"/>
  <version value="0.3.1"/>
  <name value="CARINBlueButton_HealthPlan_API_CapabilityStatement"/>
  <title
         value="Consumer-Directed Payer Data Exchange HealthPlan API CapabilityStatement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2019-12-04T05:00:00+00:00"/>
  <publisher value="HL7 Financial Management Working Group"/>
  <contact>
    <name value="HL7 Financial Management Working Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fm/index.cfm"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fm@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="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."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/carin-bb/ImplementationGuide/carin-bb"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The Consumer-Directed Payer Data Exchange Server **SHALL**:

1. Support the CARIN Blue Button Patient and ExplanationOfBenefit resource profiles.
2. Support additional resource profiles from the list of CARIN Blue Button Profiles.
3. Implement the RESTful behavior according to the FHIR specification.
4. 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.
5. Support json source formats for all Consumer-Directed Payer Data Exchange interactions.

The Consumer-Directed Payer Data Exchange Server **SHOULD**:

1. Support xml source formats for all Consumer-Directed Payer Data Exchange interactions.
2. Identify the CARIN Blue Button profiles supported as part of the FHIR `meta.profile` attribute for each instance."/>
    <security>
      <cors value="true"/>
      <service>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="OAuth"/>
          <display value="OAuth"/>
        </coding>
        <text value="OAuth"/>
      </service>
      <service>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="SMART-on-FHIR"/>
          <display value="SMART-on-FHIR"/>
        </coding>
        <text
              value="OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"/>
      </service>
      <description
                   value="1. See the [General Security Considerations](Authorization,_Authentication,_and_Registration.html) section for requirements and recommendations.
2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
    </security>
    <resource>
      <type value="Patient"/>
      <profile
               value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-patient"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <type value="Coverage"/>
      <profile
               value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-coverage"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <referencePolicy value="resolves"/>
      <searchParam>
        <name value="patient"/>
        <definition
                    value="http://hl7.org/fhir/us/carin/SearchParameter/carin-bb-searchparameter-coverage-patient"/>
        <type value="reference"/>
      </searchParam>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <extension url="required">
          <valueString value="patient"/>
        </extension>
        <extension url="optional">
          <valueString value="created"/>
        </extension>
      </extension>
      <type value="ExplanationOfBenefit"/>
      <profile
               value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-explanationofbenefit"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-explanationofbenefit-inpatient-facility"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-explanationofbenefit-outpatient-facility"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-explanationofbenefit-pharmacy"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-explanationofbenefit-professional-nonclinician"/>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <referencePolicy value="resolves"/>
      <searchParam>
        <name value="patient"/>
        <definition
                    value="http://hl7.org/fhir/us/carin/SearchParameter/carin-bb-searchparameter-explanationofbenefit-patient"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <name value="created"/>
        <definition
                    value="http://hl7.org/fhir/us/carin/SearchParameter/carin-bb-searchparameter-explanationofbenefit-patient"/>
        <type value="date"/>
      </searchParam>
    </resource>
    <resource>
      <type value="RelatedPerson"/>
      <profile
               value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-relatedperson"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <type value="PractitionerRole"/>
      <profile
               value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-practitionerrole"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <type value="Organization"/>
      <profile
               value="http://hl7.org/fhir/us/carin/StructureDefinition/carin-bb-organization"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <type value="ValueSet"/>
      <operation>
        <name value="expand"/>
        <definition
                    value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/>
        <documentation
                       value="A  client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions."/>
      </operation>
    </resource>
    <interaction>
      <code value="search-system"/>
    </interaction>
  </rest>
</CapabilityStatement>