Hospital Consultations 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: HospitalConsultationsSection - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the HospitalConsultationsSection 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
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
4. Section.templateId:primary
Slice Name	primary
Comments	SHALL contain exactly one [1..1] templateId (CONF:81-9915) such that it, SHALL not contain [0..0] extension.
Control	1..1
6. Section.templateId:primary.root
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.2.42" (CONF:81-10393).
Control	1..?
Pattern Value	2.16.840.1.113883.10.20.22.2.42
8. Section.templateId:primary.extension
Control	0..0
10. Section.code
Comments	SHALL contain exactly one [1..1] code (CONF:81-15485).
Control	1..?
12. Section.code.code
Comments	This code SHALL contain exactly one [1..1] @code="18841-7" Hospital Consultations Section (CONF:81-15486).
Control	1..?
Pattern Value	18841-7
14. Section.code.codeSystem
Comments	This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-26479).
Control	1..?
Pattern Value	2.16.840.1.113883.6.1
16. Section.title
Comments	SHALL contain exactly one [1..1] title (CONF:81-9917).
Control	1..?
18. Section.text
Comments	SHALL contain exactly one [1..1] text (CONF:81-9918).
Control	1..?

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
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
4. Section.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:81-9915) such that it, SHALL not contain [0..0] extension.
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
6. Section.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.2.42" (CONF:81-10393).
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.42
8. Section.templateId:primary.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
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	Extension
10. Section.code
Comments	SHALL contain exactly one [1..1] code (CONF:81-15485).
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from DocumentSectionType
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
12. Section.code.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 code SHALL contain exactly one [1..1] @code="18841-7" Hospital Consultations Section (CONF:81-15486).
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
Pattern Value	18841-7
14. Section.code.codeSystem
Definition	Specifies the code system that defines the code.
Comments	This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-26479).
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	Code System
Pattern Value	2.16.840.1.113883.6.1
16. Section.code.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
18. Section.title
Comments	SHALL contain exactly one [1..1] title (CONF:81-9917).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ST
20. Section.text
Comments	SHALL contain exactly one [1..1] text (CONF:81-9918).
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.

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
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
12. Section.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:81-9915) such that it, SHALL not contain [0..0] extension.
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
14. Section.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
16. Section.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
18. Section.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
20. Section.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.2.42" (CONF:81-10393).
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.42
22. Section.templateId:primary.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
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	Extension
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 (CONF:81-15485).
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from DocumentSectionType
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
28. Section.code.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
30. Section.code.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 code SHALL contain exactly one [1..1] @code="18841-7" Hospital Consultations Section (CONF:81-15486).
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
Pattern Value	18841-7
32. Section.code.codeSystem
Definition	Specifies the code system that defines the code.
Comments	This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:81-26479).
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	Code System
Pattern Value	2.16.840.1.113883.6.1
34. Section.code.codeSystemName
Definition	The common name of the coding system.
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	Code System Name
36. Section.code.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
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	Code System Version
38. Section.code.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
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	Display Name
40. Section.code.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`.
42. Section.code.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`.
44. Section.code.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
46. Section.code.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
48. Section.code.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	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
50. Section.title
Comments	SHALL contain exactly one [1..1] title (CONF:81-9917).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ST
52. Section.text
Comments	SHALL contain exactly one [1..1] text (CONF:81-9918).
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.
54. Section.confidentialityCode
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
56. Section.languageCode
Control	0..1
Binding	The codes SHALL be taken from HumanLanguage
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
58. Section.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
60. Section.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
62. Section.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
64. Section.entry
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Entry
66. 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())`)
68. 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
70. 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
72. 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
74. 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
76. 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
78. 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
80. Section.component.section
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Section