Da Vinci Clinical Data Exchange (CDex)
1.0.0 - STU R1 US

This page is part of the Da Vinci Clinical Documentation Exchange (v1.0.0: STU1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, 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: 1.0.0
Active as of 2022-02-28 Computable Name: DataSourceServerCapabilityStatement

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 (often an EHR) in Server mode when responding to a Data Consumer (often a Payer) during a clinical data exchange. This includes the following interactions:

  1. Responding to a FHIR RestFul Query for Clinical Data
  2. Responding to a POST of a Task resource representing a request for clinical data
  3. Responding to a POST of a Subscription resource
  4. Responding to polling of a Task resource

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 Source SHALL:

  1. Support at least one of the two FHIR transaction approaches for requesting information as defined in this Guide:
    1. Direct Query
    2. Task Based Approachs
  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.

The Da Vinci CDex Data Source SHOULD:

  1. Support xml source formats for all Da Vinci CDex interactions.

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 - - - - -
Claim PAS Claim - - - -
Subscription - - - - -
Task CDex Task Data Request Profile - - - -

Bundle

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to fetch Clinical Information from data source

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 Bundle resource using: GET [base]/Bundle/[id]

Claim

Conformance Expectation: SHOULD

Resource Specific Documentation:

Resource type to carry information regarding reason for requesting 1) attachments to support claim submission, medical necessity and other reasons for attachments between payers and providers, and 2) additional information to support prior authorization requests.

Supported Profiles:

Profile Interaction Summary:

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

Fetch and Search Criteria:

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

Subscription

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to subscribe to data source

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:

  • Required resource type to request and fetch clinical information from data source
  • There SHOULD be a reason stated in Task.statusReason by the Data-Source-Server when the status is updated to 'failed', 'refused', 'cancelled' or 'held'

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 Server SHOULD be capable of returning a Task resource using: GET [base]/Task/[id]