MCC eCare Plan Implementation Guide
1.0.0-ballot2 - ballot United States of America flag

This page is part of the MCC eCare Plan Implementation Guide (v1.0.0-ballot2: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: Multiple Chronic Condition Care Plan Patient/Caregiver Condition Status Observation

Official URL: http://hl7.org/fhir/us/mcc/StructureDefinition/MCCPatientCaregiverConditionStatus Version: 1.0.0-ballot2
Active as of 2022-09-27 Computable Name: MCCPatientCaregiverConditionStatus

This profile constrains US Core Simple Observation for use in the MCC FHIR Care Plan or other FHIR Care Plans. It is using Observation resource to record, search, and fetch Observations of the Patient or Caregivers feelings towards the status of patient conditions. The focus is on the conditions of interest and the performer element indicates weather this is the Patient or Caregiver’s feelings. This is similar to a clinical impression but is being made by a non-clinican.

The US Core Simple Observation sets minimum expectations for the Observation resource to record, search, and fetch Observations of the Patient or Caregivers feelings towards the status of patient conditions. This is similar to a clinical impression but is being made by a non-clinician. It is a self or non-professional assessment of the status of the condition/observation and intentionally has different values than Condition.status value set. The profile identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. In addition to the requirements set forth in US Core Simple Observation this derived profile is designed to add requirements to the following elements:

  • MCCPatientCaregiverConditionStatus.extension:resource-pertainsToGoal (Must Support) to encourage linking to the goal to facilitate and/or to encourage systems to be able to receive and understand a goal linkage if present.
  • MCCPatientCaregiverConditionStatus.category requires LOINC code 81380-8 (Goals, preferences, and priorities for care experience)
  • MCCPatientCaregiverConditionStatus.code requires LOINC code 89253-9 (Trend)
  • MCCPatientCaregiverConditionStatus.focus is limited to us-core-condition-problems-health-concerns and us-core-condition-encounter-diagnosis and set to must support
  • MCCPatientCaregiverConditionStatus.performer is limited to Patient and RelatedPerson (caregiver)

Comments are welcome with respect to the pragmatic use of the “Must Support” rules defined on these elements.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreSimpleObservationProfileassessment observation
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainesToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... status S1..1code(USCDI) registered | preliminary | final | amended +
... code S1..1CodeableConceptObservation on patient/caregiver feelings on the condition status (what is the trend of the condition status?)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 89253-9
... subject S1..1Reference(US Core Patient Profile)(USCDI) Who and/or what the observation is about
... focus S1..*Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile)What the observation is about, when it is not about the subject of record
Slice: Unordered, Open by value:url
... effective[x] S0..1dateTime S, Period, Timing, instant(USCDI) Clinically relevant time/time-period for observation
... performer S1..*Reference(US Core Patient Profile | US Core RelatedPerson Profile)Represents the caregiver or patient who is making the observation on the condition’s trend
... value[x] S0..1Coded or narrative feeling about condition
.... valueCodeableConceptCodeableConcept
.... valueStringstring
... valueCodeableConcept S0..1CodeableConceptResponse for feeling about the condition
Binding: LOINC Answer List LL4938-8 (example): Use CodeableConcept.text for the exact words of the patient/caregiver, or when not using a coding. valueString is also available as an alternative to valueCodeableConcept.

.... text 0..1stringcan be used with or in place of code to provide a string representation
... dataAbsentReason S0..1CodeableConceptWhy the result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valueCodeableConceptexampleLOINC LL4938-8

Constraints

IdGradePath(s)DetailsRequirements
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreSimpleObservationProfileassessment observation
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainesToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... status ?!SΣ1..1code(USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category S1..*CodeableConcept(USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:us-core S0..*CodeableConcept(USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ1..1CodeableConceptObservation on patient/caregiver feelings on the condition status (what is the trend of the condition status?)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 89253-9
... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who and/or what the observation is about
... focus SΣ1..*Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile)What the observation is about, when it is not about the subject of record
Slice: Unordered, Open by value:url
... effective[x] SΣ0..1(USCDI) Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
... performer SΣ1..*Reference(US Core Patient Profile | US Core RelatedPerson Profile)Represents the caregiver or patient who is making the observation on the condition’s trend
... Slices for value[x] SΣC0..1Coded or narrative feeling about condition
Slice: Unordered, Open by type:$this
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... value[x]:valueCodeableConcept SΣC0..1CodeableConceptResponse for feeling about the condition
Binding: LOINC Answer List LL4938-8 (example): Use CodeableConcept.text for the exact words of the patient/caregiver, or when not using a coding. valueString is also available as an alternative to valueCodeableConcept.

... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:us-corerequiredUSCoreSimpleObservationCategory
Observation.codepreferredPattern: LOINC code 89253-9
Observation.value[x]:valueCodeableConceptexampleLOINC LL4938-8
Observation.dataAbsentReasonextensibleDataAbsentReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreSimpleObservationProfileassessment observation
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainesToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1code(USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category S1..*CodeableConcept(USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:us-core S0..*CodeableConcept(USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ1..1CodeableConceptObservation on patient/caregiver feelings on the condition status (what is the trend of the condition status?)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 89253-9
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who and/or what the observation is about
... focus SΣ1..*Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile)What the observation is about, when it is not about the subject of record
Slice: Unordered, Open by value:url
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣ0..1(USCDI) Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime S
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ1..*Reference(US Core Patient Profile | US Core RelatedPerson Profile)Represents the caregiver or patient who is making the observation on the condition’s trend
... Slices for value[x] SΣC0..1Coded or narrative feeling about condition
Slice: Unordered, Open by type:$this
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... value[x]:valueCodeableConcept SΣC0..1CodeableConceptResponse for feeling about the condition
Binding: LOINC Answer List LL4938-8 (example): Use CodeableConcept.text for the exact words of the patient/caregiver, or when not using a coding. valueString is also available as an alternative to valueCodeableConcept.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringcan be used with or in place of code to provide a string representation
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence)(USCDI) US Core Profiles or other resource the observation is made from
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:us-corerequiredUSCoreSimpleObservationCategory
Observation.codepreferredPattern: LOINC code 89253-9
Observation.value[x]:valueCodeableConceptexampleLOINC LL4938-8
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()

Differential View

This structure is derived from USCoreSimpleObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreSimpleObservationProfileassessment observation
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainesToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... status S1..1code(USCDI) registered | preliminary | final | amended +
... code S1..1CodeableConceptObservation on patient/caregiver feelings on the condition status (what is the trend of the condition status?)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 89253-9
... subject S1..1Reference(US Core Patient Profile)(USCDI) Who and/or what the observation is about
... focus S1..*Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile)What the observation is about, when it is not about the subject of record
Slice: Unordered, Open by value:url
... effective[x] S0..1dateTime S, Period, Timing, instant(USCDI) Clinically relevant time/time-period for observation
... performer S1..*Reference(US Core Patient Profile | US Core RelatedPerson Profile)Represents the caregiver or patient who is making the observation on the condition’s trend
... value[x] S0..1Coded or narrative feeling about condition
.... valueCodeableConceptCodeableConcept
.... valueStringstring
... valueCodeableConcept S0..1CodeableConceptResponse for feeling about the condition
Binding: LOINC Answer List LL4938-8 (example): Use CodeableConcept.text for the exact words of the patient/caregiver, or when not using a coding. valueString is also available as an alternative to valueCodeableConcept.

.... text 0..1stringcan be used with or in place of code to provide a string representation
... dataAbsentReason S0..1CodeableConceptWhy the result is missing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valueCodeableConceptexampleLOINC LL4938-8

Constraints

IdGradePath(s)DetailsRequirements
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreSimpleObservationProfileassessment observation
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainesToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... status ?!SΣ1..1code(USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category S1..*CodeableConcept(USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:us-core S0..*CodeableConcept(USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ1..1CodeableConceptObservation on patient/caregiver feelings on the condition status (what is the trend of the condition status?)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 89253-9
... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who and/or what the observation is about
... focus SΣ1..*Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile)What the observation is about, when it is not about the subject of record
Slice: Unordered, Open by value:url
... effective[x] SΣ0..1(USCDI) Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
... performer SΣ1..*Reference(US Core Patient Profile | US Core RelatedPerson Profile)Represents the caregiver or patient who is making the observation on the condition’s trend
... Slices for value[x] SΣC0..1Coded or narrative feeling about condition
Slice: Unordered, Open by type:$this
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... value[x]:valueCodeableConcept SΣC0..1CodeableConceptResponse for feeling about the condition
Binding: LOINC Answer List LL4938-8 (example): Use CodeableConcept.text for the exact words of the patient/caregiver, or when not using a coding. valueString is also available as an alternative to valueCodeableConcept.

... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:us-corerequiredUSCoreSimpleObservationCategory
Observation.codepreferredPattern: LOINC code 89253-9
Observation.value[x]:valueCodeableConceptexampleLOINC LL4938-8
Observation.dataAbsentReasonextensibleDataAbsentReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
us-core-2errorObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreSimpleObservationProfileassessment observation
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... resource-pertainesToGoal S0..*Reference(Goal)The resource-pertainsToGoal relates the resource to the goal(s) that pertain to it. Whenever there is a goal associated with a health concern or problem, this extension should be present and populated in activity (event or intent) resources.
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1code(USCDI) registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category S1..*CodeableConcept(USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:us-core S0..*CodeableConcept(USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


... code SΣ1..1CodeableConceptObservation on patient/caregiver feelings on the condition status (what is the trend of the condition status?)
Binding: LOINCCodes (preferred)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 89253-9
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Core Patient Profile)(USCDI) Who and/or what the observation is about
... focus SΣ1..*Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile)What the observation is about, when it is not about the subject of record
Slice: Unordered, Open by value:url
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣ0..1(USCDI) Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime S
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ1..*Reference(US Core Patient Profile | US Core RelatedPerson Profile)Represents the caregiver or patient who is making the observation on the condition’s trend
... Slices for value[x] SΣC0..1Coded or narrative feeling about condition
Slice: Unordered, Open by type:$this
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... value[x]:valueCodeableConcept SΣC0..1CodeableConceptResponse for feeling about the condition
Binding: LOINC Answer List LL4938-8 (example): Use CodeableConcept.text for the exact words of the patient/caregiver, or when not using a coding. valueString is also available as an alternative to valueCodeableConcept.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringcan be used with or in place of code to provide a string representation
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence)(USCDI) US Core Profiles or other resource the observation is made from
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:us-corerequiredUSCoreSimpleObservationCategory
Observation.codepreferredPattern: LOINC code 89253-9
Observation.value[x]:valueCodeableConceptexampleLOINC LL4938-8
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()

 

Other representations of profile: CSV, Excel, Schematron