Da Vinci Clinical Data Exchange (CDex), published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ecdx/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client | Version: 2.1.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: DataConsumerClientCapabilityStatement | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.21.13.2 | ||||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
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:
Raw OpenAPI-Swagger Definition file | Download
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
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]