Data Exchange For Quality Measures Implementation Guide
4.0.0 - STU4 United States of America

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v4.0.0: STU4 (v4.0.0)) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Consumer Server CapabilityStatement - XML Representation

Active as of 2020-07-05

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="consumer-server"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>ConsumerServerCapabilityStatement</h2><div><p>This profile defines the expected capabilities of a Da Vinci DEQM Consumer Server when conforming to the Da Vinci DEQM Implementation Guide.  Consumers include systems that are primary consumers of patient healthcare information and systems that consume data from Producers.  This CapabilityStatement resource includes the complete list of the <em>recommended</em>  Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Consumer Server could support. Servers have the option of choosing from this list based on their local use cases and other contextual requirements.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><div><p>Da Vinci DEQM Consumer Server <strong>SHALL</strong></p>
<ol>
<li>Support the Submit Data transaction defined in the <em>Framework</em> Section of  this  Implementation Guide.</li>
<li>Declare a CapabilityStatement identifying the list of supported profiles and operations.
<ul>
<li>Use the <a href="http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType">DEQM Submit Data Update Type Extension</a> to indicate whether it whether it supports snapshot or incremental data exchange.</li>
</ul>
</li>
<li>Implement the FHIR RESTful API for operations including returning the appropriate response classes as described in the FHIR specification for <a href="http://hl7.org/fhir/R4/operations.html">Extended Operations on the RESTful API </a>.</li>
<li>Support both xml and json resource formats for all interactions.</li>
</ol>
</div></td></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td>y</td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>Measure</td><td>Supported profiles:<br/>  <a href="http://hl7.org/fhir/us/cqfmeasures/STU4/StructureDefinition-measure-cqfm.html">CQFM Measure</a></td><td>y</td><td></td><td></td><td></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cqi"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/consumer-server"/>
  <version value="4.0.0"/>
  <name value="ConsumerServerCapabilityStatement"/>
  <title value="Consumer Server CapabilityStatement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2020-07-05"/>
  <publisher value="HL7 International / Clinical Quality Information"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cqi"/>
    </telecom>
  </contact>
  <description
               value="This profile defines the expected capabilities of a Da Vinci DEQM Consumer Server when conforming to the Da Vinci DEQM Implementation Guide.  Consumers include systems that are primary consumers of patient healthcare information and systems that consume data from Producers.  This CapabilityStatement resource includes the complete list of the *recommended*  Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Consumer Server could support. Servers have the option of choosing from this list 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.1"/>
  <format value="xml"/>
  <format value="json"/>
  <patchFormat value="application/json-patch+json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="Da Vinci DEQM Consumer Server **SHALL**

1. Support the Submit Data transaction defined in the *Framework* Section of  this  Implementation Guide.
1. Declare a CapabilityStatement identifying the list of supported profiles and operations.
   - Use the [DEQM Submit Data Update Type Extension](http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType) to indicate whether it whether it supports snapshot or incremental data exchange.
1. Implement the FHIR RESTful API for operations including returning the appropriate response classes as described in the FHIR specification for [Extended Operations on the RESTful API ](http://hl7.org/fhir/R4/operations.html).
1. Support both xml and json resource formats for all interactions."/>
    <security>
      <description
                   value="For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)."/>
    </security>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="Measure"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
      <operation>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="data-requirements"/>
        <definition
                    value="http://hl7.org/fhir/OperationDefinition/Measure-data-requirements"/>
      </operation>
      <operation>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <extension
                   url="http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType">
          <valueCode value="incremental"/>
        </extension>
        <name value="submit-data"/>
        <definition
                    value="http://hl7.org/fhir/OperationDefinition/Measure-submit-data"/>
        <documentation
                       value="**SHALL** Use the [DEQM Submit Data Update Type Extension](http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType) to indicate whether it whether it supports snapshot or incremental data exchange.  **SHALL** reject the submit data payload if there is mismatch between the update type stated in the data exchange MeasureReport submitted by the Producer (client) and the capabilities supported by the Consumer (server) by returning a 400 Bad Request http error code. An OperationOutcome **SHOULD** be returned stating that the [snapshot/incremental] update is not supported ."/>
      </operation>
      <operation>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <extension
                   url="http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType">
          <valueCode value="incremental"/>
        </extension>
        <name value="bulk-submit-data"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data"/>
        <documentation
                       value="**SHALL** Use the [DEQM Submit Data Update Type Extension](http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-submitDataUpdateType) to indicate whether it whether it supports snapshot or incremental data exchange.  **SHALL** reject the submit data payload if there is mismatch between the update type stated in the data exchange MeasureReport submitted by the Producer (client) and the capabilities supported by the Consumer (server) by returning a 400 Bad Request http error code. An OperationOutcome **SHOULD** be returned stating that the [snapshot/incremental] update is not supported ."/>
      </operation>
    </resource>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="transaction"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="batch"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="search-system"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="history-system"/>
    </interaction>
  </rest>
</CapabilityStatement>