| 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-source-server.html |
| Url | http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-server |
| Version | 2.1.0 |
| Status | active |
| Date | 2024-10-22T19:20:32.840062-08:00 |
| Name | DataSourceServerCapabilityStatement |
| Title | Data Source Server CapabilityStatement |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| 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: 1. Responding to a FHIR RestFul Query for Clinical Data 2. Responding to a Task-based query request for clinical data including: - Polling or Subscription requests for Task update notifications 1. Responding to - 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 Source Server SHALL:
Support at least one of the CDex approaches for exchanging clinical information:
Support JSON source formats for all Da Vinci CDex interactions.
Follow the guidelines for Generating and Verifying Signed Resources if signatures are required.
Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.
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 | - | - | - | match |
| PractitionerRole | CDex PractitionerRole Profile | - | - | - | - |
| Provenance | - | - | - | - | - |
| 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 for responding to Clinical data requests. SHALL support CDex Signature Bundle Profile for signed Bundles.
Supported Profiles:
Profile Interaction Summary:
create, search-type, read, vread.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:
Reference Policy
Profile Interaction Summary:
create, search-type, read, vread, update, patch, delete, history-instance, history-type.Operation Summary:
Used for discovery of the FHIR Patient.id by CDex Data Consumers
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:
Reference Policy
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 complete questionnaires from data source. SHALL support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.
Supported Profiles:
Profile Interaction Summary:
create, search-type, read, vread.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:
- If Da Vinci CDex Data Source Server supports Task-based query, they SHALL support the CDex Task Data Request Profile.
- If Da Vinci CDex Data Source Server supports requesting attachments, they SHALL support the:
- CDex Task Attachment Request Profile
- CDex Patient Demographic Profile
- CDex PractitionerRequest Profile
Supported Profiles:
Reference Policy
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-source-server",
"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 Source Server <strong>SHALL</strong>:</p> <ol> <li> <p>Support at least one of the CDex approaches for exchanging clinical information:</p> <ol> <li>Direct Query</li> <li>Task-Based Approach</li> <li>Attachments</li> </ol> </li> <li> <p>Support JSON source formats for all Da Vinci CDex interactions.</p> </li> <li> <p>Follow the guidelines for <a href=\"signatures.html\">Generating and Verifying Signed Resources</a> <em>if signatures are required</em>.</p> </li> <li> <p>Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.</p> <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. The Da Vinci CDex Data Source Server <strong>MAY</strong>:</li> </ul> </li> <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> <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> match </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=\"#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 for responding to Clinical data requests. <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>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <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 Server <strong>SHOULD</strong> be capable of returning 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>Reference Policy</p> <ul> <li><strong>SHALL</strong> support <a href=\"http://hl7.org/fhir/valueset-reference-handling-policy.html#expansion\">logical</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>Operation Summary:</p> <ul> <li><strong>SHOULD</strong> support the <a href=\"http://hl7.org/fhir/OperationDefinition/Patient-match\">$match</a> operation <p>Used for discovery of the FHIR Patient.id by CDex Data Consumers</p> </li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>MAY</strong> be capable of returning 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>Reference Policy</p> <ul> <li><strong>SHALL</strong> support <a href=\"http://hl7.org/fhir/valueset-reference-handling-policy.html#expansion\">logical</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 Server <strong>MAY</strong> be capable of returning 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 Server <strong>SHOULD</strong> be capable of returning a Provenance resource using: <code class=\"highlighter-rouge\">GET [base]/Provenance/[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 complete 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>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <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 Server <strong>SHOULD</strong> be capable of returning 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 Server <strong>SHOULD</strong> be capable of returning 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><ol> <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> <li>If Da Vinci CDex Data Source Server supports requesting attachments, they <strong>SHALL</strong> support the: <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>Reference Policy</p> <ul> <li><strong>SHALL</strong> support <a href=\"http://hl7.org/fhir/valueset-reference-handling-policy.html#expansion\">logical</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 Server <strong>SHOULD</strong> be capable of returning 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-source-server",
"version" : "2.1.0",
"name" : "DataSourceServerCapabilityStatement",
"title" : "Data Source Server CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2024-10-22T19:20:32.840062-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",
"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"
}
]
}
],
"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" : "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"
],
"_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"
],
"_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"
],
"_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"
],
"_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",
"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" : "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"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.