Consolidated CDA Release 2.2
2.2 - CI Build
Consolidated CDA Release 2.2
2.2 - CI Build
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.13 resource profile.
| 1. Observation | |
| Control | 1..1 |
| Invariants | Defined on this element 81-9310: Code Observations SHALL be rendered into section/text in separate paragraphs (CONF:81-9310). (: ) |
| 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: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9304). |
| 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-9305). |
| 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-15523). |
| 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 | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.6.2.13" (CONF:81-15524). |
| Pattern Value | 2.16.840.1.113883.10.20.6.2.13 |
| 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-19181). |
| 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 |
| 18. Observation.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 19. 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-9309). |
| 20. 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 |
| 21. Observation.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| 22. Observation.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 23. Observation.value | |
| Control | 1..1 |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/BL, http://hl7.org/fhir/cda/StructureDefinition/ED, http://hl7.org/fhir/cda/StructureDefinition/ST, http://hl7.org/fhir/cda/StructureDefinition/CD, http://hl7.org/fhir/cda/StructureDefinition/CV, http://hl7.org/fhir/cda/StructureDefinition/CE, http://hl7.org/fhir/cda/StructureDefinition/SC, http://hl7.org/fhir/cda/StructureDefinition/II, http://hl7.org/fhir/cda/StructureDefinition/TEL, http://hl7.org/fhir/cda/StructureDefinition/AD, http://hl7.org/fhir/cda/StructureDefinition/EN, http://hl7.org/fhir/cda/StructureDefinition/INT, http://hl7.org/fhir/cda/StructureDefinition/REAL, http://hl7.org/fhir/cda/StructureDefinition/PQ, http://hl7.org/fhir/cda/StructureDefinition/MO, http://hl7.org/fhir/cda/StructureDefinition/TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS, http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ |
| Requirements | SHALL contain exactly one [1..1] value (CONF:81-9308). |
| 24. Observation.interpretationCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from ObservationInterpretation |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 25. 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 |
| 26. Observation.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 27. Observation.subject | |
| Control | 0..1 |
| Type | Element |
| 28. Observation.subject.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code |
| Default Value | SBJ |
| Fixed Value | SBJ |
| 29. Observation.subject.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| Default Value | OP |
| Fixed Value | OP |
| 30. 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 |
| 31. Observation.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 32. Observation.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 33. Observation.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 34. Observation.author | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 35. Observation.informant | |
| Control | 0..* |
| Type | Element |
| 36. Observation.informant.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationInformationGenerator |
| Type | code |
| Default Value | INF |
| Fixed Value | INF |
| 37. Observation.informant.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| Default Value | OP |
| Fixed Value | OP |
| 38. Observation.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 39. Observation.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 40. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| 41. 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:
|
| 42. Observation.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| 43. Observation.entryRelationship.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| 44. Observation.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| Default Value | true |
| 45. Observation.entryRelationship.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 46. Observation.entryRelationship.negationInd | |
| Control | 0..1 |
| Type | boolean |
| 47. Observation.entryRelationship.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 48. Observation.entryRelationship.observation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 49. Observation.entryRelationship.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 50. Observation.entryRelationship.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 51. Observation.entryRelationship.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 52. Observation.entryRelationship.supply | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 53. Observation.entryRelationship.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 54. Observation.entryRelationship.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 55. Observation.entryRelationship.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 56. Observation.entryRelationship.act | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 57. Observation.entryRelationship:SOPInstanceObservation | |
| SliceName | SOPInstanceObservation |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:81-9311) 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) |
| 58. 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-9312). |
| Pattern Value | SPRT |
| 59. Observation.entryRelationship:SOPInstanceObservation.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| 60. Observation.entryRelationship:SOPInstanceObservation.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| Default Value | true |
| 61. Observation.entryRelationship:SOPInstanceObservation.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 62. Observation.entryRelationship:SOPInstanceObservation.negationInd | |
| Control | 0..1 |
| Type | boolean |
| 63. Observation.entryRelationship:SOPInstanceObservation.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 64. 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-16083). |
| 65. Observation.entryRelationship:SOPInstanceObservation.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 66. Observation.entryRelationship:SOPInstanceObservation.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 67. Observation.entryRelationship:SOPInstanceObservation.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 68. Observation.entryRelationship:SOPInstanceObservation.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 69. Observation.entryRelationship:SOPInstanceObservation.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 70. Observation.entryRelationship:SOPInstanceObservation.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 71. Observation.entryRelationship:SOPInstanceObservation.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 72. Observation.entryRelationship:SOPInstanceObservation.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 73. Observation.entryRelationship:quantityMeasurementObservation | |
| SliceName | quantityMeasurementObservation |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:81-9314) 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) |
| 74. 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-9315). |
| Pattern Value | SPRT |
| 75. Observation.entryRelationship:quantityMeasurementObservation.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| 76. Observation.entryRelationship:quantityMeasurementObservation.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| Default Value | true |
| 77. Observation.entryRelationship:quantityMeasurementObservation.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 78. Observation.entryRelationship:quantityMeasurementObservation.negationInd | |
| Control | 0..1 |
| Type | boolean |
| 79. Observation.entryRelationship:quantityMeasurementObservation.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 80. 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-16084). |
| 81. Observation.entryRelationship:quantityMeasurementObservation.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 82. Observation.entryRelationship:quantityMeasurementObservation.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 83. Observation.entryRelationship:quantityMeasurementObservation.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 84. Observation.entryRelationship:quantityMeasurementObservation.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 85. Observation.entryRelationship:quantityMeasurementObservation.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 86. Observation.entryRelationship:quantityMeasurementObservation.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 87. Observation.entryRelationship:quantityMeasurementObservation.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 88. Observation.entryRelationship:quantityMeasurementObservation.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 89. Observation.reference | |
| Control | 0..* |
| Type | Element |
| 90. Observation.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| 91. Observation.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 92. Observation.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 93. Observation.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 94. Observation.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 95. Observation.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 96. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
| 97. Observation.referenceRange | |
| Control | 0..* |
| Type | Element |
| 98. Observation.referenceRange.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActRelationshipPertains |
| Type | code |
| Default Value | REFV |
| Fixed Value | REFV |
| 99. Observation.referenceRange.observationRange | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationRange |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccdar2dot2#2.2 based on FHIR 4.0.1. Generated 2022-05-13
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change