Observation - FHIR v6.0.0-ballot3

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

10.1.20 Resource Observation - Search Parameters

Orders and Observations icon

Work Group

Maturity Level: N/A

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

10.1.21 based-on

Parameter based-on:reference

Reference to the service request.

Resource Observation

Expression Observation.basedOn

Processing Mode Normal

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

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-category

Generated Narrative: SearchParameter Observation-category

10.1.22 category

Parameter category:token

The classification of the type of observation

Resource Observation

Expression Observation.category

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/clinical-code

This search parameter is part of the common search parameter clinical-code

Generated Narrative: SearchParameter clinical-code

10.1.23 code TU

Parameter code:token

Observation: The code of the observation type

Resource Observation

Expression Observation.code

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-code-value-concept

Generated Narrative: SearchParameter Observation-code-value-concept

10.1.24 code-value-concept

Parameter code-value-concept:composite

Code and coded value parameter pair

Resource Observation

Expression Observation

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: The parameter may only have one value (no comma separators)

Comparators

code code

value-concept value.ofType(CodeableConcept)

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

Generated Narrative: SearchParameter Observation-code-value-date

10.1.25 code-value-date

Parameter code-value-date:composite

Code and date/time value parameter pair

Resource Observation

Expression Observation

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: The parameter may only have one value (no comma separators)

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

10.1.26 code-value-quantity

Parameter code-value-quantity:composite

Code and quantity value parameter pair

Resource Observation

Expression Observation

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: The parameter may only have one value (no comma separators)

Comparators

code code

value-quantity value.ofType(Quantity)

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

Generated Narrative: SearchParameter Observation-code-value-string

10.1.27 code-value-string

Parameter code-value-string:composite

Code and string value parameter pair

Resource Observation

Expression Observation

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: The parameter may only have one value (no comma separators)

Comparators

code code

value-string value.ofType(string)

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

Generated Narrative: SearchParameter Observation-combo-code

10.1.28 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

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-combo-code-value-concept

Generated Narrative: SearchParameter Observation-combo-code-value-concept

10.1.29 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

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

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

10.1.30 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

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

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

10.1.31 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

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-combo-interpretation

Generated Narrative: SearchParameter Observation-combo-interpretation

10.1.32 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

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-combo-value-concept

Generated Narrative: SearchParameter Observation-combo-value-concept

10.1.33 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

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-combo-value-quantity

Generated Narrative: SearchParameter Observation-combo-value-quantity

10.1.34 combo-value-quantity

Parameter combo-value-quantity:quantity

The value or component value of the observation, if the value is a Quantity.

Resource Observation

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

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

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

10.1.35 component-code

Parameter component-code:token

The component code of the observation type

Resource Observation

Expression Observation.component.code

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-component-code-value-concept

Generated Narrative: SearchParameter Observation-component-code-value-concept

10.1.36 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

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

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

10.1.37 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

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

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

10.1.38 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

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-interpretation

Generated Narrative: SearchParameter Observation-component-interpretation

10.1.39 component-interpretation

Parameter component-interpretation:token

The component interpretation of the observation type

Resource Observation

Expression Observation.component.interpretation

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-component-value-concept

Generated Narrative: 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)

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-component-value-quantity

Generated Narrative: 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.

Resource Observation

Expression Observation.component.value.ofType(Quantity)

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

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

10.1.42 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 MolecularDefinition

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-data-absent-reason

Generated Narrative: SearchParameter Observation-data-absent-reason

10.1.43 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

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/clinical-date

This search parameter is part of the common search parameter clinical-date

Generated Narrative: SearchParameter clinical-date

10.1.44 date TU

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

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

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

10.1.45 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, MolecularDefinition, GenomicStudy, ImagingSelection, QuestionnaireResponse

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-device

Generated Narrative: SearchParameter Observation-device

10.1.46 device

Parameter device:reference

The Device that generated the observation data.

Resource Observation

Expression Observation.device

Processing Mode Normal

Target Resources Device, DeviceMetric

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/clinical-encounter

This search parameter is part of the common search parameter clinical-encounter

Generated Narrative: SearchParameter clinical-encounter

10.1.47 encounter TU

Parameter encounter:reference

Observation: Encounter related to the observation

Resource Observation

Expression Observation.encounter

Processing Mode Normal

Target Resources Encounter

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-focus

Generated Narrative: SearchParameter Observation-focus

10.1.48 focus TU

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 All Resources

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-has-member

Generated Narrative: SearchParameter Observation-has-member

10.1.49 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, MolecularDefinition, QuestionnaireResponse

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/clinical-identifier

This search parameter is part of the common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

10.1.50 identifier TU

Parameter identifier:token

Observation: The unique id for a particular observation

Resource Observation

Expression Observation.identifier

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-interpretation

Generated Narrative: SearchParameter Observation-interpretation

10.1.51 interpretation

Parameter interpretation:token

The interpretation of the observation type

Resource Observation

Expression Observation.interpretation

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-method

Generated Narrative: SearchParameter Observation-method

10.1.52 method

Parameter method:token

The method used for the observation

Resource Observation

Expression Observation.method

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-part-of

Generated Narrative: SearchParameter Observation-part-of

10.1.53 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

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/clinical-patient

This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

10.1.54 patient TU

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

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-performer

Generated Narrative: SearchParameter Observation-performer

10.1.55 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

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-specimen

Generated Narrative: SearchParameter Observation-specimen

10.1.56 specimen

Parameter specimen:reference

Specimen used for this observation

Resource Observation

Expression Observation.specimen

Processing Mode Normal

Target Resources Group, Specimen

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-status

Generated Narrative: SearchParameter Observation-status

10.1.57 status

Parameter status:token

The status of the observation

Resource Observation

Expression Observation.status

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-subject

Generated Narrative: SearchParameter Observation-subject

10.1.58 subject

Parameter subject:reference

The subject that the observation is about

Resource Observation

Expression Observation.subject

Processing Mode Normal

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

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-value-concept

Generated Narrative: SearchParameter Observation-value-concept

10.1.59 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

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-value-date

Generated Narrative: SearchParameter Observation-value-date

10.1.60 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

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

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

10.1.61 value-quantity

Parameter value-quantity:quantity

The value of the observation, if the value is a Quantity.

Resource Observation

Expression Observation.value.ofType(Quantity)

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

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

10.1.62 value-reference

Parameter value-reference:reference

Reference contained in valueReference.

Resource Observation

Expression Observation.value.ofType(Reference)

Processing Mode Normal

Target Resources MolecularDefinition

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-value-string

Generated Narrative: SearchParameter Observation-value-string

10.1.63 value-string

Parameter value-string:string

The value of the observation, if the value is a string.

Resource Observation

Expression Observation.value.ofType(string)

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