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

## : DTR Payer Service

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

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="dtr-payer-service"/>
      <language value="en"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement dtr-payer-service</b></p><a name="dtr-payer-service"> </a><a name="hcdtr-payer-service"> </a><h2 id="title">DTR Payer Service</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: 2026-02-04 </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><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>A DTR Payer service provides a service endpoint for DTR apps and full EHRs to connect to</p>
    </div><div class="lead"><em>Security</em></div><blockquote><div><p>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>.</p>
    </div></blockquote></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="#Questionnaire1-1">Questionnaire</a></td><td> </td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td><code>$questionnaire-package</code>, <code>$next-question</code>, <code>$log-questionnaire-errors</code></td></tr><tr><td><a href="#ValueSet1-2">ValueSet</a></td><td> </td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td><code>$expand</code></td></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Questionnaire1-1" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Questionnaire</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/questionnaire.html">Questionnaire</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/></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-questionnaire-package.html">$questionnaire-package</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/uv/sdc/STU4/OperationDefinition-Questionnaire-next-question.html">$next-question</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-log-questionnaire-errors.html">$log-questionnaire-errors</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="ValueSet1-2" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>ValueSet</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/valueset.html">ValueSet</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/></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$expand</td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>
      </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/dtr-payer-service"/>
      <version value="2.2.0"/>
      <name value="DTRPayerService"/>
      <title value="DTR Payer Service"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2026-02-04"/>
      <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 capability statement defines the expected capabilities of payer systems that provide questionnaires to DTR clients. Such systems need only support server capabilities 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"/>
      <fhirVersion value="4.0.1"/>
      <format value="json"/>
      <rest>
        <mode value="server"/>
        <documentation
                       value="A DTR Payer service provides a service endpoint for DTR apps and full EHRs to connect to"/>
        <security>
          <description
                       value="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="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>