PACIO Personal Functioning and Engagement Implementation Guide
1.0.0 - STU1 United States of America flag

This page is part of the PACIO Personal Functioning and Engagement Implementation Guide (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Personal Functioning and Engagement Clinical Test Observation

Official URL: http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-clinicaltest Version: 1.0.0
Draft as of 2024-01-05 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:

  • Query for an observation representing a clinical test related to a patient’s functioning and engagement.
  • Record or update observations related to a clinical test for a Patient.

Mandatory and Must Support Data Elements

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:

  1. a status
  2. a category code of “clinical-test” and “functioning”
  3. a code identifying the clinical test
  4. a patient
  5. the point in time or period when the observation was made
  6. who made the observation

Each Personal Functioning and Engagement Observation must support:

  1. the location the observation was made
  2. any devices the patient used
  3. an additional category value or values specifying the specific health or health-related domain that this observation is related to**
  4. the result or a reason why the data is absent*

* ** see guidance below

Profile specific implementation guidance:

  • *An Observation without a value, SHALL include a reason why the data is absent unless there are component observations. Systems that never provide an observation without a value are not required to support Observation.dataAbsentReason.
  • **When a health or health-related domain is specified as an additional category value, Observation.code SHOULD be drawn from the corresponding domain-based value set as discussed below and on the domains page.

Domain-specific Value Set Bindings

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:

Formal Views of Profile Content

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

This structure is derived from USCoreObservationClinicalTestResultProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreObservationClinicalTestResultProfileMeasurements and simple assertions
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... event-location S0..1Reference(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 S0..*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
... category 2..*CodeableConceptClassification of type of observation
... category:functioning S1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: functioning
..... display1..1stringRepresentation defined by the system
Fixed Value: Functioning
... category:PFEDomain S0..*CodeableConceptClassification of type of observation
Binding: Personal Functioning and Engagement Category Value Set (required)
... effective[x] 1..1dateTimeClinically 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.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.category:PFEDomainrequiredPFECategoryVS (a valid code from Personal Functioning and Engagement Category)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreObservationClinicalTestResultProfileMeasurements and simple assertions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... event-location S0..1Reference(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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeShould 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 S2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:clinical-test S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-test
.... category:functioning S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: functioning
...... display1..1stringRepresentation defined by the system
Fixed Value: Functioning
.... category:PFEDomain S0..*CodeableConceptClassification of type of observation
Binding: Personal Functioning and Engagement Category Value Set (required)
... code SΣ1..1CodeableConceptClinical Test Name
Binding: US Core Clinical Test Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] SΣC1..1dateTimeClinically 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.
... value[x] SΣC0..1Result Value
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:clinical-testpreferredPattern: clinical-test
Observation.category:functioningpreferredPattern: functioning("Functioning")
Observation.category:PFEDomainrequiredPFECategoryVS (a valid code from Personal Functioning and Engagement Category)
Observation.codeextensibleUSCoreClinicalTestCodes
Observation.dataAbsentReasonextensibleDataAbsentReason
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreObservationClinicalTestResultProfileMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... event-location S0..1Reference(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 S0..*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..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1codeShould 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 S2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:clinical-test S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-test
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:functioning S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: functioning
...... display1..1stringRepresentation defined by the system
Fixed Value: Functioning
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:PFEDomain S0..*CodeableConceptClassification of type of observation
Binding: Personal Functioning and Engagement Category Value Set (required)
... code SΣ1..1CodeableConceptClinical Test Name
Binding: US Core Clinical Test Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣC1..1dateTime SClinically relevant time/time-period for observation
... issued Σ0..1instantDate/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ΣC0..1Result Value
.... valueQuantityQuantity S
.... valueCodeableConceptCodeableConcept S
.... valueStringstring S
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

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

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:clinical-testpreferredPattern: clinical-test
Observation.category:functioningpreferredPattern: functioning("Functioning")
Observation.category:PFEDomainrequiredPFECategoryVS (a valid code from Personal Functioning and Engagement Category)
Observation.codeextensibleUSCoreClinicalTestCodes
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Differential View

This structure is derived from USCoreObservationClinicalTestResultProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreObservationClinicalTestResultProfileMeasurements and simple assertions
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... event-location S0..1Reference(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 S0..*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
... category 2..*CodeableConceptClassification of type of observation
... category:functioning S1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: functioning
..... display1..1stringRepresentation defined by the system
Fixed Value: Functioning
... category:PFEDomain S0..*CodeableConceptClassification of type of observation
Binding: Personal Functioning and Engagement Category Value Set (required)
... effective[x] 1..1dateTimeClinically 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.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.category:PFEDomainrequiredPFECategoryVS (a valid code from Personal Functioning and Engagement Category)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreObservationClinicalTestResultProfileMeasurements and simple assertions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... event-location S0..1Reference(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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeShould 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 S2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:clinical-test S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-test
.... category:functioning S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: functioning
...... display1..1stringRepresentation defined by the system
Fixed Value: Functioning
.... category:PFEDomain S0..*CodeableConceptClassification of type of observation
Binding: Personal Functioning and Engagement Category Value Set (required)
... code SΣ1..1CodeableConceptClinical Test Name
Binding: US Core Clinical Test Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] SΣC1..1dateTimeClinically 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.
... value[x] SΣC0..1Result Value
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:clinical-testpreferredPattern: clinical-test
Observation.category:functioningpreferredPattern: functioning("Functioning")
Observation.category:PFEDomainrequiredPFECategoryVS (a valid code from Personal Functioning and Engagement Category)
Observation.codeextensibleUSCoreClinicalTestCodes
Observation.dataAbsentReasonextensibleDataAbsentReason

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreObservationClinicalTestResultProfileMeasurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... event-location S0..1Reference(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 S0..*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..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!SΣ1..1codeShould 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 S2..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:clinical-test S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-test
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:functioning S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-functioning-cs
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: functioning
...... display1..1stringRepresentation defined by the system
Fixed Value: Functioning
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:PFEDomain S0..*CodeableConceptClassification of type of observation
Binding: Personal Functioning and Engagement Category Value Set (required)
... code SΣ1..1CodeableConceptClinical Test Name
Binding: US Core Clinical Test Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣC1..1dateTime SClinically relevant time/time-period for observation
... issued Σ0..1instantDate/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ΣC0..1Result Value
.... valueQuantityQuantity S
.... valueCodeableConceptCodeableConcept S
.... valueStringstring S
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

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

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


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:clinical-testpreferredPattern: clinical-test
Observation.category:functioningpreferredPattern: functioning("Functioning")
Observation.category:PFEDomainrequiredPFECategoryVS (a valid code from Personal Functioning and Engagement Category)
Observation.codeextensibleUSCoreClinicalTestCodes
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

 

Other representations of profile: CSV, Excel, Schematron

Notes:

The syntax used to describe the interactions below is described here.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the combination of the patient and category search parameters:

    GET [base]/Observation?patient={Type/}[id]&category={system|}[code]

    Example:

    1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category|clinical-test
    2. GET [base]/Observation?patient=1134281&category=http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-category-cs|sensory_functions_and_pain

    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)

  2. SHALL support searching using the combination of the patient and code search parameters:
    • including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=1134281&code=http://loinc.org|91375-6
    2. GET [base]/Observation?patient=1134281&code=http://loinc.org|91375-6,http://loinc.org|89024-4,http://loinc.org|91379-8

    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)

  3. SHALL support searching using the combination of the patient and category and date search parameters:
    • including support for these date comparators: gt,lt,ge,le
    • including optional support for AND search on 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:

    1. GET [base]Observation?patient=555580&category=http://terminology.hl7.org/CodeSystem/observation-category|clinical-test&date=ge2018-03-14T00:00:00Z
    2. GET [base]Observation?patient=555580&category=http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-category-cs|sensory_functions_and_pain&date=ge2018-03-14T00:00:00Z

    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)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and category and status search parameters:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category|clinical-test&status=final
    2. GET [base]/Observation?patient=1134281&category=http://hl7.org/fhir/us/pacio-pfe/CodeSystem/pfe-category-cs|sensory_functions_and_pain&status=final

    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)

  2. SHOULD support searching using the combination of the patient and code and date search parameters:
    • including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)
    • including support for these date comparators: gt,lt,ge,le
    • including optional support for AND search on 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:

    1. GET [base]Observation?patient=555580&code=http://loinc.org|91375-6&date=ge2019-01-01T00:00:00Z

    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)