Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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

Logical Model: Outcome Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/OutcomeObservation Version: 2.1
Draft as of 2023-09-29 Computable Name: OutcomeObservation
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.144

This template represents the outcome of care resulting from the interventions used to treat the patient. In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.

Often thought of as an “actual outcome”, the Outcome Observation may be related to goals, progression toward goals, and the associated interventions. For example, an observation outcome of a blood oxygen saturation level of 95% is related to the goal of “Maintain Pulse Ox greater than 92”, which in turn is related to the health concern of respiratory insufficiency and the problem of pneumonia. The template makes use of the Entry Reference (templateId:2.16.840.1.113883.10.20.22.4.122) to reference the interventions and goals defined elsewhere in the Care Plan CDA instance.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
..... extension 0..0
... code 1..1CD
... value 0..1ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... typeCode 1..1csFixed Value: GEVL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation 0..1EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... typeCode 1..1csFixed Value: SPRT
..... inversionInd 1..1blFixed Value: true
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference2 C0..*EntryRelationship1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... typeCode 1..1csFixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Reference
.... typeCode 1..1csFixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReference2This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... code 1..1CDBinding: ObservationType (extensible)
... value 0..1
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: GEVL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation 0..1EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference2 C0..*EntryRelationship1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.entryRelationship:entryReference.typeCoderequiredFixed Value: GEVL
Observation.entryRelationship:progressTowardGoalObservation.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:entryReference2.typeCoderequiredFixed Value: RSON
Observation.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReference2This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 0..1
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: GEVL
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:progressTowardGoalObservation 0..1EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryReference2 C0..*EntryRelationship1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.entryRelationship:entryReference.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryReference.typeCoderequiredFixed Value: GEVL
Observation.entryRelationship:progressTowardGoalObservation.nullFlavorrequiredNullFlavor
Observation.entryRelationship:progressTowardGoalObservation.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:entryReference2.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryReference2.typeCoderequiredFixed Value: RSON
Observation.reference.nullFlavorrequiredNullFlavor
Observation.reference.typeCoderequiredFixed Value: REFR
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReference2This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Observation

Summary

Mandatory: 4 elements (5 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the value of value:root
  • The element Observation.entryRelationship is sliced based on the values of profile:act, profile:observation

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
..... extension 0..0
... code 1..1CD
... value 0..1ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... typeCode 1..1csFixed Value: GEVL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation 0..1EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... typeCode 1..1csFixed Value: SPRT
..... inversionInd 1..1blFixed Value: true
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference2 C0..*EntryRelationship1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... typeCode 1..1csFixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Reference
.... typeCode 1..1csFixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReference2This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... code 1..1CDBinding: ObservationType (extensible)
... value 0..1
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: GEVL
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:progressTowardGoalObservation 0..1EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 1..1blFixed Value: true
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
.... entryRelationship:entryReference2 C0..*EntryRelationship1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... act 1..1EntryReferenceBase for all types and resources
... reference 0..*Reference
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.entryRelationship:entryReference.typeCoderequiredFixed Value: GEVL
Observation.entryRelationship:progressTowardGoalObservation.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:entryReference2.typeCoderequiredFixed Value: RSON
Observation.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReference2This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
1098-32782: SHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.144
... id 1..*II
... code 1..1CDBinding: ObservationType (extensible)
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value 0..1
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS
.... valueRTO_PQ_PQ
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipWhere an Outcome Observation needs to reference an Intervention Act already described in the CDA document instance, rather than repeating the full content of the Intervention Act, the Entry Reference template may be used to reference this entry.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:entryReference C0..*EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Goal Observation. Because the Goal Observation is already described in the CDA document instance's Goals section, rather than repeating the full content of the Goal Observation, the Entry Reference template can be used to reference this entry.
1098-32461: This entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: GEVL
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:progressTowardGoalObservation 0..1EntryRelationshipThe following entryRelationship represents the relationship between an Outcome Observation and a Progress Toward Goal Observation (Outcome Observation SUPPORTS Progress Toward Goal Observation). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1ProgressTowardGoalObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryReference2 C0..*EntryRelationship1098-32462: This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1EntryReferenceBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 1..1csBinding: x_ActRelationshipExternalReference (required)
Fixed Value: REFR
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:primary.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.entryRelationship:entryReference.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryReference.typeCoderequiredFixed Value: GEVL
Observation.entryRelationship:progressTowardGoalObservation.nullFlavorrequiredNullFlavor
Observation.entryRelationship:progressTowardGoalObservation.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:entryReference2.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryReference2.typeCoderequiredFixed Value: RSON
Observation.reference.nullFlavorrequiredNullFlavor
Observation.reference.typeCoderequiredFixed Value: REFR
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1098-32461errorObservation.entryRelationship:entryReferenceThis entryReference template **SHALL** reference an instance of a Goal Observation template (CONF:1098-32461).
:
1098-32462errorObservation.entryRelationship:entryReference2This entryReference template **SHALL** reference an instance of a Intervention Act template (CONF:1098-32462).
:
1098-32782errorObservationSHALL contain at least one [1..*] entryRelationships (CONF:1098-32782).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Observation

Summary

Mandatory: 4 elements (5 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the value of value:root
  • The element Observation.entryRelationship is sliced based on the values of profile:act, profile:observation

 

Other representations of profile: CSV, Excel