Da Vinci Clinical Data Exchange (CDex)
1.1.0 - STU1.1
US
Da Vinci Clinical Data Exchange (CDex)
1.1.0 - STU1.1
US
This page is part of the Da Vinci Clinical Documentation Exchange (v1.1.0: STU1.1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Active as of 2022-07-22 |
{
"resourceType" : "CapabilityStatement",
"id" : "data-consumer-client",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <h3 id=\"shall_igs\" class=\"no_toc\">SHALL Support the Following Implementation Guides:</h3> <ul> <li><a href=\"http://hl7.org/fhir/us/core/index.html\">HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1</a></li> </ul> <h3 id=\"should_igs\" class=\"no_toc\">SHOULD Support the Following Implementation Guides:</h3> <ul> <li><a href=\"http://hl7.org/fhir/us/davinci-hrex/STU1/index.html\">Da Vinci Health Record Exchange (HRex) 1.0.0 - STU R1</a></li> </ul> <h3 id=\"shall_css\" class=\"no_toc\">SHALL Implement All Or Parts Of The Following Capability Statements:</h3> <ul> <li><a href=\"http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client\">Data Consumer Client CapabilityStatement</a></li> </ul> <ul> <li><a href=\"http://hl7.org/fhir/us/core/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatement</a></li> </ul> <h3 id=\"behavior\">FHIR RESTful Capabilities</h3> <p>The Da Vinci CDex Data 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.</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> <p id=\"security\"><strong>Security:</strong></p> <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> <p><strong>Summary of System Wide Interactions</strong></p> <ul> <li><strong>MAY</strong> support the <code>transaction</code> interaction.</li> <li><strong>MAY</strong> support the <code>batch</code> interaction.</li> <li><strong>MAY</strong> support the <code>search-system</code> interaction.</li> <li><strong>MAY</strong> support the <code>history-system</code> interaction.</li> </ul> <h3 id=\"resource-details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3> <h4>Summary</h4> <table class=\"grid\"> <thead> <tr> <th>Resource Type</th> <th>Supported Profiles</th> <th>Supported Searches</th> <th>Supported <code>_includes</code></th> <th>Supported <code>_revincludes</code></th> <th>Supported Operations</th> </tr> </thead> <tbody> <tr> <td> <a href=\"#bundle\">Bundle</a> </td> <td> <a href=\"StructureDefinition-cdex-signature-bundle.html\">CDex Signature Bundle Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#provenance\">Provenance</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#subscription\">Subscription</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#task\">Task</a> </td> <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> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> </tbody> </table> <h4 id=\"bundle\" class=\"no_toc\">Bundle</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to fetch Clinical Information from data source. <strong>SHALL</strong> support CDex Signature Bundle Profile for signed Bundles.</p> </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>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Bundle resource using: <code class=\"highlighter-rouge\">GET [base]/Bundle/[id]</code> </li> </ul> <hr/> <h4 id=\"provenance\" class=\"no_toc\">Provenance</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to fetch provenance along with clinical information</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Provenance resource using: <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]</code> </li> </ul> <hr/> <h4 id=\"subscription\" class=\"no_toc\">Subscription</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to subscribe to data source for Task-based requests.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Subscription resource using: <code class=\"highlighter-rouge\">GET [base]/Subscription/[id]</code> </li> </ul> <hr/> <h4 id=\"task\" class=\"no_toc\">Task</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to request and fetch clinical information from data source using Task-based requests. <strong>SHALL</strong> support <em>CDex Task Data Request Profile</em> and/or <em>CDex Task Attachment Request Profile</em>.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-cdex-task-data-request.html\">CDex Task Data Request Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-cdex-task-attachment-request.html\">CDex Task Attachment Request Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Task resource using: <code class=\"highlighter-rouge\">GET [base]/Task/[id]</code> </li> </ul> <hr/> </div>"
},
"url" : "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client",
"version" : "1.1.0",
"name" : "DataConsumerClientCapabilityStatement",
"title" : "Data Consumer Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2022-07-22T17:11:29.853589-08:00",
"publisher" : "HL7 International - Patient Care Work Group",
"contact" : [
{
"name" : "HL7 International - Patient Care Work Group",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
},
{
"system" : "email",
"value" : "patientcare@lists.HL7.org"
}
]
}
],
"description" : "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:\n\n1. Requesting Clinical Data using a FHIR RESTful query\n2. Requesting Attachments\n3. POSTing a Task resource representing a request for clinical data\n4. POSTing a Subscription resource\n5. Polling a Task resource",
"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/davinci-cdex/CapabilityStatement/data-consumer-client",
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client"
],
"_instantiates" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"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"
}
]
}
],
"patchFormat" : [
"application/json-patch+json"
],
"_patchFormat" : [
{
"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/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.0.0"
],
"_implementationGuide" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "The Da Vinci CDex Data Consumer Client **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\n2. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.\n3. Support JSON source formats for all Da Vinci CDex interactions.\n4. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.\n\nThe Da Vinci CDex Data Consumer Client **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 [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. 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)\n"
},
"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"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type to fetch Clinical Information from data source. **SHALL** support CDex Signature Bundle Profile for signed Bundles.\n",
"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" : "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" : "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",
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-attachment-request"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Required resource type to request and fetch clinical information from data source using Task-based requests. **SHALL** support *CDex Task Data Request Profile* and/or *CDex Task Attachment Request 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"
}
]
}
],
"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 © 2022+ HL7 International - Patient Care Work Group. Package hl7.fhir.us.davinci-cdex#1.1.0 based on FHIR 4.0.1. Generated 2022-08-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change