Da Vinci - Documentation Templates and Rules
2.2.0 - STU 2.2

Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions

## : SMART DTR Client

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

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="smart-dtr-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 smart-dtr-client</b></p><a name="smart-dtr-client"> </a><a name="hcsmart-dtr-client"> </a><h2 id="title">SMART on FHIR DTR Client</h2><ul><li>Implementation Guide Version: 2.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2024-08-02 </li><li>Published by: HL7 International / Clinical Decision Support </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><p>This CapabilityStatement imports the CapabilityStatement <a href="http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html">US Core Client CapabilityStatementversion: 7.0.0)</a></p><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>A SMART on FHIR DTR Client provides an application conforming to the SMART on FHIR specification and related requirements declared in this Implementation Guide.</p>
    </div><div class="lead"><em>Security</em></div><blockquote><div><p>caps-6^dtr-server,dtr-client^exchange:Implementations <strong>SHALL</strong> meet the general security requirements documented in the <a href="https://build.fhir.org/ig/HL7/davinci-ehrx">HRex implementation guide</a>.caps-6^dtr-server,dtr-client^exchange:Implementations <strong>SHALL</strong> meet the general security requirements documented in the <a href="https://build.fhir.org/ig/HL7/davinci-ehrx">HRex implementation guide</a>.
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="cds"/>
      </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-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"/>
          </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-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client"/>
      <version value="2.2.0"/>
      <name value="DTRSmartClient"/>
      <title value="SMART on FHIR DTR Client"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2024-08-02"/>
      <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 DTR SMART on FHIR applications. Such apps require client support for retrieving and editing QuestionnaireResponse resources and related resources, as well as client support for the Questionnaire Package, ValueSet Expand, and Next Question operations."/>
      <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-client|7.0.0"/>
      <fhirVersion value="4.0.1"/>
      <format value="json"/>
      <rest>
        <mode value="client"/>
        <documentation
                       value="A SMART on FHIR DTR Client provides an application conforming to the SMART on FHIR specification and related requirements declared in this Implementation Guide."/>
        <security>
          <description
                       value="caps-6^dtr-server,dtr-client^exchange:Implementations **SHALL** meet the general security requirements documented in the [HRex implementation guide](https://build.fhir.org/ig/HL7/davinci-ehrx).caps-6^dtr-server,dtr-client^exchange:Implementations **SHALL** meet the general security requirements documented in the [HRex implementation guide](https://build.fhir.org/ig/HL7/davinci-ehrx).security>
        <resource>
          <type value="QuestionnaireResponse"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaireresponse|2.2.0"/>
          <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/qr-context|2.2.0"/>
            <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-encounter|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="DeviceRequest"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="MedicationRequest"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="NutritionOrder"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="CommunicationRequest"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="ServiceRequest"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="VisionPrescription"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription|2.2.1"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
        </resource>
        <resource>
          <type value="Task"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-task|2.2.1"/>
          <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>
        </resource>
        <resource>
          <type value="Questionnaire"/>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="questionnaire-package"/>
            <definition
                        value="http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/questionnaire-package|2.2.0"/>
          </operation>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="next-question"/>
            <definition
                        value="http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question|4.0.0"/>
          </operation>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="log-questionnaire-errors"/>
            <definition
                        value="http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/log-questionnaire-errors|2.2.0"/>
          </operation>
        </resource>
        <resource>
          <type value="ValueSet"/>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="expand"/>
            <definition
                        value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/>
          </operation>
        </resource>
      </rest>
    </CapabilityStatement>