Da Vinci Clinical Data Exchange (CDex)
2.1.0-preview - CI Build
Da Vinci Clinical Data Exchange (CDex)
2.1.0-preview - CI Build
Da Vinci Clinical Data Exchange (CDex), published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ecdx/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="data-consumer-client"/>
<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 Client CapabilityStatement</h2>
<ul>
<li><b>Title:</b>Data Consumer Client CapabilityStatement</li>
<li><b>Implementation Guide Version:</b> 2.1.0-preview</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-04-23 12:06:58-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>Client</em> mode when requesting clinical data from the Data Source during clinical data exchange. The capabilities include one or more of the following interactions:</p>
<ol>
<li>Requesting and Fetching Clinical Data using a FHIR RESTful query</li>
<li>Requesting and Fetching Clinical Data using a Task-based query including:
<ul>
<li>Polling or Subscribing for Task update notifications</li>
</ul>
</li>
<li>Requesting Attachments
<ul>
<li>Requesting Attachments Using Attachments Codes</li>
<li>Requesting Attachments Using Questionnaires</li>
</ul>
</li>
</ol>
</div></div>
<br/>
<h3>Support and Requirements for Other Artifacts</h3>
<tr>
<th>Instantiates other capabilities:</th>
<td>
<ul>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html">US Core Client CapabilityStatement</a>
</li>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html">US Core Client CapabilityStatement</a>
</li>
</ul>
</td>
</tr>
<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 Core</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 Guide</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)</a>
</li>
<li>
<strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/davinci-dtr/STU2/ImplementationGuide-hl7.fhir.us.davinci-dtr.html">Da Vinci - Documentation Templates and Rules</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="#client">REST client</a></li>
</ul>
<!-- REST Capabilities -->
<br/>
<a name="client"> </a>
<h3 id="behavior">FHIR client RESTful Capabilities</h3>
<div><div><p>The Da Vinci CDex Data Consumer Client <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>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="task-based-conformance.html">Conforming to CDex Task Based Approach</a> if supporting this exchange.</li>
<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 Client <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 <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 Da Vinci HRex Implementation Guide section on <a href="http://hl7.org/fhir/us/davinci-hrex/security.html">Security and Privacy</a></li>
</ol>
</div></div>
<!-- REST System wide Capabilities -->
<h3>System-wide client 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 -->
<!-- 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="#client_Bundle"><span style="white-space: nowrap;">Bundle</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-signature-bundle.html">CDex Signature Bundle Profile</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="#client_Patient"><span style="white-space: nowrap;">Patient</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-patient-demographics.html">CDex Patient Demographics Profile</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="#client_PractitionerRole"><span style="white-space: nowrap;">PractitionerRole</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-practitionerrole.html">CDex PractitionerRole Profile</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="#client_Provenance"><span style="white-space: nowrap;">Provenance</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="#client_Questionnaire"><span style="white-space: nowrap;">Questionnaire</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/davinci-dtr/STU2/StructureDefinition-dtr-std-questionnaire.html">DTR Standard Questionnaire</a>,
<a href="http://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-questionnaire-adapt.html">DTR Questionnaire for adaptive form</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="#client_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 Profile</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="#client_Subscription"><span style="white-space: nowrap;">Subscription</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="#client_Task"><span style="white-space: nowrap;">Task</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-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>
<!-- 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 client Capabilities by Resource/Profile:</h3>
<!-- Each REST Resource Detail -->
<h4 id="client_Bundle" class="no_toc">Bundle</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to fetch Clinical Information from data source. <strong>SHALL</strong> support CDex Signature Bundle Profile for signed Bundles.</p>
</div></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>
</p>
<!-- Resource Interactions -->
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a Bundle resource using:
<code class="highlighter-rouge">POST [base]/Bundle/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>MAY</strong> be capable of putting a existing Bundle resource using:
<code class="highlighter-rouge">PUT [base]/Bundle/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing Bundle resource using:
<code class="highlighter-rouge">PATCH [base]/Bundle/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a Bundle resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching Bundle resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Bundle/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Bundle resource using:
<code class="highlighter-rouge">GET [base]/Bundle/[id]</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Bundle resource using:
<code class="highlighter-rouge">GET [base]/Bundle/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Bundle using:
<code class="highlighter-rouge">GET [base]/Bundle/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Bundle resources using:
<code class="highlighter-rouge">GET [base]/Bundle/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="client_Patient" class="no_toc">Patient</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to supply patient demographic data when requesting attachments.</p>
</div></blockquote>
<p>Supported Profiles:</p>
<ul>
<li><strong>SHALL</strong> support
<a href="StructureDefinition-cdex-patient-demographics.html">CDex Patient Demographics Profile</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 client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a Patient resource using:
<code class="highlighter-rouge">POST [base]/Patient/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>MAY</strong> be capable of putting a existing Patient resource using:
<code class="highlighter-rouge">PUT [base]/Patient/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing Patient resource using:
<code class="highlighter-rouge">PATCH [base]/Patient/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a Patient resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Patient resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>read</code> interaction fetching a Patient resource using:
<code class="highlighter-rouge">GET [base]/Patient/[id]</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>vread</code> interaction fetching a Patient resource using:
<code class="highlighter-rouge">GET [base]/Patient/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Patient using:
<code class="highlighter-rouge">GET [base]/Patient/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Patient resources using:
<code class="highlighter-rouge">GET [base]/Patient/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="client_PractitionerRole" class="no_toc">PractitionerRole</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to supply patient demographic data when requesting attachments.</p>
</div></blockquote>
<p>Supported Profiles:</p>
<ul>
<li><strong>SHALL</strong> support
<a href="StructureDefinition-cdex-practitionerrole.html">CDex PractitionerRole Profile</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 client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a PractitionerRole resource using:
<code class="highlighter-rouge">POST [base]/PractitionerRole/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>MAY</strong> be capable of putting a existing PractitionerRole resource using:
<code class="highlighter-rouge">PUT [base]/PractitionerRole/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing PractitionerRole resource using:
<code class="highlighter-rouge">PATCH [base]/PractitionerRole/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a PractitionerRole resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching PractitionerRole resources matching a search query using:
<code class="highlighter-rouge">GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>read</code> interaction fetching a PractitionerRole resource using:
<code class="highlighter-rouge">GET [base]/PractitionerRole/[id]</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>vread</code> interaction fetching a PractitionerRole resource using:
<code class="highlighter-rouge">GET [base]/PractitionerRole/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a PractitionerRole using:
<code class="highlighter-rouge">GET [base]/PractitionerRole/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of PractitionerRole resources using:
<code class="highlighter-rouge">GET [base]/PractitionerRole/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="client_Provenance" class="no_toc">Provenance</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to fetch provenance along with 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 client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a Provenance resource using:
<code class="highlighter-rouge">POST [base]/Provenance/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>MAY</strong> be capable of putting a existing Provenance resource using:
<code class="highlighter-rouge">PUT [base]/Provenance/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing Provenance resource using:
<code class="highlighter-rouge">PATCH [base]/Provenance/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a Provenance resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching Provenance resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Provenance/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Provenance resource using:
<code class="highlighter-rouge">GET [base]/Provenance/[id]</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Provenance resource using:
<code class="highlighter-rouge">GET [base]/Provenance/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Provenance using:
<code class="highlighter-rouge">GET [base]/Provenance/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Provenance resources using:
<code class="highlighter-rouge">GET [base]/Provenance/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="client_Questionnaire" class="no_toc">Questionnaire</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to when requesting data or attachments using Questionnaire</p>
</div></blockquote>
<p>Supported Profiles:</p>
<ul>
<li><strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-std-questionnaire.html">DTR Standard Questionnaire</a>
</li>
<li><strong>SHOULD</strong> support
<a href="http://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-questionnaire-adapt.html">DTR Questionnaire for adaptive form</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 client <strong>SHOULD</strong> be capable of a <code>create</code> interaction posting a Questionnaire resource using:
<code class="highlighter-rouge">POST [base]/Questionnaire/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>SHOULD</strong> be capable of putting a existing Questionnaire resource using:
<code class="highlighter-rouge">PUT [base]/Questionnaire/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing Questionnaire resource using:
<code class="highlighter-rouge">PATCH [base]/Questionnaire/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a Questionnaire resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching Questionnaire resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Questionnaire resource using:
<code class="highlighter-rouge">GET [base]/Questionnaire/[id]</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Questionnaire resource using:
<code class="highlighter-rouge">GET [base]/Questionnaire/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Questionnaire using:
<code class="highlighter-rouge">GET [base]/Questionnaire/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Questionnaire resources using:
<code class="highlighter-rouge">GET [base]/Questionnaire/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="client_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 fetch completed questionnaires from data source. <strong>SHALL</strong> 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 Profile</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 client <strong>MAY</strong> be capable of a <code>create</code> interaction posting 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 client <strong>MAY</strong> be capable of putting a existing QuestionnaireResponse resource using:
<code class="highlighter-rouge">PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <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 client <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 client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching QuestionnaireResponse resources matching a search query using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a QuestionnaireResponse resource using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a QuestionnaireResponse resource using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a QuestionnaireResponse using:
<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching 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="client_Subscription" class="no_toc">Subscription</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to subscribe to data source for Task-based requests.</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 client <strong>SHOULD</strong> be capable of a <code>create</code> interaction posting a Subscription resource using:
<code class="highlighter-rouge">POST [base]/Subscription/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>SHOULD</strong> be capable of putting a existing Subscription resource using:
<code class="highlighter-rouge">PUT [base]/Subscription/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing Subscription resource using:
<code class="highlighter-rouge">PATCH [base]/Subscription/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a Subscription resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching Subscription resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Subscription/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Subscription resource using:
<code class="highlighter-rouge">GET [base]/Subscription/[id]</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Subscription resource using:
<code class="highlighter-rouge">GET [base]/Subscription/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Subscription using:
<code class="highlighter-rouge">GET [base]/Subscription/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Subscription resources using:
<code class="highlighter-rouge">GET [base]/Subscription/_history{?[parameters]&_format=[mime-type]}</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="client_Task" class="no_toc">Task</h4>
<p>Conformance Expectation: <strong>SHOULD</strong></p>
<p>Resource Specific Documentation:</p>
<blockquote><div><p>Required resource type to request and fetch clinical information using Task-based query and for requesting attachments.</p>
<ol>
<li>If Da Vinci CDex Data Consumer Client supports Task-based query, they <strong>SHALL</strong> support the <em>CDex Task Data Request Profile</em>.</li>
<li>If Da Vinci CDex Data Consumer Client supports requesting attachments, they <strong>SHALL</strong> support the following profiles:
<ul>
<li><em>CDex Task Attachment Request Profile</em></li>
<li><em>CDex Patient Demographic Profile</em></li>
<li><em>CDex PractitionerRequest Profile</em></li>
</ul>
</li>
</ol>
</div></blockquote>
<p>Supported Profiles:</p>
<ul>
<li><strong>SHOULD</strong> support
<a href="StructureDefinition-cdex-task-data-request.html">CDex Task Data Request Profile</a>
</li>
<li><strong>SHOULD</strong> support
<a href="StructureDefinition-cdex-task-attachment-request.html">CDex Task Attachment Request Profile</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 client <strong>SHOULD</strong> be capable of a <code>create</code> interaction posting a Task resource using:
<code class="highlighter-rouge">POST [base]/Task/[id]{?_format=[mime-type]}</code>
</li>
<li>
<!-- TODO change note if server allows putting of a new one (with a specified ID) -->
A client <strong>SHOULD</strong> be capable of putting a existing Task resource using:
<code class="highlighter-rouge">PUT [base]/Task/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of patching an existing Task resource using:
<code class="highlighter-rouge">PATCH [base]/Task/[id]{?_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of deleting a Task resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching Task resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Task/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Task resource using:
<code class="highlighter-rouge">GET [base]/Task/[id]</code>
</li>
<li>
A client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Task resource using:
<code class="highlighter-rouge">GET [base]/Task/[id]/_history/vid</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Task using:
<code class="highlighter-rouge">GET [base]/Task/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li>
<li>
A client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Task resources using:
<code class="highlighter-rouge">GET [base]/Task/_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-client"/>
<version value="2.1.0-preview"/>
<name value="DataConsumerClientCapabilityStatement"/>
<title value="Data Consumer Client CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2024-04-23T12:06:58.986185-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 *Client* mode when requesting clinical data from the Data Source during clinical data exchange. The capabilities include one or more of the following interactions:
1. Requesting and Fetching Clinical Data using a FHIR RESTful query
2. Requesting and Fetching Clinical Data using a Task-based query including:
- Polling or Subscribing for Task update notifications
3. Requesting Attachments
- Requesting Attachments Using Attachments Codes
- Requesting Attachments Using Questionnaires"/>
<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/core/CapabilityStatement/us-core-client|3.1.1">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</instantiates>
<instantiates
value="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|6.1.0">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</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>
<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/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>
<implementationGuide
value="http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr|2.0.1">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</implementationGuide>
<rest>
<mode value="client"/>
<documentation
value="The Da Vinci CDex Data Consumer Client **SHALL**:
1. Support at least one of the CDex approaches for exchanging clinical information:
1. Direct Query
2. Task-Based Approach
3. Attachments
2. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.
3. Support JSON source formats for all Da Vinci CDex interactions.
4. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.
- Follow the guidelines for [Conforming to CDex Task Based Approach](task-based-conformance.html) if supporting this exchange.
- Follow the guidelines for [Conforming to CDex Attachments](attachments-conformance.html) if supporting this exchange.
The Da Vinci CDex Data Consumer Client **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 [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html).
1. For security considerations specific to this guide refer to the Da Vinci HRex Implementation Guide section on [Security and Privacy](http://hl7.org/fhir/us/davinci-hrex/security.html)
"/>
</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|2.1.0-preview">🔗
<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="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="Patient"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-patient-demographics|2.1.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="Required resource type to supply patient demographic data when requesting attachments."/>
<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="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="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="PractitionerRole"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-practitionerrole|2.1.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="Required resource type to supply patient demographic data when requesting attachments."/>
<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="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="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="Questionnaire"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-std-questionnaire">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation
value="Required resource type to when requesting data or attachments using Questionnaire"/>
<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="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 fetch completed questionnaires from data source. **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="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|2.1.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-attachment-request|2.1.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation
value="Required resource type to request and fetch clinical information using Task-based query and for requesting attachments.
1. If Da Vinci CDex Data Consumer Client supports Task-based query, they **SHALL** support the *CDex Task Data Request Profile*.
2. If Da Vinci CDex Data Consumer Client supports requesting attachments, they **SHALL** support the following profiles:
- *CDex Task Attachment Request Profile*
- *CDex Patient Demographic Profile*
- *CDex PractitionerRequest 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>
IG © 2024+ HL7 International / Payer/Provider Information Exchange Work Group. Package hl7.fhir.us.davinci-cdex#2.1.0-preview based on FHIR 4.0.1. Generated 2024-05-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change