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: Informative |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="cdex-capabilitystatement-inline-example"/>
<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"/>
<ul>
<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>
json;
</li>
<li><b>Published:</b> 2024-05-16</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>R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription</p>
</div></div>
<br/>
<h3>Support and Requirements for Other Artifacts</h3>
<tr>
<th>Instantiates other capabilities:</th>
<td>
<ul>
<li>
<a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/CapabilityStatement-backport-subscription-server-r4.html">BackportSubscriptionCapabilityStatementR4version: null1.1.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>
<!-- REST Security -->
<!-- REST System wide Capabilities -->
<!-- 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_Subscription"><span style="white-space: nowrap;">Subscription</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">update</span>,
</td>
<!-- Supported Profiles -->
<td>
<a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html">R4/B Topic-Based Subscriptionversion: null1.1.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>
<span style="white-space: nowrap;">$status</span>
</td>
</tr>
<tr>
<td>
<a href="#Server_Patient"><span style="white-space: nowrap;">Patient</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">delete</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_Encounter"><span style="white-space: nowrap;">Encounter</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">delete</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_Observation"><span style="white-space: nowrap;">Observation</span></a>
</td>
<!-- Supported Interactions -->
<td>
<span style="white-space: nowrap;">read</span>,
<span style="white-space: nowrap;">create</span>,
<span style="white-space: nowrap;">update</span>,
<span style="white-space: nowrap;">delete</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_Subscription" class="no_toc">Subscription</h4>
<p>Conformance Expectation: <strong/></p>
<p>Supported Profiles:</p>
<ul>
<li>
<a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html">R4/B Topic-Based Subscriptionversion: null1.1.0)</a>
</li>
</ul>
<p>
</p>
<!-- Resource Interactions -->
<p>Subscription Interaction Summary:</p>
<ul>
<li> read, create, update, </li>
</ul>
<!-- Resource Operations -->
<!-- TODO Nexted ul items do not appear with a subbullet style -->
<br/>
<p>Modify Criteria:</p>
<ul>
<li>
A Server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating 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 Server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Subscription resource using:
<code class="highlighter-rouge">PUT [base]/Subscription/[id]{?_format=[mime-type]}</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Subscription resource using:
<code class="highlighter-rouge">GET [base]/Subscription/[id]</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_Patient" class="no_toc">Patient</h4>
<p>Conformance Expectation: <strong/></p>
<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>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating 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 Server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Patient resource using:
<code class="highlighter-rouge">PUT [base]/Patient/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>(conformance expectation undefined)</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 Server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Patient resource using:
<code class="highlighter-rouge">GET [base]/Patient/[id]</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_Encounter" class="no_toc">Encounter</h4>
<p>Conformance Expectation: <strong/></p>
<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>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Encounter resource using:
<code class="highlighter-rouge">POST [base]/Encounter/[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>(conformance expectation undefined)</strong> be capable of updating a existing Encounter resource using:
<code class="highlighter-rouge">PUT [base]/Encounter/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>(conformance expectation undefined)</strong> be capable of deleting a Encounter resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Encounter resource using:
<code class="highlighter-rouge">GET [base]/Encounter/[id]</code>
</li>
</ul>
<!-- Search Combination -->
<h4 id="Server_Observation" class="no_toc">Observation</h4>
<p>Conformance Expectation: <strong/></p>
<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>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Observation resource using:
<code class="highlighter-rouge">POST [base]/Observation/[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>(conformance expectation undefined)</strong> be capable of updating a existing Observation resource using:
<code class="highlighter-rouge">PUT [base]/Observation/[id]{?_format=[mime-type]}</code>
</li>
<li>
A Server <strong>(conformance expectation undefined)</strong> be capable of deleting a Observation resource using:
<code class="highlighter-rouge">DELETE [base]//[id]</code>
</li>
</ul>
<br/>
<p>Fetch and Search Criteria:</p>
<ul>
<li>
A Server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Observation resource using:
<code class="highlighter-rouge">GET [base]/Observation/[id]</code>
</li>
</ul>
<!-- Search Combination -->
<!-- Messaging Capabilities -->
<!-- Document Capabilities -->
</div>
</text>
<url
value="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/cdex-capabilitystatement-inline-example"/>
<version value="2.1.0-snapshot"/>
<status value="active"/>
<date value="2024-05-16"/>
<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="R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription"/>
<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/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4|1.1.0"/>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<rest>
<mode value="server"/>
<resource>
<extension
url="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-hrex/SubscriptionTopic/Task"/>
</extension>
<type value="Subscription"/>
<supportedProfile
value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription|1.1.0"/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<operation>
<name value="status"/>
<definition
value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"/>
</operation>
</resource>
<resource>
<type value="Patient"/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
</resource>
<resource>
<type value="Encounter"/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
</resource>
<resource>
<type value="Observation"/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
</resource>
</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