Physical Activity Implementation Guide
1.0.1 - STU Release 1 United States of America flag

Physical Activity Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/physical-activity/ and changes regularly. See the Directory of published versions

Resource Profile: PA Observation EVS Base ( Abstract )

Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs Version: 1.0.1
Standards status: Trial-use Maturity Level: 2 Computable Name: PAObservationEVS

A generic profile that encapsulates all the physical activity vital sign observations.

This profile defines the common characteristics of all of the "exercise vital sign" observations used as the base measures of a patient's physical activity level. It is not intended to be implemented directly. Please note that the term "exercise vital sign" refers to observations related to physical activity and is not equivalent to traditional vital signs.

Usage:

Formal Views of Profile Content

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

This structure is derived from PAObservationBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*PAObservationBaseThis is an abstract profile. Child profiles: PAObservationEVSDaysPerWeek, PAObservationEVSMinutesPerDay, PAObservationEVSMinutesPerWeek, PAObservationStrengthDaysPerWeek
Measurements and simple assertions
... code 1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Vital Sign Codes (required)
... effective[x] 1..1dateTimeClinically relevant time/time-period for observation
... effective[x]:effectivePeriod 0..0
... value[x]:valueCodeableConcept 0..0
... Slices for derivedFrom 0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:supportingObs S0..*Reference(PA Observation Base)Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredPAObservationCodeEVS
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-observation-code-evs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*PAObservationBaseThis is an abstract profile. Child profiles: PAObservationEVSDaysPerWeek, PAObservationEVSMinutesPerDay, PAObservationEVSMinutesPerWeek, PAObservationStrengthDaysPerWeek
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... status ?!SΣ1..1codefinal | amended | corrected | entered-in-error
Binding: ObservationStatus (required)
... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Activity S1..1CodeableConceptActivity (Required for U.S. Core)
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: activity
.... category:PhysicalActivity S1..1CodeableConceptPhysical Activity
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PhysicalActivity
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Vital Sign Codes (required)
... Slices for effective[x] SΣ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
... performer SΣ0..*ReferenceRestOrLogical(US Core Patient Profile | US Core Practitioner Profile)Who is responsible for the observation
... Slices for value[x] SΣC0..1QuantityActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity C0..1SimpleQuantityA fixed quantity (no comparator)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... system ΣC1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
... note S0..*AnnotationComments about the observation
.... author[x] SΣ1..1ReferenceRestOrLogical(Practitioner | Patient)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... Slices for derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:supportingObs SΣ0..*Reference(PA Observation Base)Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ActivitypreferredPattern: activity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.coderequiredPAObservationCodeEVS
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-observation-code-evs
from this IG

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())
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()
qty-3errorObservation.value[x]:valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorObservation.value[x]:valueQuantityThe comparator is not used on a SimpleQuantity
: comparator.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*PAObservationBaseThis is an abstract profile. Child profiles: PAObservationEVSDaysPerWeek, PAObservationEVSMinutesPerDay, PAObservationEVSMinutesPerWeek, PAObservationStrengthDaysPerWeek
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... 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..1codefinal | amended | corrected | entered-in-error
Binding: ObservationStatus (required)
... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Activity S1..1CodeableConceptActivity (Required for U.S. Core)
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: activity
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:PhysicalActivity S1..1CodeableConceptPhysical Activity
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PhysicalActivity
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Vital Sign Codes (required)
... subject SΣ1..1ReferenceRest(US Core Patient Profile)Who and/or what the observation is about
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... Slices for effective[x] SΣ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*ReferenceRestOrLogical(US Core Patient Profile S | US Core Practitioner Profile S | US Core PractitionerRole Profile | RelatedPerson)Who is responsible for the observation
... Slices for value[x] SΣC0..1QuantityActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity C0..1SimpleQuantityA fixed quantity (no comparator)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... unit Σ0..1stringUnit representation
..... system ΣC1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
... dataAbsentReason C0..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 S0..*AnnotationComments about the observation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] SΣ1..1ReferenceRestOrLogical(Practitioner S | Patient S | RelatedPerson)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... 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.

... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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
... Slices for derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:supportingObs SΣ0..*Reference(PA Observation Base)Related measurements 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 / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ActivitypreferredPattern: activity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.coderequiredPAObservationCodeEVS
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-observation-code-evs
from this IG
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

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-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.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()
qty-3errorObservation.value[x]:valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorObservation.value[x]:valueQuantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from PAObservationBase

Summary

Must-Support: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.derivedFrom is sliced based on the value of profile:resolve()

Maturity: 2

Differential View

This structure is derived from PAObservationBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*PAObservationBaseThis is an abstract profile. Child profiles: PAObservationEVSDaysPerWeek, PAObservationEVSMinutesPerDay, PAObservationEVSMinutesPerWeek, PAObservationStrengthDaysPerWeek
Measurements and simple assertions
... code 1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Vital Sign Codes (required)
... effective[x] 1..1dateTimeClinically relevant time/time-period for observation
... effective[x]:effectivePeriod 0..0
... value[x]:valueCodeableConcept 0..0
... Slices for derivedFrom 0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:supportingObs S0..*Reference(PA Observation Base)Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredPAObservationCodeEVS
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-observation-code-evs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*PAObservationBaseThis is an abstract profile. Child profiles: PAObservationEVSDaysPerWeek, PAObservationEVSMinutesPerDay, PAObservationEVSMinutesPerWeek, PAObservationStrengthDaysPerWeek
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... status ?!SΣ1..1codefinal | amended | corrected | entered-in-error
Binding: ObservationStatus (required)
... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Activity S1..1CodeableConceptActivity (Required for U.S. Core)
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: activity
.... category:PhysicalActivity S1..1CodeableConceptPhysical Activity
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PhysicalActivity
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Vital Sign Codes (required)
... Slices for effective[x] SΣ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
... performer SΣ0..*ReferenceRestOrLogical(US Core Patient Profile | US Core Practitioner Profile)Who is responsible for the observation
... Slices for value[x] SΣC0..1QuantityActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity C0..1SimpleQuantityA fixed quantity (no comparator)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... system ΣC1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
... note S0..*AnnotationComments about the observation
.... author[x] SΣ1..1ReferenceRestOrLogical(Practitioner | Patient)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... Slices for derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:supportingObs SΣ0..*Reference(PA Observation Base)Related measurements the observation is made from

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ActivitypreferredPattern: activity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.coderequiredPAObservationCodeEVS
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-observation-code-evs
from this IG

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())
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()
qty-3errorObservation.value[x]:valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorObservation.value[x]:valueQuantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*PAObservationBaseThis is an abstract profile. Child profiles: PAObservationEVSDaysPerWeek, PAObservationEVSMinutesPerDay, PAObservationEVSMinutesPerWeek, PAObservationStrengthDaysPerWeek
Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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
... extension 0..*ExtensionAdditional content defined by implementations
... 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..1codefinal | amended | corrected | entered-in-error
Binding: ObservationStatus (required)
... Slices for category 2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Activity S1..1CodeableConceptActivity (Required for U.S. Core)
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: activity
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:PhysicalActivity S1..1CodeableConceptPhysical Activity
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



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://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: PhysicalActivity
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Vital Sign Codes (required)
... subject SΣ1..1ReferenceRest(US Core Patient Profile)Who and/or what the observation is about
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... Slices for effective[x] SΣ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*ReferenceRestOrLogical(US Core Patient Profile S | US Core Practitioner Profile S | US Core PractitionerRole Profile | RelatedPerson)Who is responsible for the observation
... Slices for value[x] SΣC0..1QuantityActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity C0..1SimpleQuantityA fixed quantity (no comparator)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... unit Σ0..1stringUnit representation
..... system ΣC1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
... dataAbsentReason C0..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 S0..*AnnotationComments about the observation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] SΣ1..1ReferenceRestOrLogical(Practitioner S | Patient S | RelatedPerson)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... 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.

... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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
... Slices for derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
Slice: Unordered, Open by profile:resolve()
.... derivedFrom:supportingObs SΣ0..*Reference(PA Observation Base)Related measurements 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 / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ActivitypreferredPattern: activity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.coderequiredPAObservationCodeEVS
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-observation-code-evs
from this IG
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

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-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.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()
qty-3errorObservation.value[x]:valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorObservation.value[x]:valueQuantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from PAObservationBase

Summary

Must-Support: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.derivedFrom is sliced based on the value of profile:resolve()

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron