Da Vinci Payer Data Exchange
2.1.0 - STU2 United States of America flag

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. 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-epdx/ and changes regularly. See the Directory of published versions


Page standards status: Informative

Previous Page - Overview

The PDex Implementation Guide (IG) identifies three actors and specifies three interactions that occur. Each interaction differs based upon the actors involved and the data payload that is being communicated.


  1. Health Plans
  2. Providers
  3. Third-Party Applications.


  1. Payer to Provider Exchange
  2. Member-authorized Health Plan to Health Plan Exchange
  3. Member-authorized Health Plan to Third Party Applications.

The Blue Button 2.0 initiative (The CMS Blue Button 2.0 API and the CARIN Consumer-Directed Exchange IG) specifies the profiles used to communicate claims information between health plans and their members. The PDex Implementation Guide (IG) is focused on presenting a member’s health and claims information as FHIR clinical profiles (based on US Core) that are more easily consumed by Electronic Medical Records (EMR) systems.

Ad-hoc PDex Member History Requests via CDS Hooks provides a mechanism for providers/clinicians to request information from health plans about the medical history of their patient as part of their regular workflow. The requestor should be aware that the Health Plan may not have a complete medical history of services provided due to delays in billing, patient ability to pay for services, etc.

The same FHIR profiles used to support communication between the health plan and providers will also be used to provide the payload of member health information which will be exchanged between health plans when authorized by a health plan member.

While the authorization and communication mechanisms may differ between the provider-to-payer exchange and the member-authorized Payer-to-Payer exchange or member-authorized Payer to Third-Party Application exchange the API interactions and data formats may be the same.

The objective with the above approach is to:

  • Minimize the proliferation of FHIR profiles by encouraging the re-use of FHIR profiles that have seen significant development effort invested by stakeholders across health care systems.
  • Consolidate the number of operational interfaces that health plans and EMR systems need to maintain in order to meet regulatory requirements.

Implementation Guide Scope

The first release of the PDex IG will focus on the following in-scope items. Items in the deferred scope category will be considered for future iterations of the IG or will be accommodated via an alternative Da Vinci Use Case. Out of scope items are not being considered at this time.

In Scope

  • Ambulatory Care Provider queries
  • Member-authorized Payer-to-Payer information exchange
  • Member-authorized Payer-to-Third-Party Application information exchange.

Deferred Scope

  • In Patient Care Provider queries
  • Provider initiated data push.

Out of Scope

  • Wearable device data.

Member/Patient Consent for scenarios covered in this Implementation Guide fall into two areas:

  1. Provider-Health Plan Exchange
  2. Member-mediated Information Exchange.

Provider-Health Plan Exchange

Provider-Health Plan exchange of data is covered by the Health Insurance Portability and Accountability Act (HIPAA) under the Treatment Payment and Health Care Operations provision.

Member-mediated Information Exchange

The CMS Interoperability and Patient Access Rule requires that a member to a new health plan SHALL be able to request that their information be passed from their old health plan to their new health plan.

The CMS rule also specifies that all data from the member’s health record that is held by the health plan since January 1, 2016, be available via API.

A Member SHALL also be able to use APIs to share information with Third Party Applications.

The Member-mediated Information Exchange method will build upon established OAuth2.0 protocols for patient access to their health and claims information that enables the sharing of information with third-party applications. The process of Member Authentication, typically using the member’s user credentials from the Health Plan’s portal, and OAuth2.0 authorization to share will form the basis of the member Consent to share.

The health history payload for the exchange would be the same FHIR resources that are passed to providers under the Provider-Payer exchange scenario.

The exchange of healthcare network/directory information and Pharmacy network/directory information is covered in the PDex-Plan-Net IG.

The exchange of Prescription drug formulary information is covered in the PDex-formulary IG.

The OAuth2.0-based exchange is covered in detail in the Member-Authorized OAuth2 Exchange.

Supporting Specifications

This Implementation Guide is dependent on other specifications. Please submit any comments you have on these base specifications as follows:

  • Feedback on CDS Hooks should be posted to the CDS Hooks GitHub Issue List

  • Feedback on this Implementation Guide and supporting HL7 specifications should be submitted as issue tickets via the HL7 FHIR Jira system. Login to Jira and create an issue. Next enter the following information to identify the relevant specification:

Project: FHIR Specification Feedback Issue Type: Change Request Specification:

  • FHIR Core (FHIR)
  • US Core (FHIR)
  • US Da Vinci PDex (FHIR).

Individuals interested in participating in Payer Data exchange (PDex) or other HL7 Da Vinci projects can find information about the Da Vinci accelerator project here.


This Implementation Guide uses terminology, notations and design principles that are specific to FHIR. Before reading this implementation guide, it’s important to be familiar with some of the basic principles of FHIR as well as general guidance on how to read FHIR specifications. Readers who are unfamiliar with FHIR are encouraged to read (or at least skim) the following prior to reading the rest of this Implementation Guide.

Implementation Assumptions

Wherever possible, the PDex IG will use established US Core STU 3.1.1 Profiles or US Core STU 6.1.0 Profiles. Where information must be presented in FHIR resources that fall outside of the US Core Implementation Guide (IG) the HL7 Da Vinci Health Record exchange (HRex) IG will define the necessary Da Vinci FHIR profiles or will refer to other Implementation Guides, as necessary.

Where profiles are specific to the PDex use case, the profiles will be defined in this guide.

Implementation Hierarchy and Priorities

The PDex Implementation Guide (IG) will utilize existing HL7 FHIR Profiles in the following order of descending priority:

  1. HL7 FHIR US Core STU3 v3.1.1 (based on FHIR R4 - http://hl7.org/fhir/us/core/STU3.1.1/STU3.1.1)
  2. HL7 FHIR US Core STU6 v6.1.0 (based on FHIR R4 - http://hl7.org/fhir/us/core/STU3.1.1/STU6.1)
  3. Da Vinci HRex IG profiles (based on FHIR R4 - http://hl7.org/fhir/us/davinci-hrex/ ).

Note: The ONC HTI-1 rule has set a date for January 1, 2026 when US Core 6.1.0 becomes the base standard, superceding US Core 3.1.1. Prior to that date Implementers may choose to implement either version of US Core.

This Implementation Guide recognizes that Electronic Medical Record systems used by providers may have existing FHIR APIs that are based on versions of FHIR prior to FHIR R4, with DSTU2 (Argonaut) being the most popular implementation.

Amongst Health Plans there has been limited adoption of FHIR specifications and FHIR APIs. Therefore, for profiles and APIs identified in this IG, the FHIR R4 version SHALL be used.

PDex Data Payloads

The PDex IG defines four types of data payload:

  1. Member Membership, Clinical and Claims-derived History. Referred to in this IG as the “Member Health History”
  2. Healthcare Network Directory
  3. Pharmacy Network Directory
  4. Medication Formulary.

The CMS Interoperability rule requires Health Plans to make available data they hold for a member from Jan 1, 2016, onwards. When data is transferred from one plan to another the receiving health plan is only obligated to share the data received from another health plan in the same electronic form and format in which it was received.

The Directory and Formulary data payloads are covered in their respective Da Vinci Implementation Guides.

All resources available via a FHIR API endpoint SHALL be declared in a FHIR CapabilityStatement.

The FHIR CapabilityStatement defines the resources and operations supported by the resources exposed via the FHIR API.

The Read and Search Operations SHALL be supported for the FHIR Profiles covered in this payload section. The V-Read and History operations MAY be supported.

Member Health History

The FHIR Resources that comprise the Member Clinical and Claims-derived history, otherwise referred to as the “Member Health History” SHOULD include the following profiles where payers have data to support the use of those profiles:

US Core Profiles (STU3 - 3.1.1)

In addition, US Core 3.1.1 uses the Vital Signs Profile from the FHIR Specification.

US Core Profiles (STU6 - 6.1.0)

To understand the changes between US Core 3.1.1 and US Core 6.1.0 check out the Cross Version Comparisons Section section of the US Core 6.1.0 IG.

Da Vinci PDex / HRex

CapabilityStatement (STU3 - US Core 3.1.1)

The FHIR CapabilityStatement defines the resources and operations permitted on the resources exposed via the FHIR API.

The Permitted Operations for the FHIR Profiles covered in this payload section are defined as follows:

Resource Type Profile Read V-Read Search History
AllergyIntolerance http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-allergyintolerance.html Y Y Y Y
CarePlan http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careplan.html Y Y Y Y
CareTeam http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careteam.html Y Y Y Y
Condition http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-condition.html Y Y Y Y
Coverage http://hl7.org/fhir/us/davinci-hrex/2019Jun/StructureDefinition-hrex-coverage.html Y Y Y Y
Device http://hl7.org/fhir/us/davinci-epdx/StructureDefinition-pdex-device.html Y Y Y Y
DiagnosticReport for Laboratory Results Reporting http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-diagnosticreport-lab.html Y Y Y Y
DiagnosticReport for Report and Note Exchange http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-diagnosticreport-note.html Y Y Y Y
DocumentReference http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html Y Y Y Y
Encounter http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-encounter.html Y Y Y Y
Goal http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-goal.html Y Y Y Y
Immunization http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-immunization.html Y Y Y Y
Implantable Device http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-implantable-device.html Y Y Y Y
Laboratory Result Observation http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-observation-lab.html Y Y Y Y
Location http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-location.html Y Y Y Y
Medication http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html Y Y Y Y
MedicationDispense http://hl7.org/fhir/us/davinci-epdx/StructureDefinition-pdex-medicationdispense.html Y Y Y Y
MedicationRequest http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medicationrequest.html Y Y Y Y
Organization http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html Y Y Y Y
Patient http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html Y Y Y Y
Pediatric BMI for Age Observation http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-pediatric-bmi-for-age.html Y Y Y Y
Pediatric Head Occipital Frontal Circumference Percentile http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-head-occipital-frontal-circumference-percentile.html Y Y Y Y
Pediatric Weight for Height Observation http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-pediatric-weight-for-height.html Y Y Y Y
Practitioner http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitioner.html Y Y Y Y
PractitionerRole http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html Y Y Y Y
Procedure http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-procedure.html Y Y Y Y
Provenance http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-provenance.html Y Y Y Y
PDex Provenance http://hl7.org/fhir/us/davinci-epdx/StructureDefinition-pdex-provenance.html Y Y Y Y
Pulse Oximetry http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-pulse-oximetry.html Y Y Y Y
Smoking Status Observation http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-smokingstatus.html Y Y Y Y
Vital Signs http://hl7.org/fhir/R4/observation-vitalsigns.html Y Y Y Y

Healthcare Network Directory

The provision of a Member-accessible Healthcare Network Directory API is detailed in the companion, subsidiary Payer Data Exchange Plan Network Implementation Guide (PDex-plan-net IG).

Pharmacy Network Directory

The provision of a Member-accessible Pharmacy Network Directory API is detailed in the companion, subsidiary Payer Data Exchange Plan Network Implementation Guide (PDex-plan-net IG). A Health Plan’s Pharmacy Network SHOULD be expressed using the same FHIR profiles used for the Healthcare Network Directory.

Medication Formulary

When a Health Plan provides prescription drug coverage the list of covered medications is known as a “Formulary.” The provision of a Member-accessible Prescription Drug Formulary API is detailed in the companion, subsidiary Payer Data Exchange Drug Formulary Implementation Guide (PDex-formulary IG).

Next Page - Security and Privacy