PACIO Personal Functioning and Engagement Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-pfe/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-clinicaltest | Version: 2.0.0-ballot | |||
Active as of 2024-08-13 | Computable Name: PFEClinicalTestObservation |
An exchange of post-acute care observation for a patient. This profile is used for exchanging a single piece of observation data that resulted from a clinical test.
Example Usage Scenarios:
The following are example usage scenarios for this Profile:
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 Observation must have:
Each Personal Functioning and Engagement Observation must support:
* ** see guidance below
Profile specific implementation guidance:
Observation.category |
Domain | Element binding | Assessment Observation Codes ValueSet |
---|---|---|---|
sensory_functions_and_pain | Sensory functions and pain | Observation.code | PFE - Sensory functions and pain ValueSet |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreObservationClinicalResultProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreObservationClinicalResultProfile | 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 | 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. | |
category | 1..* | CodeableConcept | (USCDI) Classification of type of observation | |
Slices for category | Content/Rules for all slices | |||
category:us-core | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Clinical Result Observation Category (required) | |
Slices for category | Content/Rules for all slices | |||
category:PFEDomain | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
effective[x] | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation | |
performer | 1..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | The person who performed the assessment. The preferred way to specify the performer is to use the PractitionerRole resource to provide both the practitioner and organization. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.category:us-core | required | USCoreClinicalResultObservationCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category | |
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | 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 us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must 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 | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Clinical Result Observation Category (required) |
category:PFEDomain | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
code | SΣ | 1..1 | CodeableConcept | (USCDI) Clinical Test or Procedure Name Binding: LOINCCodes (extensible) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣC | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation us-core-1: Datetime must be at least to day. |
performer | Σ | 1..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | The person who performed the assessment. The preferred way to specify the performer is to use the PractitionerRole resource to provide both the practitioner and organization. |
value[x] | SΣC | 0..1 | (USCDI) Result Value us-core-3: SHALL use UCUM for coded quantity units. | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
dataAbsentReason | SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet | 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:us-core | required | USCoreClinicalResultObservationCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category | |
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 | extensible | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | 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 us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must 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 | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Clinical Result Observation Category (required) | ||||
category:PFEDomain | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) | ||||
code | SΣ | 1..1 | CodeableConcept | (USCDI) Clinical Test or Procedure Name Binding: LOINCCodes (extensible) | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) 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ΣC | 1..1 | dateTime S | (USCDI) Clinically relevant time/time-period for observation us-core-1: Datetime must be at least to day. | ||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 1..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | The person who performed the assessment. The preferred way to specify the performer is to use the PractitionerRole resource to provide both the practitioner and organization. | ||||
value[x] | SΣC | 0..1 | (USCDI) Result Value us-core-3: SHALL use UCUM for coded quantity units. | |||||
valueQuantity | Quantity S | |||||||
valueCodeableConcept | CodeableConcept S | |||||||
valueString | string S | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | SC | 0..1 | CodeableConcept | (USCDI) 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 | 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:us-core | required | USCoreClinicalResultObservationCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category | ||||
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 | extensible | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
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 USCoreObservationClinicalResultProfile
Summary
Mandatory: 2 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreObservationClinicalResultProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreObservationClinicalResultProfile | 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 | 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. | |
category | 1..* | CodeableConcept | (USCDI) Classification of type of observation | |
Slices for category | Content/Rules for all slices | |||
category:us-core | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Clinical Result Observation Category (required) | |
Slices for category | Content/Rules for all slices | |||
category:PFEDomain | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
effective[x] | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation | |
performer | 1..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | The person who performed the assessment. The preferred way to specify the performer is to use the PractitionerRole resource to provide both the practitioner and organization. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.category:us-core | required | USCoreClinicalResultObservationCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category | |
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 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | 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 us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must 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 | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Clinical Result Observation Category (required) |
category:PFEDomain | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) |
code | SΣ | 1..1 | CodeableConcept | (USCDI) Clinical Test or Procedure Name Binding: LOINCCodes (extensible) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) Who and/or what the observation is about |
effective[x] | SΣC | 1..1 | dateTime | (USCDI) Clinically relevant time/time-period for observation us-core-1: Datetime must be at least to day. |
performer | Σ | 1..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | The person who performed the assessment. The preferred way to specify the performer is to use the PractitionerRole resource to provide both the practitioner and organization. |
value[x] | SΣC | 0..1 | (USCDI) Result Value us-core-3: SHALL use UCUM for coded quantity units. | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
dataAbsentReason | SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet | 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:us-core | required | USCoreClinicalResultObservationCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category | |
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 | extensible | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreObservationClinicalResultProfile | 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 us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must 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 | (USCDI) Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:us-core | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: US Core Clinical Result Observation Category (required) | ||||
category:PFEDomain | S | 0..* | CodeableConcept | (USCDI) Classification of type of observation Binding: Personal Functioning and Engagement Category Value Set (required) | ||||
code | SΣ | 1..1 | CodeableConcept | (USCDI) Clinical Test or Procedure Name Binding: LOINCCodes (extensible) | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | (USCDI) 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ΣC | 1..1 | dateTime S | (USCDI) Clinically relevant time/time-period for observation us-core-1: Datetime must be at least to day. | ||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 1..* | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | The person who performed the assessment. The preferred way to specify the performer is to use the PractitionerRole resource to provide both the practitioner and organization. | ||||
value[x] | SΣC | 0..1 | (USCDI) Result Value us-core-3: SHALL use UCUM for coded quantity units. | |||||
valueQuantity | Quantity S | |||||||
valueCodeableConcept | CodeableConcept S | |||||||
valueString | string S | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | SC | 0..1 | CodeableConcept | (USCDI) 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 | 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:us-core | required | USCoreClinicalResultObservationCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category | ||||
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 | extensible | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
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 USCoreObservationClinicalResultProfile
Summary
Mandatory: 2 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
The syntax used to describe the interactions below is described here.
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the combination of the patient
and category
search parameters:
GET [base]/Observation?patient={Type/}[id]&category={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and a category code = clinical-test
or sensory_functions_and_pain
respectively (how to search by reference and how to search by token)
patient
and code
search parameters:
code
(e.g.code={system|}[code],{system|}[code],...
)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). SHOULD support search by multiple report codes. The Observation code
parameter searches `Observation.code only. (how to search by reference and how to search by token)
patient
and category
and date
search parameters:
date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = clinical-test
or sensory_functions_and_pain
respectively (how to search by reference and how to search by token and how to search by date)
The following search parameter combinations SHOULD be supported:
patient
and category
and status
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category = clinical-test
or sensory_functions_and_pain
respectively and status final
(how to search by reference and how to search by token)
patient
and code
and date
search parameters:
code
(e.g.code={system|}[code],{system|}[code],...
)date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and report code(s). SHOULD support search by multiple report codes. (how to search by reference and how to search by token and how to search by date)