Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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:

Formal Views of Profile Content

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

This structure is derived from CDAR2.ExternalDocument

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument CDAR2.ExternalDocumentXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber
... classCode 1..1csFixed Value: DOCCLIN
... moodCode 1..1cs
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stRequired Pattern: 2014-06-09
... code 1..1CD
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocumentXML 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..1csBinding: ActClassDocument (required)
Fixed Value: DOCCLIN
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... @extension 1..1stRequired Pattern: 2014-06-09
... code 1..1CDBinding: FHIRDocumentTypeCodes (extensible)
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredFixed Value: DOCCLIN
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocumentXML 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..1csBinding: ActClassDocument (required)
Fixed Value: DOCCLIN
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... @extension 1..1stRequired Pattern: 2014-06-09
... code 1..1CDBinding: FHIRDocumentTypeCodes (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredFixed Value: DOCCLIN
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.templateId:primary.nullFlavorrequiredNullFlavor
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument CDAR2.ExternalDocumentXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, templateId, id, code, text, setId, versionNumber
... classCode 1..1csFixed Value: DOCCLIN
... moodCode 1..1cs
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stRequired Pattern: 2014-06-09
... code 1..1CD
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocumentXML 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..1csBinding: ActClassDocument (required)
Fixed Value: DOCCLIN
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... @extension 1..1stRequired Pattern: 2014-06-09
... code 1..1CDBinding: FHIRDocumentTypeCodes (extensible)
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredFixed Value: DOCCLIN
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocumentXML 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..1csBinding: ActClassDocument (required)
Fixed Value: DOCCLIN
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... @extension 1..1stRequired Pattern: 2014-06-09
... code 1..1CDBinding: FHIRDocumentTypeCodes (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredFixed Value: DOCCLIN
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.templateId:primary.nullFlavorrequiredNullFlavor
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll 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