Consolidated CDA (C-CDA)
3.0.0 - STU United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Progress Toward Goal Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProgressTowardGoalObservation Version: 3.0.0
Draft as of 2024-05-07 Computable Name: ProgressTowardGoalObservation
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.110

This template represents a patient’s progress toward a goal. It can describe whether a goal has been achieved or not and can also describe movement a patient is making toward the achievement of a goal (e.g., “Goal not achieved - no discernible change”, “Goal not achieved - progressing toward goal”, “Goal not achieved - declining from goal”).

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.

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” and in this case the Progress Toward Goal Observation template would record that the related goal has been achieved.

Usage:

Formal Views of Template Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:progress-toward-goal-obs 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.110
..... @extension 0..0
... @classCode 1..1 cs Fixed Value: OBS
... @moodCode 1..1 cs Fixed Value: EVN
... code 1..1 CD
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: completed
... effectiveTime C 1..1 IVL_TS value-only: Interval fields SHALL not be present
.... @value 0..1 ts value should be used instead of low/high
... value 1..1 CD Binding: Goal Achievement . (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.valuerequiredGoalAchievement .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.55

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-onlyerrorObservation.effectiveTimeInterval fields SHALL not be present
: (low | high | width | center).empty()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:progress-toward-goal-obs 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.110
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code 1..1 CD Binding: ObservationType (example)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: completed
... effectiveTime C 1..1 IVL_TS value-only: Interval fields SHALL not be present
.... @value 0..1 ts value should be used instead of low/high
Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
... value 1..1 CD Binding: Goal Achievement . (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.codeexampleObservationType
http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.valuerequiredGoalAchievement .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.55

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-onlyerrorObservation.effectiveTimeInterval fields SHALL not be present
: (low | high | width | center).empty()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:progress-toward-goal-obs 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.110
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1 bl
... id 1..* II
... code 1..1 CD Binding: ObservationType (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... derivationExpr 0..1 ST
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: completed
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime C 1..1 IVL_TS value-only: Interval fields SHALL not be present
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts value should be used instead of low/high
Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 0..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 0..1 IVXB_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 CD Binding: Goal Achievement . (required)
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
... methodCode 0..* CE Binding: ObservationMethod (example)
... targetSiteCode 0..* CD
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..* InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
Fixed Value: REFV
.... observationRange 1..1 ObservationRange
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.templateId:progress-toward-goal-obs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.codeexampleObservationType
http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Observation.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Observation.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Observation.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Observation.valuerequiredGoalAchievement .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.55
Observation.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV
http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-onlyerrorObservation.effectiveTimeInterval fields SHALL not be present
: (low | high | width | center).empty()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Observation

Summary

Mandatory: 10 elements
Fixed: 3 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.templateId

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:progress-toward-goal-obs 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.110
..... @extension 0..0
... @classCode 1..1 cs Fixed Value: OBS
... @moodCode 1..1 cs Fixed Value: EVN
... code 1..1 CD
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @code 1..1 cs Fixed Value: completed
... effectiveTime C 1..1 IVL_TS value-only: Interval fields SHALL not be present
.... @value 0..1 ts value should be used instead of low/high
... value 1..1 CD Binding: Goal Achievement . (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.valuerequiredGoalAchievement .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.55

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-onlyerrorObservation.effectiveTimeInterval fields SHALL not be present
: (low | high | width | center).empty()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:progress-toward-goal-obs 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.110
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code 1..1 CD Binding: ObservationType (example)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: completed
... effectiveTime C 1..1 IVL_TS value-only: Interval fields SHALL not be present
.... @value 0..1 ts value should be used instead of low/high
Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
... value 1..1 CD Binding: Goal Achievement . (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.codeexampleObservationType
http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.valuerequiredGoalAchievement .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.55

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-onlyerrorObservation.effectiveTimeInterval fields SHALL not be present
: (low | high | width | center).empty()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 1..1 Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:progress-toward-goal-obs 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.110
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1 bl
... id 1..* II
... code 1..1 CD Binding: ObservationType (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... derivationExpr 0..1 ST
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: completed
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime C 1..1 IVL_TS value-only: Interval fields SHALL not be present
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts value should be used instead of low/high
Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 0..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 0..1 IVXB_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value 1..1 CD Binding: Goal Achievement . (required)
... interpretationCode 0..* CE Binding: CDAObservationInterpretation (required)
... methodCode 0..* CE Binding: ObservationMethod (example)
... targetSiteCode 0..* CD
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..* InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: CDAActRelationshipType (required)
Fixed Value: REFV
.... observationRange 1..1 ObservationRange
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.templateId:progress-toward-goal-obs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.codeexampleObservationType
http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Observation.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Observation.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Observation.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Observation.valuerequiredGoalAchievement .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.55
Observation.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV
http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType

Constraints

IdGradePath(s)DetailsRequirements
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-onlyerrorObservation.effectiveTimeInterval fields SHALL not be present
: (low | high | width | center).empty()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Observation

Summary

Mandatory: 10 elements
Fixed: 3 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.templateId

 

Other representations of profile: CSV, Excel