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 Base ( Abstract )

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

A profile describing base requirements for all primary physical activity observations.

This generic profile sets the common expectations that will be inherited by all of the observation profiles in this IG. It is not intended to be implemented directly.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation
Measurements and simple assertions
... implicitRules 0..0
... modifierExtension 0..0
... status S1..1codefinal | amended | corrected | entered-in-error
Binding: ObservationStatus (required)
.... category:Activity S1..1CodeableConceptActivity (Required for U.S. Core)
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
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 S1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (preferred)
... subject S1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus 0..0
... Slices for effective[x] S1..1Clinically relevant time/time-period for observation
Slice: Unordered, Open 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 S1..1dateTimeStarting time with inclusive boundary
..... end S1..1dateTimeEnd time with inclusive boundary, if not ongoing
... performer S0..*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] S0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... value[x]:valueCodeableConcept 0..1CodeableConceptActual result
.... value[x]:valueQuantity 0..1SimpleQuantityA fixed quantity (no comparator)
..... value S1..1decimalNumerical value (with implicit precision)
..... system 1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
... note S0..*AnnotationComments about the observation
.... author[x] S1..1Reference(Practitioner S | Patient S | RelatedPerson)Individual responsible for the annotation
.... time S1..1dateTimeWhen the annotation was made
.... text S1..1markdownThe annotation - text content (as markdown)
... specimen 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.statusrequiredObservationStatus
Observation.codepreferredLOINCCodes (a valid code from LOINC)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation
Measurements 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: LOINCCodes (preferred)
... 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..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptActual result
.... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codepreferredLOINCCodes (a valid code from LOINC)

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..*ObservationThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation
Measurements 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: LOINCCodes (preferred)
... 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
.... effectivePeriodPeriod
.... 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..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptActual result
.... 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
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

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

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codepreferredLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
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 Observation

Summary

Mandatory: 4 elements (7 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:$this
  • The element Observation.effective[x] is sliced based on the value of type:$this
  • The element Observation.value[x] is sliced based on the value of type:$this

Maturity: 2

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation
Measurements and simple assertions
... implicitRules 0..0
... modifierExtension 0..0
... status S1..1codefinal | amended | corrected | entered-in-error
Binding: ObservationStatus (required)
.... category:Activity S1..1CodeableConceptActivity (Required for U.S. Core)
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
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 S1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (preferred)
... subject S1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus 0..0
... Slices for effective[x] S1..1Clinically relevant time/time-period for observation
Slice: Unordered, Open 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 S1..1dateTimeStarting time with inclusive boundary
..... end S1..1dateTimeEnd time with inclusive boundary, if not ongoing
... performer S0..*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] S0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... value[x]:valueCodeableConcept 0..1CodeableConceptActual result
.... value[x]:valueQuantity 0..1SimpleQuantityA fixed quantity (no comparator)
..... value S1..1decimalNumerical value (with implicit precision)
..... system 1..1uriSystem that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
... note S0..*AnnotationComments about the observation
.... author[x] S1..1Reference(Practitioner S | Patient S | RelatedPerson)Individual responsible for the annotation
.... time S1..1dateTimeWhen the annotation was made
.... text S1..1markdownThe annotation - text content (as markdown)
... specimen 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.statusrequiredObservationStatus
Observation.codepreferredLOINCCodes (a valid code from LOINC)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation
Measurements 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: LOINCCodes (preferred)
... 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..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptActual result
.... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codepreferredLOINCCodes (a valid code from LOINC)

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..*ObservationThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation
Measurements 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: LOINCCodes (preferred)
... 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
.... effectivePeriodPeriod
.... 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..1Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... value[x]:valueCodeableConcept ΣC0..1CodeableConceptActual result
.... 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
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

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

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:ActivitypreferredPattern: activity
Observation.category:PhysicalActivitypreferredPattern: PhysicalActivity
Observation.codepreferredLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
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 Observation

Summary

Mandatory: 4 elements (7 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:$this
  • The element Observation.effective[x] is sliced based on the value of type:$this
  • The element Observation.value[x] is sliced based on the value of type:$this

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron