Instruction - Definitions - Consolidated CDA Release 2.1 StructureDefinition Publication v2.1

Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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

Logical Model: Instruction - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the Instruction logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. Act
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Act.classCode
Comments	SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7391).
Fixed Value	ACT
4. Act.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7392).
Fixed Value	INT
6. Act.templateId
Control	1..?
Slicing	This element introduces a set of slices on `Act.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ extension value @ root
8. Act.templateId:primary
Slice Name	primary
Comments	SHALL contain exactly one [1..1] templateId (CONF:1098-7393) such that it
Control	1..1
10. Act.templateId:primary.root
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.20" (CONF:1098-10503).
Control	1..?
Pattern Value	2.16.840.1.113883.10.20.22.4.20
12. Act.templateId:primary.extension
Comments	SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32598).
Control	1..?
Pattern Value	2014-06-09
14. Act.code
Comments	SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Patient Education urn:oid:2.16.840.1.113883.11.20.9.34 DYNAMIC (CONF:1098-16884).
Binding	The codes SHOULD be taken from Patient Education
16. Act.statusCode
Comments	SHALL contain exactly one [1..1] statusCode (CONF:1098-7396).
Control	1..?
18. Act.statusCode.code
Comments	This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19106).
Control	1..?
Fixed Value	completed

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

0. Act
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. Act.classCode
Definition	Element Act.classCode
Comments	SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7391).
Control	1..1
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	ACT
4. Act.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7392).
Control	1..1
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	INT
6. Act.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 `Act.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ extension value @ root
8. Act.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-7393) such that it
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
10. Act.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.20" (CONF:1098-10503).
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.20
12. Act.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-32598).
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. Act.code
Comments	SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Patient Education urn:oid:2.16.840.1.113883.11.20.9.34 DYNAMIC (CONF:1098-16884).
Control	1..1
Binding	The codes SHOULD be taken from Patient Education
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
16. Act.statusCode
Comments	SHALL contain exactly one [1..1] statusCode (CONF:1098-7396).
Control	1..1
Binding	The codes SHALL be taken from ActStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
18. Act.statusCode.code
Definition	The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments	This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19106).
Control	1..1
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	Code
Fixed Value	completed
20. Act.statusCode.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..0
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	Code System
22. Act.statusCode.codeSystemName
Definition	The common name of the coding system.
Control	0..0
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	Code System Name
24. Act.statusCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..0
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	Code System Version
26. Act.statusCode.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..0
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	Display Name
28. Act.statusCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
30. Act.statusCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
32. Act.statusCode.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Translation

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

0. Act
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. Act.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
4. Act.classCode
Definition	Element Act.classCode
Comments	SHALL contain exactly one [1..1] @classCode="ACT" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7391).
Control	1..1
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	ACT
6. Act.moodCode
Comments	SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7392).
Control	1..1
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	INT
8. Act.realmCode
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. Act.typeId
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. Act.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 `Act.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ extension value @ root
14. Act.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-7393) such that it
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. Act.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
18. Act.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
20. Act.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
22. Act.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.20" (CONF:1098-10503).
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.20
24. Act.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-32598).
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
26. Act.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
28. Act.code
Comments	SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Patient Education urn:oid:2.16.840.1.113883.11.20.9.34 DYNAMIC (CONF:1098-16884).
Control	1..1
Binding	The codes SHOULD be taken from Patient Education
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
30. Act.negationInd
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.
32. Act.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
34. Act.statusCode
Comments	SHALL contain exactly one [1..1] statusCode (CONF:1098-7396).
Control	1..1
Binding	The codes SHALL be taken from ActStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
36. Act.statusCode.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
38. Act.statusCode.code
Definition	The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments	This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1098-19106).
Control	1..1
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	Code
Fixed Value	completed
40. Act.statusCode.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..0
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	Code System
42. Act.statusCode.codeSystemName
Definition	The common name of the coding system.
Control	0..0
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	Code System Name
44. Act.statusCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..0
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	Code System Version
46. Act.statusCode.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..0
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	Display Name
48. Act.statusCode.sdtcValueSet
Definition	The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control	0..1
Type	string(oid: ISO Object Identifier)
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.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
50. Act.statusCode.sdtcValueSetVersion
Definition	The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
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.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
52. Act.statusCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
54. Act.statusCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
56. Act.statusCode.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Translation
58. Act.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
60. Act.priorityCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from ActPriority
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
62. Act.languageCode
Control	0..1
Binding	The codes SHALL be taken from HumanLanguage
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
64. Act.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
66. Act.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
68. Act.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
70. Act.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
72. Act.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
74. Act.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
76. Act.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
78. Act.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
80. Act.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition

IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents | QA Report | Version History external | | Propose a change