PreNUDGE FHIR® IG for Data Provider / Data from Apps (R4)
0.1.0 - ci-build
PreNUDGE FHIR® IG for Data Provider / Data from Apps (R4)
0.1.0 - ci-build
PreNUDGE FHIR® IG for Data Provider / Data from Apps (R4) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.hl7.at/prenudge/appdata/r4/StructureDefinition/at-prenudge-physical-activity-minutes-observation | Version: 0.1.0 | |||
| Draft as of 2026-10-21 | Responsible: The PreNUDGE Consortium | Computable Name: AtPrenudgeObservationPhysicalActivity | ||
Observation profile for recording physical activity duration as a panel (moderate, vigorous, and two alternative aggregate components) derived from either a wearable device or the EHIS-PAQ/ATHIS questionnaire (Q7/PE7).
Two aggregate flavors may be sent independently of each other:
Both, either, or neither aggregate MAY be present; pa-panel-01 only requires that at least one component (of any kind) exists. Sending only an aggregate (without moderateActivity/vigorousActivity) is valid and expected whenever the source cannot distinguish intensity levels at all (e.g. a single questionnaire total). However, whenever a source CAN distinguish moderate from vigorous activity, it SHOULD send moderateActivity and vigorousActivity individually (in addition to any aggregate) — sending only a pre-computed aggregate discards information a consumer might need. This cannot be enforced by an invariant (an instance cannot express "the source could have distinguished this but chose not to"), so it is stated here as implementation guidance rather than a machine-checkable rule.
Example component combinations (not exhaustive): (a) aggregateActivity only — questionnaire source, no intensity split (Q7/PE7) (b) moderate only — manual source; vigorous implicitly 0, aggregates SHOULD equal moderateActivity (pa-agg-01/pa-agg-02 warning if absent) (c) moderate + aggregateActivityWeighted — partial wearable or manual source (d) vigorous + aggregateActivityWeighted — partial wearable source (e) moderate + vigorous + aggregateActivityWeighted — full wearable source (g) moderate + vigorous + aggregateActivity + aggregateActivityWeighted — full wearable source reporting both aggregate flavors side by side
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Observation |
C | 0..* | AtPrenudgeObservation | AT APS Observation Constraints: obs-6, obs-7, at-prenudge-result-present, pa-panel-01, pa-agg-01, pa-agg-02, pa-wearable-01, pa-manual-comp-01 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  identifier |
1..* | Identifier | Business Identifier for observation, at least one is assigned by the data provider | |
 use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value, if no other specifications are given, use your website url Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
 Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  effective[x]:effectiveDateTime |
1..1 | dateTime | The mandatory clinically relevant time for observation | |
| issued |
1..1 | instant | The mandatory date/time this version was made available | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| note |
0..* | Annotation | Comments about the observation including patient comments have to be possible | |
| method |
1..1 | CodeableConcept | How it was done Binding: AT PreNUDGE Observation Methods (required) | |
 device |
0..1 | Reference(AT APS Device | DeviceMetric) | (Measurement) Devices should be documented when used | |
 Slices for component |
0..* | BackboneElement | Physical activity duration components Slice: Unordered, Open by pattern:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   component:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:moderateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
 value[x] |
0..1 | Quantity | Actual component result | |
 comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
 dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:vigorousActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:aggregateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:aggregateActivityWeighted |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
 component:classificationMethod |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | CodeableConcept | Actual component result Binding: AT PreNUDGE Physical Activity Classification Method ValueSet (required) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | required | AT PreNUDGE Observation Methods | 📦0.1.0 | This IG |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.value[x] | Base | required | AT PreNUDGE Physical Activity Classification Method ValueSet | 📦0.1.0 | This IG |
| Observation.component:classificationMethod.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| at-prenudge-result-present | error | Observation | A PreNUDGE Observation must contain a root result, a root data absent reason, or at least one component result or component data absent reason. |
value.exists() or dataAbsentReason.exists() or component.where(value.exists() or dataAbsentReason.exists()).exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
| pa-agg-01 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivityWeighted SHOULD equal moderateActivity (or 0) + (vigorousActivity × 2, or 0) |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '68130003').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ (iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0) * 2)
|
| pa-agg-02 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivity SHOULD equal moderateActivity (or 0) + vigorousActivity (or 0), with no intensity weighting |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '101691-4').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0)
|
| pa-manual-comp-01 | warning | Observation | When method is Manual, classificationMethod component must be absent or carry only code self-rp |
method.coding.exists(system = 'http://snomed.info/sct' and code = '87982008')
implies (
component.where(code.coding.where(code = '246501002').exists()).empty()
or component.where(code.coding.where(code = '246501002').exists())
.value.ofType(CodeableConcept).coding.where(code = 'self-rp').exists()
)
|
| pa-panel-01 | error | Observation | At least one activity component must be present |
component.exists()
|
| pa-wearable-01 | error | Observation | When method is Automated, aggregateActivityWeighted must be present |
method.coding.exists(system = 'http://snomed.info/sct' and code = '8359006') implies component.where(code.coding.where(code = '68130003').exists()).exists()
|
This structure is derived from AtPrenudgeObservation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | AtPrenudgeObservation | AT APS Observation Constraints: pa-panel-01, pa-agg-01, pa-agg-02, pa-wearable-01, pa-manual-comp-01 |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: | |
| method |
1..1 | CodeableConcept | How it was done | |
| Slices for component |
0..* | BackboneElement | Physical activity duration components Slice: Unordered, Open by pattern:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| component:moderateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
 value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:vigorousActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:aggregateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:aggregateActivityWeighted |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:classificationMethod |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | CodeableConcept | Actual component result Binding: AT PreNUDGE Physical Activity Classification Method ValueSet (required) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.component:classificationMethod.value[x] | Base | required | AT PreNUDGE Physical Activity Classification Method ValueSet | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| pa-agg-01 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivityWeighted SHOULD equal moderateActivity (or 0) + (vigorousActivity × 2, or 0) |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '68130003').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ (iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0) * 2)
|
| pa-agg-02 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivity SHOULD equal moderateActivity (or 0) + vigorousActivity (or 0), with no intensity weighting |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '101691-4').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0)
|
| pa-manual-comp-01 | warning | Observation | When method is Manual, classificationMethod component must be absent or carry only code self-rp |
method.coding.exists(system = 'http://snomed.info/sct' and code = '87982008')
implies (
component.where(code.coding.where(code = '246501002').exists()).empty()
or component.where(code.coding.where(code = '246501002').exists())
.value.ofType(CodeableConcept).coding.where(code = 'self-rp').exists()
)
|
| pa-panel-01 | error | Observation | At least one activity component must be present |
component.exists()
|
| pa-wearable-01 | error | Observation | When method is Automated, aggregateActivityWeighted must be present |
method.coding.exists(system = 'http://snomed.info/sct' and code = '8359006') implies component.where(code.coding.where(code = '68130003').exists()).exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AtPrenudgeObservation | AT APS Observation Constraints: obs-6, obs-7, at-prenudge-result-present, pa-panel-01, pa-agg-01, pa-agg-02, pa-wearable-01, pa-manual-comp-01 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Business Identifier for observation, at least one is assigned by the data provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value, if no other specifications are given, use your website url Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| basedOn |
0..* | Reference(AT APS CarePlan | DeviceRequest | ImmunizationRecommendation | AT APS MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||
| partOf |
0..* | Reference(AT APS MedicationAdministration | AT APS MedicationDispense | AT APS MedicationStatement | AT APS Procedure | AT APS Immunization | AT APS ImagingStudy) | Part of referenced event | |||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||
| category |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| subject |
0..1 | Reference(AT APS Patient | Group | AT APS Device | Location) | Who and/or what the observation is about | |||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| effective[x]:effectiveDateTime |
1..1 | dateTime | The mandatory clinically relevant time for observation | |||||
| issued |
1..1 | instant | The mandatory date/time this version was made available | |||||
| performer |
0..* | Reference(AT APS Practitioner | AT APS PractitionerRole | AT APS Organization | CareTeam | AT APS Patient | RelatedPerson) | Who is responsible for the observation | |||||
 value[x] |
C | 0..1 | Actual result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation including patient comments have to be possible | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
1..1 | CodeableConcept | How it was done Binding: AT PreNUDGE Observation Methods (required) | |||||
| specimen |
0..1 | Reference(AT APS Specimen) | Specimen used for this observation | |||||
| device |
0..1 | Reference(AT APS Device | DeviceMetric) | (Measurement) Devices should be documented when used | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
0..* | Reference(AT APS Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||
| derivedFrom |
0..* | Reference(AT APS DocumentReference | AT APS ImagingStudy | Media | QuestionnaireResponse | AT APS Observation | MolecularSequence) | Related measurements the observation is made from | |||||
| Slices for component |
0..* | BackboneElement | Physical activity duration components Slice: Unordered, Open by pattern:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| component:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
| value[x] |
0..1 | Actual component result | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:moderateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:vigorousActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:aggregateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:aggregateActivityWeighted |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:classificationMethod |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | CodeableConcept | Actual component result Binding: AT PreNUDGE Physical Activity Classification Method ValueSet (required) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | required | AT PreNUDGE Observation Methods | 📦0.1.0 | This IG |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.value[x] | Base | required | AT PreNUDGE Physical Activity Classification Method ValueSet | 📦0.1.0 | This IG |
| Observation.component:classificationMethod.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| at-prenudge-result-present | error | Observation | A PreNUDGE Observation must contain a root result, a root data absent reason, or at least one component result or component data absent reason. |
value.exists() or dataAbsentReason.exists() or component.where(value.exists() or dataAbsentReason.exists()).exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
| pa-agg-01 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivityWeighted SHOULD equal moderateActivity (or 0) + (vigorousActivity × 2, or 0) |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '68130003').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ (iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0) * 2)
|
| pa-agg-02 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivity SHOULD equal moderateActivity (or 0) + vigorousActivity (or 0), with no intensity weighting |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '101691-4').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0)
|
| pa-manual-comp-01 | warning | Observation | When method is Manual, classificationMethod component must be absent or carry only code self-rp |
method.coding.exists(system = 'http://snomed.info/sct' and code = '87982008')
implies (
component.where(code.coding.where(code = '246501002').exists()).empty()
or component.where(code.coding.where(code = '246501002').exists())
.value.ofType(CodeableConcept).coding.where(code = 'self-rp').exists()
)
|
| pa-panel-01 | error | Observation | At least one activity component must be present |
component.exists()
|
| pa-wearable-01 | error | Observation | When method is Automated, aggregateActivityWeighted must be present |
method.coding.exists(system = 'http://snomed.info/sct' and code = '8359006') implies component.where(code.coding.where(code = '68130003').exists()).exists()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AtPrenudgeObservation
Summary
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | AtPrenudgeObservation | AT APS Observation Constraints: obs-6, obs-7, at-prenudge-result-present, pa-panel-01, pa-agg-01, pa-agg-02, pa-wearable-01, pa-manual-comp-01 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..* | Identifier | Business Identifier for observation, at least one is assigned by the data provider | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value, if no other specifications are given, use your website url Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| effective[x]:effectiveDateTime |
1..1 | dateTime | The mandatory clinically relevant time for observation | |
| issued |
1..1 | instant | The mandatory date/time this version was made available | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| note |
0..* | Annotation | Comments about the observation including patient comments have to be possible | |
| method |
1..1 | CodeableConcept | How it was done Binding: AT PreNUDGE Observation Methods (required) | |
| device |
0..1 | Reference(AT APS Device | DeviceMetric) | (Measurement) Devices should be documented when used | |
| Slices for component |
0..* | BackboneElement | Physical activity duration components Slice: Unordered, Open by pattern:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| component:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:moderateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:vigorousActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:aggregateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:aggregateActivityWeighted |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:classificationMethod |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |
| value[x] |
0..1 | CodeableConcept | Actual component result Binding: AT PreNUDGE Physical Activity Classification Method ValueSet (required) | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | required | AT PreNUDGE Observation Methods | 📦0.1.0 | This IG |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.value[x] | Base | required | AT PreNUDGE Physical Activity Classification Method ValueSet | 📦0.1.0 | This IG |
| Observation.component:classificationMethod.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| at-prenudge-result-present | error | Observation | A PreNUDGE Observation must contain a root result, a root data absent reason, or at least one component result or component data absent reason. |
value.exists() or dataAbsentReason.exists() or component.where(value.exists() or dataAbsentReason.exists()).exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
| pa-agg-01 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivityWeighted SHOULD equal moderateActivity (or 0) + (vigorousActivity × 2, or 0) |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '68130003').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ (iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0) * 2)
|
| pa-agg-02 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivity SHOULD equal moderateActivity (or 0) + vigorousActivity (or 0), with no intensity weighting |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '101691-4').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0)
|
| pa-manual-comp-01 | warning | Observation | When method is Manual, classificationMethod component must be absent or carry only code self-rp |
method.coding.exists(system = 'http://snomed.info/sct' and code = '87982008')
implies (
component.where(code.coding.where(code = '246501002').exists()).empty()
or component.where(code.coding.where(code = '246501002').exists())
.value.ofType(CodeableConcept).coding.where(code = 'self-rp').exists()
)
|
| pa-panel-01 | error | Observation | At least one activity component must be present |
component.exists()
|
| pa-wearable-01 | error | Observation | When method is Automated, aggregateActivityWeighted must be present |
method.coding.exists(system = 'http://snomed.info/sct' and code = '8359006') implies component.where(code.coding.where(code = '68130003').exists()).exists()
|
Differential View
This structure is derived from AtPrenudgeObservation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | AtPrenudgeObservation | AT APS Observation Constraints: pa-panel-01, pa-agg-01, pa-agg-02, pa-wearable-01, pa-manual-comp-01 |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: | |
| method |
1..1 | CodeableConcept | How it was done | |
| Slices for component |
0..* | BackboneElement | Physical activity duration components Slice: Unordered, Open by pattern:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| component:moderateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:vigorousActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:aggregateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:aggregateActivityWeighted |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | Quantity | Actual component result | |
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |
| system |
0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | |
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |
| component:classificationMethod |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: | |
| value[x] |
0..1 | CodeableConcept | Actual component result Binding: AT PreNUDGE Physical Activity Classification Method ValueSet (required) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.component:classificationMethod.value[x] | Base | required | AT PreNUDGE Physical Activity Classification Method ValueSet | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| pa-agg-01 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivityWeighted SHOULD equal moderateActivity (or 0) + (vigorousActivity × 2, or 0) |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '68130003').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ (iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0) * 2)
|
| pa-agg-02 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivity SHOULD equal moderateActivity (or 0) + vigorousActivity (or 0), with no intensity weighting |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '101691-4').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0)
|
| pa-manual-comp-01 | warning | Observation | When method is Manual, classificationMethod component must be absent or carry only code self-rp |
method.coding.exists(system = 'http://snomed.info/sct' and code = '87982008')
implies (
component.where(code.coding.where(code = '246501002').exists()).empty()
or component.where(code.coding.where(code = '246501002').exists())
.value.ofType(CodeableConcept).coding.where(code = 'self-rp').exists()
)
|
| pa-panel-01 | error | Observation | At least one activity component must be present |
component.exists()
|
| pa-wearable-01 | error | Observation | When method is Automated, aggregateActivityWeighted must be present |
method.coding.exists(system = 'http://snomed.info/sct' and code = '8359006') implies component.where(code.coding.where(code = '68130003').exists()).exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | AtPrenudgeObservation | AT APS Observation Constraints: obs-6, obs-7, at-prenudge-result-present, pa-panel-01, pa-agg-01, pa-agg-02, pa-wearable-01, pa-manual-comp-01 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..* | Identifier | Business Identifier for observation, at least one is assigned by the data provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value, if no other specifications are given, use your website url Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| basedOn |
0..* | Reference(AT APS CarePlan | DeviceRequest | ImmunizationRecommendation | AT APS MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||
| partOf |
0..* | Reference(AT APS MedicationAdministration | AT APS MedicationDispense | AT APS MedicationStatement | AT APS Procedure | AT APS Immunization | AT APS ImagingStudy) | Part of referenced event | |||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||
| category |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| subject |
0..1 | Reference(AT APS Patient | Group | AT APS Device | Location) | Who and/or what the observation is about | |||||
| focus |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| effective[x]:effectiveDateTime |
1..1 | dateTime | The mandatory clinically relevant time for observation | |||||
| issued |
1..1 | instant | The mandatory date/time this version was made available | |||||
| performer |
0..* | Reference(AT APS Practitioner | AT APS PractitionerRole | AT APS Organization | CareTeam | AT APS Patient | RelatedPerson) | Who is responsible for the observation | |||||
| value[x] |
C | 0..1 | Actual result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation including patient comments have to be possible | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
1..1 | CodeableConcept | How it was done Binding: AT PreNUDGE Observation Methods (required) | |||||
| specimen |
0..1 | Reference(AT APS Specimen) | Specimen used for this observation | |||||
| device |
0..1 | Reference(AT APS Device | DeviceMetric) | (Measurement) Devices should be documented when used | |||||
| referenceRange |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| low |
C | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||
| type |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age |
0..1 | Range | Applicable age range, if relevant | |||||
| text |
0..1 | string | Text based reference range in an observation | |||||
| hasMember |
0..* | Reference(AT APS Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||
| derivedFrom |
0..* | Reference(AT APS DocumentReference | AT APS ImagingStudy | Media | QuestionnaireResponse | AT APS Observation | MolecularSequence) | Related measurements the observation is made from | |||||
| Slices for component |
0..* | BackboneElement | Physical activity duration components Slice: Unordered, Open by pattern:code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| component:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
| value[x] |
0..1 | Actual component result | ||||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:moderateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:vigorousActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:aggregateActivity |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:aggregateActivityWeighted |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | Quantity | Actual component result | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation Required Pattern: min/wk (extensions allowed) | |||||
| system |
C | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org (extensions allowed) | ||||
| code |
0..1 | code | Coded form of the unit Required Pattern: min/wk (extensions allowed) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:classificationMethod |
0..1 | BackboneElement | Components should only be used when multiple values are inseparably connected to a single measurement (e.g., score domains). | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: | |||||
| value[x] |
0..1 | CodeableConcept | Actual component result Binding: AT PreNUDGE Physical Activity Classification Method ValueSet (required) | |||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Reason why no clinically or analytically meaningful component result is available Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | required | AT PreNUDGE Observation Methods | 📦0.1.0 | This IG |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:moderateActivity.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:vigorousActivity.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivity.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:aggregateActivityWeighted.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.value[x] | Base | required | AT PreNUDGE Physical Activity Classification Method ValueSet | 📦0.1.0 | This IG |
| Observation.component:classificationMethod.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component:classificationMethod.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| at-prenudge-result-present | error | Observation | A PreNUDGE Observation must contain a root result, a root data absent reason, or at least one component result or component data absent reason. |
value.exists() or dataAbsentReason.exists() or component.where(value.exists() or dataAbsentReason.exists()).exists()
|
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Observation | If 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-4 | error | Observation | If 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text |
low.exists() or high.exists() or text.exists()
|
| obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present |
dataAbsentReason.empty() or value.empty()
|
| obs-7 | error | Observation | If 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()
|
| pa-agg-01 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivityWeighted SHOULD equal moderateActivity (or 0) + (vigorousActivity × 2, or 0) |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '68130003').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ (iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0) * 2)
|
| pa-agg-02 | warning | Observation | When moderateActivity or vigorousActivity are present, aggregateActivity SHOULD equal moderateActivity (or 0) + vigorousActivity (or 0), with no intensity weighting |
(component.where(code.coding.where(code = '77592-4').exists()).exists()
or component.where(code.coding.where(code = '77593-2').exists()).exists())
implies
component.where(code.coding.where(code = '101691-4').exists()).value.ofType(Quantity).value =
iif(component.where(code.coding.where(code = '77592-4').exists()).exists(),
component.where(code.coding.where(code = '77592-4').exists()).value.ofType(Quantity).value,
0)
+ iif(component.where(code.coding.where(code = '77593-2').exists()).exists(),
component.where(code.coding.where(code = '77593-2').exists()).value.ofType(Quantity).value,
0)
|
| pa-manual-comp-01 | warning | Observation | When method is Manual, classificationMethod component must be absent or carry only code self-rp |
method.coding.exists(system = 'http://snomed.info/sct' and code = '87982008')
implies (
component.where(code.coding.where(code = '246501002').exists()).empty()
or component.where(code.coding.where(code = '246501002').exists())
.value.ofType(CodeableConcept).coding.where(code = 'self-rp').exists()
)
|
| pa-panel-01 | error | Observation | At least one activity component must be present |
component.exists()
|
| pa-wearable-01 | error | Observation | When method is Automated, aggregateActivityWeighted must be present |
method.coding.exists(system = 'http://snomed.info/sct' and code = '8359006') implies component.where(code.coding.where(code = '68130003').exists()).exists()
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from AtPrenudgeObservation
Summary
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron