Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft

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

Logical Model: ExternalDocument (CDA Class)

Official URL: http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: CDAR2.ExternalDocument

ExternalDocument is a derivative of the RIM Document class, used for representing external documents. ExternalDocument.text is modeled as an ED data type - allowing for the expression of the MIME type of the external document.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1codeBinding: ActClassDocument (required)
... @moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CDBinding: FHIRDocumentTypeCodes (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredActClassDocument
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.codeextensibleFHIRDocumentTypeCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1BaseBase for all types and resources
... classCode 1..1codeBinding: ActClassDocument (required)
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredActClassDocument
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..1BaseBase for all types and resources
... classCode 1..1codeBinding: ActClassDocument (required)
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredActClassDocument
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

This structure is derived from Base

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 1 element

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1codeBinding: ActClassDocument (required)
... @moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... code 0..1CDBinding: FHIRDocumentTypeCodes (extensible)
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredActClassDocument
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExternalDocument 1..1BaseBase for all types and resources
... classCode 1..1codeBinding: ActClassDocument (required)
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredActClassDocument
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..1BaseBase for all types and resources
... classCode 1..1codeBinding: ActClassDocument (required)
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... templateId 0..*II
... text 0..1ED
... setId 0..1II
... versionNumber 0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ExternalDocument.classCoderequiredActClassDocument
ExternalDocument.moodCoderequiredFixed Value: EVN
ExternalDocument.codeextensibleFHIRDocumentTypeCodes

This structure is derived from Base

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 1 element

 

Other representations of profile: CSV, Excel