Data Exchange For Quality Measures Implementation Guide
1.0.0-cibuild - CI Build International flag

Data Exchange For Quality Measures Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-deqm/ and changes regularly. See the Directory of published versions

: Receiver Server CapabilityStatement

Page standards status: Trial-use Maturity Level: 4

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="receiver-server"/>
  <language value="en"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement receiver-server</b></p><a name="receiver-server"> </a><a name="hcreceiver-server"> </a><h2 id="title">Receiver Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 1.0.0-cibuild </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>server</code></h3></div><div class="panel-body"><div><p>Da Vinci DEQM Producer Server <strong>SHALL</strong></p>
<ol>
<li>
<p>Support the following  transactions defined in the <em>Framework</em> Section of  this  Implementation Guide:</p>
<ul>
<li>Individual Reporting</li>
<li>Summary Reporting</li>
</ul>
</li>
<li>
<p>Declare a CapabilityStatement identifying the list of supported profiles and operations.</p>
</li>
<li>
<p>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>.</p>
</li>
<li>
<p>Support both xml and json resource formats for all interactions.</p>
</li>
<li>
<p>Support support for one of 'batch' or 'transaction'.</p>
</li>
</ol>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>For general security consideration refer to the <a href="http://build.fhir.org/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 class="text-center"><b title="DELETE a resource (delete interaction)">D</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="#MeasureReport1-1">MeasureReport</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-deqm-summarymeasurereport.html">DEQM Summary MeasureReport Profile</a><br/>  <a href="StructureDefinition-deqm-individualmeasurereport.html">DEQM Individual MeasureReport Profile</a><br/>  <a href="StructureDefinition-deqm-subjectlistmeasurereport.html">DEQM Subject List MeasureReport</a></td><td class="text-center"/><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHOULD">Y</span></td><td>measurereport-category</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="MeasureReport1-1" 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>SHALL</strong> support <code>create</code>, <code>update</code>, <code>search-type</code>.</li><li><strong>SHOULD</strong> support <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-deqm-summarymeasurereport.html">DEQM Summary MeasureReport Profile</a><br/><a href="StructureDefinition-deqm-individualmeasurereport.html">DEQM Individual MeasureReport Profile</a><br/><a href="StructureDefinition-deqm-subjectlistmeasurereport.html">DEQM Subject List MeasureReport</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>The DaVinci DEQM Receiver Server <strong>SHALL</strong> be capable of supporting the DEQM Summary MeasureReport Profile, the DEQM SubjectList MeasureReport Profile, and DEQM Individual MeasureReport Profile and all the DEQM and QI Core Profiles they reference.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-measurereport-category.html">measurereport-category</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </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/receiver-server"/>
  <version value="1.0.0-cibuild"/>
  <name value="ReceiverServerCapabilityStatement"/>
  <title value="Receiver 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 Receiver Server when conforming to the Da Vinci DEQM Implementation Guide. Receivers are the systems that receive quality measure results from a Reporter, typically aggregate-level stakeholders such as quality reporting programs, payers, public health agencies, and other healthcare-related agencies.  This CapabilityStatement resource includes the complete list of the *recommended*  Da Vinci DEQM profiles and RESTful operations that a Da Vinci DEQM Receiver 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="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="server"/>
    <documentation
                   value="Da Vinci DEQM Producer Server **SHALL**

1. Support the following  transactions defined in the *Framework* Section of  this  Implementation Guide:

   - Individual Reporting
   - Summary Reporting
1. Declare a CapabilityStatement identifying the list of supported profiles and operations.
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.
1. Support support for one of 'batch' or 'transaction'."/>
    <security>
      <description
                   value="For general security consideration refer to the [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html)."/>
    </security>
    <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-summarymeasurereport"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/deqm/StructureDefinition/deqm-individualmeasurereport"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/deqm/StructureDefinition/deqm-subjectlistmeasurereport"/>
      <documentation
                     value="The DaVinci DEQM Receiver Server **SHALL** be capable of supporting the DEQM Summary MeasureReport Profile, the DEQM SubjectList MeasureReport Profile, and DEQM Individual MeasureReport Profile and all the DEQM and QI Core Profiles they reference."/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="measurereport-category"/>
        <definition
                    value="http://hl7.org/fhir/uv/deqm/SearchParameter/measurereport-category"/>
        <type value="token"/>
      </searchParam>
    </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>