Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Orders and Observations icon Work GroupMaturity Level: N/A  Normative (from v4.0.0)Security Category: Patient Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Search parameters for the Resource Observation - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to 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

Parameter based-on:reference

Reference to the service request.

ResourceObservation
ExpressionObservation.basedOn
Processing ModeNormal
Target ResourcesDeviceRequest, ServiceRequest, CarePlan, MedicationRequest, ImmunizationRecommendation, NutritionOrder
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-category

Parameter category:token

The classification of the type of observation

ResourceObservation
ExpressionObservation.category
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-code
This search parameter is part of the common search parameter clinical-code

Parameter code:token

Observation: The code of the observation type

ResourceObservation
ExpressionObservation.code
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-code-value-concept

Parameter code-value-concept:composite

Code and coded value parameter pair

ResourceObservation
ExpressionObservation
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

codecode
value-conceptvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/Observation-code-value-date

Parameter code-value-date:composite

Code and date/time value parameter pair

ResourceObservation
ExpressionObservation
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

codecode
value-datevalue.ofType(dateTime) | value.ofType(Period)
 
http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity

Parameter code-value-quantity:composite

Code and quantity value parameter pair

ResourceObservation
ExpressionObservation
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

codecode
value-quantityvalue.ofType(Quantity)
 
http://hl7.org/fhir/SearchParameter/Observation-code-value-string

Parameter code-value-string:composite

Code and string value parameter pair

ResourceObservation
ExpressionObservation
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

codecode
http://hl7.org/fhir/SearchParameter/Observation-value-stringvalue.ofType(string)
 
http://hl7.org/fhir/SearchParameter/Observation-combo-code

Parameter combo-code:token

The code of the observation type or component type

ResourceObservation
ExpressionObservation.code | Observation.component.code
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept

Parameter combo-code-value-concept:composite

Code and coded value parameter pair, including in components

ResourceObservation
ExpressionObservation | Observation.component
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

combo-codecode
combo-value-conceptvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity

Parameter combo-code-value-quantity:composite

Code and quantity value parameter pair, including in components

ResourceObservation
ExpressionObservation | Observation.component
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

combo-codecode
combo-value-quantityvalue.ofType(Quantity)
 
http://hl7.org/fhir/SearchParameter/Observation-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.

ResourceObservation
ExpressionObservation.dataAbsentReason | Observation.component.dataAbsentReason
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept

Parameter combo-value-concept:token

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

ResourceObservation
ExpressionObservation.value.ofType(CodeableConcept) | Observation.component.value.ofType(CodeableConcept)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-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)

ResourceObservation
ExpressionObservation.value.ofType(Quantity) | Observation.value.ofType(SampledData) | Observation.component.value.ofType(Quantity) | Observation.component.value.ofType(SampledData)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Observation-component-code

Parameter component-code:token

The component code of the observation type

ResourceObservation
ExpressionObservation.component.code
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept

Parameter component-code-value-concept:composite

Component code and component coded value parameter pair

ResourceObservation
ExpressionObservation.component
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

component-codecode
component-value-conceptvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity

Parameter component-code-value-quantity:composite

Component code and component quantity value parameter pair

ResourceObservation
ExpressionObservation.component
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

component-codecode
component-value-quantityvalue.ofType(Quantity)
 
http://hl7.org/fhir/SearchParameter/Observation-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.

ResourceObservation
ExpressionObservation.component.dataAbsentReason
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-component-value-canonical

Parameter component-value-canonical:uri

URL contained in valueCanonical.

ResourceObservation
ExpressionObservation.component.value.ofType(canonical)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-component-value-concept

Parameter component-value-concept:token

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

ResourceObservation
ExpressionObservation.component.value.ofType(CodeableConcept)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-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)

ResourceObservation
ExpressionObservation.component.value.ofType(Quantity) | Observation.component.value.ofType(SampledData)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Observation-component-value-reference

Parameter component-value-reference:reference

Reference contained in valueReference.

ResourceObservation
ExpressionObservation.component.value.ofType(Reference)
Processing ModeNormal
Target ResourcesMolecularSequence
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason

Parameter data-absent-reason:token

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

ResourceObservation
ExpressionObservation.dataAbsentReason
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

Parameter date:date

Observation: Clinically relevant time/time-period for observation

ResourceObservation
ExpressionObservation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Observation-derived-from

Parameter derived-from:reference

Related measurements the observation is made from

ResourceObservation
ExpressionObservation.derivedFrom
Processing ModeNormal
Target ResourcesImagingStudy, DocumentReference, Observation, MolecularSequence, GenomicStudy, ImagingSelection, QuestionnaireResponse
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-device

Parameter device:reference

The Device that generated the observation data.

ResourceObservation
ExpressionObservation.device
Processing ModeNormal
Target ResourcesDevice, DeviceMetric
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-encounter
This search parameter is part of the common search parameter clinical-encounter

Parameter encounter:reference

Observation: Encounter related to the observation

ResourceObservation
ExpressionObservation.encounter
Processing ModeNormal
Target ResourcesEncounter
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-focus

Parameter focus:reference

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

ResourceObservation
ExpressionObservation.focus
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-has-member

Parameter has-member:reference

Related resource that belongs to the Observation group

ResourceObservation
ExpressionObservation.hasMember
Processing ModeNormal
Target ResourcesObservation, MolecularSequence, QuestionnaireResponse
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Parameter identifier:token

Observation: The unique id for a particular observation

ResourceObservation
ExpressionObservation.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-method

Parameter method:token

The method used for the observation

ResourceObservation
ExpressionObservation.method
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-part-of

Parameter part-of:reference

Part of referenced event

ResourceObservation
ExpressionObservation.partOf
Processing ModeNormal
Target ResourcesImagingStudy, Procedure, MedicationStatement, MedicationAdministration, GenomicStudy, Immunization, MedicationDispense
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Parameter patient:reference

Observation: The subject that the observation is about (if patient)

ResourceObservation
ExpressionObservation.subject.where(resolve() is Patient)
Processing ModeNormal
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-performer

Parameter performer:reference

Who performed the observation

ResourceObservation
ExpressionObservation.performer
Processing ModeNormal
Target ResourcesOrganization, CareTeam, RelatedPerson, PractitionerRole, Practitioner, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-specimen

Parameter specimen:reference

Specimen used for this observation

ResourceObservation
ExpressionObservation.specimen
Processing ModeNormal
Target ResourcesGroup, Specimen
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-status

Parameter status:token

The status of the observation

ResourceObservation
ExpressionObservation.status
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-subject

Parameter subject:reference

The subject that the observation is about

ResourceObservation
ExpressionObservation.subject
Processing ModeNormal
Target ResourcesDevice, Organization, Procedure, NutritionProduct, Group, Practitioner, BiologicallyDerivedProduct, Substance, Location, Patient, Medication
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-value-canonical

Parameter value-canonical:uri

URL contained in valueCanonical.

ResourceObservation
ExpressionObservation.value.ofType(canonical)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-value-concept

Parameter value-concept:token

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

ResourceObservation
ExpressionObservation.value.ofType(CodeableConcept)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-value-date

Parameter value-date:date

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

ResourceObservation
ExpressionObservation.value.ofType(dateTime) | Observation.value.ofType(Period)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Observation-value-markdown

Parameter value-markdown:string

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

ResourceObservation
ExpressionObservation.value.ofType(markdown) | Observation.value.ofType(CodeableConcept).text
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Observation-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)

ResourceObservation
ExpressionObservation.value.ofType(Quantity) | Observation.value.ofType(SampledData)
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Observation-value-reference

Parameter value-reference:reference

Reference contained in valueReference.

ResourceObservation
ExpressionObservation.value.ofType(Reference)
Processing ModeNormal
Target ResourcesMolecularSequence
MultiplesThe parameter cannot repeat or have multiple values