Da Vinci Clinical Data Exchange (CDex)
2.1.0-snapshot - CI Build
Da Vinci Clinical Data Exchange (CDex)
2.1.0-snapshot - CI Build
This page is part of the Da Vinci Clinical Documentation Exchange (v2.1.0-snapshot: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="data-consumer-server"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<!-- TODO
Jurisdiction
Prohibited extension - http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited -->
<!-- set include_symbols = false to turn off confonrmance symbols and legen, true to turn on -->
<h2 id="title">Data Consumer Server CapabilityStatement</h2>
<ul>
<li><b>Title:</b>Data Consumer Server CapabilityStatement</li>
<li><b>Implementation Guide Version:</b> 2.1.0-snapshot</li>
<li><b>FHIR Version:</b> 4.0.1</li>
<li><b>Intended Use:</b> Requirements</li>
<li><b>Supported Formats: </b>
<strong>SHALL</strong> support
json;
<strong>MAY</strong> support
xml;
</li>
<li><b>Supported Patch Formats:</b>
<strong>MAY</strong> support
application/json-patch+json;
</li>
<li><b>Published:</b> 2024-09-10 15:05:28-0800</li>
<li><b>Published by:</b> HL7 International / Payer/Provider Information Exchange Work Group</li>
<li><b>Status:</b> Active</li>
<li><b>Copyright:</b> <div><p>Used by permission of HL7 International all rights reserved Creative Commons License</p>
</div></li>
</ul>
<br/>
<strong>Description:</strong> <div><div><p>This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer in <em>Server</em> mode when responding to a Data Source or one of its proxies during clinical data exchange. The capabilities include one or more of the following interactions:</p>
<ol>
<li>Responding to a query for authorization information represented by a CommunicationRequest or ServiceRequest</li>
<li>Responding to the <code>$submit-attachment</code> operation.</li>
</ol>
</div></div>
<br/>
<h3>Support and Requirements for Other Artifacts</h3>
<tr>
<th>Supports other guides:</th>
<td>
<ul>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/core/STU3.1.1/ImplementationGuide-hl7.fhir.us.core.html">US Coreversion: null3.1.1)</a>
</li>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/core/STU6.1/ImplementationGuide-hl7.fhir.us.core.html">US Core Implementation Guideversion: null6.1.0)</a>
</li>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/core/STU7/index.html">US Core Implementation Guideversion: null7.0.0)</a>
</li>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/davinci-hrex/STU1/ImplementationGuide-hl7.fhir.us.davinci-hrex.html">Da Vinci Health Record Exchange (HRex)version: null1.0.0)</a>
</li>
</ul>
</td>
</tr>
<br/>
<!-- TODO - Make this a summary of capabilities, including system wide and each paradigm -->
<p>
<b>Jump to:</b>
</p>
<ul>
<li><a href="#Server">REST Server</a></li>
</ul>
<!-- REST Capabilities -->
<br/>
<a name="Server"> </a>
<h3 id="behavior">FHIR Server RESTful Capabilities</h3>
<div><div><p>The Da Vinci CDex Data Consumer Server <strong>SHALL</strong>:</p>
<ol>
<li>Support at least one of the CDex approaches for exchanging clinical information:
<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>.</li>
<li>Support JSON source formats for all Da Vinci CDex interactions.</li>
<li>Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.
<ul>
<li>Follow the guidelines for <a href="attachments-conformance.html">Conforming to CDex Attachments</a> if supporting this exchange.</li>
</ul>
</li>
</ol>
<p>The Da Vinci CDex Data Consumer 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>
</div></div>
<!-- REST Security -->
<br/>
<p id="security"><strong>Security:</strong></p>
<div><div><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>
</div></div>
<!-- REST System wide Capabilities -->
<h3>System-wide Server Capabilities</h3>
<!-- REST System wide interactions -->
<h4>Interactions</h4>
<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>
<!-- REST System wide operations -->
<h4>Operations</h4>
<ul>
<li>
<strong>SHOULD</strong> support the
<code>submit-attachment</code><sup>+</sup> operation.</li>
</ul>
<blockquote>
<sup>+</sup>submit-attachment<div><p>If <a href="attachments.html">Attachments</a> is supported, the Data Consumer Server <strong>SHALL</strong> support the <code>$submit-attachment</code> operation.</p>
</div>
</blockquote>
<!-- REST System wide search parameters -->
<!-- Resource Capabilities -->
<h4>Summary of Resource/Profile Capabilities</h4>
<!-- TODO need include conformance verb legend -->
<table class="grid">
<thead>
<tr>
<th>Resource Type</th>
<th>Supported Interactions</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="#Server_CommunicationRequest"><span style="white-space: nowrap;">CommunicationRequest</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">search-type</span>,
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">vread</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">patch</span>,
<span style="white-space: nowrap;">delete</span>,
<span style="white-space: nowrap;">history-instance</span>,
<span style="white-space: nowrap;">history-type</span>,
</td>
<!-- Supported Profiles -->
<td>
</td>
<!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
<td>
</td>
<!-- Supported _includes -->
<td>
</td>
<!-- Supported _revincludes -->
<td>
</td>
<!-- Supported Operations -->
<td>
</td>
</tr>
<tr>
<td>
<a href="#Server_DocumentReference"><span style="white-space: nowrap;">DocumentReference</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">search-type</span>,
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">vread</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">patch</span>,
<span style="white-space: nowrap;">delete</span>,
<span style="white-space: nowrap;">history-instance</span>,
<span style="white-space: nowrap;">history-type</span>,
</td>
<!-- Supported Profiles -->
<td>
<a href="http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profileversion: null3.1.1)</a>,
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profileversion: null6.1.0)</a>,
<a href="http://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profileversion: null7.0.0)</a>,
</td>
<!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
<td>
</td>
<!-- Supported _includes -->
<td>
</td>
<!-- Supported _revincludes -->
<td>
</td>
<!-- Supported Operations -->
<td>
</td>
</tr>
<tr>
<td>
<a href="#Server_Parameters"><span style="white-space: nowrap;">Parameters</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">search-type</span>,
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">vread</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">patch</span>,
<span style="white-space: nowrap;">delete</span>,
<span style="white-space: nowrap;">history-instance</span>,
<span style="white-space: nowrap;">history-type</span>,
</td>
<!-- Supported Profiles -->
<td>
</td>
<!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
<td>
</td>
<!-- Supported _includes -->
<td>
</td>
<!-- Supported _revincludes -->
<td>
</td>
<!-- Supported Operations -->
<td>
</td>
</tr>
<tr>
<td>
<a href="#Server_QuestionnaireResponse"><span style="white-space: nowrap;">QuestionnaireResponse</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">search-type</span>,
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">vread</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">patch</span>,
<span style="white-space: nowrap;">delete</span>,
<span style="white-space: nowrap;">history-instance</span>,
<span style="white-space: nowrap;">history-type</span>,
</td>
<!-- Supported Profiles -->
<td>
<a href="StructureDefinition-cdex-sdc-questionnaireresponse.html">CDex SDC QuestionnaireResponse Profileversion: null2.1.0-snapshot)</a>,
</td>
<!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
<td>
</td>
<!-- Supported _includes -->
<td>
</td>
<!-- Supported _revincludes -->
<td>
</td>
<!-- Supported Operations -->
<td>
</td>
</tr>
<tr>
<td>
<a href="#Server_ServiceRequest"><span style="white-space: nowrap;">ServiceRequest</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">search-type</span>,
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">vread</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">patch</span>,
<span style="white-space: nowrap;">delete</span>,
<span style="white-space: nowrap;">history-instance</span>,
<span style="white-space: nowrap;">history-type</span>,
</td>
<!-- Supported Profiles -->
<td>
</td>
<!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
<td>
</td>
<!-- Supported _includes -->
<td>
</td>
<!-- Supported _revincludes -->
<td>
</td>
<!-- Supported Operations -->
<td>
</td>
</tr>
</tbody>
</table>
<br/>
<h3 id="resource-details" class="no_toc">RESTful Server Capabilities by Resource/Profile:</h3>
<!-- Each REST Resource Detail -->
<h4 id="Server_CommunicationRequest" class="no_toc">CommunicationRequest</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to carry authorization information regarding for requesting Clinical information</p>
</div></blockquote>
<p>
</p>
<!-- Resource Interactions -->
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A Server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a CommunicationRequest resource using:
<code class="highlighter-rouge">POST [base]/CommunicationRequest/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A Server <strong>MAY</strong> be capable of updating a existing CommunicationRequest resource using:
<code class="highlighter-rouge">PUT [base]/CommunicationRequest/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of patching an existing CommunicationRequest resource using:
<code class="highlighter-rouge">PATCH [base]/CommunicationRequest/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of deleting a CommunicationRequest resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning CommunicationRequest resources matching a search query using:
<code class="highlighter-rouge">GET [base]/CommunicationRequest/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a CommunicationRequest resource using:
<code class="highlighter-rouge">GET [base]/CommunicationRequest/[id]</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a CommunicationRequest resource using:
<code class="highlighter-rouge">GET [base]/CommunicationRequest/[id]/_history/vid</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a CommunicationRequest using:
<code class="highlighter-rouge">GET [base]/CommunicationRequest/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of CommunicationRequest resources using:
<code class="highlighter-rouge">GET [base]/CommunicationRequest/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_DocumentReference" class="no_toc">DocumentReference</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to support the <code>$submit-attachment</code> operation</p>
</div></blockquote>
<p>Supported Profiles:</p>
<ul>
<li><strong>SHALL</strong> support
<a href="http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profileversion: null3.1.1)</a>
</li>
<li><strong>SHALL</strong> support
<a href="http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profileversion: null6.1.0)</a>
</li>
<li><strong>SHALL</strong> support
<a href="http://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profileversion: null7.0.0)</a>
</li>
</ul>
<p>
</p>
<!-- Resource Interactions -->
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>create</code> interaction creating a DocumentReference resource using:
<code class="highlighter-rouge">POST [base]/DocumentReference/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A Server <strong>SHOULD</strong> be capable of updating a existing DocumentReference resource using:
<code class="highlighter-rouge">PUT [base]/DocumentReference/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of patching an existing DocumentReference resource using:
<code class="highlighter-rouge">PATCH [base]/DocumentReference/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of deleting a DocumentReference resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>MAY</strong> be capable of a <code>search-type</code> interaction returning DocumentReference resources matching a search query using:
<code class="highlighter-rouge">GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a DocumentReference resource using:
<code class="highlighter-rouge">GET [base]/DocumentReference/[id]</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a DocumentReference resource using:
<code class="highlighter-rouge">GET [base]/DocumentReference/[id]/_history/vid</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a DocumentReference using:
<code class="highlighter-rouge">GET [base]/DocumentReference/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of DocumentReference resources using:
<code class="highlighter-rouge">GET [base]/DocumentReference/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_Parameters" class="no_toc">Parameters</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to support the <code>$submit-attachment</code> operation</p>
</div></blockquote>
<p>
</p>
<!-- Resource Interactions -->
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A Server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a Parameters resource using:
<code class="highlighter-rouge">POST [base]/Parameters/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A Server <strong>MAY</strong> be capable of updating a existing Parameters resource using:
<code class="highlighter-rouge">PUT [base]/Parameters/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of patching an existing Parameters resource using:
<code class="highlighter-rouge">PATCH [base]/Parameters/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of deleting a Parameters resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning Parameters resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Parameters/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a Parameters resource using:
<code class="highlighter-rouge">GET [base]/Parameters/[id]</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a Parameters resource using:
<code class="highlighter-rouge">GET [base]/Parameters/[id]/_history/vid</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a Parameters using:
<code class="highlighter-rouge">GET [base]/Parameters/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of Parameters resources using:
<code class="highlighter-rouge">GET [base]/Parameters/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_QuestionnaireResponse" class="no_toc">QuestionnaireResponse</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to support the <code>$submit-attachment</code> operation for Requesting Attachments Using Questionnaires. <em>SHALL</em>* support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.</p>
</div></blockquote>
<p>Supported Profiles:</p>
<ul>
<li><strong>SHOULD</strong> support
<a href="StructureDefinition-cdex-sdc-questionnaireresponse.html">CDex SDC QuestionnaireResponse Profileversion: null2.1.0-snapshot)</a>
</li>
</ul>
<p>
</p>
<!-- Resource Interactions -->
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A Server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a QuestionnaireResponse resource using:
<code class="highlighter-rouge">POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A Server <strong>MAY</strong> be capable of updating a existing QuestionnaireResponse resource using:
<code class="highlighter-rouge">PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of patching an existing QuestionnaireResponse resource using:
<code class="highlighter-rouge">PATCH [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of deleting a QuestionnaireResponse resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning QuestionnaireResponse resources matching a search query using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a QuestionnaireResponse resource using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a QuestionnaireResponse resource using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]/_history/vid</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a QuestionnaireResponse using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of QuestionnaireResponse resources using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_ServiceRequest" class="no_toc">ServiceRequest</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to carry authorization information regarding for requesting Clinical information</p>
</div></blockquote>
<p>
</p>
<!-- Resource Interactions -->
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A Server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a ServiceRequest resource using:
<code class="highlighter-rouge">POST [base]/ServiceRequest/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A Server <strong>MAY</strong> be capable of updating a existing ServiceRequest resource using:
<code class="highlighter-rouge">PUT [base]/ServiceRequest/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of patching an existing ServiceRequest resource using:
<code class="highlighter-rouge">PATCH [base]/ServiceRequest/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of deleting a ServiceRequest resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning ServiceRequest resources matching a search query using:
<code class="highlighter-rouge">GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a ServiceRequest resource using:
<code class="highlighter-rouge">GET [base]/ServiceRequest/[id]</code>
</li>
<li>
A Server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a ServiceRequest resource using:
<code class="highlighter-rouge">GET [base]/ServiceRequest/[id]/_history/vid</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a ServiceRequest using:
<code class="highlighter-rouge">GET [base]/ServiceRequest/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A Server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of ServiceRequest resources using:
<code class="highlighter-rouge">GET [base]/ServiceRequest/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<!-- Messaging Capabilities -->
<!-- Document Capabilities -->
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="claims"/>
</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-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"/>
</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-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-server"/>
<version value="2.1.0-snapshot"/>
<name value="DataConsumerServerCapabilityStatement"/>
<title value="Data Consumer Server CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2024-09-10T15:05:28.498183-08:00"/>
<publisher
value="HL7 International / 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>
<telecom>
<system value="email"/>
<value value="pie@lists.hl7.org"/>
</telecom>
</contact>
<description
value="This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer in *Server* mode when responding to a Data Source or one of its proxies during clinical data exchange. The capabilities include one or more of the following interactions:
1. Responding to a query for authorization information represented by a CommunicationRequest or ServiceRequest
1. Responding to the `$submit-attachment` operation."/>
<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"/>
<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>
<patchFormat value="application/json-patch+json">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
</patchFormat>
<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="SHOULD"/>
</extension>
</implementationGuide>
<implementationGuide
value="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|6.1.0">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</implementationGuide>
<implementationGuide
value="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|7.0.0">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</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 Consumer Server **SHALL**:
1. Support at least one of the CDex approaches for exchanging clinical information:
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 the scenarios, transactions and profiles supported.
- Follow the guidelines for [Conforming to CDex Attachments](attachments-conformance.html) if supporting this exchange.
The Da Vinci CDex Data Consumer Server **MAY**:
1. Support XML source formats for all Da Vinci CDex interactions.
> 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="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="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="DocumentReference"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|3.1.1">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|6.1.0">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|7.0.0">🔗
<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="Parameters"/>
<documentation
value="Required resource type to support the `$submit-attachment` operation"/>
<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="QuestionnaireResponse"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse|2.1.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation
value="Required resource type to support the `$submit-attachment` operation for Requesting Attachments Using Questionnaires. *SHALL** support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse."/>
<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="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>
<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 Consumer Server **SHALL** support the `$submit-attachment` operation."/>
</operation>
</rest>
</CapabilityStatement>
IG © 2024+ HL7 International / Payer/Provider Information Exchange Work Group. Package hl7.fhir.us.davinci-cdex#2.1.0-snapshot based on FHIR 4.0.1. Generated 2024-09-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change