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: Goal Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/GoalObservation Version: 2.1
Draft as of 2023-09-29 Computable Name: GoalObservation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.121:2022-06-01

This template represents a patient health goal. A Goal Observation template may have related components that are acts, encounters, observations, procedures, substance administrations, or supplies. A goal identifies a future desired condition or state. Goals are often related to physical or mental health conditions or diseases, but also may be related to a Social Determinant of Health (SDOH) risks or states. For example, to have adequate quality meals and snacks, gain transportation security - able to access health and social needs). SDOH data relate to conditions in which people live, learn, work, and play and their effects on health risks and outcomes. A Goal is established by the patient or provider.

A goal may be a patient or provider goal. If the author is set to the recordTarget (patient), this is a patient goal. If the author is set to a provider, this is a provider goal. If both patient and provider are set as authors, this is a negotiated goal.

A goal usually has a related health concern and/or risk.

A goal may have components consisting of other goals (milestones). These milestones are related to the overall goal through entryRelationships.

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 CDAR2.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
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: GOL
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.121
..... extension 1..1stRequired Pattern: 2022-06-01
... code C1..1CD4515-32887: When the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
... statusCode 1..1CS
.... code 1..1csBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... value C0..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_PQ4515-32963: When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by value:act, value:typeCode
.... entryRelationship:entryRelationship1 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: COMP
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:entryRelationship4 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: COMP
..... observation 1..1GoalObservationBase for all types and resources
.... entryRelationship:entryRelationship5 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship6 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1ProgressTowardGoalObservationact
... reference 0..*Reference
.... typeCode 1..1csFixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.statusCode.coderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
4515-32887warningObservation.codeWhen the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
:
4515-32963warningObservation.valueWhen the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..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
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: GOL
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.121
..... @extension 1..1stRequired Pattern: 2022-06-01
... code C1..1CDBinding: ObservationType (extensible)
4515-32887: When the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... value C0..14515-32963: When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
.... 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..*EntryRelationshipSlice: Unordered, Open by value:act, value:typeCode
.... entryRelationship:entryRelationship1 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:entryRelationship4 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... observation 1..1GoalObservationBase for all types and resources
.... entryRelationship:entryRelationship5 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship6 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1ProgressTowardGoalObservationact
... 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.statusCoderequiredActStatus
Observation.statusCode.coderequiredActStatus
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship5.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship6.typeCoderequiredFixed Value: REFR
Observation.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
4515-32887warningObservation.codeWhen the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
:
4515-32963warningObservation.valueWhen the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..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
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: GOL
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @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.121
..... @extension 1..1stRequired Pattern: 2022-06-01
... id 1..*II
... code C1..1CDBinding: ObservationType (extensible)
4515-32887: When the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: ActStatus (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value C0..14515-32963: When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
.... 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..*EntryRelationshipSlice: Unordered, Open by value:act, value:typeCode
.... entryRelationship:entryRelationship1 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @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:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @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:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship4 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1GoalObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship5 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @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:entryRelationship6 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1ProgressTowardGoalObservationact
..... 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:templateId1.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.statusCode.coderequiredActStatus
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship2.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship3.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship4.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship5.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship5.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship6.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship6.typeCoderequiredFixed Value: REFR
Observation.reference.nullFlavorrequiredNullFlavor
Observation.reference.typeCoderequiredFixed Value: REFR
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
4515-32887warningObservation.codeWhen the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
:
4515-32963warningObservation.valueWhen the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
:
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: 7 elements (7 nested mandatory elements)
Fixed Value: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation CDAR2.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
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: GOL
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.121
..... extension 1..1stRequired Pattern: 2022-06-01
... code C1..1CD4515-32887: When the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
... statusCode 1..1CS
.... code 1..1csBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... value C0..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_PQ4515-32963: When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by value:act, value:typeCode
.... entryRelationship:entryRelationship1 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: COMP
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:entryRelationship4 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: COMP
..... observation 1..1GoalObservationBase for all types and resources
.... entryRelationship:entryRelationship5 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship6 0..*EntryRelationshipentryRelationship
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1ProgressTowardGoalObservationact
... reference 0..*Reference
.... typeCode 1..1csFixed Value: REFR
.... externalDocument 1..1ExternalDocumentReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.statusCode.coderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
4515-32887warningObservation.codeWhen the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
:
4515-32963warningObservation.valueWhen the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..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
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: GOL
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.121
..... @extension 1..1stRequired Pattern: 2022-06-01
... code C1..1CDBinding: ObservationType (extensible)
4515-32887: When the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... value C0..14515-32963: When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
.... 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..*EntryRelationshipSlice: Unordered, Open by value:act, value:typeCode
.... entryRelationship:entryRelationship1 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:entryRelationship4 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... observation 1..1GoalObservationBase for all types and resources
.... entryRelationship:entryRelationship5 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... act 1..1EntryReferenceBase for all types and resources
.... entryRelationship:entryRelationship6 0..*EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1ProgressTowardGoalObservationact
... 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.statusCoderequiredActStatus
Observation.statusCode.coderequiredActStatus
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship5.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship6.typeCoderequiredFixed Value: REFR
Observation.reference.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
4515-32887warningObservation.codeWhen the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
:
4515-32963warningObservation.valueWhen the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..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
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: GOL
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @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.121
..... @extension 1..1stRequired Pattern: 2022-06-01
... id 1..*II
... code C1..1CDBinding: ObservationType (extensible)
4515-32887: When the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: ActStatus (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value C0..14515-32963: When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
.... 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..*EntryRelationshipSlice: Unordered, Open by value:act, value:typeCode
.... entryRelationship:entryRelationship1 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @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:entryRelationship2 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @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:entryRelationship3 0..1EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship4 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1GoalObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:entryRelationship5 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @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:entryRelationship6 0..*EntryRelationshipentryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1ProgressTowardGoalObservationact
..... 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:templateId1.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.statusCode.coderequiredActStatus
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship2.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship2.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship3.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship3.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship4.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship4.typeCoderequiredFixed Value: COMP
Observation.entryRelationship:entryRelationship5.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship5.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:entryRelationship6.nullFlavorrequiredNullFlavor
Observation.entryRelationship:entryRelationship6.typeCoderequiredFixed Value: REFR
Observation.reference.nullFlavorrequiredNullFlavor
Observation.reference.typeCoderequiredFixed Value: REFR
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
4515-32887warningObservation.codeWhen the Goal is Social Determinant of Health Goal, the observation/code **SHOULD** contain exactly one [1..1] code, which **SHOULD** contain exactly one [1..1] @code="8689-2 "History of Social function” This code **SHALL** contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC 2.16.840.1.113883.6.1) (CONF:4515-32887).
:
4515-32963warningObservation.valueWhen the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC** (CONF:4515-32963).
:
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: 7 elements (7 nested mandatory elements)
Fixed Value: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel