Da Vinci Health Record Exchange (HRex)
1.1.0-cibuild - STU 1.1 post-ballot build 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-cibuild 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

Profile overview

Page standards status: Informative

Da Vinci IGs make use of a variety of FHIR profiles, extensions, operations, and other artifacts. These are drawn from the core specification, US Core, defined within other Da Vinci IGs and defined in other (non-Da Vinci) IGs. This page provides a summary of key artifacts currently in use in at least one Da Vinci IG. Because Da Vinci has so many IGs and they are changing relatively frequently, this summary page will not always be completely up to date. However, the team will do their best to keep it so. (If you find an issue, please use the Propose a Change link below to get it fixed.)

Some of the artifacts that are currently defined in this HRex IG are candidates for incorporation into the underlying US Core IG - either by updating the underlying US Core profile or introducing new profiles to US Core. If that occurs, the HRex profiles will be removed in a future release. Specific plans for migration are captured in comments in the artifacts below.

Note: At present, this table does not contain Da Vinci terminology artifacts. In the long term, we expect all Da Vinci code systems to be replaced by external terminologies (LOINC, SNOMED, terminology.hl7.org, etc.). At present, no requirement for sharing Da Vinci value sets has been identified.

Each of the following tables make use of 5 columns:

  • Resource: indicates the resource or data type the artifact is associated with. 'General' is used for artifacts that are not resource specific.
  • Defined: is the IG in which the artifact is published and maintained. (See below for a list of all IGs, including links.)
  • Artifact: the name (and a link) for the artifact. Hover to see the canonical URL.
  • Used: a list of the Da Vinci IG(s) that use this artifact.
  • Notes: any information about artifact relationships, migration, deprecation, etc.

The list of IGs whose artifacts are covered (and the short-form codes used to refer to them) are as follows:

Profiles

Note: This table does not list profiles on the Parameters resource used to define inputs and outputs to operations. Information on usage for these is instead tracked in the Operations table below.

Resource Defined Artifact Used Notes
AllergyIntolerance USCORE 3 US Core AllergyIntolerance Profile HRex
Appointment CRD Appointment CRD
Bundle PAS PAS Inquiry Request Bundle PAS
PAS Inquiry Response Bundle PAS
PAS Request Bundle PAS
PAS Response Bundle PAS
DEQM DEQM Gaps In Care Bundle Profile DEQM
Alerts Da Vinci Notifications Bundle Profile Alerts
PCDE PCDE Coverage Transition Bundle Profile PCDE
CarePlan USCORE 3 US Core CarePlan Profile HRex
PCDE PCDE Coverage Transition CarePlan Profile PCDE This is based on US Core CarePlan profile.
CareTeam USCORE 3 US Core CareTeam Profile HRex
Claim PAS PAS Claim PAS, PCDE
PAS Claim Inquiry PAS
PAS Claim Inquiry Response PAS
PAS Claim Response PAS, PCDE
PAS Claim Update PAS This is based on PAS Claim profile.
ClaimResponse CRD ClaimResponse CRD
CommunicationRequest PAS PAS CommunicationRequest PAS
CRD CommunicationRequest CRD
Composition DEQM DEQM Gaps In Care Composition Profile DEQM
PCDE PCDE Coverage Transition Composition Profile PCDE
Condition USCORE 3 US Core Condition Profile HRex, CRD, PCDE
Alerts Da Vinci Admit/Transfer/Discharge Notification Condition Profile Alerts This is based on US Core Condition profile.
Coverage HRex HRex Coverage HRex, PDex, PCDE This is a candidate for US-core migration, though Coverage is not currently tied to patient data sharing requirements
PAS PAS Coverage PAS
CRD Coverage CRD
CoverageDeident CRD
DEQM DEQM Coverage Profile DEQM This is based on QI-Core Coverage profile.
Alerts Da Vinci Admit/Transfer/Discharge Notification Coverage Profile Alerts This is based on HRex Coverage profile.
ATR Davinci ATR Coverage ATR
DetectedIssue DEQM DEQM Gaps In Care Detected Issue Profile DEQM
Device USCORE 3 US Core Implantable Device Profile HRex
CRD Device CRD
PDex PDex Device PDex
Quality Measure CQFM Device DEQM
DeviceRequest PAS PAS Device Request PAS
CRD DeviceRequest CRD
DiagnosticReport USCORE 3 US Core DiagnosticReport Profile for Laboratory Results Reporting HRex, PCDE
US Core DiagnosticReport Profile for Report and Note exchange HRex, PCDE
DocumentReference USCORE 3 US Core DocumentReference Profile HRex, PCDE
Encounter USCORE 3 US Core Encounter Profile HRex
PAS PAS Encounter PAS This is based on US Core Encounter profile.
CRD Encounter CRD This is based on US Core Encounter profile.
Alerts Da Vinci Admit/Transfer/Discharge Notification Encounter Profile Alerts This is based on US Core Encounter profile.
Endpoint PDex Plan Net Plan-Net Endpoint PDex Plan Net
Goal USCORE 3 US Core Goal Profile HRex
Group DEQM DEQM Gaps In Care Group Profile DEQM
ATR Davinci ATR Group ATR
HealthcareService PDex Plan Net Plan-Net HealthcareService PDex Plan Net
Immunization USCORE 3 US Core Immunization Profile HRex
InsurancePlan PDex Plan Net Plan-Net InsurancePlan PDex Plan Net
List PDex Drug Formulary Formulary Coverage Plan PDex Drug Formulary
Location USCORE 3 US Core Location Profile HRex, PDex, Alerts
CRD Location CRD This is based on US Core Location profile.
ATR Davinci ATR Location ATR This is based on US Core Location profile.
PDex Plan Net Plan-Net Location PDex Plan Net This is based on US Core Location profile.
MeasureReport DEQM DEQM Data Exchange MeasureReport Profile DEQM
DEQM Individual MeasureReport Profile DEQM
DEQM Summary MeasureReport Profile DEQM
Medication USCORE 3 US Core Medication Profile HRex
MedicationAdministration DEQM DEQM MedicationAdministration Profile DEQM This is based on QI-Core MedicationAdministration profile.
MedicationDispense PDex PDex MedicationDispense PDex
MedicationKnowledge PDex Drug Formulary Formulary Drug PDex Drug Formulary
MedicationRequest USCORE 3 US Core MedicationRequest Profile HRex, PDex
PAS PAS Medication Request PAS This is based on US Core MedicationRequest profile.
CRD MedicationRequest CRD
MessageHeader Alerts Da Vinci Notifications MessageHeader Profile Alerts
Da Vinci Admit Notification MessageHeader Profile Alerts
Da Vinci Discharge Notification MessageHeader Profile Alerts
Da Vinci Transfer Notification MessageHeader Profile Alerts
NutritionOrder CRD NutritionOrder CRD
Observation USCORE 3 US Core Laboratory Result Observation Profile HRex, CRD
US Core Pediatric BMI for Age Observation Profile HRex
US Core Pediatric Weight for Height Observation Profile HRex
US Core Pulse Oximetry Profile HRex
US Core Smoking Status Observation Profile HRex
Organization HRex HRex Organization HRex This is based on US Core Organization profile. The requirement for tax id may migrate to US Core, but the CCN identifier likely will not.
USCORE 3 US Core Organization Profile HRex, PAS, CRD, PDex, Alerts, PCDE
PAS PAS Insurer Organization PAS This is based on US Core Organization profile.
PAS Requestor Organization PAS This is based on US Core Organization profile.
CRD Organization CRD This is based on US Core Organization profile.
DEQM DEQM Organization Profile DEQM This is based on QI-Core Organization profile.
ATR Davinci ATR Organization ATR This is based on US Core Organization profile.
PDex Plan Net Plan-Net Network PDex Plan Net This is based on US Core Organization profile.
Plan-Net Organization PDex Plan Net This is based on US Core Organization profile.
OrganizationAffiliation PDex Plan Net Plan-Net OrganizationAffiliation PDex Plan Net
Patient USCORE 3 US Core Patient Profile HRex, CRD, PDex, Alerts, PCDE
QI-CORE QI-Core Patient Profile DEQM
PAS PAS Beneficiary Patient PAS This is based on US Core Patient profile.
PAS Subscriber Patient PAS This is based on US Core Patient profile.
CRD Patient CRD This is based on US Core Patient profile.
CRD Deidentified Patient CRD
ATR Davinci ATR Patient ATR This is based on US Core Patient profile.
Practitioner HRex HRex Practitioner HRex This profile is based on US Core Practitioner profile. This will likely remain HRex-specific as neither the additional identifier types, nor the requirement to support qualification are needed in US Core's scope
USCORE 3 US Core Practitioner Profile HRex, CRD, PDex, Alerts, PCDE
PAS PAS Practitioner PAS This is based on US Core Practitioner profile.
CRD Practitioner CRD This is based on US Core Practitioner profile.
DEQM DEQM Practitioner Profile DEQM This is based on QI-Core Practitioner profile.
ATR Davinci ATR Practitioner ATR This is based on US Core Practitioner profile.
PDex Plan Net Plan-Net Practitioner PDex Plan Net This is based on US Core Practitioner profile.
PractitionerRole HRex HRex Practitioner Role HRex This profile is based on US Core PractitionerRole profile. As a binding between two non-migrated profiles, this will also remain HRex-specific
USCORE 3 US Core PractitionerRole Profile CRD, PDex, Alerts, PCDE
ATR Davinci ATR PractitionerRole ATR This is based on US Core PractitionerRole profile.
PDex Plan Net Plan-Net PractitionerRole PDex Plan Net
Procedure USCORE 3 US Core Procedure Profile HRex
Provenance HRex HRex Provenance HRex This is based on US Core Provenance profile. The changes included in this profile are likely appropriate to migrate to US Core in the future
USCORE 3 US Core Provenance Profile HRex
PDex Provenance PDex This is based on US Core Provenance profile.
Questionnaire DTR DTRQuestionnaire DTR This is based on CQF-Questionnaire profile.
QuestionnaireResponse DTR DTRQuestionnaireResponse DTR
RelatedPerson ATR Davinci ATR RelatedPerson ATR
ServiceRequest PAS PAS Service Request PAS
CRD ServiceRequest CRD
Task HRex HRex Data Request Task HRex This is a good candidate for migration to the core specification as part of workflow
CRD TaskQuestionnaire CRD
PCDE PCDE Coverage Transition Task - Request Profile PCDE This is based on HRex Data Request Task profile.
PCDE Coverage Transition Task - Search Profile PCDE This is based on HRex Data Request Task profile.
DTR DTRTask DTR

HRex includes the definition of a Task profile that can return data - any US Core profile could be used to return such information, though the IG does not mention this profile specifically.

Extensions

Resource Defined Artifact Used Notes
ContactPoint data type USCORE 3 US Core Direct email Extension N/A
Patient USCORE 3 US Core Birth Sex Extension N/A
US Core Ethnicity Extension N/A
US Core Race Extension N/A

Search Parameters

This table does not expose search parameters that are defined solely for the purpose of asserting conformance criteria but that do not add any additional search capabilities beyond those provided in the base definition of the search parameter.

Resource Defined Artifact Used Notes
Coverage HRex HRex Claim subscriberId HRex This has been proposed for introduction to the core specification
Patient USCORE 3 US Core Ethnicity HRex
US Core Race HRex

Operations

Resource Defined Artifact Used Notes
Coverage HRex Member Match HRex
DocumentReference USCORE 3 US Core Fetch DocumentReferences N/A