This page is part of the Da Vinci Clinical Documentation Exchange (v1.1.0: STU1.1) based on FHIR 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

• Narrative Content
• XML
• JSON

: Data Source Server CapabilityStatement - XML Representation

Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="data-source-server"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"> <h3 id="shall_igs" class="no_toc">SHALL Support the Following Implementation Guides:</h3> <ul> <li><a href="http://hl7.org/fhir/us/core/index.html">HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1</a></li> </ul> <h3 id="should_igs" class="no_toc">SHOULD Support the Following Implementation Guides:</h3> <ul> <li><a href="http://hl7.org/fhir/us/davinci-hrex/STU1/index.html">Da Vinci Health Record Exchange (HRex) 1.0.0 - STU R1</a></li> </ul> <h3 id="shall_css" class="no_toc">SHALL Implement All Or Parts Of The Following Capability Statements:</h3> <ul> <li><a href="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-server">Data Source Server CapabilityStatement</a></li> </ul> <ul> <li><a href="http://hl7.org/fhir/us/core/CapabilityStatement-us-core-server.html">US Core Server CapabilityStatement</a></li> </ul> <h3 id="behavior">FHIR RESTful Capabilities</h3> <p>The Da Vinci CDex Data Source Server <strong>SHALL</strong>:</p> <ol> <li>Support at least one of the CDex approaches for exchanging clinical information: <ol> <li>Direct Query</li> <li>Task-Based Approach</li> <li>Attachments</li> </ol> </li> <li>Support JSON source formats for all Da Vinci CDex interactions.</li> <li>Follow the guidelines for <a href="signatures.html">Generating and Verifying Signed Resources</a> <em>if signatures are required</em>.</li> <li>Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.</li> </ol> <p>The Da Vinci CDex Data Source Server <strong>MAY</strong>:</p> <ol> <li> <p>Support XML source formats for all Da Vinci CDex interactions.</p> <blockquote> <p>Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.</p> </blockquote> </li> </ol> <p id="security"><strong>Security:</strong></p> <ol> <li>For general security consideration refer to the FHIR <a href="http://build.fhir.org/secpriv-module.html">Security and Privacy Considerations</a>.</li> <li>For security considerations specific to this guide refer to the <a href="security.html">Security and Privacy</a> section.</li> </ol> <p><strong>Summary of System Wide Interactions</strong></p> <ul> <li><strong>MAY</strong> support the <code>transaction</code> interaction.</li> <li><strong>MAY</strong> support the <code>batch</code> interaction.</li> <li><strong>MAY</strong> support the <code>search-system</code> interaction.</li> <li><strong>MAY</strong> support the <code>history-system</code> interaction.</li> </ul> <h3 id="resource-details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3> <h4>Summary</h4> <table class="grid"> <thead> <tr> <th>Resource Type</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="#bundle">Bundle</a> </td> <td> <a href="StructureDefinition-cdex-signature-bundle.html">CDex Signature Bundle Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href="#provenance">Provenance</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href="#subscription">Subscription</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href="#task">Task</a> </td> <td> <a href="StructureDefinition-cdex-task-data-request.html">CDex Task Data Request Profile</a>, <a href="StructureDefinition-cdex-task-attachment-request.html">CDex Task Attachment Request Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> </tbody> </table> <h4 id="bundle" class="no_toc">Bundle</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to fetch Clinical Information from data source. <strong>SHALL</strong> support CDex Signature Bundle Profile for signed Bundles.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHOULD</strong> support: <a href="StructureDefinition-cdex-signature-bundle.html">CDex Signature Bundle Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a Bundle resource using: <code class="highlighter-rouge">GET [base]/Bundle/[id]</code> </li> </ul> <hr/> <h4 id="provenance" class="no_toc">Provenance</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to fetch provenance along with clinical information</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a Provenance resource using: <code class="highlighter-rouge">GET [base]/Provenance/[id]</code> </li> </ul> <hr/> <h4 id="subscription" class="no_toc">Subscription</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to subscribe to data source for Task-based requests.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHOULD</strong> be capable of returning a Subscription resource using: <code class="highlighter-rouge">GET [base]/Subscription/[id]</code> </li> </ul> <hr/> <h4 id="task" class="no_toc">Task</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to request and fetch clinical information from data source using Task-based requests. <strong>SHALL</strong> support <em>CDex Task Data Request Profile</em> and/or <em>CDex Task Attachment Request Profile</em>.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href="StructureDefinition-cdex-task-data-request.html">CDex Task Data Request Profile</a>, </li> <li><strong>SHALL</strong> support: <a href="StructureDefinition-cdex-task-attachment-request.html">CDex Task Attachment Request Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-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> <hr/> </div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-server"/>
  <version value="1.1.0"/>
  <name value="DataSourceServerCapabilityStatement"/>
  <title value="Data Source Server CapabilityStatement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2022-07-22T17:08:00.193060-08:00"/>
  <publisher value="HL7 International - Patient Care Work Group"/>
  <contact>
    <name value="HL7 International - Patient Care Work Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/patientcare"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="patientcare@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source  in *Server* mode when responding to a Data Consumer   during clinical data exchange. The capabilities include one or more of the following interactions:

1. Responding to a FHIR RestFul Query for Clinical Data 
1. Responding to a POST of a Task resource representing a request for clinical data
1. Responding to a POST of a Subscription  resource
1. Responding to polling of a Task resource"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Used by permission of HL7 International all rights reserved Creative Commons License"/>
  <kind value="requirements"/>
  <instantiates
                value="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-server">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </extension>
  </instantiates>
  <instantiates
                value="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </extension>
  </instantiates>
  <fhirVersion value="4.0.1"/>
  <format value="json">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </extension>
  </format>
  <format value="xml">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="MAY"/>
    </extension>
  </format>
  <implementationGuide
                       value="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHALL"/>
    </extension>
  </implementationGuide>
  <implementationGuide
                       value="http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.0.0">
    <extension
               url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
      <valueCode value="SHOULD"/>
    </extension>
  </implementationGuide>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The  Da Vinci CDex Data Source Server **SHALL**:

1. Support at least one of the CDex approaches for exchanging clinical information:
     1. Direct Query
     1. Task-Based Approach
     1. Attachments 
1. Support JSON source formats for all Da Vinci CDex interactions.
1. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.
1. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.

The  Da Vinci CDex Data Source Server **MAY**:

1. Support XML source formats for all Da Vinci CDex interactions.
   
   &gt; Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures."/>
    <security>
      <description
                   value="1. For general security consideration refer to the FHIR [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). 
1. For security considerations specific to this guide refer to the [Security and Privacy](security.html) section."/>
    </security>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <type value="Bundle"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle">
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
      </supportedProfile>
      <documentation
                     value="Required resource type to fetch Clinical Information from data source. **SHALL** support CDex Signature Bundle Profile for signed Bundles.
"/>
      <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="search-type"/>
      </interaction>
      <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="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <type value="Provenance"/>
      <documentation
                     value="Required resource type to fetch provenance along with clinical information"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <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="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <type value="Subscription"/>
      <documentation
                     value="Required resource type to subscribe to data source for Task-based requests."/>
      <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="search-type"/>
      </interaction>
      <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="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <type value="Task"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request">
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
      </supportedProfile>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-attachment-request">
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
      </supportedProfile>
      <documentation
                     value="Required resource type to request and fetch clinical information from data source using Task-based requests. **SHALL** support *CDex Task Data Request Profile* and/or *CDex Task Attachment Request Profile*."/>
      <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="search-type"/>
      </interaction>
      <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="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
    </resource>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="transaction"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="batch"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="search-system"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="history-system"/>
    </interaction>
  </rest>
</CapabilityStatement>