Da Vinci Clinical Data Exchange (CDex)
2.0.0 - CI Build United States of America flag

Da Vinci Clinical Data Exchange (CDex), published by HL7 International - Patient Care Work Group. This is not an authorized publication; it is the continuous build for version 2.0.0). 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 Consumer Client CapabilityStatement

Official URL: http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client Version: 2.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: DataConsumerClientCapabilityStatement

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:

  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

Raw OpenAPI-Swagger Definition file | Download

SHALL Support the Following Implementation Guides:

SHOULD Support the Following Implementation Guides:

SHALL Implement All Or Parts Of The Following Capability Statements:

FHIR RESTful Capabilities

The Da Vinci CDex Data Consumer Client SHALL:

  1. Support at least one of the CDex approaches for exchanging clinical information:
    1. Direct Query
    2. Task-Based Approach
    3. Attachments
  2. Follow the guidelines for Generating and Verifying Signed Resources if signatures are required.
  3. Support JSON source formats for all Da Vinci CDex interactions.
  4. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.

The Da Vinci CDex Data Consumer Client MAY:

  1. 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 Security and Privacy Considerations.
  2. For security considerations specific to this guide refer to the Da Vinci HRex Implementation Guide section on Security and Privacy

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 - - - -
PractitionerRole CDex PractitionerRole Profile - - - -
Provenance - - - - -
Subscription - - - - -
Task CDex Task Data Request Profile, CDex Task Attachment Request Profile - - - -

Bundle

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:

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

Fetch and Search Criteria:

  • A Client SHOULD be capable of fetching 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:

Profile Interaction Summary:

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

Fetch and Search Criteria:

  • A Client MAY be capable of fetching 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:

Profile Interaction Summary:

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

Fetch and Search Criteria:

  • A Client MAY be capable of fetching 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 Client SHOULD be capable of fetching a Provenance resource using: GET [base]/Provenance/[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 Client SHOULD be capable of fetching a Subscription resource using: GET [base]/Subscription/[id]

Task

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to request and fetch clinical information using Task-based query and for requesting attachments.

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

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

Fetch and Search Criteria:

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