Catalog Number Observation - 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: CatalogNumberObservation - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the CatalogNumberObservation 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. Observation
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Observation.templateId
Comments	SHALL contain exactly one [1..1] templateId (CONF:4437-3432).
Control	1..1
4. Observation.templateId.root
Short	template oid
Comments	This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.302" (CONF:4437-3434).
Control	1..?
Pattern Value	2.16.840.1.113883.10.20.22.4.302
6. Observation.templateId.extension
Comments	This templateId SHALL contain exactly one [1..1] @extension="2019-06-21" (CONF:4437-3435).
Control	1..?
Pattern Value	2019-06-21
8. Observation.code
Short	Code for "Device Catalog Number"
Comments	SHALL contain exactly one [1..1] code (CONF:4437-3433).
10. Observation.code.code
Comments	This code SHALL contain exactly one [1..1] @code="C99286" Catalog Number (CodeSystem: NCI Thesaurus (NCIt) urn:oid:2.16.840.1.113883.3.26.1.1 STATIC) (CONF:4437-3436).
Control	1..?
Pattern Value	C99286
12. Observation.code.codeSystem
Comments	This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.3.26.1.1" (CONF:4437-3437).
Control	1..?
Pattern Value	2.16.840.1.113883.3.26.1.1
14. Observation.code.codeSystemName
Comments	This code MAY contain zero or one [0..1] @codeSystemName="NCI Thesaurus" (CONF:4437-3438).
Pattern Value	NCI Thesaurus
16. Observation.code.displayName
Comments	This code MAY contain zero or one [0..1] @displayName="Catalog Number" (CONF:4437-3439).
Pattern Value	Catalog Number
18. Observation.value
Comments	SHALL contain exactly one [1..1] value with @xsi:type="ED" (CONF:4437-3440).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/SC

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

0. Observation
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. Observation.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassObservation
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.
4. Observation.moodCode
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.
6. Observation.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:4437-3432).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
8. Observation.templateId.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Short	template oid
Comments	This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.302" (CONF:4437-3434).
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.302
10. Observation.templateId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Comments	This templateId SHALL contain exactly one [1..1] @extension="2019-06-21" (CONF:4437-3435).
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	2019-06-21
12. Observation.code
Definition	Describes what was observed. Sometimes this is called the observation "name".
Short	Code for "Device Catalog Number"Type of observation (code / type)
Comments	SHALL contain exactly one [1..1] code (CONF:4437-3433). All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.
Control	1..1 This element is affected by the following invariants: obs-7
Binding	Unless not suitable, these codes SHALL be taken from For example codes, see ObservationTypehttp://hl7.org/fhir/ValueSet/observation-codes
Type	http://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
Is Modifier	false
XML Format	The type of this property is determined using the `xsi:type`attribute.
Requirements	Knowing what kind of observation is being made is essential to understanding the observation.
Alternate Names	Name
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Observation.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="C99286" Catalog Number (CodeSystem: NCI Thesaurus (NCIt) urn:oid:2.16.840.1.113883.3.26.1.1 STATIC) (CONF:4437-3436).
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	C99286
16. Observation.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.3.26.1.1" (CONF:4437-3437).
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.3.26.1.1
18. Observation.code.codeSystemName
Definition	The common name of the coding system.
Comments	This code MAY contain zero or one [0..1] @codeSystemName="NCI Thesaurus" (CONF:4437-3438).
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
Pattern Value	NCI Thesaurus
20. Observation.code.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Comments	This code MAY contain zero or one [0..1] @displayName="Catalog Number" (CONF:4437-3439).
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
Pattern Value	Catalog Number
22. Observation.value
Comments	SHALL contain exactly one [1..1] value with @xsi:type="ED" (CONF:4437-3440).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format	The type of this property is determined using the `xsi:type`attribute.

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

0. Observation
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. Observation.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassObservation
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.
4. Observation.moodCode
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.
6. Observation.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.
8. Observation.realmCode
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. Observation.typeId
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. Observation.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:4437-3432).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
14. Observation.templateId.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. Observation.templateId.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. Observation.templateId.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. Observation.templateId.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Short	template oid
Comments	This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.302" (CONF:4437-3434).
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.302
22. Observation.templateId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Comments	This templateId SHALL contain exactly one [1..1] @extension="2019-06-21" (CONF:4437-3435).
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	2019-06-21
24. Observation.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
26. Observation.code
Short	Code for "Device Catalog Number"
Comments	SHALL contain exactly one [1..1] code (CONF:4437-3433).
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from ObservationType
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
28. Observation.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. Observation.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="C99286" Catalog Number (CodeSystem: NCI Thesaurus (NCIt) urn:oid:2.16.840.1.113883.3.26.1.1 STATIC) (CONF:4437-3436).
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	C99286
32. Observation.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.3.26.1.1" (CONF:4437-3437).
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.3.26.1.1
34. Observation.code.codeSystemName
Definition	The common name of the coding system.
Comments	This code MAY contain zero or one [0..1] @codeSystemName="NCI Thesaurus" (CONF:4437-3438).
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
Pattern Value	NCI Thesaurus
36. Observation.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. Observation.code.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Comments	This code MAY contain zero or one [0..1] @displayName="Catalog Number" (CONF:4437-3439).
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
Pattern Value	Catalog Number
40. Observation.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. Observation.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. Observation.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. Observation.code.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
48. Observation.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. Observation.derivationExpr
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ST
52. Observation.text
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format	The type of this property is determined using the `xsi:type`attribute.
54. Observation.statusCode
Control	0..1
Binding	The codes SHALL be taken from ActStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
56. Observation.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
58. Observation.priorityCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from ActPriority
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
60. Observation.repeatNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
62. Observation.languageCode
Control	0..1
Binding	The codes SHALL be taken from HumanLanguage
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
64. Observation.value
Comments	SHALL contain exactly one [1..1] value with @xsi:type="ED" (CONF:4437-3440).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format	The type of this property is determined using the `xsi:type`attribute.
66. Observation.interpretationCode
Control	0..*
Binding	The codes SHALL be taken from ObservationInterpretation
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
68. Observation.methodCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from ObservationMethod
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
70. Observation.targetSiteCode
Definition	Drawn from concept domain ActSite
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
72. Observation.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
74. Observation.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
76. Observation.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
78. Observation.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
80. Observation.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
82. Observation.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
84. Observation.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
86. Observation.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
88. Observation.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition
90. Observation.referenceRange
Definition	Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.
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())`)
92. Observation.referenceRange.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
94. Observation.referenceRange.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
96. Observation.referenceRange.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
98. Observation.referenceRange.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
100. Observation.referenceRange.typeCode
Control	0..1
Binding	The codes SHALL be taken from ActRelationshipPertains
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	REFV
102. Observation.referenceRange.observationRange
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange