Observation - FHIR v5.0.0-ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

10.1.21 Resource Observation - Search Parameters

Orders and Observations

Work Group

Maturity Level: N/A

Standards Status: Informative

Security Category: Patient

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search Parameter Registry for the observation resource

10.1.22 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/Observation-based-on

10.1.23 based-on

Parameter based-on:reference

Reference to the service request.

Resource Observation

Expression Observation.basedOn

Target Resources CarePlan, MedicationRequest, NutritionOrder, DeviceRequest, ServiceRequest, ImmunizationRecommendation

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-category

10.1.24 category

Parameter category:token

The classification of the type of observation

Resource Observation

Expression Observation.category

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Observation-code

10.1.25 code

Parameter code:token

The code of the observation type

Resources

Expression Observation.code

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-code-value-concept

10.1.26 code-value-concept

Parameter code-value-concept:composite

Code and coded value parameter pair

Resource Observation

Expression Observation

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/clinical-code code

http://hl7.org/fhir/SearchParameter/Observation-value-concept value.ofType(CodeableConcept)

http://hl7.org/fhir/SearchParameter/Observation-code-value-date

10.1.27 code-value-date

Parameter code-value-date:composite

Code and date/time value parameter pair

Resource Observation

Expression Observation

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/clinical-code code

http://hl7.org/fhir/SearchParameter/Observation-value-date value.ofType(DateTime) | value.ofType(Period)

http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity

10.1.28 code-value-quantity

Parameter code-value-quantity:composite

Code and quantity value parameter pair

Resource Observation

Expression Observation

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/clinical-code code

http://hl7.org/fhir/SearchParameter/Observation-value-quantity value.ofType(Quantity)

http://hl7.org/fhir/SearchParameter/Observation-code-value-string

10.1.29 code-value-string

Parameter code-value-string:composite

Code and string value parameter pair

Resource Observation

Expression Observation

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/clinical-code code

http://hl7.org/fhir/SearchParameter/Observation-value-string value.ofType(string)

http://hl7.org/fhir/SearchParameter/Observation-combo-code

10.1.30 combo-code

Parameter combo-code:token

The code of the observation type or component type

Resource Observation

Expression Observation.code | Observation.component.code

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept

10.1.31 combo-code-value-concept

Parameter combo-code-value-concept:composite

Code and coded value parameter pair, including in components

Resource Observation

Expression Observation | Observation.component

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/Observation-combo-code code

http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept value.ofType(CodeableConcept)

http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity

10.1.32 combo-code-value-quantity

Parameter combo-code-value-quantity:composite

Code and quantity value parameter pair, including in components

Resource Observation

Expression Observation | Observation.component

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/Observation-combo-code code

http://hl7.org/fhir/SearchParameter/Observation-combo-value-quantity value.ofType(Quantity)

http://hl7.org/fhir/SearchParameter/Observation-combo-data-absent-reason

10.1.33 combo-data-absent-reason

Parameter combo-data-absent-reason:token

The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.

Resource Observation

Expression Observation.dataAbsentReason | Observation.component.dataAbsentReason

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept

10.1.34 combo-value-concept

Parameter combo-value-concept:token

The value or component value of the observation, if the value is a CodeableConcept

Resource Observation

Expression Observation.value.ofType(CodeableConcept) | Observation.component.value.ofType(CodeableConcept)

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-combo-value-quantity

10.1.35 combo-value-quantity

Parameter combo-value-quantity:quantity

The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

Resource Observation

Expression Observation.value.ofType(Quantity) | Observation.value.ofType(SampledData) | Observation.component.value.ofType(Quantity) | Observation.component.value.ofType(SampledData)

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Observation-component-code

10.1.36 component-code

Parameter component-code:token

The component code of the observation type

Resource Observation

Expression Observation.component.code

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept

10.1.37 component-code-value-concept

Parameter component-code-value-concept:composite

Component code and component coded value parameter pair

Resource Observation

Expression Observation.component

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/Observation-component-code code

http://hl7.org/fhir/SearchParameter/Observation-component-value-concept value.ofType(CodeableConcept)

http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity

10.1.38 component-code-value-quantity

Parameter component-code-value-quantity:composite

Component code and component quantity value parameter pair

Resource Observation

Expression Observation.component

Multiples The parameter cannot repeat or have multiple values

Components

http://hl7.org/fhir/SearchParameter/Observation-component-code code

http://hl7.org/fhir/SearchParameter/Observation-component-value-quantity value.ofType(Quantity)

http://hl7.org/fhir/SearchParameter/Observation-component-data-absent-reason

10.1.39 component-data-absent-reason

Parameter component-data-absent-reason:token

The reason why the expected value in the element Observation.component.value[x] is missing.

Resource Observation

Expression Observation.component.dataAbsentReason

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-component-value-concept

10.1.40 component-value-concept

Parameter component-value-concept:token

The value of the component observation, if the value is a CodeableConcept

Resource Observation

Expression Observation.component.value.ofType(CodeableConcept)

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-component-value-quantity

10.1.41 component-value-quantity

Parameter component-value-quantity:quantity

The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

Resource Observation

Expression Observation.component.value.ofType(Quantity) | Observation.component.value.ofType(SampledData)

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason

10.1.42 data-absent-reason

Parameter data-absent-reason:token

The reason why the expected value in the element Observation.value[x] is missing.

Resource Observation

Expression Observation.dataAbsentReason

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Observation-date

10.1.43 date

Parameter date:date

Obtained date/time. If the obtained element is a period, a date that falls in the period

Resources

Expression Observation.effective

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-derived-from

10.1.44 derived-from

Parameter derived-from:reference

Related measurements the observation is made from

Resource Observation

Expression Observation.derivedFrom

Target Resources GenomicStudy, Observation, ImagingStudy, MolecularSequence, ImagingSelection, QuestionnaireResponse, DocumentReference

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-device

10.1.45 device

Parameter device:reference

The Device that generated the observation data.

Resource Observation

Expression Observation.device

Target Resources Device, DeviceMetric

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Observation-encounter

10.1.46 encounter

Parameter encounter:reference

Encounter related to the observation

Resources

Expression Observation.encounter

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-focus

10.1.47 focus

Parameter focus:reference

The focus of an observation when the focus is not the patient of record.

Resource Observation

Expression Observation.focus

Target Resources All Resources

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-has-member

10.1.48 has-member

Parameter has-member:reference

Related resource that belongs to the Observation group

Resource Observation

Expression Observation.hasMember

Target Resources Observation, MolecularSequence, QuestionnaireResponse

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Observation-identifier

10.1.49 identifier

Parameter identifier:token

The unique id for a particular observation

Resources

Expression Observation.identifier

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-method

10.1.50 method

Parameter method:token

The method used for the observation

Resource Observation

Expression Observation.method

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-part-of

10.1.51 part-of

Parameter part-of:reference

Part of referenced event

Resource Observation

Expression Observation.partOf

Target Resources GenomicStudy, Immunization, MedicationDispense, MedicationAdministration, Procedure, ImagingStudy, MedicationUsage

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/build/SearchParameter/Observation-patient

10.1.52 patient

Parameter patient:reference

The subject that the observation is about (if patient)

Resources

Expression Observation.subject.where(resolve() is Patient)

Usage Normal

Target Resources Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-performer

10.1.53 performer

Parameter performer:reference

Who performed the observation

Resource Observation

Expression Observation.performer

Target Resources Practitioner, Organization, CareTeam, Patient, PractitionerRole, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-specimen

10.1.54 specimen

Parameter specimen:reference

Specimen used for this observation

Resource Observation

Expression Observation.specimen

Target Resources Specimen, Group

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-status

10.1.55 status

Parameter status:token

The status of the observation

Resource Observation

Expression Observation.status

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-subject

10.1.56 subject

Parameter subject:reference

The subject that the observation is about

Resource Observation

Expression Observation.subject

Target Resources Practitioner, Group, Organization, BiologicallyDerivedProduct, NutritionProduct, Device, Medication, Patient, Procedure, Substance, Location

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-value-concept

10.1.57 value-concept

Parameter value-concept:token

The value of the observation, if the value is a CodeableConcept

Resource Observation

Expression Observation.value.ofType(CodeableConcept)

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Observation-value-date

10.1.58 value-date

Parameter value-date:date

The value of the observation, if the value is a date or period of time

Resource Observation

Expression Observation.value.ofType(dateTime) | Observation.value.ofType(Period)

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Observation-value-quantity

10.1.59 value-quantity

Parameter value-quantity:quantity

The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

Resource Observation

Expression Observation.value.ofType(Quantity) | Observation.value.ofType(SampledData)

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Observation-value-string

10.1.60 value-string

Parameter value-string:string

The value of the observation, if the value is a string, and also searches in CodeableConcept.text

Resource Observation

Expression Observation.value.ofType(string) | Observation.value.ofType(CodeableConcept).text

Multiples The parameter cannot repeat or have multiple values