Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: TextObservation - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.6.2.12 resource profile.

1. Observation
Control1..1
2. Observation.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4 STATIC) (CONF:81-9288).

Pattern ValueOBS
3. Observation.moodCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:81-9289).

Pattern ValueEVN
4. Observation.negationInd
Control0..1
Typeboolean
5. Observation.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
6. Observation.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
8. Observation.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:81-9290) such that it

9. Observation.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
10. Observation.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.

Control0..1
Typestring
11. Observation.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).

Control0..1
Typeboolean
12. Observation.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.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.12" (CONF:81-10534).

Pattern Value2.16.840.1.113883.10.20.6.2.12
13. Observation.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control0..1
Typestring
14. Observation.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
15. Observation.code
Control1..1
BindingThe codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:81-9291).

16. Observation.derivationExpr
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
17. Observation.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

MAY contain zero or one [0..1] text (CONF:81-9295).

18. Observation.text.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
19. Observation.text.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
20. Observation.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
21. Observation.text.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary
22. Observation.text.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
23. Observation.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode
24. Observation.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode
25. Observation.text.representation
Control0..1
Typecode
26. Observation.text.data[x]
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
27. Observation.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

The text, if present, SHOULD contain zero or one [0..1] reference (CONF:81-15938).

28. Observation.text.reference.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
29. Observation.text.reference.value
Control0..1
Typeuri
Requirements

The reference, if present, SHOULD contain zero or one [0..1] @value (CONF:81-15939).

InvariantsDefined on this element
81-15940: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15940). (: )
30. Observation.text.reference.useablePeriod
Definition

Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.

Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
31. Observation.text.reference.use
Definition

One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.

Control0..*
BindingThe codes SHALL be taken from AddressUse
Typecode
32. Observation.text.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
33. Observation.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
34. Observation.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:81-9294).

35. Observation.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
36. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
37. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
38. Observation.value
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="ED" (CONF:81-9292).

39. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
40. Observation.methodCode
Control0..*
BindingThe codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
41. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
42. Observation.subject
Control0..1
TypeElement
43. Observation.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
44. Observation.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
45. Observation.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
46. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
47. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
48. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
49. Observation.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
50. Observation.informant
Control0..*
TypeElement
51. Observation.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
52. Observation.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
53. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
54. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
55. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
56. Observation.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
57. Observation.entryRelationship.typeCode
Control1..1
Typecode
58. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
59. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
60. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
61. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
62. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
63. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
64. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
65. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
66. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
67. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
68. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
69. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
70. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
71. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
72. Observation.entryRelationship:SOPInstanceObservation
SliceNameSOPInstanceObservation
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:81-9298) such that it

InvariantsDefined on this element
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
73. Observation.entryRelationship:SOPInstanceObservation.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="SPRT" Has Support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-9299).

Pattern ValueSPRT
74. Observation.entryRelationship:SOPInstanceObservation.inversionInd
Control0..1
Typeboolean
75. Observation.entryRelationship:SOPInstanceObservation.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
76. Observation.entryRelationship:SOPInstanceObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
77. Observation.entryRelationship:SOPInstanceObservation.negationInd
Control0..1
Typeboolean
78. Observation.entryRelationship:SOPInstanceObservation.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
79. Observation.entryRelationship:SOPInstanceObservation.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(SOPInstanceObservation)
Requirements

SHALL contain exactly one [1..1] SOP Instance Observation (identifier: urn:oid:2.16.840.1.113883.10.20.6.2.8) (CONF:81-15941).

80. Observation.entryRelationship:SOPInstanceObservation.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
81. Observation.entryRelationship:SOPInstanceObservation.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
82. Observation.entryRelationship:SOPInstanceObservation.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
83. Observation.entryRelationship:SOPInstanceObservation.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
84. Observation.entryRelationship:SOPInstanceObservation.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
85. Observation.entryRelationship:SOPInstanceObservation.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
86. Observation.entryRelationship:SOPInstanceObservation.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
87. Observation.entryRelationship:SOPInstanceObservation.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
88. Observation.entryRelationship:quantityMeasurementObservation
SliceNamequantityMeasurementObservation
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:81-9301) such that it

InvariantsDefined on this element
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
89. Observation.entryRelationship:quantityMeasurementObservation.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="SPRT" Has Support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-9302).

Pattern ValueSPRT
90. Observation.entryRelationship:quantityMeasurementObservation.inversionInd
Control0..1
Typeboolean
91. Observation.entryRelationship:quantityMeasurementObservation.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
92. Observation.entryRelationship:quantityMeasurementObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
93. Observation.entryRelationship:quantityMeasurementObservation.negationInd
Control0..1
Typeboolean
94. Observation.entryRelationship:quantityMeasurementObservation.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
95. Observation.entryRelationship:quantityMeasurementObservation.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(QuantityMeasurementObservation)
Requirements

SHALL contain exactly one [1..1] Quantity Measurement Observation (identifier: urn:oid:2.16.840.1.113883.10.20.6.2.14) (CONF:81-15942).

96. Observation.entryRelationship:quantityMeasurementObservation.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
97. Observation.entryRelationship:quantityMeasurementObservation.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
98. Observation.entryRelationship:quantityMeasurementObservation.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
99. Observation.entryRelationship:quantityMeasurementObservation.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
100. Observation.entryRelationship:quantityMeasurementObservation.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
101. Observation.entryRelationship:quantityMeasurementObservation.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
102. Observation.entryRelationship:quantityMeasurementObservation.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
103. Observation.entryRelationship:quantityMeasurementObservation.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
104. Observation.reference
Control0..*
TypeElement
105. Observation.reference.typeCode
Control1..1
Typecode
106. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
107. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
108. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
109. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
110. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
111. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
112. Observation.referenceRange
Control0..*
TypeElement
113. Observation.referenceRange.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode
Default ValueREFV
Fixed ValueREFV
114. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange