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

This page is part of the U.S. Physical Activity IG (v1.0.0: STU 1.0) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: PA Observation - Supporting, Time-based

Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-time-measure Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: PAObservationTimeMeasure

A profile for observations that capture physical activity-related measures that apply over an extended period, such as a day or week.

Used to capture observations in accordance with the codes, data types, and other constraints shown in the Time-based Measures section on the Measures page. These measures are primarily captured on a per/day basis, though resting heart rate may occur over a longer period of time.

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..*PAObservationBaseMeasurements and simple assertions
... code 1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Time-related codes (extensible)
... effective[x] 1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... value[x] 0..1QuantityActual result
... Slices for component 0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:percentActive S0..1BackboneElementComponent results
..... code 1..1CodeableConceptType of component observation (code / type)
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: DeviceActivePercentage
..... value[x] 0..1QuantityActual component result
...... value S1..1decimalNumerical value (with implicit precision)
...... system 0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 0..1codeCoded form of the unit
Required Pattern: %

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codeextensiblePAObservationTimeMeasures
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*PAObservationBaseMeasurements and simple assertions
... 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 Time-related codes (extensible)
... Slices for effective[x] SΣ1..1Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
.... effective[x]:effectivePeriod Σ0..1PeriodClinically relevant time/time-period for observation
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
... performer SΣ0..*Reference(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)
..... 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..1Reference(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 component Σ0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... 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.

.... component:percentActive SΣ0..1BackboneElementComponent results
..... 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.


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: DeviceActivePercentage
..... value[x] Σ0..1QuantityActual component result
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... system ΣC0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
Required Pattern: %

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codeextensiblePAObservationTimeMeasures
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component:percentActive.codeexamplePattern: DeviceActivePercentage
Observation.component:percentActive.value[x].comparatorrequiredQuantityComparator

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()
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..*PAObservationBaseMeasurements and simple assertions
... 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 Time-related codes (extensible)
... subject SΣ1..1Reference(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..1Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effectiveDateTimedateTime S
.... effectivePeriodPeriod S
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
.... effective[x]:effectivePeriod Σ0..1PeriodClinically relevant time/time-period for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(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)
..... 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..1Reference(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
.... 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(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component Σ0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... 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
.... component:percentActive SΣ0..1BackboneElementComponent 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.


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: DeviceActivePercentage
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1QuantityActual component result
...... 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)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣC0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
Required Pattern: %
..... 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:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codeextensiblePAObservationTimeMeasures
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
Observation.component:percentActive.codeexamplePattern: DeviceActivePercentage
Observation.component:percentActive.value[x].comparatorrequiredQuantityComparator
Observation.component:percentActive.dataAbsentReasonextensibleDataAbsentReason
Observation.component:percentActive.interpretationextensibleObservationInterpretationCodes

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

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 2 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the value of pattern:code

Maturity: 2

Differential View

This structure is derived from PAObservationBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*PAObservationBaseMeasurements and simple assertions
... code 1..1CodeableConceptType of observation (code / type)
Binding: PA Observation Time-related codes (extensible)
... effective[x] 1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... value[x] 0..1QuantityActual result
... Slices for component 0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:percentActive S0..1BackboneElementComponent results
..... code 1..1CodeableConceptType of component observation (code / type)
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: DeviceActivePercentage
..... value[x] 0..1QuantityActual component result
...... value S1..1decimalNumerical value (with implicit precision)
...... system 0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code 0..1codeCoded form of the unit
Required Pattern: %

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codeextensiblePAObservationTimeMeasures

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*PAObservationBaseMeasurements and simple assertions
... 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 Time-related codes (extensible)
... Slices for effective[x] SΣ1..1Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
.... effective[x]:effectivePeriod Σ0..1PeriodClinically relevant time/time-period for observation
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
... performer SΣ0..*Reference(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)
..... 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..1Reference(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 component Σ0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... 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.

.... component:percentActive SΣ0..1BackboneElementComponent results
..... 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.


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: DeviceActivePercentage
..... value[x] Σ0..1QuantityActual component result
...... value SΣ1..1decimalNumerical value (with implicit precision)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... system ΣC0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
Required Pattern: %

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codeextensiblePAObservationTimeMeasures
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component:percentActive.codeexamplePattern: DeviceActivePercentage
Observation.component:percentActive.value[x].comparatorrequiredQuantityComparator

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()
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..*PAObservationBaseMeasurements and simple assertions
... 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 Time-related codes (extensible)
... subject SΣ1..1Reference(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..1Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effectiveDateTimedateTime S
.... effectivePeriodPeriod S
.... effective[x]:effectiveDateTime Σ0..1dateTimeClinically relevant time/time-period for observation
.... effective[x]:effectivePeriod Σ0..1PeriodClinically relevant time/time-period for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC1..1dateTimeStarting time with inclusive boundary
..... end SΣC1..1dateTimeEnd time with inclusive boundary, if not ongoing
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(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)
..... 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..1Reference(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
.... 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(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... Slices for component Σ0..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:All Slices Content/Rules for all slices
..... 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
.... component:percentActive SΣ0..1BackboneElementComponent 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.


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: DeviceActivePercentage
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1QuantityActual component result
...... 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)
...... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ0..1stringUnit representation
...... system ΣC0..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
...... code Σ0..1codeCoded form of the unit
Required Pattern: %
..... 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:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codeextensiblePAObservationTimeMeasures
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
Observation.component:percentActive.codeexamplePattern: DeviceActivePercentage
Observation.component:percentActive.value[x].comparatorrequiredQuantityComparator
Observation.component:percentActive.dataAbsentReasonextensibleDataAbsentReason
Observation.component:percentActive.interpretationextensibleObservationInterpretationCodes

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

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 2 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element Observation.component is sliced based on the value of pattern:code

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron