Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: External Document Reference

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.115 Version: 2.1.0-draft1
Active as of 2023-01-16 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 1..1CDAR2.ExternalDocumentBase for all types and resources
... 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.ExternalDocumentBase for all types and resources
... 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
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stringRequired 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.classCoderequiredPattern: 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.ExternalDocumentBase for all types and resources
... 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..1CDBinding: FHIRDocumentTypeCodes (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

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

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.ExternalDocumentBase for all types and resources
... 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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1CDAR2.ExternalDocumentBase for all types and resources
... 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
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.115
..... extension 1..1stringRequired 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.classCoderequiredPattern: 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.ExternalDocumentBase for all types and resources
... 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..1CDBinding: FHIRDocumentTypeCodes (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

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

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

 

​Other representations of profile: CSV, Excel, Schematron