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 Consumer Client CapabilityStatement

Official URL: http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client Version: 1.0.0
Active as of 2022-02-28 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 (often a Payer) in Client mode when requesting clinical data from the Data Source (often an EHR) during a clinical data exchange. This includes the following interactions:

  1. Requesting Clinical Data using a FHIR RESTful query
  2. POSTing a Task resource representing a request for clinical data
  3. POSTing a Subscription resource
  4. Polling 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 Consumer SHALL:

  1. Support at least one of these FHIR transaction approaches for exchanging clinical information as defined in this Guide:
    1. Direct Query
    2. Task Based Approach
  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 SHOULD:

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

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

Claim

Conformance Expectation: SHOULD

Resource Specific Documentation:

Resource type to carry information regarding reason for requesting information 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 Client SHOULD be capable of fetching 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 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 from data source

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]