Data Exchange For Quality Measures STU3 for FHIR R4
2.1.0 - Ballot

This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v2.1.0: STU 3) based on FHIR R4. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions

: Producer Client CapabilityStatement - XML Representation

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="producer-client"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Producer Client CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.1.0</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2020-07-05</li><li>Published by: HL7 International - Clinical Quality Information Work Group</li></ul><p><p>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 <em>recommended</em>  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.</p></p><h3 id="igs" class="no_toc">SHALL Support the Following Implementation Guides:</h3><ul><li><a href="http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore%7C4.0.0">http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0</a></li></ul><ul><li><a href="http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures%7C2.0.0">http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0</a></li></ul><h3 id="behavior">FHIR RESTful Capabilities</h3><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><p id="security"><strong>Security:</strong></p><p>For general security consideration refer to the <a href="http://hl7.org/fhir/R4/secpriv-module.html">Security and Privacy Considerations</a>.</p><p><strong>Summary of System Wide Interactions</strong></p><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><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href="#library">Library</a></td><td>

						</td><td>
							
						</td><td>
							
						</td><td>
              
            </td><td>
							
						</td></tr><tr><td><a href="#measure">Measure</a></td><td><a href="http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm">CQFM Measure</a></td><td>
							
						</td><td>
							
						</td><td>
              
       s      </td><td>
							data-requirements, submit-data
						</td></tr><tr><td><a href="#measurereport">MeasureReport</a></td><td><a href="StructureDefinition-datax-measurereport-deqm.html">DEQM Data Exchange MeasureReport Profile</a></td><td>
							
						</td><td>
							
						</td><td>
              
            </td><td>
							
						</td></tr></tbody></table><br/><h4 id="library" class="no_toc">Library</h4><p>Conformance Expectation:	<strong>SHOULD</strong></p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support 
																							<code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A Client <strong>SHOULD</strong> be capable of fetching a Library resource using:
					<br/>
						<code class="highlighter-rouge">GET [base]/Library/[id]</code>
				</li><br/>  <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id="measure" class="no_toc">Measure</h4><p>Conformance Expectation:	<strong>SHALL</strong></p><p>Supported Profiles:
				
											<a href="http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/measure-cqfm">CQFM Measure</a>
				
				</p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support 
																							<code>read</code>.</li></ul><p>Operation  Summary:</p><ul><li><strong>SHALL</strong> support the 
																								<a href="http://hl7.org/fhir/OperationDefinition/Measure-data-requirements">$data-requirements</a> operation
																								, 
																								<a href="http://hl7.org/fhir/OperationDefinition/Measure-submit-data">$submit-data</a> operation
																								<p><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></p></li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A Client <strong>SHOULD</strong> be capable of fetching a Measure resource using:
					<br/>
						<code class="highlighter-rouge">GET [base]/Measure/[id]</code>
				</li><br/>  <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><h4 id="measurereport" class="no_toc">MeasureReport</h4><p>Conformance Expectation:	<strong>SHALL</strong></p><p>Supported Profiles:
				
											<a href="StructureDefinition-datax-measurereport-deqm.html">DEQM Data Exchange MeasureReport Profile</a>
				
				</p><p>Resource Specific Documentation:</p><blockquote><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></blockquote><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support 
																							<code>create</code>.</li></ul><p>Fetch and Search Criteria:</p><ul>  <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet -->  <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><hr/><br/></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-deqm/CapabilityStatement/producer-client"/>
  <version value="2.1.0"/>
  <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 Work Group"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cqi/index.cfm"/>
    </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="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|2.1.0"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/qicore/ImplementationGuide/hl7.fhir.us.qicore|4.0.0"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures|2.0.0"/>
  <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/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>
        <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>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="MeasureReport"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/datax-measurereport-deqm"/>
      <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>