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

This page is part of the Da Vinci Clinical Documentation Exchange (v2.1.0-snapshot: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

CDex ImplementationGuide Resource

Page standards status: Informative

   
Official URL: http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex Version: 2.1.0-snapshot
NPM package name: hl7.fhir.us.davinci-cdex ComputableName: DaVinciCDex
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License Standards status: trial-use
Maturity Level: 2

This IG provides detailed guidance that helps implementers use FHIR-based interactions to support specific exchanges of clinical data between providers and payers (or other providers).

Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.us.davinci-cdex.r4) and R4B (hl7.fhir.us.davinci-cdex.r4b) are available.

IG Dependencies

This IG Contains the following dependencies on other IGs.

IGPackageFHIRComment
.. Da Vinci Clinical Data Exchange (CDex)hl7.fhir.us.davinci-cdex#2.1.0-snapshotR4
... HL7 Terminology (THO)hl7.terminology.r4#6.0.2R4Automatically added as a dependency - all IGs depend on HL7 Terminology
... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.1.0R4Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
... US Core (Reuse Wrapper)hl7.fhir.us.core.3.1.1#3.1.1R4
.... US Corehl7.fhir.us.core#3.1.1R4
... US Core Implementation Guidehl7.fhir.us.core#6.1.0R4
.... HL7 Terminology (THO)hl7.terminology.r4#5.0.0R4
.... FHIR Extensions Packhl7.fhir.uv.extensions.r4#1.0.0R4
.... Bulk Data Access IGhl7.fhir.uv.bulkdata#2.0.0R4
.... SMART App Launchhl7.fhir.uv.smart-app-launch#2.1.0R4
.... VSACus.nlm.vsac#0.11.0R4
.... Structured Data Capturehl7.fhir.uv.sdc#3.0.0R4
.... PHINVadsus.cdc.phinvads#0.12.0R4
.... IHE FormatCode Vocabularyihe.formatcode.fhir#1.1.0R4
... US Core (Reuse Wrapper)hl7.fhir.us.core.v700#7.0.0R4
.... US Core Implementation Guidehl7.fhir.us.core#7.0.0R4
..... HL7 Terminology (THO)hl7.terminology.r4#5.5.0R4
..... SMART App Launchhl7.fhir.uv.smart-app-launch#2.0.0R4
..... VSACus.nlm.vsac#0.18.0R4
... Da Vinci Health Record Exchange (HRex)hl7.fhir.us.davinci-hrex#1.1.0-ballotR4
.... VSACus.nlm.vsac#0.19.0R4
... Da Vinci Prior Authorization Support (PAS) FHIR IGhl7.fhir.us.davinci-pas#2.1.0-previewR4
.... US Core (Reuse Wrapper)hl7.fhir.us.core.v311#3.1.1R4
.... Da Vinci - Coverage Requirements Discoveryhl7.fhir.us.davinci-crd#2.0.0R4
..... HL7 Terminology (THO)hl7.terminology.r4#5.3.0R4
..... Da Vinci Health Record Exchange (HRex)hl7.fhir.us.davinci-hrex#1.0.0R4
...... Security for Scalable Registration, Authentication, and Authorizationhl7.fhir.us.udap-security#0.1.0R4
.... Subscriptions R5 Backporthl7.fhir.uv.subscriptions-backport.r4#1.1.0R4
.... CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)hl7.fhir.us.carin-bb#2.0.0R4
..... VSACus.nlm.vsac#0.7.0R4
... Da Vinci - Documentation Templates and Ruleshl7.fhir.us.davinci-dtr#2.1.0-previewR4
.... Da Vinci - Coverage Requirements Discoveryhl7.fhir.us.davinci-crd#2.1.0-previewR4
..... HL7 Terminology (THO)hl7.terminology#6.0.2R5
..... FHIR Tooling Extensions IGhl7.fhir.uv.tools#0.2.0R5
...... HL7 Terminology (THO)hl7.terminology.r5#5.5.0R5

Package hl7.fhir.uv.extensions.r4#5.1.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.uv.extensions.r4#1.0.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Mar 26, 2023 08:46+1100+11:00)

Package hl7.fhir.uv.bulkdata#2.0.0

FHIR based approach for exporting large data sets from a FHIR server to a client application (built Fri, Nov 26, 2021 05:56+1100+11:00)

Package hl7.fhir.uv.sdc#3.0.0

The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR.
This includes two components:
* Support more sophisticated questionnaire/form use-cases such as those needed for research, oncology, pathology and other clinical domains.
*Support pre-population and auto-population of EHR data into forms/questionnaires for uses outside direct clinical care (patient safety, adverse event reporting, public health reporting, etc.). (built Tue, Mar 8, 2022 18:32+0000+00:00)

Package ihe.formatcode.fhir#1.1.0

Implementation Guide for IHE defined FormatCode vocabulary. (built Thu, Feb 24, 2022 16:55-0600-06:00)

Package hl7.fhir.us.core#6.1.0

The US Core Implementation Guide is based on FHIR Version R4 and defines the minimum conformance requirements for accessing patient data. The Argonaut pilot implementations, ONC 2015 Edition Common Clinical Data Set (CCDS), and ONC U.S. Core Data for Interoperability (USCDI) v1 provided the requirements for this guide. The prior Argonaut search and vocabulary requirements, based on FHIR DSTU2, are updated in this guide to support FHIR Version R4. This guide was used as the basis for further testing and guidance by the Argonaut Project Team to provide additional content and guidance specific to Data Query Access for purpose of ONC Certification testing. These profiles are the foundation for future US Realm FHIR implementation guides. In addition to Argonaut, they are used by DAF-Research, QI-Core, and CIMI. Under the guidance of HL7 and the HL7 US Realm Steering Committee, the content will expand in future versions to meet the needs specific to the US Realm. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the Office of the National Coordinator for Health Information Technology (ONC) sponsored Data Access Framework (DAF) project. For more information on how DAF became US Core see the US Core change notes. (built Fri, Jun 30, 2023 14:02+0000+00:00)

Package hl7.fhir.us.core#7.0.0

The US Core Implementation Guide is based on FHIR Version R4 and defines the minimum conformance requirements for accessing patient data. The Argonaut pilot implementations, ONC 2015 Edition Common Clinical Data Set (CCDS), and ONC U.S. Core Data for Interoperability (USCDI) v1 provided the requirements for this guide. The prior Argonaut search and vocabulary requirements, based on FHIR DSTU2, are updated in this guide to support FHIR Version R4. This guide was used as the basis for further testing and guidance by the Argonaut Project Team to provide additional content and guidance specific to Data Query Access for purpose of ONC Certification testing. These profiles are the foundation for future US Realm FHIR implementation guides. In addition to Argonaut, they are used by DAF-Research, QI-Core, and CIMI. Under the guidance of HL7 and the HL7 US Realm Steering Committee, the content will expand in future versions to meet the needs specific to the US Realm. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the Office of the National Coordinator for Health Information Technology (ONC) sponsored Data Access Framework (DAF) project. For more information on how DAF became US Core see the US Core change notes. (built Wed, May 8, 2024 15:33+0000+00:00)

Package hl7.fhir.us.davinci-hrex#1.1.0-ballot

The Da Vinci Payer Health Record exchange (HRex) Framework/library specifies the FHIR elements used in multiple Da Vinci implementation guides. This includes FHIR profiles, functions, operations, and constraints on other specifications such as CDS-Hooks and other aspects of Da Vinci Use Cases that are common across more than a single use case.\n\nDa Vinci HRex Implementation Guide (IG) will make use of US Core profiles that are based on the FHIR R4 specification wherever practical. The HRex IG will use the HL7 FHIR Release 4/US Core STU3 specification as its base but will provide additional guidance and documentation to support implementations that follow the HL7 FHIR STU3/US Core STU2 and HL7 FHIR DSTU2/Argonaut specifications.\n\nThe HRex profiles documented in this IG will be used to exchange data between providers systems (e.g. EHRs) and other providers, payers, and third-party applications where appropriate. In addition, exchanges from payer systems to providers, other payers, and third-party applications are supported by the HRex profiles and operations.\n\nHRex may define new extensions, profiles, value sets, constraints/extension to other specification (e.g. specific CDS-Hooks) that are specific Da Vinci requirements. Where appropriate these Da Vinci specific artifacts will be promoted for incorporation into the future versions of existing standards (e.g. R4 US Core profiles) and deprecated in this guide on publication in the updated standard. (built Tue, Aug 13, 2024 16:31+0000+00:00)

Package hl7.fhir.us.udap-security#0.1.0

This implementation guide describes how to extend OAuth 2.0 to support secure and scalable workflows for business-to-business (B2B) apps that implement the client credentials flow or authorization code flow. (built Fri, Aug 6, 2021 15:57+0000+00:00)

Package hl7.fhir.us.davinci-hrex#1.0.0

The Da Vinci Payer Health Record exchange (HRex) Framework/library specifies the FHIR elements used in multiple Da Vinci implementation guides. This includes FHIR profiles, functions, operations, and constraints on other specifications such as CDS-Hooks and other aspects of Da Vinci Use Cases that are common across more than a single use case.

Da Vinci HRex Implementation Guide (IG) will make use of US Core profiles that are based on the FHIR R4 specification wherever practical. The HRex IG will use the HL7 FHIR Release 4/US Core STU3 specification as its base but will provide additional guidance and documentation to support implementations that follow the HL7 FHIR STU3/US Core STU2 and HL7 FHIR DSTU2/Argonaut specifications.

The HRex profiles documented in this IG will be used to exchange data between providers systems (e.g. EHRs) and other providers, payers, and third-party applications where appropriate. In addition, exchanges from payer systems to providers, other payers, and third-party applications are supported by the HRex profiles and operations.

HRex may define new extensions, profiles, value sets, constraints/extension to other specification (e.g. specific CDS-Hooks) that are specific Da Vinci requirements. Where appropriate these Da Vinci specific artifacts will be promoted for incorporation into the future versions of existing standards (e.g. R4 US Core profiles) and deprecated in this guide on publication in the updated standard. (built Wed, Mar 23, 2022 18:55+0000+00:00)

Package hl7.fhir.us.davinci-crd#2.0.0

Guidelines for conveying coverage requirements to clinicians when planning treatment (built Fri, Oct 20, 2023 14:17+0000+00:00)

Package hl7.fhir.uv.subscriptions-backport.r4#1.1.0

The Subscription R5 Backport Implementation Guide enables servers running versions of FHIR earlier than R5 to implement a subset of R5 Subscriptions in a standardized way. (built Wed, Jan 11, 2023 15:34+1100+11:00)

Package hl7.fhir.us.carin-bb#2.0.0

CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®) (built Mon, Nov 28, 2022 15:15+0000+00:00)

Package hl7.fhir.us.davinci-pas#2.1.0-preview

Guidelines for conveying coverage requirements to clinicians when planning treatment. (built Thu, Sep 26, 2024 18:54-0400-04:00)

Package hl7.fhir.uv.tools#0.2.0

This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Fri, Apr 26, 2024 06:44+1000+10:00)

Package hl7.fhir.us.davinci-crd#2.1.0-preview

Guidelines for conveying coverage requirements to clinicians when planning treatment (built Thu, Sep 26, 2024 14:58-0400-04:00)

Package hl7.fhir.us.davinci-dtr#2.1.0-preview

The Documentation Templates and Rules (DTR) Implementation Guide (IG) specifies how payer rules can be executed in a provider context to ensure that documentation requirements are met. The IG is a companion to the Coverage Requirements Discovery (CRD) IG, which uses CDS Hooks to query payers to determine if there are documentation requirements for a proposed medication, procedure or other service. (built Fri, Sep 27, 2024 06:27-0400-04:00)

Global Profiles

There are no Global profiles defined

Copyrights

This publication includes IP covered under the following statements.

Parameter Settings

The following IG Parameters are set for this Implementation Guide:

  • code: copyrightyear
    value: 2024+
  • code: releaselabel
    value: CI Build
  • code: path-resource
    value: input/resources
  • code: path-resource
    value: fsh-generated/resources
  • code: path-resource
    value: input/examples
  • code: path-pages
    value: input/pagecontent
  • code: path-pages
    value: input/intro-notes
  • code: path-pages
    value: fsh-generated/includes
  • code: path-expansion-params
    value: ../../input/_resources/exp-params.json
  • code: path-liquid
    value: liquid
  • code: active-tables
    value: false
  • code: apply-contact
    value: true
  • code: apply-jurisdiction
    value: true
  • code: apply-publisher
    value: true
  • code: apply-version
    value: true
  • code: show-inherited-invariants
    value: false
  • code: usage-stats-opt-out
    value: true
  • code: excludettl
    value: true
  • code: generate
    value: xml
  • code: generate
    value: json
  • code: version-comparison
    value: 1.0.0
  • code: version-comparison
    value: 1.1.0
  • code: version-comparison
    value: 2.0.0
  • code: bundle-references-resolve
    value: false
  • code: no-narrative
    value: Parameters/cdex-parameters-example4
  • code: no-narrative
    value: Parameters/cdex-parameters-example5
  • code: no-narrative
    value: Parameters/cdex-parameters-example1
  • code: no-narrative
    value: Parameters/cdex-parameters-example2
  • code: no-narrative
    value: Parameters/cdex-parameters-example3
  • code: no-narrative
    value: Task/cdex-task-inline-example1
  • code: no-narrative
    value: Task/cdex-task-inline-example4
  • code: no-narrative
    value: Task/cdex-task-inline-example6
  • code: no-narrative
    value: Task/cdex-task-inline-example21
  • code: no-narrative
    value: Task/cdex-task-inline-example22
  • code: no-narrative
    value: Task/cdex-task-inline-example26
  • code: no-narrative
    value: Task/cdex-task-inline-example10
  • code: no-narrative
    value: Task/cdex-task-inline-example11
  • code: no-narrative
    value: Task/cdex-task-inline-example13
  • code: no-narrative
    value: Task/cdex-task-inline-example15
  • code: no-narrative
    value: Task/cdex-task-inline-example17
  • code: no-narrative
    value: Task/cdex-task-inline-example19
  • code: no-narrative
    value: Subscription/cdex-task-inline-scenario1-subscription-requested
  • code: no-narrative
    value: Subscription/cdex-task-inline-scenario1-subscription-active
  • code: no-narrative
    value: QuestionnaireResponse/cdex-questionnaireresponse-inline-example1
  • code: no-narrative
    value: Bundle/cdex-task-inline-scenario1-subscription-notification
  • code: no-narrative
    value: Bundle/cdex-bundle-inline-example-858p
  • code: suppressed-ids
    value: Parameters/cdex-parameters-example1,Parameters/cdex-parameters-example2,Parameters/cdex-parameters-example3,Parameters/cdex-parameters-example4,Parameters/cdex-parameters-example5,Task/cdex-task-inline-example1,Subscription/cdex-task-inline-scenario1-subscription-requested,Task/cdex-task-inline-example4,Task/cdex-task-inline-example6,Task/cdex-task-inline-example21,Task/cdex-task-inline-example10,Task/cdex-task-inline-example11,Task/cdex-task-inline-example13,Task/cdex-task-inline-example15,Task/cdex-task-inline-example17,Task/cdex-task-inline-example26,QuestionnaireResponse/cdex-questionnaireresponse-inline-example1,Task/cdex-task-inline-example19,Task/cdex-task-inline-example22,OperationOutcome/cdex-operationoutcome-inline-example1
  • code: tabbed-snapshots
    value: true
  • code: auto-oid-root
    value: 2.16.840.1.113883.4.642.40.21
  • code: path-history
    value: http://hl7.org/fhir/us/davinci-cdex/history.html