Da Vinci Clinical Data Exchange (CDex)
2.0.0-ballot - Ballot
US
Da Vinci Clinical Data Exchange (CDex)
2.0.0-ballot - Ballot
US
This page is part of the Da Vinci Clinical Documentation Exchange (v2.0.0-ballot: STU2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
| Active as of 2022-07-22 |
{
"resourceType" : "CapabilityStatement",
"id" : "data-source-client",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <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 Source Client <strong>SHALL</strong>:</p> <ol> <li>Support at least one of the CDex approaches for exchanging clinical information <ol> <li>Task-Based Approach</li> <li>Attachments</li> </ol> </li> <li>Follow the guidelines for <a href=\"signatures.html\">Generating and Verifying Signed Resources</a> <em>if signatures are required</em>.</li> <li>Support JSON source formats for all Da Vinci CDex interactions.</li> <li>Declare a CapabilityStatement identifying transactions, and profiles supported.</li> </ol> <p>The Da Vinci CDex Data Source 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 FHIR <a href=\"http://build.fhir.org/secpriv-module.html\">Security and Privacy Considerations</a>.</li> <li>For security considerations specific to this guide refer to the <a href=\"security.html\">Security and Privacy</a> section.</li> </ol> <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> <p><strong>Summary of System Wide Operations</strong></p> <ul> <li><strong>SHOULD</strong> support the <a href=\"http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment\"><code>$submit-attachment</code></a> operation.</li> <blockquote><p>If <a href=\"attachments.html\">Attachments</a> is supported, the Data Source Client <strong>SHALL</strong> support the <code>$submit-attachment</code> operation.</p> </blockquote></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=\"#communicationrequest\">CommunicationRequest</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#documentreference\">DocumentReference</a> </td> <td> <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">US Core DocumentReference Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#parameters\">Parameters</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#servicerequest\">ServiceRequest</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> </tbody> </table> <h4 id=\"communicationrequest\" class=\"no_toc\">CommunicationRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to carry authorization information regarding for requesting Clinical information</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code><sup>†</sup>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <blockquote>read<sup>†</sup><p>Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a CommunicationRequest resource using: <code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/[id]</code> </li> </ul> <hr/> <h4 id=\"documentreference\" class=\"no_toc\">DocumentReference</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to support the <code>$submit-attachment</code> operation</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference\">US Core DocumentReference Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</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 DocumentReference resource using: <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code> </li> </ul> <hr/> <h4 id=\"parameters\" class=\"no_toc\">Parameters</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to support the <code>$submit-attachment</code> operation</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>create</code>, <code>read</code>, <code>vread</code>, <code>update</code>.</li><li><strong>MAY</strong> support <code>search-type</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 Parameters resource using: <code class=\"highlighter-rouge\">GET [base]/Parameters/[id]</code> </li> </ul> <hr/> <h4 id=\"servicerequest\" class=\"no_toc\">ServiceRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to carry authorization information regarding for requesting Clinical information</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code><sup>†</sup>, <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> <blockquote>read<sup>†</sup><p>Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a ServiceRequest resource using: <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code> </li> </ul> <hr/> </div>"
},
"url" : "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-client",
"version" : "2.0.0-ballot",
"name" : "DataSourceClientCapabilityStatement",
"title" : "Data Source Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2022-07-22T17:16:28.548142-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 Source in *Client* mode during clinical data exchange with a Data Consumer. The capabilities include one or more of the following interactions:\n1. Post the `$submit-attachment` operation to a Data Consumer endpoint.\n1. Query for Authorization information represented by a CommunicationRequest or ServiceRequest.\n1. Post a subscription notification to a Data Consumer endpoint updating the status of a task.",
"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"
}
]
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "The Da Vinci CDex Data Source Client **SHALL**:\n\n1. Support at least one of the CDex approaches for exchanging clinical information\n 1. Task-Based Approach\n 1. Attachments\n1. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.\n1. Support JSON source formats for all Da Vinci CDex interactions.\n1. Declare a CapabilityStatement identifying transactions, and profiles supported.\n\nThe Da Vinci CDex Data Source 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.\n\n",
"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" : "CommunicationRequest",
"documentation" : "Required resource type to carry authorization information regarding for requesting 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" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"
},
{
"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" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Required resource type to support the `$submit-attachment` operation",
"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" : "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" : "Parameters",
"documentation" : "Required resource type to support the `$submit-attachment` operation",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"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" : "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" : "ServiceRequest",
"documentation" : "Required resource type to carry authorization information regarding for requesting 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",
"documentation" : "Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"
},
{
"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"
}
]
}
],
"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"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "submit-attachment",
"definition" : "http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment",
"documentation" : "If [Attachments](attachments.html) is supported, the Data Source Client **SHALL** support the `$submit-attachment` operation."
}
]
}
]
}
IG © 2022+ HL7 International - Patient Care Work Group. Package hl7.fhir.us.davinci-cdex#2.0.0-ballot based on FHIR 4.0.1. Generated 2022-08-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change