Da Vinci Clinical Data Exchange (CDex)
1.0.0 - STU R1
US
Da Vinci Clinical Data Exchange (CDex)
1.0.0 - STU R1
US
This page is part of the Da Vinci Clinical Documentation Exchange (v1.0.0: STU1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
| Active as of 2022-02-28 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="data-source-client"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"> <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-consumer-client">Data Consumer Client CapabilityStatement</a></li> </ul> <ul> <li><a href="http://hl7.org/fhir/us/core/CapabilityStatement-us-core-client.html">US Core Client CapabilityStatement</a></li> </ul> <h3 id="behavior">FHIR RESTful Capabilities</h3> <p>The Da Vinci CDex Data Source <strong>SHALL</strong>:</p> <ol> <li>Support at least one of these FHIR transaction approaches for exchanging clinical information as defined in this Guide: <ol> <li>Task Based Approach</li> <li>Attachments</li> </ol> </li> <li>Follow the guidelines for <a href="signatures.html">Generating and Verifying Signed Resources</a> <em>if signatures are required</em>.1. Support json source formats for all Da Vinci CDex interactions.</li> <li>Declare a CapabilityStatement identifying transactions and profiles supported.</li> </ol> <p>The Da Vinci CDex Data Source <strong>SHOULD</strong>:</p> <ol> <li>Support xml source formats for all Da Vinci CDex interactions.</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> <p><strong>Summary of System Wide Operations</strong></p> <ul> <li><strong>SHOULD</strong> support the <a href="http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment"><code>$submit-attachment</code></a> operation.</li> <blockquote><p>If <a href="attachments.html">Attachments</a> is supported, the Data Source Client <strong>SHALL</strong> support the <code>$submit-attachment</code> operation.</p> </blockquote></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="#communicationrequest">CommunicationRequest</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href="#documentreference">DocumentReference</a> </td> <td> <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference">US Core DocumentReference Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href="#servicerequest">ServiceRequest</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> </tbody> </table> <h4 id="communicationrequest" class="no_toc">CommunicationRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to carry authorization information regarding for requesting Clinical information</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code><sup>†</sup>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <blockquote>read<sup>†</sup><p>Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a CommunicationRequest resource using: <code class="highlighter-rouge">GET [base]/CommunicationRequest/[id]</code> </li> </ul> <hr/> <h4 id="documentreference" class="no_toc">DocumentReference</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to support the <code>$submit-attachment</code> operation</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference">US Core DocumentReference Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>search-type</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 Client <strong>SHOULD</strong> be capable of fetching a DocumentReference resource using: <code class="highlighter-rouge">GET [base]/DocumentReference/[id]</code> </li> </ul> <hr/> <h4 id="servicerequest" class="no_toc">ServiceRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to carry authorization information regarding for requesting Clinical information</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code><sup>†</sup>, <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> <blockquote>read<sup>†</sup><p>Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a ServiceRequest resource using: <code class="highlighter-rouge">GET [base]/ServiceRequest/[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</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code><sup>†</sup>, <code>update</code><sup>†</sup>.</li><li><strong>MAY</strong> support <code>create</code>, <code>read</code>, <code>vread</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <blockquote>search-type<sup>†</sup><p>If subscriptions are supported the subscription notification is posted to it endpoint updating the status of a Task</p> </blockquote><blockquote>update<sup>†</sup><p>If subscriptions are supported the subscription notification is posted to it endpoint updating the status of a Task</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>MAY</strong> be capable of fetching a Subscription resource using: <code class="highlighter-rouge">GET [base]/Subscription/[id]</code> </li> </ul> <hr/> </div>
</text>
<url
value="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-client"/>
<version value="1.0.0"/>
<name value="DataSourceClientCapabilityStatement"/>
<title value="Data Source Client CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2022-02-28T19:34:33.446501-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 (often an EHR) in *Client* mode during a clinical data exchange with a Data Consumer. This includes the following interactions:
1. POSTing the `$submit-attachment` operation to exchange clinical data using a FHIR based Attachments transaction.
1. Query for Authorization information represented by a CommunicationRequest or ServiceRequest.
1. Posting a subscription notification to a Data Consumer endpoint updating the status of a Task."/>
<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-consumer-client">
<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-client">
<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="SHOULD"/>
</extension>
</format>
<rest>
<mode value="client"/>
<documentation
value="The Da Vinci CDex Data Source **SHALL**:
1. Support at least one of these FHIR transaction approaches for exchanging clinical information as defined in this Guide:
1. Task Based Approach
1. Attachments
1. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.1. Support json source formats for all Da Vinci CDex interactions.
1. Declare a CapabilityStatement identifying transactions and profiles supported.
The Da Vinci CDex Data Source **SHOULD**:
1. Support xml source formats for all Da Vinci CDex interactions."/>
<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="CommunicationRequest"/>
<documentation
value="Required resource type to carry authorization information regarding for requesting 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="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation
value="Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"/>
</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="DocumentReference"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="Required resource type to support the `$submit-attachment` operation"/>
<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="MAY"/>
</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="ServiceRequest"/>
<documentation
value="Required resource type to carry authorization information regarding for requesting 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"/>
<documentation
value="Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"/>
</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"/>
<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"/>
<documentation
value="If subscriptions are supported the subscription notification is posted to it endpoint updating the status of a Task"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="update"/>
<documentation
value="If subscriptions are supported the subscription notification is posted to it endpoint updating the status of a Task"/>
</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>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="submit-attachment"/>
<definition
value="http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment"/>
<documentation
value="If [Attachments](attachments.html) is supported, the Data Source Client **SHALL** support the `$submit-attachment` operation."/>
</operation>
</rest>
</CapabilityStatement>
IG © 2022+ HL7 International - Patient Care Work Group. Package hl7.fhir.us.davinci-cdex#1.0.0 based on FHIR 4.0.1. Generated 2022-03-28
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change