Observation

ResourceClinical · DiagnosticsNormativeMaturity 5

Measurements and simple assertions made about a patient, device or other subject.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

30 of 38 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business 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
statusRequired?!Σ	1..1	code	registered | preliminary | final | amended +Binding (required): observation-status
category	0..*	CodeableConcept	Classification of type of observationBinding (preferred): observation-category
codeRequiredΣ	1..1	CodeableConcept	Type of observation (code / type)Binding (example): observation-codes
subjectΣ	0..1	Reference(Patient | Group | Device | Location)	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..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]Σ	0..1	dateTime | Period | Timing | instant	Clinically relevant time/time-period for observation
issuedΣ	0..1	instant	Date/Time this version was made available
performerΣ	0..*	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)	Who is responsible for the observation
value[x]Σ	0..1	Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period	Actual result
dataAbsentReason	0..1	CodeableConcept	Why the result is missingBinding (extensible): data-absent-reason
interpretation	0..*	CodeableConcept	High, low, normal, etc.Binding (extensible): observation-interpretation
note	0..*	Annotation	Comments about the observation
bodySite	0..1	CodeableConcept	Observed body partBinding (example): body-site
method	0..1	CodeableConcept	How it was doneBinding (example): observation-methods
specimen	0..1	Reference(Specimen)	Specimen used for this observation
device	0..1	Reference(Device | DeviceMetric)	(Measurement) Device
referenceRange	0..*	BackboneElement	Provides guide for interpretation
low	0..1	Quantity	Low Range, if relevant
high	0..1	Quantity	High Range, if relevant
type	0..1	CodeableConcept	Reference range qualifierBinding (preferred): referencerange-meaning
appliesTo	0..*	CodeableConcept	Reference range populationBinding (example): referencerange-appliesto
age	0..1	Range	Applicable age range, if relevant
text	0..1	string	Text 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..*	BackboneElement	Component results
codeRequiredΣ	1..1	CodeableConcept	Type of component observation (code / type)Binding (example): observation-codes
value[x]Σ	0..1	Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period	Actual component result
dataAbsentReason	0..1	CodeableConcept	Why the component result is missingBinding (extensible): data-absent-reason
interpretation	0..*	CodeableConcept	High, low, normal, etc.Binding (extensible): observation-interpretation
referenceRange	0..*	Same as Observation.referenceRange	Provides guide for interpretation of component result

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Observation?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
based-on	reference	Reference to the service request. Observation.basedOn
category	token	The classification of the type of observation Observation.category
code	token	The code of the observation type Observation.code
code-value-concept	composite	Code and coded value parameter pair Observation
code-value-date	composite	Code and date/time value parameter pair Observation
code-value-quantity	composite	Code and quantity value parameter pair Observation
code-value-string	composite	Code and string value parameter pair Observation
combo-code	token	The code of the observation type or component type Observation.code | Observation.component.code
combo-code-value-concept	composite	Code and coded value parameter pair, including in components Observation.component
combo-code-value-quantity	composite	Code and quantity value parameter pair, including in components Observation.component
combo-data-absent-reason	token	The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. Observation.dataAbsentReason | Observation.component.dataAbsentReason
combo-value-concept	token	The value or component value of the observation, if the value is a CodeableConcept (Observation.value.ofType(CodeableConcept)) | (Observation.component.value.ofType(CodeableConcept))
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) (Observation.value.ofType(Quantity)) | (Observation.value.ofType(SampledData)) | (Observation.component.value.ofType(Quantity)) | (Observation.component.value.ofType(SampledData))
component-code	token	The component code of the observation type Observation.component.code
component-code-value-concept	composite	Component code and component coded value parameter pair Observation.component
component-code-value-quantity	composite	Component code and component quantity value parameter pair Observation.component
component-data-absent-reason	token	The reason why the expected value in the element Observation.component.value[x] is missing. Observation.component.dataAbsentReason
component-value-concept	token	The value of the component observation, if the value is a CodeableConcept (Observation.component.value.ofType(CodeableConcept))
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) (Observation.component.value.ofType(Quantity)) | (Observation.component.value.ofType(SampledData))
data-absent-reason	token	The reason why the expected value in the element Observation.value[x] is missing. Observation.dataAbsentReason
date	date	Obtained date/time. If the obtained element is a period, a date that falls in the period Observation.effective
derived-from	reference	Related measurements the observation is made from Observation.derivedFrom
device	reference	The Device that generated the observation data. Observation.device
encounter	reference	Encounter related to the observation Observation.encounter
focus	reference	The focus of an observation when the focus is not the patient of record. Observation.focus
has-member	reference	Related resource that belongs to the Observation group Observation.hasMember
identifier	token	The unique id for a particular observation Observation.identifier
method	token	The method used for the observation Observation.method
part-of	reference	Part of referenced event Observation.partOf
patient	reference	The subject that the observation is about (if patient) Observation.subject.where(resolve() is Patient)
performer	reference	Who performed the observation Observation.performer
specimen	reference	Specimen used for this observation Observation.specimen
status	token	The status of the observation Observation.status
subject	reference	The subject that the observation is about Observation.subject
value-concept	token	The value of the observation, if the value is a CodeableConcept (Observation.value.ofType(CodeableConcept))
value-date	date	The value of the observation, if the value is a date or period of time (Observation.value.ofType(dateTime)) | (Observation.value.ofType(Period))
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) (Observation.value.ofType(Quantity)) | (Observation.value.ofType(SampledData))
value-string	string	The value of the observation, if the value is a string, and also searches in CodeableConcept.text (Observation.value.ofType(string)) | (Observation.value.ofType(CodeableConcept)).text

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition