Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Draft as of 2023-09-29 |
Definitions for the ExternalDocumentReference logical model.
Guidance on how to interpret the contents of this table can be found here
0. ExternalDocument | |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. 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). |
Fixed Value | DOCCLIN |
4. 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..? |
6. ExternalDocument.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on ExternalDocument.templateId . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
8. ExternalDocument.templateId:primary | |
Slice Name | primary |
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it |
Control | 1..1 |
10. ExternalDocument.templateId:primary.root | |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750). |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.10.20.22.4.115 |
12. ExternalDocument.templateId:primary.extension | |
Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749). |
Control | 1..? |
Pattern Value | 2014-06-09 |
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 | Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 10..1* |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. 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 |
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 |
4. 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 ActMood |
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 |
6. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
8. ExternalDocument.templateId:primary | |
Slice Name | primary |
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 |
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
10. ExternalDocument.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750). |
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 |
12. ExternalDocument.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749). |
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 |
14. 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 |
16. ExternalDocument.code | |
Comments | SHALL contain exactly one [1..1] code (CONF:1098-31933). |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
18. 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 |
20. 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 |
Guidance on how to interpret the contents of this table can be found here
0. ExternalDocument | |
Definition | Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 1..1 |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. 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 |
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 |
4. 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 ActMood |
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 |
6. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
8. ExternalDocument.templateId:primary | |
Slice Name | primary |
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 |
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
10. ExternalDocument.templateId:primary.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 NullFlavor |
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 |
12. ExternalDocument.templateId:primary.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 |
14. ExternalDocument.templateId:primary.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 |
16. ExternalDocument.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750). |
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 |
18. ExternalDocument.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749). |
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 |
20. 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 |
22. ExternalDocument.code | |
Comments | SHALL contain exactly one [1..1] code (CONF:1098-31933). |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from FHIRDocumentTypeCodes |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
24. ExternalDocument.text | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
26. 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 |
28. 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 |