External Document Reference - Definitions - Consolidated CDA (C-CDA) v4.0.0-ballot

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: ExternalDocumentReference - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the ExternalDocumentReference logical model.

Guidance on how to interpret the contents of this table can be found here

0. ExternalDocument
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	should-setId: SHOULD contain setId (`setId.exists()`) should-versionNumber: SHOULD contain versionNumber (`versionNumber.exists()`)
2. ExternalDocument.templateId
Control	1..?
Slicing	This element introduces a set of slices on `ExternalDocument.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
4. ExternalDocument.templateId:external-doc-ref
Slice Name	external-doc-ref
Control	1..1
6. ExternalDocument.templateId:external-doc-ref.root
Control	1..?
Pattern Value	`2.16.840.1.113883.10.20.22.4.115`
8. ExternalDocument.templateId:external-doc-ref.extension
Control	1..?
Pattern Value	`2014-06-09`
10. ExternalDocument.classCode
Comments	SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).
Control	1..?
Fixed Value	`DOCCLIN`
12. ExternalDocument.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).
Control	1..?
14. ExternalDocument.id
Comments	SHALL contain exactly one [1..1] id (CONF:1098-32751).
Control	1..1
16. ExternalDocument.code
Comments	SHALL contain exactly one [1..1] code (CONF:1098-31933).
Control	1..?
18. ExternalDocument.setId
Comments	SHOULD contain zero or one [0..1] setId (CONF:1098-32752).
20. ExternalDocument.versionNumber
Comments	SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).

Guidance on how to interpret the contents of this table can be found here

0. ExternalDocument
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	should-setId: SHOULD contain setId (`setId.exists()`) should-versionNumber: SHOULD contain versionNumber (`versionNumber.exists()`)
2. ExternalDocument.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. ExternalDocument.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. ExternalDocument.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. ExternalDocument.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
10. ExternalDocument.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
12. ExternalDocument.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
14. ExternalDocument.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. ExternalDocument.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
18. ExternalDocument.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `ExternalDocument.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. ExternalDocument.templateId:external-doc-ref
Slice Name	external-doc-ref
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
22. ExternalDocument.templateId:external-doc-ref.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
24. ExternalDocument.templateId:external-doc-ref.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
26. ExternalDocument.templateId:external-doc-ref.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
28. ExternalDocument.templateId:external-doc-ref.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	`2.16.840.1.113883.10.20.22.4.115`
30. ExternalDocument.templateId:external-doc-ref.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	`2014-06-09`
32. ExternalDocument.classCode
Comments	SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).
Control	1..1
Binding	The codes SHALL be taken from ActClassDocument (required to `http://terminology.hl7.org/ValueSet/v3-ActClassDocument`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`DOC`
Fixed Value	`DOCCLIN`
34. ExternalDocument.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).
Control	1..1
Binding	The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`EVN`
36. ExternalDocument.id
Comments	SHALL contain exactly one [1..1] id (CONF:1098-32751).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
38. ExternalDocument.code
Comments	SHALL contain exactly one [1..1] code (CONF:1098-31933).
Control	1..1
Binding	For example codes, see FHIRDocumentTypeCodes (example to `http://hl7.org/fhir/ValueSet/doc-typecodes`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
40. ExternalDocument.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
42. ExternalDocument.setId
Comments	SHOULD contain zero or one [0..1] setId (CONF:1098-32752).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
44. ExternalDocument.versionNumber
Comments	SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
46. ExternalDocument.sdtcAuthor
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`author`.

Guidance on how to interpret the contents of this table can be found here

0. ExternalDocument
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	should-setId: SHOULD contain setId (`setId.exists()`) should-versionNumber: SHOULD contain versionNumber (`versionNumber.exists()`)
2. ExternalDocument.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. ExternalDocument.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. ExternalDocument.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. ExternalDocument.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
10. ExternalDocument.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
12. ExternalDocument.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
14. ExternalDocument.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. ExternalDocument.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
18. ExternalDocument.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `ExternalDocument.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. ExternalDocument.templateId:external-doc-ref
Slice Name	external-doc-ref
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
22. ExternalDocument.templateId:external-doc-ref.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
24. ExternalDocument.templateId:external-doc-ref.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
26. ExternalDocument.templateId:external-doc-ref.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
28. ExternalDocument.templateId:external-doc-ref.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	`2.16.840.1.113883.10.20.22.4.115`
30. ExternalDocument.templateId:external-doc-ref.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	`2014-06-09`
32. ExternalDocument.classCode
Comments	SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).
Control	1..1
Binding	The codes SHALL be taken from ActClassDocument (required to `http://terminology.hl7.org/ValueSet/v3-ActClassDocument`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	`DOC`
Fixed Value	`DOCCLIN`
34. ExternalDocument.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).
Control	1..1
Binding	The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`EVN`
36. ExternalDocument.id
Comments	SHALL contain exactly one [1..1] id (CONF:1098-32751).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
38. ExternalDocument.code
Comments	SHALL contain exactly one [1..1] code (CONF:1098-31933).
Control	1..1
Binding	For example codes, see FHIRDocumentTypeCodes (example to `http://hl7.org/fhir/ValueSet/doc-typecodes`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
40. ExternalDocument.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
42. ExternalDocument.setId
Comments	SHOULD contain zero or one [0..1] setId (CONF:1098-32752).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
44. ExternalDocument.versionNumber
Comments	SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
46. ExternalDocument.sdtcAuthor
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`author`.