This page is part of the Da Vinci Health Record Exchange (v1.1.0: STU 1.1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Home

Official URL: http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex				Version: 1.1.0
IG Standards status: Trial-use			Maturity Level: 2	Computable Name: DaVinciHealthRecordExchangeHRex
Other Identifiers: OID:2.16.840.1.113883.4.642.40.19

Introduction

The Da Vinci Health Record Exchange (HRex) implementation guide (IG) is a foundational guide for all other Da Vinci guides. It defines FHIR profiles, operations and guidance that are relevant to more than one, and sometimes all, Da Vinci use-case IGs. In the future, it could define additional types of artifacts such as extensions or value sets. All HRex artifacts are intended to be use-case independent, though they are specifically tied to the HRex scope. They might be referenced in RESTful exchanges, passed in CDS Hooks, or manipulated by SMART apps. Because the artifacts defined here are use-case independent, this IG does not include a use-case or patient stories section. Use-cases can instead be found in the various Da Vinci guides that leverage the artifacts defined here for specific business purposes.

As a supporting IG, HRex is expected to continue to evolve as additional shared content needs are identified as part of the Da Vinci work. Da Vinci use case IGs will derive from this IG and reference specific pages and sections that are relevant to their use-case and mandate the use of the profiles and artifacts defined here, or that are inherited from US Core. Da Vinci IGs may also refine or further constrain content defined here when the use case requirements are tighter than the general 'shared' requirement.

The scope of Da Vinci is US payer and provider data exchange with each other and other covered entities under HIPAA (including their business associates). It includes data exchange with the patient/member. The exchanges are typically ones that are 'of interest' in value-based care. Some of the Da Vinci content may be relevant outside this defined scope (e.g. non-US implementations). However, requests for change should be focused on HRex’s official scope.

Content and Organization

The main menu in this IG is categorized into several primary topics with several sub-topics:

• Background provides supporting information relevant for implementers of this IG or Da Vinci guides in general. These sections may be referenced from other Da Vinci IGs, but do not contain any rules that impact IG conformance. (Nothing in these sections will ever become 'normative' or define functionality that implementer systems must or must not do.) These sections will provide context to implementers to help them understand other parts of the IG and make better and more efficient decisions with respect to FHIR implementation.
  • Da Vinci Overview provides an overview of the Da Vinci project and provides guidance on how to get involved in the project and where to find the use-case specific IGs.
  • Guiding Principles describes key principles that underly all Da Vinci interoperability.
  • FHIR Introduction highlights the key sections of the FHIR core specification that Da Vinci implementers should be familiar with.
  • Approaches to Exchanging FHIR Data provides a detailed overview of all the mechanisms that FHIR supports for exchanging information. Implementers do not need to read this, but Da Vinci use case IGs may refer to this information.
  • Managing Instance Validation gives general guidance about managing validation of Da Vinci instances across different IGs and different versions of an IG.
  • Participants and Credits provides thanks to key contributors to the creation of this guide.
• Specification content includes pages that define artifacts or include formal conformance rules that apply to this IG and that may be included by reference in other Da Vinci IGs.
  • Conformance Expectations describes conformance language used within the spec and expectations around mustSupport and missing data
  • Privacy, Safety, and Security provides general expectations to ensure security and privacy of Da Vinci exchanges
  • Task-based Queries describes the mechanisms for using Task to ask for information
  • Dynamic Registration for SMART Apps documents requirements for cross-registration of SMART on FHIR apps
  • Member Match describes the process to resolve a member as known by the target payer system
• FHIR Artifacts includes links to artifacts (profiles, operations, etc.) defined both in this specification as well as in the imported US Core implementation guides. This index also includes a list of all of the examples - there are at least two examples for every profile, sometimes more to demonstrate the range of possible content supported. (Examples relevant to a given profile are also linked to from the profile page.)
• Base Specs includes links to the FHIR core specification as well as the US Core specs that underlie this IG.
• Support includes various links for support and guidance, as well as download links for this IG and guidance on tools and support for Da Vinci implementers.

The main menu at the top of all IG pages will allow you to jump to any of the main pages in the IG. The breadcrumbs bar (right below the menu bar) will let you navigate 'up' to ancestor pages of whatever page you are looking at. The Table of Contents (TOC) will show you all pages in the IG and the Artifacts list will list all of the artifacts (profiles, extensions, operations, value sets, etc.) defined in this specification. As well, this IG makes heavy use of hyperlinks which will allow navigation to relevant sections of this specification and parent specifications.

NOTE: Past versions of this IG included a cross-reference of what HRex and US Core profiles were used in which Da Vinci IGs. Experience has proven that this list is very difficult to keep current given the release frequency of HRex as compared to other Da Vinci IGs. We have removed this summary and instead encourage readers to leverage the FHIR Statistics page. Search for the canonical of the profile you're interested in seeing the use of, and this index will indicate which artifacts leverage that profile (either pointing to it or deriving from it).

Dependencies

At present, HRex is based on FHIR R4. In addition, this guide also relies on a number of parent implementation guides:

Implementation Guide	Version(s)	Reason
FHIR Extensions Pack	5.1.0	Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
FHIR R4 package : Core	4.0.1	Imported by HL7 Terminology (THO) (and potentially others)
HL7 Terminology (THO)	6.1.0	Automatically added as a dependency - all IGs depend on HL7 Terminology
	5.5.0	Imported by US Core (and potentially others)
Public Health Information Network Vocabulary Access and Distribution System (PHIN VADS)	0.12.0	Imported by US Core (and potentially others)
SMART App Launch	2.0.0	Imported by US Core (and potentially others)
Structured Data Capture	3.0.0	Imported by US Core (and potentially others)
US Core	7.0.0	Needed for systems supporting USCDI v4
	6.1.0	Needed for systems supporting USCDI v3
	3.1.1	Needed for systems supporting USCDI v1
Value Set Authority Center (VSAC)	0.19.0	Defines some of the US Core value set bound to in this IG
	0.18.0	Imported by US Core (and potentially others)

This implementation guide defines additional constraints and usage expectations above and beyond the information found in these base specifications.

As seen in the above table, HRex is dependent on the US Core 3.1 (FHIR R4), US Core 6.1 (FHIR R4) and US Core 7.0 (FHIR R4) implementation guides. The first is supported for those systems limited to United States Core Data for Interoperability (USCDI) v1 capabilities, the second is for upcoming regulatory requirements mandating support for USCDI v3, and the last is to enable support for proposed regulations mandating support for USCDI v4. Wherever possible, Da Vinci profiles strive to comply with all three releases, simplifying implementation for those who will need to support varying regulatory expectations over time.

In some situations, the payer community requires additional constraints or needs to profile resources that are not yet supported by US Core. In these cases, this IG does not derive from the US Core profiles, though it does align with them as much as possible. It is possible that certain HRex profiles and/or descriptive content may migrate to a future release of US Core, and in some cases, to the base FHIR standard. In certain instances, Da Vinci IGs will also declare conformance with the QI Core, which supplements US Core with additional profiles and constraints for use in quality measurements. This IG is not derived from QI core, but HRex profiles will be generally compliant with the QI Core specification.

In addition to the direct dependencies listed above, some Da Vinci specifications will make use of content from the following FHIR-related specifications and implementation guides:

• Bulk Data
• C-CDA on FHIR
• CDS Hooks
• CQL
• FHIRPath
• SMART on FHIR

Intellectual Property Considerations

This implementation guide and the underlying FHIR specification are licensed as public domain under the FHIR license. The license page also describes rules for the use of the FHIR name and logo.

This publication includes IP covered under the following statements.

• ISO Maintains the copyright on the country codes, and controls it's use carefully. For futher details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  • ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: CareTeamMemberFunctionNUCCMap, CoverageDavinciWellknownLocation... Show 28 more, DaVinciHealthRecordExchangeHRex, HRexConsent, HRexConsentPolicy, HRexCoverage, HRexCoverageIdentifier, HRexCoveragePatient, HRexCoveragePayor, HRexCoverageRelationship, HRexCoverageSubscriber, HRexCoverageSubscriberId, HRexEndPointName, HRexIdentifierNamespaced, HRexMemberMatchRequestParameters, HRexMemberMatchResponseParameters, HRexOrganization, HRexPatientDemographics, HRexPractitionerRole, HRexProvenance, HRexProvenanceTarget, HRexReferenceId, HRexReferenceRest, HRexTaskDataRequest, HRexTaskStatus, HRexTaskTopic, HRexTempCodes, HRexWellknownDefinition, MemberMatch and NUCCCareTeamMemberFunctionMap
• These codes are excerpted from ASTM Standard, E1762-95(2013) - Standard Guide for Electronic Authentication of Health Care Information, Copyright by ASTM International, 100 Barr Harbor Drive, West Conshohocken, PA 19428. Copies of this standard are available through the ASTM Web Site at www.astm.org.
  Show Usage
  • Signature Type Codes: Provenance/full
• This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  • LOINC: Bundle/subscription-notification-with-document, Bundle/task-poll-response and Task/document-complete
• This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): Bundle/subscription-notification-with-data, HRexPractitionerRole, PractitionerRole/full and Task/query-complete
• This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  • Condition Category Codes: Bundle/subscription-notification-with-data and Task/query-complete
  • Condition Clinical Status Codes: Bundle/subscription-notification-with-data and Task/query-complete
  • ConditionVerificationStatus: Bundle/subscription-notification-with-data and Task/query-complete
  • Consent Action Codes: HRexConsent, Parameters/member-match-in and Parameters/member-match-in-provider
  • Consent Scope Codes: HRexConsent, Parameters/member-match-in and Parameters/member-match-in-provider
  • Coverage Class Codes: HRexCoverage, Parameters/member-match-in and Parameters/member-match-in-provider
  • DataAbsentReason: Coverage/min, HRexCoverage, HRexCoverageRelationship, Parameters/member-match-in and Parameters/member-match-in-provider
  • Provenance participant type: HRexConsent, HRexProvenance... Show 4 more, Parameters/member-match-in, Parameters/member-match-in-provider, Provenance/full and Provenance/min
  • SubscriberPolicyholder Relationship Codes: Coverage/full
  • identifierType: Coverage/full, HRexCoverage, Parameters/member-match-in and Parameters/member-match-in-provider
  • ActCode: HRexConsent, Parameters/member-match-in and Parameters/member-match-in-provider
  • ParticipationFunction: HRexPractitionerRole
  • ParticipationType: HRexConsent, Parameters/member-match-in and Parameters/member-match-in-provider
• Used by permission of HL7 International, all rights reserved Creative Commons License
  Show Usage
  • US Core Provenance Participant Type Extension Codes: HRexProvenance and Provenance/full

</div>