Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Functional Status Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/FunctionalStatusObservation Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: FunctionalStatusObservation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.67:2014-06-09

This template represents the patient’s physical function (e.g., mobility status, instrumental activities of daily living, self-care status) and problems that limit function (dyspnea, dysphagia). The template may include assessment scale observations, identify supporting caregivers, and provide information about non-medicinal supplies. This template is used to represent physical or developmental function of all patient populations.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1ObservationXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:functional-status-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.67
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csFixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... code 1..1CD
.... @code 1..1csRequired Pattern: 54522-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
... value C1..1ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ1098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, profile:observation, value:typeCode
.... entryRelationship:nonMedSupply 0..1EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:caregiverCharacteristics 0..1EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1CaregiverCharacteristicsBase for all types and resources
.... entryRelationship:assessmentScaleObservation 0..1EntryRelationship
..... @typeCode 1..1csFixed Value: COMP
..... observation 1..1AssessmentScaleObservationBase for all types and resources
... referenceRange 0..*InfrastructureRootreferenceRange could be used to represent normal or expected capability for the function being evaluated.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
1098-14234warningObservation.valueIf coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
: codeSystem.exists() implies codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningObservationSHOULD contain author
: author.exists()
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
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 C1..1ObservationXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:functional-status-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.67
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code 1..1CDBinding: ObservationType (example)
.... @code 1..1csRequired Pattern: 54522-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
... value C1..11098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueCO
.... 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 profile:supply, profile:observation, value:typeCode
.... entryRelationship:nonMedSupply 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:caregiverCharacteristics 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1CaregiverCharacteristicsBase for all types and resources
.... entryRelationship:assessmentScaleObservation 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... observation C1..1AssessmentScaleObservationBase for all types and resources
... referenceRange 0..*InfrastructureRootreferenceRange could be used to represent normal or expected capability for the function being evaluated.
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.statusCoderequiredActStatus
Observation.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:caregiverCharacteristics.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:assessmentScaleObservation.typeCoderequiredFixed Value: COMP

Constraints

IdGradePath(s)DetailsRequirements
1098-14234warningObservation.valueIf coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
: codeSystem.exists() implies codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningObservation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
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 C1..1ObservationXML 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
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:functional-status-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.67
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDBinding: ObservationType (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 54522-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @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)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @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 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value C1..11098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueCO
.... 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 (example)
... 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 profile:supply, profile:observation, value:typeCode
.... entryRelationship:nonMedSupply 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply C1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:caregiverCharacteristics 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..1CaregiverCharacteristicsBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:assessmentScaleObservation 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..1AssessmentScaleObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRootreferenceRange could be used to represent normal or expected capability for the function being evaluated.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:functional-status-obs.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.code.nullFlavorrequiredCDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.entryRelationship:nonMedSupply.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:nonMedSupply.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:caregiverCharacteristics.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:caregiverCharacteristics.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:caregiverCharacteristics.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:assessmentScaleObservation.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:assessmentScaleObservation.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:assessmentScaleObservation.typeCoderequiredFixed Value: COMP
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1098-14234warningObservation.valueIf coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
: codeSystem.exists() implies codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningObservation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
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: 11 elements (3 nested mandatory elements)
Fixed Value: 6 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 profile:supply, profile:observation, value:typeCode

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1ObservationXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:functional-status-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.67
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csFixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... code 1..1CD
.... @code 1..1csRequired Pattern: 54522-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
... value C1..1ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ1098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
... author 0..*AuthorParticipationBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, profile:observation, value:typeCode
.... entryRelationship:nonMedSupply 0..1EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:caregiverCharacteristics 0..1EntryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... observation 1..1CaregiverCharacteristicsBase for all types and resources
.... entryRelationship:assessmentScaleObservation 0..1EntryRelationship
..... @typeCode 1..1csFixed Value: COMP
..... observation 1..1AssessmentScaleObservationBase for all types and resources
... referenceRange 0..*InfrastructureRootreferenceRange could be used to represent normal or expected capability for the function being evaluated.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
1098-14234warningObservation.valueIf coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
: codeSystem.exists() implies codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningObservationSHOULD contain author
: author.exists()
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
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 C1..1ObservationXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:functional-status-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.67
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code 1..1CDBinding: ObservationType (example)
.... @code 1..1csRequired Pattern: 54522-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
... value C1..11098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueCO
.... 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 profile:supply, profile:observation, value:typeCode
.... entryRelationship:nonMedSupply 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:caregiverCharacteristics 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation C1..1CaregiverCharacteristicsBase for all types and resources
.... entryRelationship:assessmentScaleObservation 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... observation C1..1AssessmentScaleObservationBase for all types and resources
... referenceRange 0..*InfrastructureRootreferenceRange could be used to represent normal or expected capability for the function being evaluated.
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.statusCoderequiredActStatus
Observation.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:caregiverCharacteristics.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:assessmentScaleObservation.typeCoderequiredFixed Value: COMP

Constraints

IdGradePath(s)DetailsRequirements
1098-14234warningObservation.valueIf coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
: codeSystem.exists() implies codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningObservation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
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 C1..1ObservationXML 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
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:functional-status-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.67
..... @extension 1..1stRequired Pattern: 2014-06-09
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 1..*II
... code 1..1CDBinding: ObservationType (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 54522-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @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)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @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 1..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value C1..11098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
.... valueANY
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueCO
.... 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 (example)
... 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 profile:supply, profile:observation, value:typeCode
.... entryRelationship:nonMedSupply 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply C1..1NonMedicinalSupplyActivityBase for all types and resources
.... entryRelationship:caregiverCharacteristics 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..1CaregiverCharacteristicsBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:assessmentScaleObservation 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..1AssessmentScaleObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRootreferenceRange could be used to represent normal or expected capability for the function being evaluated.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:functional-status-obs.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codeexampleObservationType
Observation.code.nullFlavorrequiredCDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.entryRelationship:nonMedSupply.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:nonMedSupply.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:nonMedSupply.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:caregiverCharacteristics.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:caregiverCharacteristics.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:caregiverCharacteristics.typeCoderequiredFixed Value: REFR
Observation.entryRelationship:assessmentScaleObservation.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:assessmentScaleObservation.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:assessmentScaleObservation.typeCoderequiredFixed Value: COMP
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
1098-14234warningObservation.valueIf coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234).
: codeSystem.exists() implies codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningObservationSHOULD contain author
: author.exists()
should-effectiveTimewarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningObservation.entryRelationship:nonMedSupply.supplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningObservationSHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningObservation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
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: 11 elements (3 nested mandatory elements)
Fixed Value: 6 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 profile:supply, profile:observation, value:typeCode

 

Other representations of profile: CSV, Excel