Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: External Document Reference

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.115 Version: 2.2
Active as of 2022-05-13 Computable Name: ExternalDocumentReference
Other Identifiers: : 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

Summary

Mandatory: 7 elements

Slices

This structure defines the following Slices:

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

This structure is derived from CDAR2.ExternalDocument

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocument
... classCode 1..1codeRequired Pattern: DOCCLIN
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CD
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocument
... classCode 1..1codeBinding: ActClassDocument (required)
Required Pattern: DOCCLIN
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CD​Binding: http://terminology.hl7.org/ValueSet/v3-DocumentType (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

This structure is derived from CDAR2.ExternalDocument

Summary

Mandatory: 7 elements

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 1..1CDAR2.ExternalDocument
... classCode 1..1codeRequired Pattern: DOCCLIN
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CD
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocument
... classCode 1..1codeBinding: ActClassDocument (required)
Required Pattern: DOCCLIN
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CD​Binding: http://terminology.hl7.org/ValueSet/v3-DocumentType (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredPattern: DOCCLIN
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.templateId:primary.nullFlavorrequiredNullFlavor
ExternalDocument.codeextensible​http://terminology.hl7.org/ValueSet/v3-DocumentType