Da Vinci - Documentation Templates and Rules
2.0.1 - STU 2 United States of America flag

This page is part of the Documentation Templates and Rules (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) 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

: Light DTR EHR - XML Representation

Page standards status: Trial-use Maturity Level: 2

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="light-dtr-ehr"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Light DTR EHR</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr</code></li><li><b>Implementation Guide Version:</b> 1.1.0-ci-build</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats: </b>JSON</li><li><b>Published:</b> 2023-08-31</li><li><b>Published by:</b> HL7 Clinical Decision Support Work Group</li><li><b>Status:</b> Active</li></ul><p>This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources.</p>  <!-- Imports --><h3 id="should_css" class="no_toc">Include And Support Everything In The Following CapabilityStatements:</h3><ul><li><a href="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server">US Core Server CapabilityStatement</a></li></ul>  <!-- REST Behavior --><h3 id="behavior">FHIR Server RESTful Capabilities</h3><p>EHR systems which leverage a SMART app to manage data capture and rules execution, but which must be able to launch the SMART app.</p><p id="security"><strong>Security:</strong></p><p>Implementations <strong>SHALL</strong> meet the general security requirements documented in the <a href="http://hl7.org/fhir/us/davinci-hrex/STU1/security.html">HRex implementation guide</a>.</p><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p><p><i>♦ = <b>SHALL</b> expectation</i>;<i>⋄ = <b>SHOULD</b> expectation</i>;<i>▿ = <b>MAY</b> expectation</i>;</p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Interactions</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="#coverage"><span style="white-space: nowrap;">Coverage</span></a></td><td><span style="white-space: nowrap;">read<span title="SHALL"><sup>♦</sup></span>, </span><span style="white-space: nowrap;">create<span title="SHALL"><sup>♦</sup></span>, </span><span style="white-space: nowrap;">update<span title="SHALL"><sup>♦</sup></span>, </span><span style="white-space: nowrap;">search-type<span title="SHALL"><sup>♦</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage">Coverage</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style="white-space: nowrap;">context<span title="SHALL"><sup>♦</sup></span>, </span><span style="white-space: nowrap;">patient<span title="SHALL"><sup>♦</sup></span></span></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#encounter"><span style="white-space: nowrap;">Encounter</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest">DeviceRequest</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#devicerequest"><span style="white-space: nowrap;">DeviceRequest</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest">DeviceRequest</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#medicationrequest"><span style="white-space: nowrap;">MedicationRequest</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest">MedicationRequest</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#nutritionorder"><span style="white-space: nowrap;">NutritionOrder</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder">NutritionOrder</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#communicationrequest"><span style="white-space: nowrap;">CommunicationRequest</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest">CommunicationRequest</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#servicerequest"><span style="white-space: nowrap;">ServiceRequest</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest">ServiceRequest</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#visionprescription"><span style="white-space: nowrap;">VisionPrescription</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td><span style="white-space: nowrap;"><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription">CRD Vision Prescription</a></span></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr><tr><td><a href="#task"><span style="white-space: nowrap;">Task</span></a></td><td><span style="white-space: nowrap;">read<span title="SHOULD"><sup>⋄</sup></span>, </span><span style="white-space: nowrap;">create<span title="SHOULD"><sup>⋄</sup></span>, </span><span style="white-space: nowrap;">update<span title="SHOULD"><sup>⋄</sup></span></span></td>  <!-- Supported Profiles --><td></td>  <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td></td>  <!-- Supported _includes --><td></td>  <!-- Supported _revincludes --><td>  <!--  --></td>  <!-- Supported Operations --><td></td></tr></tbody></table>  <!-- Resource Details --><h4 id="coverage" class="no_toc">Coverage</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage">Coverage</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul><p>Modify Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of creating a Coverage resource using:<code class="highlighter-rouge">POST [base]/Coverage/[id]{?_format=[mime-type]}</code></li><li>A Server <strong>SHALL</strong> be capable of updating an existing Coverage resource using:<code class="highlighter-rouge">PUT [base]/Coverage/[id]{?_format=[mime-type]}</code></li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a Coverage resource using:<code class="highlighter-rouge">GET [base]/Coverage/[id]</code></li><li>A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:<code class="highlighter-rouge">GET [base]/Coverage/[id]{?[parameters]{&amp;_format=[mime-type]}}</code></li></ul>  <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/coverage.html#search">context</a></td><td>reference</td><td><code class="highlighter-rouge">GET [base]/Coverage?context=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/coverage.html#search">patient</a></td><td>reference</td><td><code class="highlighter-rouge">GET [base]/Coverage?patient=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href="http://hl7.org/fhir/R4/coverage.html#search">context</a> (reference):<p>Allows retrieving QuestionnaireResponse for a context</p></li><li><a href="http://hl7.org/fhir/R4/coverage.html#search">patient</a> (reference):<p>Allows retrieving QuestionnaireResponse for a patient</p></li></ul></div><h4 id="encounter" class="no_toc">Encounter</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest">DeviceRequest</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning an Encounter resource using:<code class="highlighter-rouge">GET [base]/Encounter/[id]</code></li></ul><h4 id="devicerequest" class="no_toc">DeviceRequest</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest">DeviceRequest</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning a DeviceRequest resource using:<code class="highlighter-rouge">GET [base]/DeviceRequest/[id]</code></li></ul><h4 id="medicationrequest" class="no_toc">MedicationRequest</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest">MedicationRequest</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning a MedicationRequest resource using:<code class="highlighter-rouge">GET [base]/MedicationRequest/[id]</code></li></ul><h4 id="nutritionorder" class="no_toc">NutritionOrder</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder">NutritionOrder</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning a NutritionOrder resource using:<code class="highlighter-rouge">GET [base]/NutritionOrder/[id]</code></li></ul><h4 id="communicationrequest" class="no_toc">CommunicationRequest</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest">CommunicationRequest</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning a CommunicationRequest resource using:<code class="highlighter-rouge">GET [base]/CommunicationRequest/[id]</code></li></ul><h4 id="servicerequest" class="no_toc">ServiceRequest</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest">ServiceRequest</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning a ServiceRequest resource using:<code class="highlighter-rouge">GET [base]/ServiceRequest/[id]</code></li></ul><h4 id="visionprescription" class="no_toc">VisionPrescription</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Supported Profiles:</p><ul><li><a href="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription">CRD Vision Prescription</a></li></ul><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 Server <strong>SHOULD</strong> be capable of returning a VisionPrescription resource using:<code class="highlighter-rouge">GET [base]/VisionPrescription/[id]</code></li></ul><h4 id="task" class="no_toc">Task</h4><p>Conformance Expectation:<strong>(conformance expectation undefined)</strong></p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>, <code>create</code>, <code>update</code>.</li></ul><p>Modify Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of creating a Task resource using:<code class="highlighter-rouge">POST [base]/Task/[id]{?_format=[mime-type]}</code></li><li>A Server <strong>SHOULD</strong> be capable of updating an existing Task resource using:<code class="highlighter-rouge">PUT [base]/Task/[id]{?_format=[mime-type]}</code></li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a Task resource using:<code class="highlighter-rouge">GET [base]/Task/[id]</code></li></ul></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cds"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr"/>
  <version value="2.0.1"/>
  <name value="LightDTREHR"/>
  <title value="Light DTR EHR"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-08-31"/>
  <publisher value="HL7 International / Clinical Decision Support"/>
  <contact>
    <name value="HL7 International / Clinical Decision Support"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description
               value="This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <imports
           value="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="EHR systems which leverage a SMART app to manage data capture and rules execution, but which must be able to launch the SMART app."/>
    <security>
      <description
                   value="Implementations **SHALL** meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]]."/>
    </security>
    <resource>
      <type value="Coverage"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
      </interaction>
      <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="SHALL"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="context"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-dtr/SearchParameter/dtr-context"/>
        <type value="reference"/>
        <documentation
                       value="Allows retrieving QuestionnaireResponse for a context"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="patient"/>
        <type value="reference"/>
        <documentation
                       value="Allows retrieving QuestionnaireResponse for a patient"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Encounter"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="DeviceRequest"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="MedicationRequest"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="NutritionOrder"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="CommunicationRequest"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="ServiceRequest"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="VisionPrescription"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
    </resource>
    <resource>
      <type value="Task"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="update"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>