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 |
{
"resourceType" : "CapabilityStatement",
"id" : "data-source-server",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <!-- TODO \n Jurisdiction \n Prohibited extension - http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited -->\n <!-- set include_symbols = false to turn off confonrmance symbols and legen, true to turn on -->\n \n \n <h2 id=\"title\">Data Source Server CapabilityStatement</h2>\n <ul>\n <li><b>Title:</b>Data Source Server CapabilityStatement</li>\n <li><b>Implementation Guide Version:</b> 2.1.0-preview</li>\n <li><b>FHIR Version:</b> 4.0.1</li>\n <li><b>Intended Use:</b> requirements</li>\n <li><b>Supported Formats: </b> \n\n \n \n \n <strong>SHALL</strong> support \n \n json;\n \n \n \n <strong>MAY</strong> support \n \n xml;\n \n\n </li>\n \n <li><b>Published:</b> 2024-04-23 10:38:08-0800</li>\n \n <li><b>Published by:</b> HL7 International / Payer/Provider Information Exchange Work Group</li>\n <li><b>Status:</b> active</li>\n <li><b>Copyright:</b> <div><p>Used by permission of HL7 International all rights reserved Creative Commons License</p>\n</div></li>\n </ul>\n <br/>\n\n\n\n \n <strong>Description:</strong> <div><div><p>This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source in <em>Server</em> mode when responding to a Data Consumer during clinical data exchange. The capabilities include one or more of the following interactions:</p>\n<ol>\n<li>Responding to a FHIR RestFul Query for Clinical Data</li>\n<li>Responding to a Task-based query request for clinical data\nincluding:\n<ul>\n<li>Polling or Subscription requests for Task update notifications</li>\n</ul>\n</li>\n<li>Responding to\n<ul>\n<li>Requesting Attachments Using Attachments Codes</li>\n<li>Requesting Attachments Using Questionnaires</li>\n</ul>\n</li>\n</ol>\n</div></div>\n \n <br/>\n \n \n\n\n \n <h3>Support and Requirements for Other Artifacts</h3>\n \n <tr>\n <th>Instantiates other capabilities:</th>\n <td>\n <ul>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatement</a>\n </li>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatement</a>\n </li>\n \n </ul>\n </td>\n </tr>\n \n \n \n <tr>\n <th>Supports other guides:</th>\n <td>\n <ul>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/ImplementationGuide-hl7.fhir.us.core.html\">US Core</a>\n </li>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/ImplementationGuide-hl7.fhir.us.core.html\">US Core Implementation Guide</a>\n </li>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/davinci-hrex/STU1/ImplementationGuide-hl7.fhir.us.davinci-hrex.html\">Da Vinci Health Record Exchange (HRex)</a>\n </li>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/davinci-dtr/STU2/ImplementationGuide-hl7.fhir.us.davinci-dtr.html\">Da Vinci - Documentation Templates and Rules</a>\n </li>\n \n </ul>\n </td>\n </tr>\n \n \n\n <br/>\n <!-- TODO - Make this a summary of capabilities, including system wide and each paradigm -->\n <p>\n <b>Jump to:</b>\n </p>\n <ul>\n \n <li><a href=\"#server\">REST server</a></li>\n \n \n \n </ul>\n\n\n\n <!-- REST Capabilities -->\n \n <br/>\n <a name=\"server\"> </a>\n <h3 id=\"behavior\">FHIR server RESTful Capabilities</h3>\n \n <div><div><p>The Da Vinci CDex Data Source Server <strong>SHALL</strong>:</p>\n<ol>\n<li>\n<p>Support at least one of the CDex approaches for exchanging clinical information:</p>\n<ol>\n<li>Direct Query</li>\n<li>Task-Based Approach</li>\n<li>Attachments</li>\n</ol>\n</li>\n<li>\n<p>Support JSON source formats for all Da Vinci CDex interactions.</p>\n</li>\n<li>\n<p>Follow the guidelines for <a href=\"signatures.html\">Generating and Verifying Signed Resources</a> <em>if signatures are required</em>.</p>\n</li>\n<li>\n<p>Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.</p>\n<ul>\n<li>Follow the guidelines for <a href=\"task-based-conformance.html\">Conforming to CDex Task Based Approach</a> if supporting this exchange.</li>\n<li>Follow the guidelines for <a href=\"attachments-conformance.html\">Conforming to CDex Attachments</a> if supporting this exchange.\nThe Da Vinci CDex Data Source Server <strong>MAY</strong>:</li>\n</ul>\n</li>\n<li>\n<p>Support XML source formats for all Da Vinci CDex interactions.</p>\n<blockquote>\n<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>\n</blockquote>\n</li>\n</ol>\n</div></div>\n \n\n <!-- REST Security -->\n \n <br/>\n <p id=\"security\"><strong>Security:</strong></p>\n \n <div><div><ol>\n<li>For general security consideration refer to the FHIR <a href=\"http://build.fhir.org/secpriv-module.html\">Security and Privacy Considerations</a>.</li>\n<li>For security considerations specific to this guide refer to the <a href=\"security.html\">Security and Privacy</a> section.</li>\n</ol>\n</div></div>\n \n \n \n\n <!-- REST System wide Capabilities -->\n \n <h3>System-wide server Capabilities</h3>\n \n <!-- REST System wide interactions -->\n \n <h4>Interactions</h4>\n\n <ul>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>transaction</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>batch</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>search-system</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>history-system</code> interaction.</li>\n \n </ul>\n \n \n \n \n \n \n \n \n \n \n\n <!-- REST System wide operations -->\n \n\n\n <!-- REST System wide search parameters -->\n \n \n\n\n\n <!-- Resource Capabilities -->\n \n\n <h4>Summary of Resource/Profile Capabilities</h4>\n <!-- TODO need include conformance verb legend -->\n \n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource Type</th>\n <th>Supported Interactions</th>\n <th>Supported Profiles</th>\n <th>Supported Searches</th>\n <th>Supported <code>_includes</code></th>\n <th>Supported <code>_revincludes</code></th>\n <th>Supported Operations</th>\n </tr>\n </thead>\n <tbody>\n \n <tr>\n <td>\n <a href=\"#server_Bundle\"><span style=\"white-space: nowrap;\">Bundle</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"StructureDefinition-cdex-signature-bundle.html\">CDex Signature Bundle Profile</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Patient\"><span style=\"white-space: nowrap;\">Patient</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"StructureDefinition-cdex-patient-demographics.html\">CDex Patient Demographics Profile</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">$match</span>\n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_PractitionerRole\"><span style=\"white-space: nowrap;\">PractitionerRole</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"StructureDefinition-cdex-practitionerrole.html\">CDex PractitionerRole Profile</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Provenance\"><span style=\"white-space: nowrap;\">Provenance</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_QuestionnaireResponse\"><span style=\"white-space: nowrap;\">QuestionnaireResponse</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"StructureDefinition-cdex-sdc-questionnaireresponse.html\">CDex SDC QuestionnaireResponse Profile</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Subscription\"><span style=\"white-space: nowrap;\">Subscription</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Task\"><span style=\"white-space: nowrap;\">Task</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"StructureDefinition-cdex-task-data-request.html\">CDex Task Data Request Profile</a>,\n \n \n <a href=\"StructureDefinition-cdex-task-attachment-request.html\">CDex Task Attachment Request Profile</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n </tbody>\n </table>\n <br/>\n\n <h3 id=\"resource-details\" class=\"no_toc\">RESTful server Capabilities by Resource/Profile:</h3>\n <!-- Each REST Resource Detail -->\n \n <h4 id=\"server_Bundle\" class=\"no_toc\">Bundle</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type for responding to Clinical data requests. <strong>SHALL</strong> support CDex Signature Bundle Profile for signed Bundles.</p>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHOULD</strong> support \n <a href=\"StructureDefinition-cdex-signature-bundle.html\">CDex Signature Bundle Profile</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>create</code> interaction creating a Bundle resource using:\n <code class=\"highlighter-rouge\">POST [base]/Bundle/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>MAY</strong> be capable of updating a existing Bundle resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Bundle/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing Bundle resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Bundle/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a Bundle resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning Bundle resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Bundle/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a Bundle resource using:\n <code class=\"highlighter-rouge\">GET [base]/Bundle/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a Bundle resource using:\n <code class=\"highlighter-rouge\">GET [base]/Bundle/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a Bundle using:\n <code class=\"highlighter-rouge\">GET [base]/Bundle/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of Bundle resources using:\n <code class=\"highlighter-rouge\">GET [base]/Bundle/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Patient\" class=\"no_toc\">Patient</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to supply patient demographic data when requesting attachments.</p>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHALL</strong> support \n <a href=\"StructureDefinition-cdex-patient-demographics.html\">CDex Patient Demographics Profile</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n Reference Policy: <code>logical</code>,\n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n <p>Patient Interaction Summary:</p>\n <ul>\n \n \n \n \n <li><strong>MAY</strong> support create, search-type, read, vread, update, patch, delete, history-instance, history-type, </li>\n \n \n </ul>\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a Patient resource using:\n <code class=\"highlighter-rouge\">POST [base]/Patient/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>MAY</strong> be capable of updating a existing Patient resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Patient/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing Patient resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Patient/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a Patient resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>search-type</code> interaction returning Patient resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>read</code> interaction returning a Patient resource using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>vread</code> interaction returning a Patient resource using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a Patient using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of Patient resources using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_PractitionerRole\" class=\"no_toc\">PractitionerRole</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to supply patient demographic data when requesting attachments.</p>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHALL</strong> support \n <a href=\"StructureDefinition-cdex-practitionerrole.html\">CDex PractitionerRole Profile</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n Reference Policy: <code>logical</code>,\n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">POST [base]/PractitionerRole/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>MAY</strong> be capable of updating a existing PractitionerRole resource using:\n <code class=\"highlighter-rouge\">PUT [base]/PractitionerRole/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing PractitionerRole resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/PractitionerRole/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>search-type</code> interaction returning PractitionerRole resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>read</code> interaction returning a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>vread</code> interaction returning a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a PractitionerRole using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of PractitionerRole resources using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Provenance\" class=\"no_toc\">Provenance</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to fetch provenance along with clinical information</p>\n</div></blockquote>\n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>create</code> interaction creating a Provenance resource using:\n <code class=\"highlighter-rouge\">POST [base]/Provenance/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>MAY</strong> be capable of updating a existing Provenance resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Provenance/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing Provenance resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Provenance/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a Provenance resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning Provenance resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a Provenance resource using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a Provenance resource using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a Provenance using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of Provenance resources using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_QuestionnaireResponse\" class=\"no_toc\">QuestionnaireResponse</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type complete questionnaires from data source. <strong>SHALL</strong> support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.</p>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHOULD</strong> support \n <a href=\"StructureDefinition-cdex-sdc-questionnaireresponse.html\">CDex SDC QuestionnaireResponse Profile</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>create</code> interaction creating a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>MAY</strong> be capable of updating a existing QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning QuestionnaireResponse resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a QuestionnaireResponse using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of QuestionnaireResponse resources using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Subscription\" class=\"no_toc\">Subscription</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to subscribe to data source for Task-based requests.</p>\n</div></blockquote>\n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>create</code> interaction creating a Subscription resource using:\n <code class=\"highlighter-rouge\">POST [base]/Subscription/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>SHOULD</strong> be capable of updating a existing Subscription resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Subscription/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing Subscription resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Subscription/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a Subscription resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning Subscription resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Subscription/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a Subscription resource using:\n <code class=\"highlighter-rouge\">GET [base]/Subscription/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a Subscription resource using:\n <code class=\"highlighter-rouge\">GET [base]/Subscription/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a Subscription using:\n <code class=\"highlighter-rouge\">GET [base]/Subscription/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of Subscription resources using:\n <code class=\"highlighter-rouge\">GET [base]/Subscription/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Task\" class=\"no_toc\">Task</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ol>\n<li>If Da Vinci CDex Data Source Server supports Task-based query, they <strong>SHALL</strong> support the <em>CDex Task Data Request Profile</em>.</li>\n<li>If Da Vinci CDex Data Source Server supports requesting attachments, they <strong>SHALL</strong> support the:\n<ul>\n<li><em>CDex Task Attachment Request Profile</em></li>\n<li><em>CDex Patient Demographic Profile</em></li>\n<li><em>CDex PractitionerRequest Profile</em></li>\n</ul>\n</li>\n</ol>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHOULD</strong> support \n <a href=\"StructureDefinition-cdex-task-data-request.html\">CDex Task Data Request Profile</a>\n </li>\n \n <li><strong>SHOULD</strong> support \n <a href=\"StructureDefinition-cdex-task-attachment-request.html\">CDex Task Attachment Request Profile</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n Reference Policy: <code>logical</code>,\n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>create</code> interaction creating a Task resource using:\n <code class=\"highlighter-rouge\">POST [base]/Task/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>SHOULD</strong> be capable of updating a existing Task resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Task/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A server <strong>MAY</strong> be capable of patching an existing Task resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Task/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A server <strong>MAY</strong> be capable of deleting a Task resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction returning Task resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Task/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>read</code> interaction returning a Task resource using:\n <code class=\"highlighter-rouge\">GET [base]/Task/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>SHOULD</strong> be capable of a <code>vread</code> interaction returning a Task resource using:\n <code class=\"highlighter-rouge\">GET [base]/Task/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-instance</code> interaction returning a history of a Task using:\n <code class=\"highlighter-rouge\">GET [base]/Task/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A server <strong>MAY</strong> be capable of a <code>history-type</code> interaction returning the history of Task resources using:\n <code class=\"highlighter-rouge\">GET [base]/Task/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n \n\n\n\n \n\n\n\n\n\n\n\n\n\n <!-- Messaging Capabilities -->\n \n\n <!-- Document Capabilities -->\n \n\n</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "claims"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-server",
"version" : "2.1.0-preview",
"name" : "DataSourceServerCapabilityStatement",
"title" : "Data Source Server CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2024-04-23T10:38:08.605243-08:00",
"publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
"contact" : [
{
"name" : "HL7 International / Payer/Provider Information Exchange Work Group",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/claims"
},
{
"system" : "email",
"value" : "pie@lists.hl7.org"
}
]
}
],
"description" : "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source in *Server* mode when responding to a Data Consumer during clinical data exchange. The capabilities include one or more of the following interactions:\n\n1. Responding to a FHIR RestFul Query for Clinical Data \n2. Responding to a Task-based query request for clinical data\nincluding:\n - Polling or Subscription requests for Task update notifications\n1. Responding to\n - Requesting Attachments Using Attachments Codes\n - Requesting Attachments Using Questionnaires",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"copyright" : "Used by permission of HL7 International all rights reserved Creative Commons License",
"kind" : "requirements",
"instantiates" : [
🔗 "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|3.1.1"🔗 ,
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|6.1.0"
],
"_instantiates" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"_format" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
}
],
"implementationGuide" : [
🔗 "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1"🔗 ,
"http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|6.1.0"🔗 ,
"http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.0.0"🔗 ,
"http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr|2.0.1"
],
"_implementationGuide" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"rest" : [
{
"mode" : "server",
"documentation" : "The Da Vinci CDex Data Source Server **SHALL**:\n\n1. Support at least one of the CDex approaches for exchanging clinical information:\n 1. Direct Query\n 1. Task-Based Approach\n 1. Attachments \n1. Support JSON source formats for all Da Vinci CDex interactions.\n1. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.\n1. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.\n - Follow the guidelines for [Conforming to CDex Task Based Approach](task-based-conformance.html) if supporting this exchange.\n - Follow the guidelines for [Conforming to CDex Attachments](attachments-conformance.html) if supporting this exchange.\nThe Da Vinci CDex Data Source Server **MAY**:\n\n1. Support XML source formats for all Da Vinci CDex interactions.\n \n > 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" : "1. For general security consideration refer to the FHIR [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. For security considerations specific to this guide refer to the [Security and Privacy](security.html) section."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Bundle",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle|2.1.0-preview"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type for responding to Clinical data requests. **SHALL** support CDex Signature Bundle Profile for signed Bundles.\n",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Patient",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-patient-demographics|2.1.0-preview"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Required resource type to supply patient demographic data when requesting attachments.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"logical"
],
"_referencePolicy" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "match",
"definition" : "http://hl7.org/fhir/OperationDefinition/Patient-match",
"documentation" : "Used for discovery of the FHIR Patient.id by CDex Data Consumers"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-practitionerrole|2.1.0-preview"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Required resource type to supply patient demographic data when requesting attachments.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"logical"
],
"_referencePolicy" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Provenance",
"documentation" : "Required resource type to fetch provenance along with clinical information",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse|2.1.0-preview"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type complete questionnaires from data source. **SHALL** support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Subscription",
"documentation" : "Required resource type to subscribe to data source for Task-based requests.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Task",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request|2.1.0-preview"🔗 ,
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-attachment-request|2.1.0-preview"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "1. If Da Vinci CDex Data Source Server supports Task-based query, they **SHALL** support the *CDex Task Data Request Profile*.\n2. If Da Vinci CDex Data Source Server supports requesting attachments, they **SHALL** support the: \n - *CDex Task Attachment Request Profile*\n - *CDex Patient Demographic Profile*\n - *CDex PractitionerRequest Profile*",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"logical"
],
"_referencePolicy" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "transaction"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "batch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
]
}
]
}
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-04-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change