Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1
Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1
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
| Official URL: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-reference-id | Version: 1.1.0 | |||
| 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 is intended to 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Reference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference |
C | 0..* | Reference | A reference from one resource to another ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children |
 display |
SΣ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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')) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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')) |
Differential View
This structure is derived from Reference
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Reference |
C | 0..* | Reference | A reference from one resource to another ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children |
| display |
SΣ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier |
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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')) |
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Interoperability Council. Package hl7.fhir.us.davinci-hrex#1.1.0 based on FHIR 4.0.1. Generated 2024-12-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change