Da Vinci - Documentation Templates and Rules
2.2.0-snapshot - STU 2.2 - Peer Review United States of America flag

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-snapshot 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 json | Download

{
  "resourceType" : "CapabilityStatement",
  "id" : "dtr-payer-service",
  "language" : "en",
  "text" : {
    "status" : "extensions",
    "div" : "<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-snapshot </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>\n</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>\n</div></blockquote><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide 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>$expand</td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"https://build.fhir.org/ig/HL7/sdc/OperationDefinition-Questionnaire-next-question.html\">$next-question</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/dtr-payer-service",
  "version" : "2.2.0-snapshot",
  "name" : "DTRPayerService",
  "title" : "DTR Payer Service",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-02-04",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "name" : "HL7 International / Clinical Decision Support",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "This 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" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "A DTR Payer service provides a service endpoint for DTR apps and full EHRs to connect to",
      "security" : {
        "description" : "Implementations **SHALL** meet the general security requirements documented in the [HRex implementation guide](https://build.fhir.org/ig/HL7/davinci-ehrx)."
      },
      "operation" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "name" : "questionnaire-package",
          "definition" : "http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/questionnaire-package"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "name" : "expand",
          "definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "name" : "next-question",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question|4.0.0"
        }
      ]
    }
  ]
}