Notes Section - Definitions - Consolidated CDA Release 2.1 StructureDefinition Publication v2.1

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: NotesSection - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the NotesSection 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. Section
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Section.templateId
Comments	SHALL contain exactly one [1..1] templateId (CONF:3250-16935) such that it
Control	1..?
Slicing	This element introduces a set of slices on `Section.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
4. Section.templateId:templateId1
Slice Name	templateId1
Short	templateId
Control	1..1
6. Section.templateId:templateId1.root
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.2.65" (CONF:3250-16936).
Control	1..?
Pattern Value	2.16.840.1.113883.10.20.22.2.65
8. Section.templateId:templateId1.extension
Comments	SHALL contain exactly one [1..1] @extension="2016-11-01" (CONF:3250-16938).
Control	1..?
Pattern Value	2016-11-01
10. Section.code
Comments	SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Note Types urn:oid:2.16.840.1.113883.11.20.9.68 DYNAMIC (CONF:3250-16892).
Control	1..?
Binding	The codes SHOULD be taken from Note Types
12. Section.title
Comments	SHALL contain exactly one [1..1] title (CONF:3250-16891).
Control	1..?
14. Section.text
Comments	SHALL contain exactly one [1..1] text (CONF:3250-16894).
Control	1..?
16. Section.entry
Comments	SHALL contain at least one [1..*] entry (CONF:3250-16904) such that it
Control	1..?
Slicing	This element introduces a set of slices on `Section.entry`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ act
18. Section.entry:entry1
Slice Name	entry1
Short	entry
Control	1..*
20. Section.entry:entry1.act
Comments	SHALL contain exactly one [1..1] Note Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.202:2016-11-01) (CONF:3250-16905).
Control	1..?
Type	http://hl7.org/cda/stds/core/StructureDefinition/Act(Note Activity)

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

0. Section
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. Section.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
Comments	SHALL contain exactly one [1..1] templateId (CONF:3250-16935) such that it
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Section.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
4. Section.templateId:templateId1
Slice Name	templateId1
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
Short	templateId
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
6. Section.templateId:templateId1.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.2.65" (CONF:3250-16936).
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.2.65
8. Section.templateId:templateId1.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Comments	SHALL contain exactly one [1..1] @extension="2016-11-01" (CONF:3250-16938).
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	2016-11-01
10. Section.code
Comments	SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Note Types urn:oid:2.16.840.1.113883.11.20.9.68 DYNAMIC (CONF:3250-16892).
Control	1..1
Binding	The codes SHOULD be taken from Note Types
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
12. Section.title
Comments	SHALL contain exactly one [1..1] title (CONF:3250-16891).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ST
14. Section.text
Comments	SHALL contain exactly one [1..1] text (CONF:3250-16894).
Control	1..1
Type	xhtml
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
XML Format	This property is represented as CDA Text in the XML.
16. Section.entry
Comments	SHALL contain at least one [1..*] entry (CONF:3250-16904) such that it
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Entry
Slicing	This element introduces a set of slices on `Section.entry`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ act
18. Section.entry:entry1
Slice Name	entry1
Short	entry
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Entry
20. Section.entry:entry1.act
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Comments	SHALL contain exactly one [1..1] Note Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.202:2016-11-01) (CONF:3250-16905).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Act(Note Activity)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

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

0. Section
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. Section.ID
Control	0..1
Type	id(xs:ID)
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.
4. Section.nullFlavor
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.
6. Section.classCode
Control	0..1
Binding	The codes SHALL be taken from ActClassRecordOrganizer
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	DOCSECT
8. Section.moodCode
Control	0..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
10. Section.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
Comments	SHALL contain exactly one [1..1] templateId (CONF:3250-16935) such that it
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Section.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
12. Section.templateId:templateId1
Slice Name	templateId1
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
Short	templateId
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
14. Section.templateId:templateId1.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
16. Section.templateId:templateId1.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
18. Section.templateId:templateId1.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
20. Section.templateId:templateId1.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.2.65" (CONF:3250-16936).
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.2.65
22. Section.templateId:templateId1.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Comments	SHALL contain exactly one [1..1] @extension="2016-11-01" (CONF:3250-16938).
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	2016-11-01
24. Section.id
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
26. Section.code
Comments	SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Note Types urn:oid:2.16.840.1.113883.11.20.9.68 DYNAMIC (CONF:3250-16892).
Control	1..1
Binding	The codes SHOULD be taken from Note Types
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
28. Section.title
Comments	SHALL contain exactly one [1..1] title (CONF:3250-16891).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ST
30. Section.text
Comments	SHALL contain exactly one [1..1] text (CONF:3250-16894).
Control	1..1
Type	xhtml
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
XML Format	This property is represented as CDA Text in the XML.
32. Section.confidentialityCode
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
34. Section.languageCode
Control	0..1
Binding	The codes SHALL be taken from HumanLanguage
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
36. Section.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
38. Section.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
40. Section.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
42. Section.entry
Comments	SHALL contain at least one [1..*] entry (CONF:3250-16904) such that it
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Entry
Slicing	This element introduces a set of slices on `Section.entry`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ act
44. Section.entry:entry1
Slice Name	entry1
Short	entry
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Entry
46. Section.entry:entry1.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
48. Section.entry:entry1.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
50. Section.entry:entry1.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
52. Section.entry:entry1.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	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
54. Section.entry:entry1.typeCode
Control	0..1
Binding	The codes SHALL be taken from x_ActRelationshipEntry
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	COMP
56. Section.entry:entry1.contextConductionInd
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.
Fixed Value	true
58. Section.entry:entry1.act
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Comments	SHALL contain exactly one [1..1] Note Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.202:2016-11-01) (CONF:3250-16905).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Act(Note Activity)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Section.entry:entry1.encounter
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Encounter
62. Section.entry:entry1.observation
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Observation
64. Section.entry:entry1.observationMedia
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
66. Section.entry:entry1.organizer
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organizer
68. Section.entry:entry1.procedure
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Procedure
70. Section.entry:entry1.regionOfInterest
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
72. Section.entry:entry1.substanceAdministration
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
74. Section.entry:entry1.supply
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Supply
76. Section.component
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Section.component.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
80. Section.component.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
82. Section.component.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
84. Section.component.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	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
86. Section.component.typeCode
Definition	Drawn from concept domain DocumentSectionType
Control	0..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	COMP
88. Section.component.contextConductionInd
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.
Fixed Value	true
90. Section.component.section
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Section