Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.22.4.144 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Observation | |
| Invariants | Defined on this element 1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782). (: null) |
| 2. Observation.classCode | |
| Requirements | SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31219). |
| Pattern Value | OBS |
| 3. Observation.moodCode | |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31220). |
| Pattern Value | EVN |
| 4. Observation.templateId | |
| 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:
|
| 5. Observation.templateId:primary | |
| SliceName | primary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-31221) such that it |
| 6. Observation.templateId:primary.root | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.144" (CONF:1098-31222). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.144 |
| 7. Observation.id | |
| Control | 10..* |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-31223). |
| 8. Observation.code | |
| Requirements | SHALL contain exactly one [1..1] code, which SHOULD be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:1098-32746). |
| 9. Observation.value | |
| Control | 0..1* |
| Requirements | SHOULD contain zero or one [0..1] value (CONF:1098-32747). |
| 10. Observation.author | |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation) |
| Requirements | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31553). |
| 11. Observation.entryRelationship | |
| 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:
|
| 12. Observation.entryRelationship:entryReference | |
| SliceName | entryReference |
| Control | 0..* |
| Requirements | SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-31224) such that it |
| Invariants | Defined on this element 1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461). (: null) |
| 13. Observation.entryRelationship:entryReference.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="GEVL" Evaluates goal (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31225). |
| Pattern Value | GEVL |
| 14. Observation.entryRelationship:entryReference.act | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(EntryReference) |
| Requirements | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1098-32465). |
| 15. Observation.entryRelationship:progressTowardGoalObservation | |
| SliceName | progressTowardGoalObservation |
| Control | 0..1 |
| Requirements | SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-31427) such that it |
| 16. Observation.entryRelationship:progressTowardGoalObservation.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31428). |
| Pattern Value | SPRT |
| 17. Observation.entryRelationship:progressTowardGoalObservation.inversionInd | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-31429). |
| Pattern Value | true |
| 18. Observation.entryRelationship:progressTowardGoalObservation.observation | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(ProgressTowardGoalObservation) |
| Requirements | SHALL contain exactly one [1..1] Progress Toward Goal Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.110) (CONF:1098-31430). |
| 19. Observation.entryRelationship:entryReference | |
| SliceName | entryReference |
| Control | 0..* |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31688) such that it |
| Invariants | Defined on this element 1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462). (: null) |
| 20. Observation.entryRelationship:entryReference.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31689). |
| Pattern Value | RSON |
| 21. Observation.entryRelationship:entryReference.act | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(EntryReference) |
| Requirements | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1098-31690). |
| 22. Observation.reference | |
| Requirements | MAY contain zero or more [0..*] reference (CONF:1098-32763). |
| 23. Observation.reference.typeCode | |
| Requirements | The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32764). |
| Pattern Value | REFR |
| 24. Observation.reference.externalDocument | |
| Control | 10..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument(ExternalDocumentReference) |
| Requirements | The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1098-32765). |
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* |
| Invariants | Defined on this element 1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 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. |
| Requirements | SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31219). |
| Pattern Value | OBS |
| 3. Observation.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31220). |
| Pattern Value | EVN |
| 4. 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:
|
| 5. 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:1098-31221) such that it |
| 6. 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.144" (CONF:1098-31222). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.144 |
| 7. Observation.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Control | 10..*1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IIid |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-31223). |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| 8. 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 | SHALL contain exactly one [1..1] code, which SHOULD be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:1098-32746). 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. |
| 9. Observation.value | |
| Control | 0..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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHOULD contain zero or one [0..1] value (CONF:1098-32747). |
| 10. Observation.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation) |
| Requirements | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31553). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. 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) |
| 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:
|
| 12. Observation.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 13. Observation.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 14. Observation.entryRelationship:entryReference | |
| SliceName | entryReference |
| Control | 0..* |
| Type | Element |
| Requirements | SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-31224) such that it |
| Invariants | Defined on this element 1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461). (: null) 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) |
| 15. Observation.entryRelationship:entryReference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @typeCode="GEVL" Evaluates goal (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31225). |
| Pattern Value | GEVL |
| 16. Observation.entryRelationship:entryReference.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 17. Observation.entryRelationship:entryReference.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 18. Observation.entryRelationship:entryReference.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 19. Observation.entryRelationship:entryReference.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 20. Observation.entryRelationship:entryReference.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 21. Observation.entryRelationship:entryReference.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 22. Observation.entryRelationship:entryReference.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 23. Observation.entryRelationship:entryReference.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 24. Observation.entryRelationship:entryReference.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 25. Observation.entryRelationship:entryReference.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(EntryReference) |
| Requirements | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1098-32465). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 26. Observation.entryRelationship:progressTowardGoalObservation | |
| SliceName | progressTowardGoalObservation |
| Control | 0..1 |
| Type | Element |
| Requirements | SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-31427) such that it |
| 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) |
| 27. Observation.entryRelationship:progressTowardGoalObservation.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31428). |
| Pattern Value | SPRT |
| 28. Observation.entryRelationship:progressTowardGoalObservation.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-31429). |
| Pattern Value | true |
| 29. Observation.entryRelationship:progressTowardGoalObservation.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 30. Observation.entryRelationship:progressTowardGoalObservation.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(ProgressTowardGoalObservation) |
| Requirements | SHALL contain exactly one [1..1] Progress Toward Goal Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.110) (CONF:1098-31430). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 31. Observation.entryRelationship:progressTowardGoalObservation.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 32. Observation.entryRelationship:progressTowardGoalObservation.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 33. Observation.entryRelationship:progressTowardGoalObservation.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 34. Observation.entryRelationship:progressTowardGoalObservation.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 35. Observation.entryRelationship:progressTowardGoalObservation.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 36. Observation.entryRelationship:progressTowardGoalObservation.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 37. Observation.entryRelationship:progressTowardGoalObservation.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 38. Observation.entryRelationship:progressTowardGoalObservation.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 39. Observation.entryRelationship:entryReference | |
| SliceName | entryReference |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31688) such that it |
| Invariants | Defined on this element 1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462). (: null) 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:entryReference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31689). |
| Pattern Value | RSON |
| 41. Observation.entryRelationship:entryReference.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 42. Observation.entryRelationship:entryReference.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 43. Observation.entryRelationship:entryReference.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 44. Observation.entryRelationship:entryReference.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 45. Observation.entryRelationship:entryReference.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 46. Observation.entryRelationship:entryReference.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 47. Observation.entryRelationship:entryReference.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 48. Observation.entryRelationship:entryReference.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 49. Observation.entryRelationship:entryReference.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 50. Observation.entryRelationship:entryReference.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(EntryReference) |
| Requirements | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1098-31690). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 51. Observation.reference | |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] reference (CONF:1098-32763). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 52. Observation.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32764). |
| Pattern Value | REFR |
| 53. Observation.reference.externalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument(ExternalDocumentReference) |
| Requirements | The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1098-32765). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
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. |
| Requirements | SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31219). |
| Pattern Value | OBS |
| 3. Observation.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31220). |
| Pattern Value | EVN |
| 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 |
| 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:1098-31221) 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.144" (CONF:1098-31222). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.144 |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 14. Observation.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-31223). |
| 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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHALL contain exactly one [1..1] code, which SHOULD be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:1098-32746). |
| 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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 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 |
| 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 | 0..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 |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHOULD contain zero or one [0..1] value (CONF:1098-32747). |
| 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 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 28. 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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 29. 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:
|
| 30. 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 |
| 31. 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 |
| 32. 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 |
| 33. Observation.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 34. Observation.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 35. Observation.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 36. Observation.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation) |
| Requirements | SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31553). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 37. 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())) |
| 38. 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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 39. 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:
|
| 40. 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 |
| 41. 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 |
| 42. Observation.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 43. Observation.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 44. Observation.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| 45. 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) |
| 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:
|
| 46. 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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 47. 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:
|
| 48. Observation.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 49. Observation.entryRelationship.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 50. Observation.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 51. Observation.entryRelationship.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 52. Observation.entryRelationship.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 53. Observation.entryRelationship.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 54. Observation.entryRelationship.observation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 55. Observation.entryRelationship.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 56. Observation.entryRelationship.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 57. Observation.entryRelationship.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 58. Observation.entryRelationship.supply | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 59. Observation.entryRelationship.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 60. Observation.entryRelationship.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 61. Observation.entryRelationship.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 62. Observation.entryRelationship.act | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 63. Observation.entryRelationship:entryReference | |
| SliceName | entryReference |
| Control | 0..* |
| Type | Element |
| Requirements | SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-31224) such that it |
| Invariants | Defined on this element 1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461). (: ) 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) |
| 64. Observation.entryRelationship:entryReference.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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 65. Observation.entryRelationship:entryReference.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:
|
| 66. Observation.entryRelationship:entryReference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @typeCode="GEVL" Evaluates goal (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31225). |
| Pattern Value | GEVL |
| 67. Observation.entryRelationship:entryReference.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 68. Observation.entryRelationship:entryReference.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 69. Observation.entryRelationship:entryReference.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 70. Observation.entryRelationship:entryReference.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 71. Observation.entryRelationship:entryReference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 72. Observation.entryRelationship:entryReference.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 73. Observation.entryRelationship:entryReference.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 74. Observation.entryRelationship:entryReference.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 75. Observation.entryRelationship:entryReference.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 76. Observation.entryRelationship:entryReference.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 77. Observation.entryRelationship:entryReference.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 78. Observation.entryRelationship:entryReference.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 79. Observation.entryRelationship:entryReference.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 80. Observation.entryRelationship:entryReference.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(EntryReference) |
| Requirements | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1098-32465). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 81. Observation.entryRelationship:progressTowardGoalObservation | |
| SliceName | progressTowardGoalObservation |
| Control | 0..1 |
| Type | Element |
| Requirements | SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-31427) such that it |
| 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) |
| 82. Observation.entryRelationship:progressTowardGoalObservation.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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 83. Observation.entryRelationship:progressTowardGoalObservation.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:
|
| 84. Observation.entryRelationship:progressTowardGoalObservation.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31428). |
| Pattern Value | SPRT |
| 85. Observation.entryRelationship:progressTowardGoalObservation.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-31429). |
| Pattern Value | true |
| 86. Observation.entryRelationship:progressTowardGoalObservation.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 87. Observation.entryRelationship:progressTowardGoalObservation.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 88. Observation.entryRelationship:progressTowardGoalObservation.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 89. Observation.entryRelationship:progressTowardGoalObservation.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 90. Observation.entryRelationship:progressTowardGoalObservation.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(ProgressTowardGoalObservation) |
| Requirements | SHALL contain exactly one [1..1] Progress Toward Goal Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.110) (CONF:1098-31430). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 91. Observation.entryRelationship:progressTowardGoalObservation.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 92. Observation.entryRelationship:progressTowardGoalObservation.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 93. Observation.entryRelationship:progressTowardGoalObservation.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 94. Observation.entryRelationship:progressTowardGoalObservation.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 95. Observation.entryRelationship:progressTowardGoalObservation.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 96. Observation.entryRelationship:progressTowardGoalObservation.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 97. Observation.entryRelationship:progressTowardGoalObservation.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 98. Observation.entryRelationship:progressTowardGoalObservation.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 99. Observation.entryRelationship:entryReference | |
| SliceName | entryReference |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31688) such that it |
| Invariants | Defined on this element 1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462). (: ) 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) |
| 100. Observation.entryRelationship:entryReference.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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 101. Observation.entryRelationship:entryReference.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:
|
| 102. Observation.entryRelationship:entryReference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @typeCode="RSON" Has reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31689). |
| Pattern Value | RSON |
| 103. Observation.entryRelationship:entryReference.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 104. Observation.entryRelationship:entryReference.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 105. Observation.entryRelationship:entryReference.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 106. Observation.entryRelationship:entryReference.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 107. Observation.entryRelationship:entryReference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 108. Observation.entryRelationship:entryReference.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 109. Observation.entryRelationship:entryReference.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 110. Observation.entryRelationship:entryReference.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 111. Observation.entryRelationship:entryReference.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 112. Observation.entryRelationship:entryReference.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 113. Observation.entryRelationship:entryReference.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 114. Observation.entryRelationship:entryReference.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 115. Observation.entryRelationship:entryReference.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 116. Observation.entryRelationship:entryReference.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(EntryReference) |
| Requirements | SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:1098-31690). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 117. Observation.reference | |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] reference (CONF:1098-32763). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 118. 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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 119. 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:
|
| 120. Observation.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32764). |
| Pattern Value | REFR |
| 121. Observation.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 122. Observation.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 123. Observation.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 124. Observation.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 125. Observation.reference.externalDocument | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument(ExternalDocumentReference) |
| Requirements | The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:1098-32765). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 126. Observation.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
| 127. 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())) |
| 128. 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 | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 129. 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:
|
| 130. 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 |
| 131. Observation.referenceRange.observationRange | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationRange |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change