This page is part of the PACIO Personal Functioning and Engagement Implementation Guide (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-abstract | Version: 2.0.0-ballot | |||
Active as of 2024-08-13 | Computable Name: PFEAbstractObservation |
An abstract profile representing the cross-cutting requirements for Personal Functioning and Engagement Observation instances. This profile is not intended to be used directly. Implementers should use specific profiles that layer these requirements on top of specific US Core Observation profiles.
This profile abstracts and collects the requirements added on top of US Core Observation profiles by the Personal Functioning and Engagement (PFE) IG. The US Core Observation profiles that PFE extends detail specific requirements for the observation based on how it is collected. For example, the Survey profile specifies requirements for representing observations made using formal assessment instruments and questionnaires while the Clinical Test Result profile contains slightly different requirements for representing observations related to clinical tests using specialized equipment. Observation in scope for this IG include those that fall under multiple US Core observation profiles. The additional representational requirements placed by this IG are the same across all US Core observation profiles and are also consistent with all of them. This abstract profile represents those shared requirements so that:
The following data elements must always be present or must be supported if the data is present in the sending system (Must Support definition). They are presented below with a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Personal Functioning and Engagement Abstract Observation must have:
Each Personal Functioning and Engagement Abstract Observation must support:
* see guidance below
Profile specific implementation guidance:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | This is an abstractprofile. Measurements and simple assertions | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
event-location | S | 0..1 | Reference(US Core Location Profile) | An extension to indicate where the observation event occurred. URL: http://hl7.org/fhir/StructureDefinition/event-location profiled by http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/event-location |
device-use | S | 0..* | Reference(Personal Functioning and Engagement Use of Device) | An extension to indicate a record of assistive device usage by a patient during an assessment. URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/device-patient-used |
status | S | 1..1 | code | Should have the value 'final' when the observation is complete and there are no further actions needed. Otherwise, another value from the value set may appropriately be used. |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this |
category:functioning | S | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: functioning | |
display | 1..1 | string | Representation defined by the system Fixed Value: Functioning | |
category:PFEDomain | S | 0..* | CodeableConcept | Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Personal Functioning and Engagement Example Observations Value Set (example) |
subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
effective[x] | S | 1..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
performer | S | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | S | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.category:PFEDomain | required | PFECategoryVS (a valid code from Personal Functioning and Engagement Category)http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-category-vs from this IG | |
Observation.code | example | PFEExampleObservationsVShttp://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-example-obs-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | This is an abstractprofile. Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
event-location | S | 0..1 | Reference(US Core Location Profile) | An extension to indicate where the observation event occurred. URL: http://hl7.org/fhir/StructureDefinition/event-location profiled by http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/event-location |
device-use | S | 0..* | Reference(Personal Functioning and Engagement Use of Device) | An extension to indicate a record of assistive device usage by a patient during an assessment. URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/device-patient-used |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | Should have the value 'final' when the observation is complete and there are no further actions needed. Otherwise, another value from the value set may appropriately be used. Binding: ObservationStatus (required): Codes providing the status of an observation. |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:functioning | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: functioning | |
display | 1..1 | string | Representation defined by the system Fixed Value: Functioning | |
category:PFEDomain | S | 0..* | CodeableConcept | Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Personal Functioning and Engagement Example Observations Value Set (example) |
subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
performer | SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | SΣ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 | |||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.category:functioning | preferred | Pattern: functioning("Functioning")http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.category:PFEDomain | required | PFECategoryVS (a valid code from Personal Functioning and Engagement Category)http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-category-vs from this IG | |
Observation.code | example | PFEExampleObservationsVShttp://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-example-obs-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | This is an abstractprofile. Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
id | Σ | 0..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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
event-location | S | 0..1 | Reference(US Core Location Profile) | An extension to indicate where the observation event occurred. URL: http://hl7.org/fhir/StructureDefinition/event-location profiled by http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/event-location | ||||
device-use | S | 0..* | Reference(Personal Functioning and Engagement Use of Device) | An extension to indicate a record of assistive device usage by a patient during an assessment. URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/device-patient-used | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | Should have the value 'final' when the observation is complete and there are no further actions needed. Otherwise, another value from the value set may appropriately be used. Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:functioning | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: functioning | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Functioning | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:PFEDomain | S | 0..* | CodeableConcept | Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Personal Functioning and Engagement Example Observations Value Set (example) | ||||
subject | SΣ | 1..1 | Reference(Patient | Group | 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 | ||||
effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
value[x] | SΣ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 | Why the result is missing 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 | |||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
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 | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
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(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
component | Σ | 0..* | BackboneElement | Component results | ||||
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 | Why the component result is missing 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 | Conformance | ValueSet / Code | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.category:functioning | preferred | Pattern: functioning("Functioning")http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.category:PFEDomain | required | PFECategoryVS (a valid code from Personal Functioning and Engagement Category)http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-category-vs from this IG | ||||
Observation.code | example | PFEExampleObservationsVShttp://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-example-obs-vs from this IG | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
This structure is derived from Observation
Summary
Mandatory: 5 elements
Must-Support: 11 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | This is an abstractprofile. Measurements and simple assertions | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
event-location | S | 0..1 | Reference(US Core Location Profile) | An extension to indicate where the observation event occurred. URL: http://hl7.org/fhir/StructureDefinition/event-location profiled by http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/event-location |
device-use | S | 0..* | Reference(Personal Functioning and Engagement Use of Device) | An extension to indicate a record of assistive device usage by a patient during an assessment. URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/device-patient-used |
status | S | 1..1 | code | Should have the value 'final' when the observation is complete and there are no further actions needed. Otherwise, another value from the value set may appropriately be used. |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this |
category:functioning | S | 1..1 | CodeableConcept | Classification of type of observation Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: functioning | |
display | 1..1 | string | Representation defined by the system Fixed Value: Functioning | |
category:PFEDomain | S | 0..* | CodeableConcept | Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Personal Functioning and Engagement Example Observations Value Set (example) |
subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
effective[x] | S | 1..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
performer | S | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | S | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual result |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.category:PFEDomain | required | PFECategoryVS (a valid code from Personal Functioning and Engagement Category)http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-category-vs from this IG | |
Observation.code | example | PFEExampleObservationsVShttp://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-example-obs-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | This is an abstractprofile. Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
event-location | S | 0..1 | Reference(US Core Location Profile) | An extension to indicate where the observation event occurred. URL: http://hl7.org/fhir/StructureDefinition/event-location profiled by http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/event-location |
device-use | S | 0..* | Reference(Personal Functioning and Engagement Use of Device) | An extension to indicate a record of assistive device usage by a patient during an assessment. URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/device-patient-used |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | Should have the value 'final' when the observation is complete and there are no further actions needed. Otherwise, another value from the value set may appropriately be used. Binding: ObservationStatus (required): Codes providing the status of an observation. |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:functioning | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: functioning | |
display | 1..1 | string | Representation defined by the system Fixed Value: Functioning | |
category:PFEDomain | S | 0..* | CodeableConcept | Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Personal Functioning and Engagement Example Observations Value Set (example) |
subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
performer | SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | SΣ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 | |||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.category:functioning | preferred | Pattern: functioning("Functioning")http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.category:PFEDomain | required | PFECategoryVS (a valid code from Personal Functioning and Engagement Category)http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-category-vs from this IG | |
Observation.code | example | PFEExampleObservationsVShttp://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-example-obs-vs from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | This is an abstractprofile. Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
id | Σ | 0..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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
event-location | S | 0..1 | Reference(US Core Location Profile) | An extension to indicate where the observation event occurred. URL: http://hl7.org/fhir/StructureDefinition/event-location profiled by http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/event-location | ||||
device-use | S | 0..* | Reference(Personal Functioning and Engagement Use of Device) | An extension to indicate a record of assistive device usage by a patient during an assessment. URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/device-patient-used | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | Should have the value 'final' when the observation is complete and there are no further actions needed. Otherwise, another value from the value set may appropriately be used. Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:functioning | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: functioning | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Functioning | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:PFEDomain | S | 0..* | CodeableConcept | Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Personal Functioning and Engagement Example Observations Value Set (example) | ||||
subject | SΣ | 1..1 | Reference(Patient | Group | 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 | ||||
effective[x] | SΣ | 1..1 | Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
value[x] | SΣ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 | Why the result is missing 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 | |||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
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 | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
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(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
component | Σ | 0..* | BackboneElement | Component results | ||||
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 | Why the component result is missing 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 | Conformance | ValueSet / Code | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.category:functioning | preferred | Pattern: functioning("Functioning")http://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.category:PFEDomain | required | PFECategoryVS (a valid code from Personal Functioning and Engagement Category)http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-category-vs from this IG | ||||
Observation.code | example | PFEExampleObservationsVShttp://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-example-obs-vs from this IG | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
This structure is derived from Observation
Summary
Mandatory: 5 elements
Must-Support: 11 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron