Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: ExternalDocumentReference - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.115 resource profile.

1. ExternalDocument
Control1..1
2. ExternalDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassDocument
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="DOCCLIN" Clinical Document (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31931).

Default ValueDOC
Pattern ValueDOCCLIN
3. ExternalDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31932).

Default ValueEVN
Fixed ValueEVN
Pattern ValueEVN
4. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ExternalDocument.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
5. ExternalDocument.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-32748) such that it

6. 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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
7. 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.

Control0..1
Typestring
8. 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).

Control0..1
Typeboolean
9. 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.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.115" (CONF:1098-32750).

Pattern Value2.16.840.1.113883.10.20.22.4.115
10. ExternalDocument.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32749).

Pattern Value2014-06-09
11. ExternalDocument.id
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] id (CONF:1098-32751).

12. ExternalDocument.code
Control1..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-DocumentType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-31933).

13. ExternalDocument.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
14. ExternalDocument.setId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHOULD contain zero or one [0..1] setId (CONF:1098-32752).

15. ExternalDocument.versionNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Requirements

SHOULD contain zero or one [0..1] versionNumber (CONF:1098-32753).