Data Exchange For Quality Measures Implementation Guide
1.0.0-ballot - STU 1 Ballot

Data Exchange For Quality Measures Implementation Guide - Downloaded Version 1.0.0-ballot See the Directory of published versions

## : Producer Client CapabilityStatement

Page standards status: Trial-use | Maturity Level: 4

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="producer-client"/>
      <language value="en"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement producer-client</b></p><a name="producer-client"> </a><a name="hcproducer-client"> </a><h2 id="title">Producer Client CapabilityStatement</h2><ul><li>Implementation Guide Version: 1.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2020-07-05 </li><li>Published by: HL7 International / Clinical Quality Information </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li><a href="index.html">http://hl7.org/fhir/uv/deqm/ImplementationGuide/hl7.fhir.uv.deqm</a></li><li><a href="http://hl7.org/fhir/uv/cqm/2026May/index.html">http://hl7.org/fhir/uv/cqm/ImplementationGuide/hl7.fhir.uv.cqm</a></li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>client</code></h3></div><div class="panel-body"><div><p>Da Vinci DEQM Producer Client <strong>SHALL</strong>  support the Submit Data transaction defined in the <em>Framework</em> Section of  this  Implementation Guide.</p>
    </div><div class="lead"><em>Security</em></div><blockquote><div><p>For general security consideration refer to the <a href="http://hl7.org/fhir/R4/secpriv-module.html">Security and Privacy Considerations</a>.</p>
    </div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li><strong>MAY </strong>support the <code>transaction</code>interaction.</li><li><strong>MAY </strong>support the <code>batch</code>interaction.</li><li><strong>MAY </strong>support the <code>search-system</code>interaction.</li><li><strong>MAY </strong>support the <code>history-system</code>interaction.</li></ul></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Library1-1">Library</a></td><td> </td><td class="text-center"><span title="SHOULD">Y</span></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#Measure1-2">Measure</a></td><td>Supported Profiles<br/>  <a href="http://hl7.org/fhir/uv/crmi/STU1/StructureDefinition-crmi-shareablemeasure.html">CRMI Shareable Measure</a></td><td class="text-center"><span title="SHOULD">Y</span></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td><code>$data-requirements</code>, <code>$submit-data</code>, <code>$bulk-submit-data</code></td></tr><tr><td><a href="#MeasureReport1-3">MeasureReport</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-deqm-dataexchangemeasurereport.html">DEQM Data Exchange MeasureReport Profile</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"><span title="SHOULD">Y</span></td><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Library1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD </span>Library</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/library.html">Library</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Measure1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Measure</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/measure.html">Measure</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="http://hl7.org/fhir/uv/crmi/STU1/StructureDefinition-crmi-shareablemeasure.html">CRMI Shareable Measure</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$data-requirements</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>$submit-data</td><td><div><p>It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement.</p>
    </div></td></tr><tr><td><b>SHOULD</b></td><td><a href="OperationDefinition-bulk-submit-data.html">$bulk-submit-data</a></td><td><div><p>It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement.</p>
    </div></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="MeasureReport1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>MeasureReport</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/measurereport.html">MeasureReport</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>create</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-deqm-dataexchangemeasurereport.html">DEQM Data Exchange MeasureReport Profile</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><ul>
    <li>The DaVinci DEQM Producer Client <strong>SHALL</strong> be capable of supporting the DEQM MeasureReport Profiles and all the DEQM and QI Core Profiles they reference.</li>
    <li>The required DEQM Submit Data Update Type Extension  is used to indicate whether the payload is a snapshot or incremental update for both the initial transaction and subsequent updates.</li>
    </ul>
    </div></blockquote></div></div></div></div></div></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="cqi"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="4">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/deqm/ImplementationGuide/hl7.fhir.uv.deqm"/>
          </extension>
        </valueInteger>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/deqm/ImplementationGuide/hl7.fhir.uv.deqm"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/uv/deqm/CapabilityStatement/producer-client"/>
      <version value="1.0.0-ballot"/>
      <name value="ProducerClientCapabilityStatement"/>
      <title value="Producer Client 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 Producer Client when conforming to the Da Vinci DEQM Implementation Guide. Producers include systems that are primary producers of patient healthcare information.  This CapabilityStatement resource includes the complete list of the *recommended*  Da Vinci DEQM profiles and RESTful operations that are  Da Vinci DEQM Producer Client could support. Clients have the option of choosing from this list based on their local use cases and other contextual requirements."/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
          <display value="World"/>
        </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/uv/deqm/ImplementationGuide/hl7.fhir.uv.deqm"/>
      <implementationGuide
                           value="http://hl7.org/fhir/uv/cqm/ImplementationGuide/hl7.fhir.uv.cqm"/>
      <rest>
        <mode value="client"/>
        <documentation
                       value="Da Vinci DEQM Producer Client **SHALL**  support the Submit Data transaction defined in the *Framework* Section of  this  Implementation Guide.
    "/>
        <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="SHOULD"/>
          </extension>
          <type value="Library"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="Measure"/>
          <supportedProfile
                            value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablemeasure"/>
          <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>
            <name value="submit-data"/>
            <definition
                        value="http://hl7.org/fhir/OperationDefinition/Measure-submit-data"/>
            <documentation
                           value="It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement."/>
          </operation>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="bulk-submit-data"/>
            <definition
                        value="http://hl7.org/fhir/uv/deqm/OperationDefinition/bulk-submit-data"/>
            <documentation
                           value="It is the responsibility of the Producer to discover whether snapshot or incremental data exchange is supported by the inspection of the Consumer Server CapabilityStatement."/>
          </operation>
        </resource>
        <resource>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="MeasureReport"/>
          <supportedProfile
                            value="http://hl7.org/fhir/uv/deqm/StructureDefinition/deqm-dataexchangemeasurereport"/>
          <documentation
                         value="- The DaVinci DEQM Producer Client **SHALL** be capable of supporting the DEQM MeasureReport Profiles and all the DEQM and QI Core Profiles they reference.
    - The required DEQM Submit Data Update Type Extension  is used to indicate whether the payload is a snapshot or incremental update for both the initial transaction and subsequent updates."/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <code value="create"/>
          </interaction>
        </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>