Da Vinci Clinical Data Exchange (CDex)
2.1.0 - STU 2.1 United States of America flag

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

CapabilityStatement: Data Source Server CapabilityStatement

Official URL: http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-server Version: 2.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: DataSourceServerCapabilityStatement
Other Identifiers: OID:2.16.840.1.113883.4.642.40.21.13.5

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 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
  3. Responding to
    • Requesting Attachments Using Attachments Codes
    • Requesting Attachments Using Questionnaires

Raw OpenAPI-Swagger Definition file | Download

SHOULD Support the Following Implementation Guides:

SHOULD Implement All Or Parts Of The Following Capability Statements:

FHIR RESTful Capabilities

The Da Vinci CDex Data Source Server SHALL:

  1. Support at least one of the CDex approaches for exchanging clinical information:

    1. Direct Query
    2. Task-Based Approach
    3. Attachments

  2. Support JSON source formats for all Da Vinci CDex interactions.

  3. Follow the guidelines for Generating and Verifying Signed Resources if signatures are required.

  4. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.

  5. 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:

  1. For general security consideration refer to the FHIR Security and Privacy Considerations.
  2. For security considerations specific to this guide refer to the Security and Privacy section.

Summary of System Wide Interactions

  • MAY support the transaction interaction.
  • MAY support the batch interaction.
  • MAY support the search-system interaction.
  • MAY support the history-system interaction.

RESTful Capabilities by Resource/Profile:

Summary

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 - - - -

Bundle

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:

  • SHOULD support create, search-type, read, vread.
  • MAY support update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

  • A Server SHOULD be capable of returning a Bundle resource using: GET [base]/Bundle/[id]

Patient

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to supply patient demographic data when requesting attachments.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

  • MAY support create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Operation Summary:

  • SHOULD support the $match operation

    Used for discovery of the FHIR Patient.id by CDex Data Consumers

Fetch and Search Criteria:

  • A Server MAY be capable of returning a Patient resource using: GET [base]/Patient/[id]

PractitionerRole

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to supply patient demographic data when requesting attachments.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

  • MAY support create, search-type, read, vread, update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

  • A Server MAY be capable of returning a PractitionerRole resource using: GET [base]/PractitionerRole/[id]

Provenance

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to fetch provenance along with clinical information

Profile Interaction Summary:

  • SHOULD support search-type, read, vread.
  • MAY support create, update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

  • A Server SHOULD be capable of returning a Provenance resource using: GET [base]/Provenance/[id]

QuestionnaireResponse

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:

  • SHOULD support create, search-type, read, vread.
  • MAY support update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

  • A Server SHOULD be capable of returning a QuestionnaireResponse resource using: GET [base]/QuestionnaireResponse/[id]

Subscription

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to subscribe to data source for Task-based requests.

Profile Interaction Summary:

  • SHOULD support create, search-type, read, vread, update.
  • MAY support patch, delete, history-instance, history-type.

Fetch and Search Criteria:

  • A Server SHOULD be capable of returning a Subscription resource using: GET [base]/Subscription/[id]

Task

Conformance Expectation: SHOULD

Resource Specific Documentation:

  1. If Da Vinci CDex Data Source Server supports Task-based query, they SHALL support the CDex Task Data Request Profile.
  2. 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:

  • SHOULD support create, search-type, read, vread, update.
  • MAY support patch, delete, history-instance, history-type.

Fetch and Search Criteria:

  • A Server SHOULD be capable of returning a Task resource using: GET [base]/Task/[id]