Da Vinci Health Record Exchange (HRex)
1.2.0-snapshot - STU 1.2 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.2.0-snapshot 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

Data Type Profile: HRex REST Reference Profile

1.2.0-snapshot
Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-reference-rest Version:
Standards status: Trial-use Active as of 2026-01-30 Maturity Level: 3 Computable Name: HRexReferenceRest
Other Identifiers: OID:2.16.840.1.113883.4.642.40.19.42.18

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference Reference
... reference 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Summary

Mandatory: 1 element

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference Reference
... reference 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ref-1 error Reference SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Summary

Mandatory: 1 element

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron