Dental Data Exchange
2.0.0-ballot - CI Build

Dental Data Exchange, published by Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/dental-data-exchange/ and changes regularly. See the Directory of published versions

## : Dental Data Exchange Client - XML Representation

Active as of 2020-08-12

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="dental-client-capstat"/>
      <meta>
        <versionId value="11"/>
        <lastUpdated value="2021-07-13T20:34:38.414+00:00"/>
        <source value="#pQcDfyrtxlIFq5DN"/>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement dental-client-capstat</b></p><a name="dental-client-capstat"> </a><a name="hcdental-client-capstat"> </a><a name="dental-client-capstat-en-US"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">version: 11; Last updated: 2021-07-13 20:34:38+0000; </p><p style="margin-bottom: 0px">Information Source: #pQcDfyrtxlIFq5DN</p></div><h2 id="title">Dental Data Exchange Client</h2><ul><li>Implementation Guide Version: 2.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-08-12 </li><li>Published by: Payer/Provider Information Exchange Work Group </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 <code>http://hl7.org/fhir/us/ccda/CapabilityStatement/CcdaOnFhirClient</code></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>The expected capabilities for the client actor within the stanadards-based exchange conforming to this FHIR ImplementationGuide,</p>
    </div><div class="lead"><em>Summary of System-wide Interactions</em></div></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 past versions of resources (vread interaction)">V-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="PATCH a new resource version (patch interaction)">P</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th class="text-center"><b title="DELETE a resource (delete interaction)">D</b></th><th class="text-center"><b title="GET changes to a resource (history interaction on instance)">H-I</b></th><th class="text-center"><b title="GET changes for all resources of the type (history interaction on type)">H-T</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="#Bundle1-1">Bundle</a></td><td> </td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Composition1-2">Composition</a></td><td>Supported Profiles<br/>  <code>http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-referral-note</code><br/>  <code>http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-consult-note</code></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Communication1-3">Communication</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-dental-communication.html">Dental Communication</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#ServiceRequest1-4">ServiceRequest</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-dental-servicerequest.html">Dental Service Request</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Observation1-5">Observation</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-dental-findings.html">Dental Findings</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Condition1-6">Condition</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-dental-condition.html">Dental Condition</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</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="Bundle1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Bundle</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/bundle.html">Bundle</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><li>Supports <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li></ul></div></div><p/><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Composition1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Composition</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/composition.html">Composition</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><li>Supports <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><code>http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-referral-note</code><br/><code>http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-consult-note</code></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Communication1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Communication</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/communication.html">Communication</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><li>Supports <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-dental-communication.html">Dental Communication</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="ServiceRequest1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>ServiceRequest</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/servicerequest.html">ServiceRequest</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><li>Supports <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-dental-servicerequest.html">Dental Service Request</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-5" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Observation</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/observation.html">Observation</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><li>Supports <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-dental-findings.html">Dental Findings</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Condition1-6" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Condition</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/condition.html">Condition</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><li>Supports <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-dental-condition.html">Dental Condition</a></p></div></div><p/></div></div></div><h2 id="document">FHIR Document Capabilities</h2><table class="table table-condensed table-hover"><thead><tr><th>Mode</th><th>Document Resource Profile</th><th>Documentation</th></tr></thead><tbody><tr><td>consumer</td><td><code>http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-referral-note</code></td><td> </td></tr><tr><td>consumer</td><td><code>http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-consult-note</code></td><td> </td></tr><tr><td>consumer</td><td><a href="StructureDefinition-dental-communication.html">Dental Communication</a></td><td> </td></tr><tr><td>consumer</td><td><a href="StructureDefinition-dental-servicerequest.html">Dental Service Request</a></td><td> </td></tr><tr><td>consumer</td><td><a href="StructureDefinition-dental-findings.html">Dental Findings</a></td><td> </td></tr><tr><td>consumer</td><td><a href="StructureDefinition-dental-condition.html">Dental Condition</a></td><td> </td></tr></tbody></table></div>
      </text>
      <url
           value="http://hl7.org/fhir/us/dental-data-exchange/CapabilityStatement/dental-client-capstat"/>
      <version value="2.0.0-ballot"/>
      <name value="DentalClient"/>
      <title value="Dental Data Exchange Client"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2020-08-12"/>
      <publisher value="Payer/Provider Information Exchange Work Group"/>
      <contact>
        <name
              value="HL7 International - Payer/Provider Information Exchange Work Group"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/claims"/>
        </telecom>
      </contact>
      <description
                   value="This section describes the expected capabilities of the Dental Data Exchange Document Consumer (aka client) actor which is responsible for creating and initiating the queries for clinical documents provided by a Dental Data Exchange Document Source (aka server) actors. This CapabilityStatement imports and extends [CCDAonFHIR-client CapabilityStatement](http://hl7.org/fhir/us/ccda/CapabilityStatement-CcdaOnFhirClient.html)CCDAonFHIR client CapabilityStatement, which imports and extends the [us-core-client CapabilityStatement](https://www.hl7.org/fhir/us/core/CapabilityStatement-us-core-client.html)"/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="United States of America"/>
        </coding>
        <text value="US"/>
      </jurisdiction>
      <kind value="requirements"/>
      <imports
               value="http://hl7.org/fhir/us/ccda/CapabilityStatement/CcdaOnFhirClient"/>
      <fhirVersion value="4.0.1"/>
      <format value="xml"/>
      <format value="json"/>
      <rest>
        <mode value="client"/>
        <documentation
                       value="The expected capabilities for the client actor within the stanadards-based exchange conforming to this FHIR ImplementationGuide,"/>
        <resource>
          <type value="Bundle"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="vread"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="patch"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <code value="history-type"/>
          </interaction>
        </resource>
        <resource>
          <type value="Composition"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-referral-note"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-consult-note"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="vread"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="patch"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <code value="history-type"/>
          </interaction>
        </resource>
        <resource>
          <type value="Communication"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-communication"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="vread"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="patch"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <code value="history-type"/>
          </interaction>
        </resource>
        <resource>
          <type value="ServiceRequest"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/dental-data-exchange/dental-servicerequest"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="vread"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="patch"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <code value="history-type"/>
          </interaction>
        </resource>
        <resource>
          <type value="Observation"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-findings"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="vread"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="patch"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <code value="history-type"/>
          </interaction>
        </resource>
        <resource>
          <type value="Condition"/>
          <supportedProfile
                            value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-condition"/>
          <interaction>
            <code value="create"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="vread"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="patch"/>
          </interaction>
          <interaction>
            <code value="delete"/>
          </interaction>
          <interaction>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <code value="history-type"/>
          </interaction>
        </resource>
      </rest>
      <document>
        <mode value="consumer"/>
        <profile
                 value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-referral-note"/>
      </document>
      <document>
        <mode value="consumer"/>
        <profile
                 value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-consult-note"/>
      </document>
      <document>
        <mode value="consumer"/>
        <profile
                 value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-communication"/>
      </document>
      <document>
        <mode value="consumer"/>
        <profile
                 value="http://hl7.org/fhir/us/dental-data-exchange/dental-servicerequest"/>
      </document>
      <document>
        <mode value="consumer"/>
        <profile
                 value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-findings"/>
      </document>
      <document>
        <mode value="consumer"/>
        <profile
                 value="http://hl7.org/fhir/us/dental-data-exchange/StructureDefinition/dental-condition"/>
      </document>
    </CapabilityStatement>