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

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

Data Type Profile: HRex Identifier Reference Profile

Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-reference-id Version: 1.1.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: HRexReferenceId
Other Identifiers: OID:2.16.840.1.113883.4.642.40.19.42.17

This HRex Reference Profile should 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).

Usage:

  • This DataType Constraint is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference 0..* Reference A reference from one resource to another
... identifier 1..1 Identifier Logical reference, when literal reference is not known
... display S 0..1 string Text alternative for the resource

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference C 0..* Reference A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ref-1errorReferenceSHALL 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 & Constraintsdoco
.. Reference C 0..* Reference A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... 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 0..1 string Literal reference, Relative, internal or absolute URL
... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL 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'))

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 1 element

Maturity: 2

Differential View

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference 0..* Reference A reference from one resource to another
... identifier 1..1 Identifier Logical reference, when literal reference is not known
... display S 0..1 string Text alternative for the resource

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference C 0..* Reference A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ref-1errorReferenceSHALL 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'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Reference C 0..* Reference A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... 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 0..1 string Literal reference, Relative, internal or absolute URL
... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Reference.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorReferenceSHALL 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'))

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron