Da Vinci Health Record Exchange (HRex)
0.2.0 - STU R1 - 2nd ballot

Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 0.2.0). 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

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

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems complying with this implementation guide

HRex Member Match Operation

The $member-match operation 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.

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 payor 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: Resource Profiles

These define constraints on FHIR resources that need to be complied with by conformant implementations

HRex Organization Profile

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

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

HRex PractitionerRole Profile

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

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 - US Core Patient containing member demographics
  • OldCoverage - details of prior health plan coverage provided by the member, typically from their health plan coverage card
  • NewCoverage - details of new or prospective health plan coverage, provided by the health plan based upon the member’s enrolment
HRex Practitioner Profile

Constraints on the US Core Practitioner profiles requiring support for qualification and requiring support for an additional identifier type

HRex Parameters - Member Match Response Profile

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

  • The unique member identifier added to the Patient.identifier in the Patient resource submitted by the new health plan.
  • The new health plan coverage resource.

(Only one Patient and one Coverage record are to be returned.)

HRex Coverage Profile

The HRex Coverage Profile defines the constraints for representing a member’s healthcare insurance information to the Payer.  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.

Terminology: Value Sets

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

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 with 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).

Example: Example Instances

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

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

$member-match example request

A Parameters instance showing what the input to the $member-match operation would look like

$member-match example response

A Parameters instance showing what the result of a $member-match operation would look like

HRex Practitioner full example

An example showing a fully populated HRex Practitioner instance

HRex Practitioner minimal example

An example showing a minimally populated HRex Practitioner 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 minimal example

An example showing a minimally populated HRex Task Data Request instance

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 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 - completed document example

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

HRex Task Subscription Notification - completed query example

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

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

Bundle/subscription-notification-with-document