Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: External Document Reference

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ExternalDocumentReference | Version: 2.1
Draft as of 2023-09-29 | Computable Name: ExternalDocumentReference
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09

Where it is necessary to reference an external clinical document, the External Document Reference template can be used to reference this external document. However, if the containing document is appending to or replacing another document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument.

Usage:

- Use this Logical Model: Goal Observation, Health Concern Act, Intervention Act, Outcome Observation... Show 2 more, Planned Intervention Act and Risk Concern Act

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from CDAR2.ExternalDocument

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ExternalDocument |  |  | CDAR2.ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber
classCode |  | 1..1 | cs | Fixed Value: DOCCLIN
moodCode |  | 1..1 | cs |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115
extension |  | 1..1 | st | Required Pattern: 2014-06-09
id |  | 1..1 | II |
code |  | 1..1 | CD |
setId |  | 0..1 | II |
versionNumber |  | 0..1 | INT |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ExternalDocument |  | 1..1 | CDAR2.ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN
@moodCode |  | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115
@extension |  | 1..1 | st | Required Pattern: 2014-06-09
id |  | 1..1 | II |
code |  | 1..1 | CD | Binding: FHIRDocumentTypeCodes (extensible)
setId |  | 0..1 | II |
versionNumber |  | 0..1 | INT |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ExternalDocument.classCode | required | Fixed Value: DOCCLIN
ExternalDocument.moodCode | required | Fixed Value: EVN
ExternalDocument.code | extensible | FHIRDocumentTypeCodes

#### Constraints

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ExternalDocument |  | 1..1 | CDAR2.ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN
@moodCode |  | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@assigningAuthorityName |  | 0..1 | st |
@displayable |  | 0..1 | bl |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115
@extension |  | 1..1 | st | Required Pattern: 2014-06-09
id |  | 1..1 | II |
code |  | 1..1 | CD | Binding: FHIRDocumentTypeCodes (extensible)
text |  | 0..1 | ED |
setId |  | 0..1 | II |
versionNumber |  | 0..1 | INT |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ExternalDocument.classCode | required | Fixed Value: DOCCLIN
ExternalDocument.moodCode | required | Fixed Value: EVN
ExternalDocument.templateId:primary.nullFlavor | required | NullFlavor
ExternalDocument.code | extensible | FHIRDocumentTypeCodes

#### Constraints

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

This structure is derived from CDAR2.ExternalDocument

Summary

Mandatory: 7 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

- The element ExternalDocument.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.ExternalDocument

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ExternalDocument |  |  | CDAR2.ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber
classCode |  | 1..1 | cs | Fixed Value: DOCCLIN
moodCode |  | 1..1 | cs |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115
extension |  | 1..1 | st | Required Pattern: 2014-06-09
id |  | 1..1 | II |
code |  | 1..1 | CD |
setId |  | 0..1 | II |
versionNumber |  | 0..1 | INT |
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ExternalDocument |  | 1..1 | CDAR2.ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN
@moodCode |  | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115
@extension |  | 1..1 | st | Required Pattern: 2014-06-09
id |  | 1..1 | II |
code |  | 1..1 | CD | Binding: FHIRDocumentTypeCodes (extensible)
setId |  | 0..1 | II |
versionNumber |  | 0..1 | INT |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ExternalDocument.classCode | required | Fixed Value: DOCCLIN
ExternalDocument.moodCode | required | Fixed Value: EVN
ExternalDocument.code | extensible | FHIRDocumentTypeCodes

#### Constraints

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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ExternalDocument |  | 1..1 | CDAR2.ExternalDocument | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber Base for all types and resources
@classCode |  | 1..1 | cs | Binding: ActClassDocument (required) Fixed Value: DOCCLIN
@moodCode |  | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:root, value:extension
templateId:primary |  | 1..1 | II |
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@assigningAuthorityName |  | 0..1 | st |
@displayable |  | 0..1 | bl |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.115
@extension |  | 1..1 | st | Required Pattern: 2014-06-09
id |  | 1..1 | II |
code |  | 1..1 | CD | Binding: FHIRDocumentTypeCodes (extensible)
text |  | 0..1 | ED |
setId |  | 0..1 | II |
versionNumber |  | 0..1 | INT |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
ExternalDocument.classCode | required | Fixed Value: DOCCLIN
ExternalDocument.moodCode | required | Fixed Value: EVN
ExternalDocument.templateId:primary.nullFlavor | required | NullFlavor
ExternalDocument.code | extensible | FHIRDocumentTypeCodes

#### Constraints

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

This structure is derived from CDAR2.ExternalDocument

Summary

Mandatory: 7 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

- The element ExternalDocument.templateId is sliced based on the values of value:root, value:extension

Other representations of profile: CSV, Excel