IPS Radiology Result Observation Component - Definitions - International Patient Summary (IPS) v1.1.0-ballot

International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions

Logical Model: IPSRadiologyResultObservationComponent - Detailed Descriptions

Draft as of 2024-08-04

Definitions for the 2.16.840.1.113883.10.22.17--20240804201847 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
Control	0..*
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Observation.templateId
Control	1..1
Must Support	true
4. Observation.templateId.root
Control	1..1
Type	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.
Fixed Value	`2.16.840.1.113883.10.12.303`
6. Observation.classCode
Control	1..1
Type	code
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	`OBS`
8. Observation.moodCode
Control	1..1
Binding	The codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.18943 (required to `urn:oid:2.16.840.1.113883.1.11.18943`) x_ActMoodDocumentObservation
Type	code
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.
10. Observation.id
Control	0..*
12. Observation.text
Control	0..1
14. Observation.statusCode
Control	0..1
Binding	The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus`) ActStatus
16. Observation.effectiveTime
Control	0..1

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

0. Observation
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Control	0..*
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. 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
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support	true
4. 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.
Control	1..1
Type	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	Root
Fixed Value	`2.16.840.1.113883.10.12.303`
6. Observation.classCode
Control	1..1
Binding	The codes SHALL be taken from CDAActClassObservation (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation`)
Type	code
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	`OBS`
8. Observation.moodCode
Control	1..1
Binding	The codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.18943 (required to `urn:oid:2.16.840.1.113883.1.11.18943`) x_ActMoodDocumentObservation
Type	code
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.
10. Observation.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short	Logical id of this artifact
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control	0..*1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IIstring
Is Modifier	false
12. Observation.code
Definition	Describes what was observed. Sometimes this is called the observation "name".
Short	Type of observation (code / type)
Comments	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
Binding	For example codes, see ObservationTypehttp://hl7.org/fhir/ValueSet/observation-codes (example to `http://terminology.hl7.org/ValueSet/v3-ObservationType`)
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.text
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short	Text summary of the resource, for human interpretation
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/EDNarrative
Is Modifier	false
XML Format	The type of this property is determined using the `xsi:type`attribute.
Alternate Names	narrative, html, xhtml, display
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Observation.statusCode
Control	0..1
Binding	The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus`) ActStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
18. Observation.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS

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

0. Observation
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Control	0..*
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Observation.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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. Observation.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
6. Observation.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
8. Observation.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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
10. Observation.typeId.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
12. Observation.typeId.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
14. Observation.typeId.root
Definition	Identifies the type as an HL7 Registered model
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
Fixed Value	`2.16.840.1.113883.1.3`
16. Observation.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
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
18. 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
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support	true
20. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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
22. 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
24. 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
26. 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.
Control	1..1
Type	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	Root
Fixed Value	`2.16.840.1.113883.10.12.303`
28. Observation.templateId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
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	Extension
30. Observation.classCode
Control	1..1
Binding	The codes SHALL be taken from CDAActClassObservation (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation`)
Type	code
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	`OBS`
32. Observation.moodCode
Control	1..1
Binding	The codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.18943 (required to `urn:oid:2.16.840.1.113883.1.11.18943`) x_ActMoodDocumentObservation
Type	code
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.
34. 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.
36. Observation.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
38. Observation.code
Control	1..1
Binding	For example codes, see ObservationType (example to `http://terminology.hl7.org/ValueSet/v3-ObservationType`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
40. Observation.derivationExpr
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ST
42. 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.
44. Observation.statusCode
Control	0..1
Binding	The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus`) ActStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
46. Observation.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
48. Observation.priorityCode
Control	0..1
Binding	For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
50. Observation.repeatNumber
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
52. Observation.languageCode
Control	0..1
Binding	The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
54. Observation.value
Control	0..*
Type	Choice of: http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/SC, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ
XML Format	The type of this property is determined using the `xsi:type`attribute.
56. Observation.interpretationCode
Control	0..*
Binding	The codes SHALL be taken from CDAObservationInterpretation (required to `http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
58. Observation.methodCode
Control	0..*
Binding	For example codes, see ObservationMethod (example to `http://terminology.hl7.org/ValueSet/v3-ObservationMethod`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
60. Observation.targetSiteCode
Definition	Drawn from concept domain ActSite
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
62. Observation.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
64. Observation.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
66. Observation.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
68. Observation.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
70. Observation.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
72. Observation.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
74. Observation.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
76. Observation.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
78. Observation.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition
80. Observation.sdtcPrecondition2
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`precondition2`.
82. 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
84. 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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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
86. 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
88. 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
90. Observation.referenceRange.typeId.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 CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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
92. Observation.referenceRange.typeId.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
94. Observation.referenceRange.typeId.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
96. Observation.referenceRange.typeId.root
Definition	Identifies the type as an HL7 Registered model
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
Fixed Value	`2.16.840.1.113883.1.3`
98. Observation.referenceRange.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
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
100. 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
102. Observation.referenceRange.typeCode
Control	0..1
Binding	The codes SHALL be taken from CDAActRelationshipType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType`)
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`
104. Observation.referenceRange.observationRange
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange
106. Observation.sdtcInFulfillmentOf1
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`inFulfillmentOf1`.