Da Vinci Risk Adjustment Implementation Guide
2.0.0 - STU2 United States of America flag

Da Vinci Risk Adjustment Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ra/ and changes regularly. See the Directory of published versions

: Risk Adjustment Data Submission Client Capability Statement - XML Representation

Page standards status: Trial-use Maturity Level: 2

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="ra-data-submission-client"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement ra-data-submission-client</b></p><a name="ra-data-submission-client"> </a><a name="hcra-data-submission-client"> </a><a name="ra-data-submission-client-en-US"> </a><h2 id="title">Risk Adjustment Data Submission Client Capability Statement</h2><ul><li>Implementation Guide Version: 2.0.0 </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: 2024-12-10 22:27:38+0000 </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>http://hl7.org/fhir/us/davinci-ra/ImplementationGuide/fhir.us.davinci-ra</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 Risk Adjustment Data Submission Client <strong>SHALL</strong> support the risk adjustment data submission transaction and profiles specified in the Methodology Section of this implementation guide and the base FHIR $submit-data operation, as specified in this capability statement.</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>SHOULD </strong>support the <code>batch</code>interaction.</li><li><strong>MAY </strong>support the <code>transaction</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="#MeasureReport1-1">MeasureReport</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-ra-datax-measurereport.html">Risk Adjustment Data Exchange MeasureReport</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td></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/><code>literal</code>, <code>logical</code></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Create allows maintainers of the Risk Adjustment Data Exchange MeasureReports to create the logical definition of a Risk Adjustment Data Exchange MeasureReport</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-ra-datax-measurereport.html">Risk Adjustment Data Exchange MeasureReport</a></p></div></div><p/></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="2">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/davinci-ra/ImplementationGuide/fhir.us.davinci-ra"/>
      </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/us/davinci-ra/ImplementationGuide/fhir.us.davinci-ra"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-ra/CapabilityStatement/ra-data-submission-client"/>
  <version value="2.0.0"/>
  <name value="RADataSubmissionClientCapabilityStatement"/>
  <title value="Risk Adjustment Data Submission Client Capability Statement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-12-10T22:27:38+00:00"/>
  <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 Risk Adjustment Data Submission Client when conforming to the Da Vinci Risk Adjustment Implementation Guide for interactions between Data Submission Clients and Data Submission Servers. Clients are the actors creating and submitting the Risk Adjustment Data Exchange Measure Reports using the $submit-data operation to the Server."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Used by permission of HL7 International - Clinical Quality Information Work Group, all rights reserved Creative Commons License"/>
  <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-ra/ImplementationGuide/fhir.us.davinci-ra"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="Da Vinci Risk Adjustment Data Submission Client **SHALL** support the risk adjustment data submission transaction and profiles specified in the Methodology Section of this implementation guide and the base FHIR $submit-data operation, as specified in this capability statement."/>
    <security>
      <description
                   value="For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)."/>
    </security>
    <resource>
      <type value="MeasureReport"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-datax-measurereport"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Create allows maintainers of the Risk Adjustment Data Exchange MeasureReports to create the logical definition of a Risk Adjustment Data Exchange MeasureReport"/>
      </interaction>
      <conditionalCreate value="true"/>
      <referencePolicy value="literal"/>
      <referencePolicy value="logical"/>
    </resource>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <code value="batch"/>
    </interaction>
    <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="search-system"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="history-system"/>
    </interaction>
  </rest>
</CapabilityStatement>