Clinical Document Architecture with Australian Schema - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: ExternalDocument (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument Version: 1.0.1
Active as of 2025-10-10 Maturity Level: 1 Responsible: HL7 Computable Name: 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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ExternalDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: ActClassDocument (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ExternalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.classCode Base required ActClassDocument 📦2.0.0 THO v5.2
ExternalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ExternalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ExternalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ExternalDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: ActClassDocument (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ExternalDocument.classCode Base required ActClassDocument 📦2.0.0 THO v5.2
ExternalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ExternalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ExternalDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: ActClassDocument (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ExternalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.classCode Base required ActClassDocument 📦2.0.0 THO v5.2
ExternalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ExternalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ExternalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ExternalDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: ActClassDocument (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ExternalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.classCode Base required ActClassDocument 📦2.0.0 THO v5.2
ExternalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ExternalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ExternalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ExternalDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: ActClassDocument (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ExternalDocument.classCode Base required ActClassDocument 📦2.0.0 THO v5.2
ExternalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ExternalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ExternalDocument 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: ActClassDocument (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CD Binding: FHIRDocumentTypeCodes (example)
... text 0..1 ED
... setId 0..1 II
... versionNumber 0..1 INT

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ExternalDocument.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
ExternalDocument.classCode Base required ActClassDocument 📦2.0.0 THO v5.2
ExternalDocument.moodCode Base required CDAActMood 📦1.0.1 This IG
ExternalDocument.code Base example FHIR Document Type Codes 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
II-1 error ExternalDocument.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel