Consolidated CDA Release 2.2
2.2 - CI Build
Unknown state code 'US'
Consolidated CDA Release 2.2
2.2 - CI Build
Unknown state code 'US'
Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions
| Active as of 2023-05-30 |
Definitions for the 2.16.840.1.113883.10.20.22.4.13 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Observation |
Guidance on how to interpret the contents of this table can be found here.
| 1. Observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| 2. Observation.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassObservation |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. Observation.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 4. Observation.code | |
| Definition | Describes what was observed. Sometimes this is called the observation "name". |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitableFor example codes, see LOINCCodes |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CDCodeableConcept |
| XML Representation | 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 |
| 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. |
Guidance on how to interpret the contents of this table can be found here.
| 1. Observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| 2. Observation.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassObservation |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. Observation.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 4. Observation.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| 8. Observation.id | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 9. 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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 10. Observation.derivationExpr | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ST |
| 11. Observation.text | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 12. Observation.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 13. Observation.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 14. 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 |
| 15. Observation.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| 16. Observation.languageCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from HumanLanguage |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 17. Observation.value | |
| Control | 0..* |
| 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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 18. Observation.interpretationCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from ObservationInterpretation |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 19. 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 |
| 20. Observation.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 21. Observation.subject | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. Observation.subject.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 23. Observation.subject.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Observation.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 24. Observation.subject.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | SBJ |
| Fixed Value | SBJ |
| 25. Observation.subject.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 26. 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 |
| 27. Observation.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 28. Observation.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 29. Observation.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 30. Observation.author | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| 31. Observation.informant | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 32. Observation.informant.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 33. Observation.informant.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Observation.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 34. Observation.informant.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationInformationGenerator |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INF |
| Fixed Value | INF |
| 35. Observation.informant.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 36. Observation.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 37. Observation.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 38. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| 39. Observation.entryRelationship | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) 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) |
| 40. Observation.entryRelationship.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 41. Observation.entryRelationship.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 42. Observation.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 43. Observation.entryRelationship.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 44. Observation.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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.reference | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 58. Observation.reference.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 59. Observation.reference.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Observation.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 60. Observation.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 61. Observation.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 62. Observation.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 63. Observation.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 64. Observation.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 65. Observation.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 66. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
| 67. Observation.referenceRange | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 68. Observation.referenceRange.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 69. Observation.referenceRange.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Observation.referenceRange.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 70. Observation.referenceRange.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActRelationshipPertains |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | REFV |
| Fixed Value | REFV |
| 71. 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 2023-05-30
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change