Advance Healthcare Directive Interoperability (cda-adi)
0.1.0 - ci-build
Advance Healthcare Directive Interoperability (cda-adi)
0.1.0 - ci-build
Advance Healthcare Directive Interoperability (cda-adi), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cda-adi/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/adi/StructureDefinition/External.Entry.Reference.Entry | Version: 0.1.0 | |||
| Draft as of 2026-06-19 | Computable Name: External_Entry_Reference_Entry | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.4.823.1.4.2.5:2026-08-28 | ||||
This entry represents the act of referencing another an external entry not include in this CDA document instance.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from EntryReference
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Act |
C | 1..1 | EntryReference | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
  Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:external-entry-reference |
1..1 | II | ||
  @root |
1..1 | oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) | Required Pattern: 2.16.840.1.113883.4.823.1.4.2.5 | |
  @extension |
1..1 | st(2.0.3-sd) | Required Pattern: 2026-08-28 | |
 id |
1..* | II | When using a FHIR Collection Bundle for the entries, use the Resource name/Resource id as the id value. For example, if the entry is a FHIR Patient resource with id 123, then the id value would be 'Condition/123'. | |
| text |
0..1 | ED | links to the rendering of the entry information contained in the externally referenced Resource. | |
 reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
 reference |
1..1 | Reference | ||
| @typeCode |
1..1 | cs(2.0.3-sd) | Fixed Value: REFR | |
| externalAct |
0..1 | ExternalAct | ||
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from EntryReference
Summary
Mandatory: 4 elements
Fixed: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from EntryReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | EntryReference | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
| Slices for templateId |
2..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:external-entry-reference |
1..1 | II | ||
| @root |
1..1 | oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) | Required Pattern: 2.16.840.1.113883.4.823.1.4.2.5 | |
| @extension |
1..1 | st(2.0.3-sd) | Required Pattern: 2026-08-28 | |
| id |
1..* | II | When using a FHIR Collection Bundle for the entries, use the Resource name/Resource id as the id value. For example, if the entry is a FHIR Patient resource with id 123, then the id value would be 'Condition/123'. | |
| text |
0..1 | ED | links to the rendering of the entry information contained in the externally referenced Resource. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| reference |
1..1 | Reference | ||
| @typeCode |
1..1 | cs(2.0.3-sd) | Fixed Value: REFR | |
| externalAct |
0..1 | ExternalAct | ||
| externalObservation |
0..1 | ExternalObservation | ||
| externalProcedure |
0..1 | ExternalProcedure | ||
| externalDocument |
0..1 | ExternalDocument | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Key Elements View
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
Snapshot View
| Id | Grade | Path(s) | Description | Expression |
| ED-1 | error | Act.text.thumbnail | Thumbnails cannot contain their own thumbnails |
thumbnail.empty()
|
| II-1 | error | Act.typeId, Act.reference.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-text-ref-value | warning | Act | SHOULD contain text/reference/@value |
text.reference.value.exists()
|
| value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value.exists() implies value.startsWith('#')
|
This structure is derived from EntryReference
Summary
Mandatory: 4 elements
Fixed: 1 element
Slices
This structure defines the following Slices:
IG © 2025+ Health Level Seven. Package hl7.cda.us.adi#0.1.0 based on FHIR 5.0.0. Generated 2026-06-19
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
