| Package | hl7.fhir.us.davinci-cdex |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-cdex/https://build.fhir.org/ig/HL7/davinci-ecdx/CapabilityStatement-data-consumer-client.html |
| Url | http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client |
| Version | 2.1.0 |
| Status | active |
| Date | 2024-10-22T19:39:23.184212-08:00 |
| Name | DataConsumerClientCapabilityStatement |
| Title | Data Consumer Client CapabilityStatement |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| 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: 1. Requesting and Fetching Clinical Data using a FHIR RESTful query 2. Requesting and Fetching Clinical Data using a Task-based query including: - Polling or Subscribing for Task update notifications 3. Requesting Attachments - Requesting Attachments Using Attachments Codes - Requesting Attachments Using Questionnaires |
| Copyright | Used by permission of HL7 International all rights reserved Creative Commons License |
| Kind | requirements |
No resources found
Note: links and images are rebased to the (stated) source
The Da Vinci CDex Data Consumer Client SHALL:
The Da Vinci CDex Data Consumer Client MAY:
Support XML source formats for all Da Vinci CDex interactions.
Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.
Security:
Summary of System Wide Interactions
FHIR
transaction interaction.batch interaction.search-system interaction.history-system interaction.| Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
|---|---|---|---|---|---|
| Bundle | CDex Signature Bundle Profile | - | - | - | - |
| Patient | CDex Patient Demographics Profile | - | - | - | - |
| PractitionerRole | CDex PractitionerRole Profile | - | - | - | - |
| Provenance | - | - | - | - | - |
| Questionnaire | DTR Standard Questionnaire, DTR Questionnaire for adaptive form | - | - | - | - |
| QuestionnaireResponse | CDex SDC QuestionnaireResponse Profile | - | - | - | - |
| Subscription | - | - | - | - | - |
| Task | CDex Task Data Request Profile, CDex Task Attachment Request Profile | - | - | - | - |
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to fetch Clinical Information from data source. SHALL support CDex Signature Bundle Profile for signed Bundles.
Supported Profiles:
Profile Interaction Summary:
search-type, read, vread.create, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Bundle/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to supply patient demographic data when requesting attachments.
Supported Profiles:
Profile Interaction Summary:
create, search-type, read, vread, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Patient/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to supply patient demographic data when requesting attachments.
Supported Profiles:
Profile Interaction Summary:
create, search-type, read, vread, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/PractitionerRole/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to fetch provenance along with clinical information
Profile Interaction Summary:
search-type, read, vread.create, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Provenance/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to when requesting data or attachments using Questionnaire
Supported Profiles:
Profile Interaction Summary:
create, search-type, read, vread, update.patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Questionnaire/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to fetch completed questionnaires from data source. SHALL support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.
Supported Profiles:
Profile Interaction Summary:
search-type, read, vread.create, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/QuestionnaireResponse/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to subscribe to data source for Task-based requests.
Profile Interaction Summary:
create, search-type, read, vread, update.patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Subscription/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to request and fetch clinical information using Task-based query and for requesting attachments.
- If Da Vinci CDex Data Consumer Client supports Task-based query, they SHALL support the CDex Task Data Request Profile.
- If Da Vinci CDex Data Consumer Client supports requesting attachments, they SHALL support the following profiles:
- CDex Task Attachment Request Profile
- CDex Patient Demographic Profile
- CDex PractitionerRequest Profile
Supported Profiles:
Profile Interaction Summary:
create, search-type, read, vread, update.patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Task/[id] {
"resourceType" : "CapabilityStatement",
"id" : "data-consumer-client",
"text" : {
"status" : "additional",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <h3 id=\"should_igs\" class=\"no_toc\">SHOULD Support the Following Implementation Guides:</h3> <ul> <li><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/index.html\">HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1</a></li> </ul> <ul> <li><a href=\"http://hl7.org/fhir/us/core/STU6.1/index.html\">HL7 FHIR® US Core Implementation Guide STU3 Release 6.1.0</a></li> </ul> <ul> <li><a href=\"http://hl7.org/fhir/us/core/STU7/index.html\">HL7 FHIR® US Core Implementation Guide STU3 Release 7.0.0</a></li> </ul> <ul> <li><a href=\"http://hl7.org/fhir/us/davinci-hrex/STU1.1/index.html\">Da Vinci Health Record Exchange (HRex) 1.1.0 - STU R1</a></li> </ul> <ul> <li><a href=\"http://hl7.org/fhir/us/davinci-dtr/STU2.1/index.html\">Documentation Templates and Rules 2.1.0</a></li> </ul> <ul> <li><a href=\"https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/\">Subscriptions R5 Backport (FHIR IG) Release 1.1.0</a></li> </ul> <h3 id=\"should_css\" class=\"no_toc\">SHOULD Implement All Or Parts Of The Following Capability Statements:</h3> <ul> <li><a href=\"https://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html\">US Core Version 3.1.1 Client CapabilityStatement</a></li> </ul> <ul> <li><a href=\"https://hl7.org/fhir/us/core/STU6.1.0/CapabilityStatement-us-core-client.html\">US Core Version 6.1.0 Client CapabilityStatement</a></li> </ul> <ul> <li><a href=\"https://hl7.org/fhir/us/core/STU7.0.0/CapabilityStatement-us-core-client.html\">US Core Version 7.0.0 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. <ul> <li>Follow the guidelines for <a href=\"task-based-conformance.html\">Conforming to CDex Task Based Approach</a> if supporting this exchange.</li> <li>Follow the guidelines for <a href=\"attachments-conformance.html\">Conforming to CDex Attachments</a> if supporting this exchange.</li> </ul> </li> </ol> <p>The Da Vinci CDex Data Consumer Client <strong>MAY</strong>:</p> <ol> <li> <p>Support XML source formats for all Da Vinci CDex interactions.</p> <blockquote> <p>Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.</p> </blockquote> </li> </ol> <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=\"#patient\">Patient</a> </td> <td> <a href=\"StructureDefinition-cdex-patient-demographics.html\">CDex Patient Demographics Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#practitionerrole\">PractitionerRole</a> </td> <td> <a href=\"StructureDefinition-cdex-practitionerrole.html\">CDex PractitionerRole 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=\"#questionnaire\">Questionnaire</a> </td> <td> <a href=\"https://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-std-questionnaire.html\">DTR Standard Questionnaire</a>, <a href=\"https://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-questionnaire-adapt.html\">DTR Questionnaire for adaptive form</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#questionnaireresponse\">QuestionnaireResponse</a> </td> <td> <a href=\"StructureDefinition-cdex-sdc-questionnaireresponse.html\">CDex SDC QuestionnaireResponse Profile</a> </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=\"patient\" class=\"no_toc\">Patient</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to supply patient demographic data when requesting attachments.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-cdex-patient-demographics.html\">CDex Patient Demographics Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</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>MAY</strong> be capable of fetching a Patient resource using: <code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code> </li> </ul> <hr/> <h4 id=\"practitionerrole\" class=\"no_toc\">PractitionerRole</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to supply patient demographic data when requesting attachments.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-cdex-practitionerrole.html\">CDex PractitionerRole Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</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>MAY</strong> be capable of fetching a PractitionerRole resource using: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[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=\"questionnaire\" class=\"no_toc\">Questionnaire</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to when requesting data or attachments using Questionnaire</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHOULD</strong> support: <a href=\"https://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-std-questionnaire.html\">DTR Standard Questionnaire</a> </li> <li><strong>SHOULD</strong> support: <a href=\"https://hl7.org/fhir/us/davinci-dtr/STU2/StructureDefinition-dtr-questionnaire-adapt.html\">DTR Questionnaire for adaptive form</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 Questionnaire resource using: <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]</code> </li> </ul> <hr/> <h4 id=\"questionnaireresponse\" class=\"no_toc\">QuestionnaireResponse</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>Required resource type to fetch completed questionnaires from data source. <strong>SHALL</strong> support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHOULD</strong> support: <a href=\"StructureDefinition-cdex-sdc-questionnaireresponse.html\">CDex SDC QuestionnaireResponse Profile</a> </li> </ul> <p>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 QuestionnaireResponse resource using: <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[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 using Task-based query and for requesting attachments.</p> <ol> <li>If Da Vinci CDex Data Consumer Client supports Task-based query, they <strong>SHALL</strong> support the <em>CDex Task Data Request Profile</em>.</li> <li>If Da Vinci CDex Data Consumer Client supports requesting attachments, they <strong>SHALL</strong> support the following profiles: <ul> <li><em>CDex Task Attachment Request Profile</em></li> <li><em>CDex Patient Demographic Profile</em></li> <li><em>CDex PractitionerRequest Profile</em></li> </ul> </li> </ol> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHOULD</strong> support: <a href=\"StructureDefinition-cdex-task-data-request.html\">CDex Task Data Request Profile</a> </li> <li><strong>SHOULD</strong> support: <a href=\"StructureDefinition-cdex-task-attachment-request.html\">CDex Task Attachment Request Profile</a> </li> </ul> <p>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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "claims"
}
],
"url" : "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client",
"version" : "2.1.0",
"name" : "DataConsumerClientCapabilityStatement",
"title" : "Data Consumer Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2024-10-22T19:39:23.184212-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 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 and Fetching Clinical Data using a FHIR RESTful query\n2. Requesting and Fetching Clinical Data using a Task-based query including:\n - Polling or Subscribing for Task update notifications\n3. Requesting Attachments\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",
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|7.0.0"
],
"_instantiates" : [
{
"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"
}
]
}
],
"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/core/ImplementationGuide/hl7.fhir.us.core|6.1.0",
"http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|7.0.0",
"http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.1.0",
"http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr|2.1.0",
"http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport|1.1.0"
],
"_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"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"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 2. Task-Based Approach\n 3. 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 - 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.\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|2.1.0"
],
"_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" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-patient-demographics|2.1.0"
],
"_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"
}
]
},
{
"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"
],
"_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"
}
]
},
{
"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" : "Questionnaire",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-std-questionnaire",
"http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type to when requesting data or attachments using Questionnaire",
"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" : "QuestionnaireResponse",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse|2.1.0"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type to fetch completed questionnaires from data source. **SHALL** support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "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|2.1.0",
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-attachment-request|2.1.0"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type to request and fetch clinical information using Task-based query and for requesting attachments.\n\n1. If Da Vinci CDex Data Consumer Client supports Task-based query, they **SHALL** support the *CDex Task Data Request Profile*.\n2. If Da Vinci CDex Data Consumer Client supports requesting attachments, they **SHALL** support the following profiles: \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"
}
]
}
],
"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"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.