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

: CARIN BlueButton Consumer App CapabilityStatement - XML Representation

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="carin-bb-capabilitystatement-consumer-app"/>
  <meta>
    <versionId value="7"/>
    <lastUpdated value="2019-12-19T03:49:13.000+00:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">CARIN BlueButton Consumer App 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 Consumer App which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Consumer-Directed Payer Data Exchange Servers are defined in the 
                    <a href="CapabilityStatement-carin-bb-capabilitystatement-healthplan-api.html">Conformance Requirements for Server</a>.Consumer-Directed Payer Data Exchange Consumer Apps have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.
                </p></p><h3 id="behavior">FHIR RESTful Capabilities</h3><p>The Consumer-Directed Payer Data Exchange Consumer App 
                <strong>SHALL</strong>:
            </p><ol><li>Support fetching and querying of one or more CARIN Blue Button profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.</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></ol><hr/><br/></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/carin/CapabilityStatement/carin-bb-capabilitystatement-consumer-app"/>
  <version value="0.3.1"/>
  <name value="CARIN_BlueButton_Consumer_App_CapabilityStatement"/>
  <title value="CARIN BlueButton Consumer App 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="The Section describes the expected capabilities of the Consumer-Directed Payer Data Exchange Consumer App which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Consumer-Directed Payer Data Exchange Servers are defined in the [Conformance Requirements for Server](carin-bb-capabilitystatement-healthplan-api.html). Consumer-Directed Payer Data Exchange Consumer Apps have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements."/>
  <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="client"/>
    <documentation
                   value="The Consumer-Directed Payer Data Exchange Consumer App **SHALL**:

1. Support fetching and querying of one or more CARIN Blue Button profile(s), using the supported RESTful interactions and search parameters declared in the Consumer-Directed Payer Data Exchange Server CapabilityStatement"/>
    <security>
      <description
                   value="1. See the [Authorization, Authentication, and Registrations] section for requirements and recommendations."/>
    </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"/>
      <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>