Skip to main content

Observation

Normative Clinical — Diagnostics

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Observation
InteractionMethodPath
ReadGET/fhir/R5/Observation/[id]
VreadGET/fhir/R5/Observation/[id]/_history/[vid]
UpdatePUT/fhir/R5/Observation/[id]
PatchPATCH/fhir/R5/Observation/[id]
DeleteDELETE/fhir/R5/Observation/[id]
CreatePOST/fhir/R5/Observation
SearchGET/fhir/R5/Observation?...
HistoryGET/fhir/R5/Observation/[id]/_history
Type-historyGET/fhir/R5/Observation/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for observation
instantiates[x]canonical / Reference0..1Instantiates FHIR ObservationDefinition
basedOnReference0..*Fulfills plan, proposal or order
triggeredByBackboneElement0..*Triggering observation(s)
partOfReference0..*Part of referenced event
statuscode1..1registered
categoryCodeableConcept0..*Classification of type of observation
codeCodeableConcept1..1Type of observation (code / type)
subjectReference0..1Who and/or what the observation is about
focusReference0..*What the observation is about, when it is not about the subject of record
encounterReference0..1Healthcare event during which this observation is made
effective[x]dateTime / Period / Timing / instant0..1Clinically relevant time/time-period for observation
issuedinstant0..1Date/Time this version was made available
performerReference0..*Who is responsible for the observation
value[x]Quantity / CodeableConcept / string / boolean / integer / Range / Ratio / SampledData / time / dateTime / Period / Attachment / Reference0..1Actual result
dataAbsentReasonCodeableConcept0..1Why the result is missing
interpretationCodeableConcept0..*High, low, normal, etc
noteAnnotation0..*Comments about the observation
bodySiteCodeableConcept0..1Observed body part
bodyStructureReference0..1Observed body structure
methodCodeableConcept0..1How it was done
specimenReference0..1Specimen used for this observation
deviceReference0..1A reference to the device that generates the measurements or the device settings for the device
referenceRangeBackboneElement0..*Provides guide for interpretation
hasMemberReference0..*Related resource that belongs to the Observation group
derivedFromReference0..*Related resource from which the observation is made
componentBackboneElement0..*Component results

Resource-specific search parameters

ParameterTypeDescription
based-onreferenceReference to the service request.
categorytokenThe classification of the type of observation
codetokenEvent or incident that occurred or was averted
code-value-conceptcompositeCode and coded value parameter pair
code-value-datecompositeCode and date/time value parameter pair
code-value-quantitycompositeCode and quantity value parameter pair
code-value-stringcompositeCode and string value parameter pair
combo-codetokenThe code of the observation type or component type
combo-code-value-conceptcompositeCode and coded value parameter pair, including in components
combo-code-value-quantitycompositeCode and quantity value parameter pair, including in components
combo-data-absent-reasontokenThe reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.
combo-value-concepttokenThe value or component value of the observation, if the value is a CodeableConcept
combo-value-quantityquantityThe 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)
component-codetokenThe component code of the observation type
component-code-value-conceptcompositeComponent code and component coded value parameter pair
component-code-value-quantitycompositeComponent code and component quantity value parameter pair
component-data-absent-reasontokenThe reason why the expected value in the element Observation.component.value[x] is missing.
component-value-canonicaluriURL contained in valueCanonical.
component-value-concepttokenThe value of the component observation, if the value is a CodeableConcept
component-value-quantityquantityThe 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)
component-value-referencereferenceReference contained in valueReference.
data-absent-reasontokenThe reason why the expected value in the element Observation.value[x] is missing.
datedateWhen the event occurred
derived-fromreferenceRelated measurements the observation is made from
devicereferenceThe Device that generated the observation data.
encounterreferenceEncounter related to the activity recorded in the AuditEvent
focusreferenceThe focus of an observation when the focus is not the patient of record.
has-memberreferenceRelated resource that belongs to the Observation group
identifiertokenAccount number
methodtokenThe method used for the observation
part-ofreferencePart of referenced event
patientreferenceThe entity that caused the expenses
performerreferenceWho performed the observation
specimenreferenceSpecimen used for this observation
statustokenThe status of the observation
subjectreferenceThe subject that the observation is about
value-canonicaluriURL contained in valueCanonical.
value-concepttokenThe value of the observation, if the value is a CodeableConcept
value-datedateThe value of the observation, if the value is a date or period of time
value-markdownstringThe value of the observation, if the value is a string, and also searches in CodeableConcept.text
value-quantityquantityThe value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
value-referencereferenceReference contained in valueReference.

Reference

  • Official FHIR R5 spec: Observation
  • Maturity: Normative (FMM 5).