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
Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.6.2.12 resource profile.
1. Observation | |
Control | 1..1 |
2. Observation.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActClassObservation |
Type | code |
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 Value | OBS |
3. Observation.moodCode | |
Control | 1..1 |
Type | code |
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 Value | EVN |
4. Observation.negationInd | |
Control | 0..1 |
Type | boolean |
5. Observation.realmCode | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
6. Observation.typeId | |
Control | 0..1 |
Type | http://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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Slicing | This element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
8. Observation.templateId:primary | |
SliceName | 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 |
Control | 1..1 |
Type | http://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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
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. |
Control | 0..1 |
Type | string |
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). |
Control | 0..1 |
Type | boolean |
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. |
Control | 1..1 |
Type | string |
Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.12" (CONF:81-10534). |
Pattern Value | 2.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. |
Control | 0..1 |
Type | string |
14. Observation.id | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
15. Observation.code | |
Control | 1..1 |
Binding | The codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
Requirements | SHALL contain exactly one [1..1] code (CONF:81-9291). |
16. Observation.derivationExpr | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
17. Observation.text | |
Control | 0..1 |
Type | http://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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
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 []. |
Control | 0..1 |
Type | code |
20. Observation.text.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..1 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
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. |
Control | 0..1 |
Type | base64Binary |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
23. Observation.text.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
24. Observation.text.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
25. Observation.text.representation | |
Control | 0..1 |
Type | code |
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.) |
Control | 0..1 |
Type | Choice of: string, base64Binary |
[x] Note | See 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. |
Control | 0..1 |
Type | http://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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
29. Observation.text.reference.value | |
Control | 0..1 |
Type | uri |
Requirements | The reference, if present, SHOULD contain zero or one [0..1] @value (CONF:81-15939). |
Invariants | Defined 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. |
Control | 0..* |
Type | Choice 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. |
Control | 0..* |
Binding | The codes SHALL be taken from AddressUse |
Type | code |
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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
33. Observation.statusCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
34. Observation.effectiveTime | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:81-9294). |
35. Observation.priorityCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
36. Observation.repeatNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
37. Observation.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from HumanLanguage |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
38. Observation.value | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
Requirements | SHALL contain exactly one [1..1] value with @xsi:type="ED" (CONF:81-9292). |
39. Observation.interpretationCode | |
Control | 0..* |
Binding | The codes SHALL be taken from ObservationInterpretation |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
40. Observation.methodCode | |
Control | 0..* |
Binding | The codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
41. Observation.targetSiteCode | |
Definition | Drawn from concept domain ActSite |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
42. Observation.subject | |
Control | 0..1 |
Type | Element |
43. Observation.subject.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationTargetSubject |
Type | code |
Default Value | SBJ |
Fixed Value | SBJ |
44. Observation.subject.contextControlCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Default Value | OP |
Fixed Value | OP |
45. Observation.subject.awarenessCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
46. Observation.subject.relatedSubject | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
47. Observation.specimen | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
48. Observation.performer | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
49. Observation.author | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
50. Observation.informant | |
Control | 0..* |
Type | Element |
51. Observation.informant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationInformationGenerator |
Type | code |
Default Value | INF |
Fixed Value | INF |
52. Observation.informant.contextControlCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Default Value | OP |
Fixed Value | OP |
53. Observation.informant.assignedEntity | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
54. Observation.informant.relatedEntity | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
55. Observation.participant | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
56. Observation.entryRelationship | |
Control | 0..* |
Type | Element |
Invariants | Defined 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) |
Slicing | This element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
57. Observation.entryRelationship.typeCode | |
Control | 1..1 |
Type | code |
58. Observation.entryRelationship.inversionInd | |
Control | 0..1 |
Type | boolean |
59. Observation.entryRelationship.contextConductionInd | |
Control | 1..1 |
Type | boolean |
Default Value | true |
60. Observation.entryRelationship.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
61. Observation.entryRelationship.negationInd | |
Control | 0..1 |
Type | boolean |
62. Observation.entryRelationship.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
63. Observation.entryRelationship.observation | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
64. Observation.entryRelationship.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
65. Observation.entryRelationship.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
66. Observation.entryRelationship.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
67. Observation.entryRelationship.supply | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
68. Observation.entryRelationship.procedure | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
69. Observation.entryRelationship.encounter | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
70. Observation.entryRelationship.organizer | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
71. Observation.entryRelationship.act | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
72. Observation.entryRelationship:SOPInstanceObservation | |
SliceName | SOPInstanceObservation |
Control | 0..* |
Type | Element |
Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:81-9298) such that it |
Invariants | Defined 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 | |
Control | 1..1 |
Type | code |
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 Value | SPRT |
74. Observation.entryRelationship:SOPInstanceObservation.inversionInd | |
Control | 0..1 |
Type | boolean |
75. Observation.entryRelationship:SOPInstanceObservation.contextConductionInd | |
Control | 1..1 |
Type | boolean |
Default Value | true |
76. Observation.entryRelationship:SOPInstanceObservation.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
77. Observation.entryRelationship:SOPInstanceObservation.negationInd | |
Control | 0..1 |
Type | boolean |
78. Observation.entryRelationship:SOPInstanceObservation.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
79. Observation.entryRelationship:SOPInstanceObservation.observation | |
Control | 1..1 |
Type | http://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 | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
81. Observation.entryRelationship:SOPInstanceObservation.observationMedia | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
82. Observation.entryRelationship:SOPInstanceObservation.substanceAdministration | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
83. Observation.entryRelationship:SOPInstanceObservation.supply | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
84. Observation.entryRelationship:SOPInstanceObservation.procedure | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
85. Observation.entryRelationship:SOPInstanceObservation.encounter | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
86. Observation.entryRelationship:SOPInstanceObservation.organizer | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
87. Observation.entryRelationship:SOPInstanceObservation.act | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
88. Observation.entryRelationship:quantityMeasurementObservation | |
SliceName | quantityMeasurementObservation |
Control | 0..* |
Type | Element |
Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:81-9301) such that it |
Invariants | Defined 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 | |
Control | 1..1 |
Type | code |
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 Value | SPRT |
90. Observation.entryRelationship:quantityMeasurementObservation.inversionInd | |
Control | 0..1 |
Type | boolean |
91. Observation.entryRelationship:quantityMeasurementObservation.contextConductionInd | |
Control | 1..1 |
Type | boolean |
Default Value | true |
92. Observation.entryRelationship:quantityMeasurementObservation.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
93. Observation.entryRelationship:quantityMeasurementObservation.negationInd | |
Control | 0..1 |
Type | boolean |
94. Observation.entryRelationship:quantityMeasurementObservation.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
95. Observation.entryRelationship:quantityMeasurementObservation.observation | |
Control | 1..1 |
Type | http://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 | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
97. Observation.entryRelationship:quantityMeasurementObservation.observationMedia | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
98. Observation.entryRelationship:quantityMeasurementObservation.substanceAdministration | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
99. Observation.entryRelationship:quantityMeasurementObservation.supply | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
100. Observation.entryRelationship:quantityMeasurementObservation.procedure | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
101. Observation.entryRelationship:quantityMeasurementObservation.encounter | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
102. Observation.entryRelationship:quantityMeasurementObservation.organizer | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
103. Observation.entryRelationship:quantityMeasurementObservation.act | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
104. Observation.reference | |
Control | 0..* |
Type | Element |
105. Observation.reference.typeCode | |
Control | 1..1 |
Type | code |
106. Observation.reference.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
107. Observation.reference.externalAct | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
108. Observation.reference.externalObservation | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
109. Observation.reference.externalProcedure | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
110. Observation.reference.externalDocument | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
111. Observation.precondition | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
112. Observation.referenceRange | |
Control | 0..* |
Type | Element |
113. Observation.referenceRange.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActRelationshipPertains |
Type | code |
Default Value | REFV |
Fixed Value | REFV |
114. Observation.referenceRange.observationRange | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationRange |