This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
Release
6
Ballot
(3rd
Draft)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
Responsible
Owner:
Orders
and
Observations
Work
Group
|
Normative (from v4.0.0) | Security Category : Patient | Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson |
Search parameters for the Observation 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
|
||||||||||||
|
Generated Narrative: SearchParameter Observation-based-on
|
| Resource | Observation |
| Expression |
Observation.basedOn
|
| Processing Mode | Normal |
| Target Resources |
DeviceRequest
,
ServiceRequest
,
CarePlan
,
MedicationRequest
,
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-body-site
Generated Narrative: SearchParameter Observation-body-site
Parameter
body-site
:
token
DEPRECATED: Observed body part
| Resource | Observation |
| Expression |
Observation.bodySite
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-body-structure-code
Generated Narrative: SearchParameter Observation-body-structure-code
Parameter
body-structure-code
:
token
Code for observed body structure
| Resource | Observation |
| Expression |
Observation.bodyStructure.concept
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-category
Generated Narrative: SearchParameter Observation-category
Parameter
category
:
token
The classification of the type of observation
| Resource | Observation |
| Expression |
Observation.category
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/clinical-code
Generated Narrative: SearchParameter clinical-code
Parameter
code
:
token
Observation : The code of the observation type
| Resource | Observation |
| Expression |
Observation.code
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-code-value-concept
Generated Narrative: SearchParameter Observation-code-value-concept
Parameter
code-value-concept
:
composite
Code and coded value parameter pair
| Resource | Observation |
| Expression |
Observation
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| code |
code
|
| value-concept |
value.ofType(CodeableConcept)
|
http://hl7.org/fhir/SearchParameter/Observation-code-value-date
Generated Narrative: SearchParameter Observation-code-value-date
Parameter
code-value-date
:
composite
Code and date/time value parameter pair
| Resource | Observation |
| Expression |
Observation
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| code |
code
|
| value-date |
value.ofType(dateTime)
|
value.ofType(Period)
|
http://hl7.org/fhir/SearchParameter/Observation-code-value-quantity
Generated Narrative: SearchParameter Observation-code-value-quantity
Parameter
code-value-quantity
:
composite
Code and quantity value parameter pair
| Resource | Observation |
| Expression |
Observation
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| code |
code
|
| value-quantity |
value.ofType(Quantity)
|
http://hl7.org/fhir/SearchParameter/Observation-code-value-string
Generated Narrative: SearchParameter Observation-code-value-string
Parameter
code-value-string
:
composite
Code and string value parameter pair
| Resource | Observation |
| Expression |
Observation
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| code |
code
|
| value-string |
value.ofType(string)
|
http://hl7.org/fhir/SearchParameter/Observation-combo-code
Generated Narrative: SearchParameter Observation-combo-code
Parameter
combo-code
:
token
The code of the observation type or component type
| Resource | Observation |
| Expression |
Observation.code
|
Observation.component.code
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-concept
Generated Narrative: SearchParameter Observation-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
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| combo-code |
code
|
| combo-value-concept |
value.ofType(CodeableConcept)
|
http://hl7.org/fhir/SearchParameter/Observation-combo-code-value-quantity
Generated Narrative: SearchParameter Observation-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
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| combo-code |
code
|
| combo-value-quantity |
value.ofType(Quantity)
|
http://hl7.org/fhir/SearchParameter/Observation-combo-data-absent-reason
Generated Narrative: 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.
| Resource | Observation |
| Expression |
Observation.dataAbsentReason
|
Observation.component.dataAbsentReason
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-combo-interpretation
Generated Narrative: SearchParameter Observation-combo-interpretation
Parameter
combo-interpretation
:
token
The interpretation of the observation type or component type
| Resource | Observation |
| Expression |
Observation.interpretation
|
Observation.component.interpretation
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-combo-value-concept
Generated Narrative: SearchParameter Observation-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)
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-combo-value-quantity
Generated Narrative: 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)
Quantity.
| Resource | Observation |
| Expression |
Observation.value.ofType(Quantity)
|
|
| Processing Mode | Normal |
| Multiples |
|
| Comparators | Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap |
http://hl7.org/fhir/SearchParameter/Observation-component-code
Generated Narrative: SearchParameter Observation-component-code
Parameter
component-code
:
token
The component code of the observation type
| Resource | Observation |
| Expression |
Observation.component.code
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-component-code-value-concept
Generated Narrative: SearchParameter Observation-component-code-value-concept
Parameter
component-code-value-concept
:
composite
Component code and component coded value parameter pair
| Resource | Observation |
| Expression |
Observation.component
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| component-code |
code
|
| component-value-concept |
value.ofType(CodeableConcept)
|
http://hl7.org/fhir/SearchParameter/Observation-component-code-value-quantity
Generated Narrative: SearchParameter Observation-component-code-value-quantity
Parameter
component-code-value-quantity
:
composite
Component code and component quantity value parameter pair
| Resource | Observation |
| Expression |
Observation.component
|
| Processing Mode | Normal |
| Multiples |
|
Comparators
| component-code |
code
|
| component-value-quantity |
value.ofType(Quantity)
|
http://hl7.org/fhir/SearchParameter/Observation-component-data-absent-reason
Generated Narrative: 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.
| Resource | Observation |
| Expression |
Observation.component.dataAbsentReason
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-component-interpretation
Generated Narrative: SearchParameter Observation-component-interpretation
Parameter
component-interpretation
:
token
The component interpretation of the observation type
| Resource | Observation |
| Expression |
Observation.component.interpretation
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-component-value-canonical
Generated
Narrative:
SearchParameter
Observation-component-value-canonical
10.1.41
component-value-canonical
Parameter
component-value-canonical
:
reference
URL
contained
in
valueCanonical.
Resource
Observation
Expression
Observation.component.value.ofType(canonical)
Processing
Mode
Normal
Target
Resources
MolecularSequence
Multiples
multipleAnd:
It's
up
to
the
server
whether
the
parameter
may
repeat
in
order
to
specify
multiple
values
that
must
all
be
true
multipleOr:
It's
up
to
the
server
whether
the
parameter
can
have
multiple
values
(separated
by
comma)
where
at
least
one
must
be
true
http://hl7.org/fhir/SearchParameter/Observation-component-value-concept
Generated Narrative: SearchParameter Observation-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)
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-component-value-quantity
Generated Narrative: 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)
Quantity.
| Resource | Observation |
| Expression |
Observation.component.value.ofType(Quantity)
|
| Processing Mode | Normal |
| Multiples |
|
| Comparators | Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap |
http://hl7.org/fhir/SearchParameter/Observation-component-value-reference
Generated Narrative: SearchParameter Observation-component-value-reference
Parameter
component-value-reference
:
reference
Reference contained in valueReference.
| Resource | Observation |
| Expression |
Observation.component.value.ofType(Reference)
|
| Processing Mode | Normal |
| Target Resources |
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-data-absent-reason
Generated Narrative: SearchParameter Observation-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
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/clinical-date
Generated Narrative: SearchParameter clinical-date
Parameter
date
:
date
Observation : Clinically relevant time/time-period for observation
| Resource | Observation |
| Expression |
Observation.effective.ofType(dateTime)
|
Observation.effective.ofType(Period)
|
Observation.effective.ofType(Timing)
|
Observation.effective.ofType(instant)
|
| Processing Mode | Normal |
| Multiples |
|
| Comparators | Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap |
http://hl7.org/fhir/SearchParameter/Observation-derived-from
Generated Narrative: SearchParameter Observation-derived-from
Parameter
derived-from
:
reference
Related measurements the observation is made from
| Resource | Observation |
| Expression |
Observation.derivedFrom
|
| Processing Mode | Normal |
| Target Resources |
ImagingStudy
,
DocumentReference
,
Observation
,
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-device
Generated Narrative: SearchParameter Observation-device
Parameter
device
:
reference
The Device that generated the observation data.
| Resource | Observation |
| Expression |
Observation.device
|
| Processing Mode | Normal |
| Target Resources | Device , DeviceMetric |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/clinical-encounter
Generated Narrative: SearchParameter clinical-encounter
Parameter
encounter
:
reference
Observation : Encounter related to the observation
| Resource | Observation |
| Expression |
Observation.encounter
|
| Processing Mode | Normal |
| Target Resources | Encounter |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-focus
Generated Narrative: SearchParameter Observation-focus
Parameter
focus
:
reference
The focus of an observation when the focus is not the patient of record.
| Resource | Observation |
| Expression |
Observation.focus
|
| Processing Mode | Normal |
| Target Resources |
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-has-member
Generated Narrative: SearchParameter Observation-has-member
Parameter
has-member
:
reference
Related resource that belongs to the Observation group
| Resource | Observation |
| Expression |
Observation.hasMember
|
| Processing Mode | Normal |
| Target Resources |
Observation
,
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/clinical-identifier
Generated Narrative: SearchParameter clinical-identifier
Parameter
identifier
:
token
Observation : The unique id for a particular observation
| Resource | Observation |
| Expression |
Observation.identifier
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-instantiates-canonical
Generated
Narrative:
SearchParameter
Observation-instantiates-canonical
10.1.53
instantiates-canonical
TU
Parameter
instantiates-canonical
:
uri
URL
contained
in
instantiatesCanonical.
Resource
Observation
Expression
Observation.instantiates.ofType(canonical)
Processing
Mode
Normal
Multiples
multipleAnd:
It's
up
to
the
server
whether
the
parameter
may
repeat
in
order
to
specify
multiple
values
that
must
all
be
true
multipleOr:
It's
up
to
the
server
whether
the
parameter
can
have
multiple
values
(separated
by
comma)
where
at
least
one
must
be
true
http://hl7.org/fhir/SearchParameter/Observation-instantiates-reference
Generated
Narrative:
SearchParameter
Observation-instantiates-reference
10.1.54
instantiates-reference
TU
Parameter
instantiates-reference
:
reference
Reference
contained
in
instantiatesReference.
Resource
Observation
Expression
Observation.instantiates.ofType(Reference)
Processing
Mode
Normal
Target
Resources
ObservationDefinition
Multiples
multipleAnd:
It's
up
to
the
server
whether
the
parameter
may
repeat
in
order
to
specify
multiple
values
that
must
all
be
true
multipleOr:
It's
up
to
the
server
whether
the
parameter
can
have
multiple
values
(separated
by
comma)
where
at
least
one
must
be
true
http://hl7.org/fhir/SearchParameter/Observation-interpretation
Generated Narrative: SearchParameter Observation-interpretation
Parameter
interpretation
:
token
The interpretation of the observation type
| Resource | Observation |
| Expression |
Observation.interpretation
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-method
Generated Narrative: SearchParameter Observation-method
Parameter
method
:
token
The method used for the observation
| Resource | Observation |
| Expression |
Observation.method
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-part-of
Generated Narrative: SearchParameter Observation-part-of
Parameter
part-of
:
reference
Part of referenced event
| Resource | Observation |
| Expression |
Observation.partOf
|
| Processing Mode | Normal |
| Target Resources | ImagingStudy , Procedure , MedicationStatement , MedicationAdministration , GenomicStudy , Immunization , MedicationDispense |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/clinical-patient
Generated Narrative: SearchParameter clinical-patient
Parameter
patient
:
reference
Observation : The subject that the observation is about (if patient)
| Resource | Observation |
| Expression |
Observation.subject.where(resolve()
is
Patient)
|
| Processing Mode | Normal |
| Target Resources | Patient |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-performer
Generated Narrative: SearchParameter Observation-performer
Parameter
performer
:
reference
Who performed the observation
| Resource | Observation |
| Expression |
Observation.performer
|
| Processing Mode | Normal |
| Target Resources | HealthcareService , Organization , CareTeam , RelatedPerson , PractitionerRole , Practitioner , Group , Patient |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-specimen
http://hl7.org/fhir/SearchParameter/Observation-reference
Generated
Narrative:
SearchParameter
Observation-specimen
Observation-reference
Parameter
:
specimen
reference
reference
Specimen
used
for
this
observation
Observed
body
structure
(reference)
| Resource | Observation |
| Expression |
|
| Processing Mode | Normal |
| Target Resources |
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-status
http://hl7.org/fhir/SearchParameter/Observation-specimen
Generated
Narrative:
SearchParameter
Observation-status
Observation-specimen
Parameter
:
status
specimen
token
reference
The
status
of
the
Specimen
used
for
this
observation
| Resource | Observation |
| Expression |
|
| Processing Mode | Normal |
| Target Resources | Group , Specimen |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-subject
http://hl7.org/fhir/SearchParameter/Observation-status
Generated
Narrative:
SearchParameter
Observation-subject
Observation-status
Parameter
:
subject
status
reference
token
The
subject
that
status
of
the
observation
is
about
| Resource | Observation |
| Expression |
|
| Processing Mode | Normal |
|
|
|
http://hl7.org/fhir/SearchParameter/Observation-value-canonical
http://hl7.org/fhir/SearchParameter/Observation-subject
Generated
Narrative:
SearchParameter
Observation-value-canonical
Observation-subject
Parameter
:
value-canonical
subject
uri
reference
URL
contained
in
valueCanonical.
The
subject
that
the
observation
is
about
| Resource | Observation |
| Expression |
|
| Processing Mode | Normal |
| Target Resources | Device , Organization , Procedure , NutritionProduct , Group , Practitioner , BiologicallyDerivedProduct , Substance , Location , Patient , Medication |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-value-concept
Generated Narrative: SearchParameter Observation-value-concept
Parameter
value-concept
:
token
The value of the observation, if the value is a CodeableConcept
| Resource | Observation |
| Expression |
Observation.value.ofType(CodeableConcept)
|
| Processing Mode | Normal |
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-value-date
Generated Narrative: SearchParameter Observation-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)
|
| Processing Mode | Normal |
| Multiples |
|
| Comparators | Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap |
http://hl7.org/fhir/SearchParameter/Observation-value-quantity
Generated Narrative: 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)
Quantity.
| Resource | Observation |
| Expression |
Observation.value.ofType(Quantity)
|
| Processing Mode | Normal |
| Multiples |
|
| Comparators | Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap |
http://hl7.org/fhir/SearchParameter/Observation-value-reference
Generated Narrative: SearchParameter Observation-value-reference
Parameter
value-reference
:
reference
Reference contained in valueReference.
| Resource | Observation |
| Expression |
Observation.value.ofType(Reference)
|
| Processing Mode | Normal |
| Target Resources |
|
| Multiples |
|
http://hl7.org/fhir/SearchParameter/Observation-value-string
Generated Narrative: SearchParameter Observation-value-string
Parameter
value-string
:
string
String
in
valueString.
The
value
of
the
observation,
if
the
value
is
a
string.
| Resource | Observation |
| Expression |
|
| Processing Mode | Normal |
| Multiples |
|