Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1 United States of America flag

Da Vinci Health Record Exchange (HRex), published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 1.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-ehrx/ and changes regularly. See the Directory of published versions

Artifact List

Page standards status: Informative

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Global profiles

There are no Global profiles defined

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

HRex Member Match Operation

The $member-match operation that can be invoked by either a payer or an EHR or other system, allows one health plan to retrieve a unique identifier for a member from another health plan using a member's demographic and coverage information. This identifier can then be used to perform subsequent queries and operations. Members implementing a deterministic match will require a match on member id or subscriber id at a minimum (i.e. A pure demographic match will not be supported by such implementations.).

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Coverage identifier Search Parameter

The primary identifier of the insured and the coverage

NOTE: This HRex SearchParameter definition extends the usage context of the capabilitystatement-expectation extension to formally express implementer expectations for these elements:

  • multipleAnd

  • multipleOr

  • modifier

  • comparator

  • chain

Coverage patient Search Parameter

Retrieve coverages for a patient

NOTE: This HRex SearchParameter definition extends the usage context of the capabilitystatement-expectation extension to formally express implementer expectations for these elements:

  • multipleAnd

  • multipleOr

  • modifier

  • comparator

  • chain

Coverage payer Search Parameter

The identity of the insurer or party paying for services

NOTE: This HRex SearchParameter definition extends the usage context of the capabilitystatement-expectation extension to formally express implementer expectations for these elements:

  • multipleAnd

  • multipleOr

  • modifier

  • comparator

  • chain

Coverage subscriber Search Parameter

Reference to the subscriber

NOTE: This HRex SearchParameter definition extends the usage context of the capabilitystatement-expectation extension to formally express implementer expectations for these elements:

  • multipleAnd

  • multipleOr

  • modifier

  • comparator

  • chain

Coverage subscriberId Search Parameter

ID assigned to the subscriber

NOTE: This HRex SearchParameter definition extends the usage context of the capabilitystatement-expectation extension to formally express implementer expectations for these elements:

  • multipleAnd

  • multipleOr

  • modifier

  • comparator

  • chain

Provenance target Search Parameter

Target Reference(s) (usually version specific)

NOTE: This HRex SearchParameter definition extends the usage context of the capabilitystatement-expectation extension to formally express implementer expectations for these elements:

  • multipleAnd

  • multipleOr

  • modifier

  • comparator

  • chain

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

Da Vinci .well-known File Definition

Definition of the content of the Da Vinci .well-known endpoint

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

HRex Consent Profile

The HRex Consent Profile defines the constraints for representing a member's consent to the sharing of their healthcare information to other organizations.

HRex Member Match Coverage Profile

The HRex Coverage Profile defines the constraints for representing a member's healthcare insurance information to the Payer for member match purposes. Coverage instances complying with this profile, sometimes together with the Patient which this profile references via beneficiary, allows a payer to identify a member in their system. It aligns with the equivalent US Core profile, but diverges in that it does not require Patient.identifier for the beneficiary.

HRex Member Match Patient

Defines constraints on the patient resource for transmission of minimal demographic information needed for $member-match.

HRex Organization Profile

Additional Da Vinci constraints on organization - to represent either provider organizations or payers

HRex Parameters - Member Match Request Profile

The Parameters profile for Da Vinci Find Member using Patient and Coverage Resources Request. The resource must contain:

  • MemberPatient - HRex Patient containing member demographics
  • CoverageToMatch - details of prior health plan coverage provided by the member, typically from their health plan coverage card
  • CoverageToLink - details of new or prospective health plan coverage, provided by the health plan based upon the member's enrollment
HRex Parameters - Member Match Response Profile

The Parameters profile for Da Vinci Find Member using Identifier datatype Response. The old health plan SHALL return the following data if records for member are found:

  • The unique member identifier (denoted through identifier parameter) submitted by the new health plan.
HRex PractitionerRole Profile

Constraints on the US Core PractitionerRole requiring the use of Da Vinci Organization and Practitioner

HRex Provenance Profile

Additional constraints on US Core Provenance to ensure it meets payer needs, including indicating when the event occurred and retaining signatures if present

HRex Task Data Request Profile

This Task profile is used to solicit information from a system when direct query is not possible and human intervention might be required

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

HRex Identifier Reference Profile

This HRex Reference Profile is intended to be used by Da Vinci IGs where there is no expectation for a RESTful reference, but there is a need for a business identifier (and possibly a display name).

HRex Namespaced Identifier

An Identifier requiring both system and value

HRex REST Reference Profile

This HRex Reference Profile is intended to be used by Da Vinci IGs where there is a need for the reference to be resolvable via REST (and potentially chained through).

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Coverage Da Vinci Wellknown Endpoint

The location of the Da Vinci endpoint .well-known file associated with this Coverage instance. This file will define a variety of endpoints and other information pertinant to data sharing related to the coverage.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

HRex Consent Policy ValueSet

The set of policy URIs for use in HRex data disclosure consent assertions

HRex Coverage Relationship ValueSet

Adds 'unknown' to the list of standard coverage relationship types

HRex Endpoint Name

The set of endpoint names (and possibly other properties) that can be defined in a Da Vinci .well-known file

HRex Task Status ValueSet

The set of task codes allowed for use in HRex data request tasks

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

HRex Temporary Code System

Codes temporarily defined as part of the HRex implementation guide. These will eventually migrate into an officially maintained terminology (likely HL7's UTG code systems).

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

NUCC to SNOMED Care Team Member Function Map

A mapping between the US Core 3.1.1 and 6.1.0 PractitionerRole.code value sets

SNOMED Care Team Member Function to NUCC Map

A mapping between the US Core 3.1.1 and 6.1.0 PractitionerRole.code value sets

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

$member-match example response

A Parameters instance showing what the result of a $member-match operation would look like when initiated by a payer system

$member-match payer example request

A Parameters instance showing what the input to the $member-match operation would look like when initiated by a payer system

$member-match provider example request

A Parameters instance showing what the input to the $member-match operation would look like when initiated by a provider system

HRex Coverage full example

An example showing a fully populated HRex Coverage instance

HRex Coverage minimal example

An example showing a minimally populated HRex Coverage instance

HRex Organization full example

An example showing a fully populated HRex Organization provider instance

HRex Organization minimal example

An example showing a minimally populated HRex Organization provider instance

HRex PractitionerRole full example

An example showing a fully populated HRex PractitionerRole instance

HRex PractitionerRole min example

An example showing a minimally populated HRex PractitionerRole instance

HRex Provenance full example

An example showing a fully populated HRex Provenance instance

HRex Provenance min example

An example showing a minimally populated HRex Provenance instance

HRex Task Data Request - completed document example

An example showing a 'code' data request task once it has results - as references to the relevant documents

HRex Task Data Request - completed query example

An example showing a 'query' data request task once it has results - as a contained searchset Bundle

HRex Task Data Request - initial query example

An example showing the initial view of a 'query' data request

HRex Task Data Request - status query example

An example showing a 'query' data request task after it has been accepted and is showing a 'progress' status

HRex Task Subscription Notification - completed document example

An example showing the subscription notification for a 'document' data request task that includes data

HRex Task Subscription Notification - completed query example

An example showing the subscription notification for a 'query' data request task that includes data

HRex Task minimal example

An example showing a minimally populated HRex Task Data Request instance

HRex Task polling response

An example showing a polling response monitoring a completed 'document' task

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

Example Wellknown endpoint

An example of the sort of content that would be found at [base]/.well-known/davinci-configuration

HRex Task Subscription Topic

The HRex Task Update Subscription Topic allows for monitoring for newly created tasks as well as updates to assigned or requested tasks. For example, when the status changes from “in-progress” to "completed".