This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/FunctionalStatusObservation | Version: 3.0.0 | |||
Draft as of 2024-05-18 | Computable Name: FunctionalStatusObservation | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 Instance 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 |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.67 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: OBS | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | Functional status | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: 54522-8 | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
![]() ![]() ![]() |
1..1 | CS | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
1..1 | IVL_TS | ||
![]() ![]() ![]() |
C | 1..1 | ANY, 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_PQ | 1098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234). |
![]() ![]() ![]() |
0..* | AuthorParticipation | Base for all types and resources | |
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, profile:observation, value:typeCode | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | NonMedicinalSupplyActivity | Base for all types and resources | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CaregiverCharacteristics | Base for all types and resources | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | (USCDI) Functional Status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AssessmentScaleObservation | Base for all types and resources | |
![]() ![]() ![]() |
0..* | InfrastructureRoot | referenceRange could be used to represent normal or expected capability for the function being evaluated. | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
1098-14234 | warning | Observation.value | If 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-author | warning | Observation | SHOULD contain author : author.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 Instance 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 |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.67 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() |
1..1 | cs | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
![]() ![]() ![]() |
1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | Functional status Binding: ObservationType (example) | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: 54522-8 | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
![]() ![]() ![]() |
1..1 | CS | Binding: ActStatus (required) | |
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
1..1 | IVL_TS | ||
![]() ![]() ![]() |
C | 1..1 | 1098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234). | |
![]() ![]() ![]() ![]() |
ANY | |||
![]() ![]() ![]() ![]() |
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_PQ | |||
![]() ![]() ![]() |
0..* | AuthorParticipation | Base for all types and resources | |
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, profile:observation, value:typeCode | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-quantity: SHOULD contain quantity |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | CaregiverCharacteristics | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | (USCDI) Functional Status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | AssessmentScaleObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
![]() ![]() ![]() |
0..* | InfrastructureRoot | referenceRange could be used to represent normal or expected capability for the function being evaluated. | |
![]() ![]() ![]() ![]() |
1..1 | ObservationRange | ||
![]() |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:caregiverCharacteristics.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:assessmentScaleObservation.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
Id | Grade | Path(s) | Details | Requirements |
1098-14234 | warning | Observation.value | If 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-author | warning | Observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-quantity | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-text-ref-value | warning | Observation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:functional-status-obs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.entryRelationship:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:caregiverCharacteristics.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:caregiverCharacteristics.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:caregiverCharacteristics.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:assessmentScaleObservation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:assessmentScaleObservation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:assessmentScaleObservation.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
1098-14234 | warning | Observation.value | If 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-author | warning | Observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-quantity | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-text-ref-value | warning | Observation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If 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: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 Instance 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 |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.67 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: OBS | |
![]() ![]() ![]() |
1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | Functional status | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: 54522-8 | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
![]() ![]() ![]() |
1..1 | CS | ||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
1..1 | IVL_TS | ||
![]() ![]() ![]() |
C | 1..1 | ANY, 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_PQ | 1098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234). |
![]() ![]() ![]() |
0..* | AuthorParticipation | Base for all types and resources | |
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, profile:observation, value:typeCode | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | NonMedicinalSupplyActivity | Base for all types and resources | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CaregiverCharacteristics | Base for all types and resources | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | (USCDI) Functional Status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AssessmentScaleObservation | Base for all types and resources | |
![]() ![]() ![]() |
0..* | InfrastructureRoot | referenceRange could be used to represent normal or expected capability for the function being evaluated. | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
1098-14234 | warning | Observation.value | If 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-author | warning | Observation | SHOULD contain author : author.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 Instance 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 |
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() |
1..1 | II | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.67 | |
![]() ![]() ![]() ![]() ![]() |
1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() |
1..1 | cs | Binding: CDAActClassObservation (required) Fixed Value: OBS | |
![]() ![]() ![]() |
1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) Fixed Value: EVN | |
![]() ![]() ![]() |
1..* | II | ||
![]() ![]() ![]() |
1..1 | CD | Functional status Binding: ObservationType (example) | |
![]() ![]() ![]() ![]() |
1..1 | cs | Required Pattern: 54522-8 | |
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |
![]() ![]() ![]() |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
![]() ![]() ![]() |
1..1 | CS | Binding: ActStatus (required) | |
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: completed | |
![]() ![]() ![]() |
1..1 | IVL_TS | ||
![]() ![]() ![]() |
C | 1..1 | 1098-14234: If coded, **SHOULD** contain a code from SNOMED CT (CodeSystem: 2.16.840.1.113883.6.96) (CONF:1098-14234). | |
![]() ![]() ![]() ![]() |
ANY | |||
![]() ![]() ![]() ![]() |
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_PQ | |||
![]() ![]() ![]() |
0..* | AuthorParticipation | Base for all types and resources | |
![]() ![]() ![]() |
0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, profile:observation, value:typeCode | |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-quantity: SHOULD contain quantity |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | CaregiverCharacteristics | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
![]() ![]() ![]() ![]() |
0..1 | EntryRelationship | (USCDI) Functional Status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | AssessmentScaleObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
![]() ![]() ![]() |
0..* | InfrastructureRoot | referenceRange could be used to represent normal or expected capability for the function being evaluated. | |
![]() ![]() ![]() ![]() |
1..1 | ObservationRange | ||
![]() |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:caregiverCharacteristics.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:assessmentScaleObservation.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
Id | Grade | Path(s) | Details | Requirements |
1098-14234 | warning | Observation.value | If 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-author | warning | Observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-quantity | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-text-ref-value | warning | Observation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:functional-status-obs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.entryRelationship:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:nonMedSupply.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:caregiverCharacteristics.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:caregiverCharacteristics.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:caregiverCharacteristics.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.entryRelationship:assessmentScaleObservation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:assessmentScaleObservation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship:assessmentScaleObservation.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
1098-14234 | warning | Observation.value | If 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-author | warning | Observation | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-quantity | warning | Observation.entryRelationship:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-text-ref-value | warning | Observation.entryRelationship:nonMedSupply.supply, Observation.entryRelationship:caregiverCharacteristics.observation, Observation.entryRelationship:assessmentScaleObservation.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If 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: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: