Observation
Measurements and simple assertions made about a patient, device or other subject.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Observation/[id] |
| Vread | GET | /fhir/R4/Observation/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Observation/[id] |
| Patch | PATCH | /fhir/R4/Observation/[id] |
| Delete | DELETE | /fhir/R4/Observation/[id] |
| Create | POST | /fhir/R4/Observation |
| Search | GET | /fhir/R4/Observation |
| History | GET | /fhir/R4/Observation/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Business Identifier for observation |
basedOn | Reference | 0..* | Fulfills plan, proposal or order |
partOf | Reference | 0..* | Part of referenced event |
status | code | 1..1 | registered | preliminary | final | amended + |
category | CodeableConcept | 0..* | Classification of type of observation |
code | CodeableConcept | 1..1 | Type of observation (code / type) |
subject | Reference | 0..1 | Who and/or what the observation is about |
focus | Reference | 0..* | What the observation is about, when it is not about the subject of record |
encounter | Reference | 0..1 | Healthcare event during which this observation is made |
effective[x] | dateTime, Period, Timing, instant | 0..1 | Clinically relevant time/time-period for observation |
issued | instant | 0..1 | Date/Time this version was made available |
performer | Reference | 0..* | Who is responsible for the observation |
value[x] | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | 0..1 | Actual result |
dataAbsentReason | CodeableConcept | 0..1 | Why the result is missing |
interpretation | CodeableConcept | 0..* | High, low, normal, etc. |
note | Annotation | 0..* | Comments about the observation |
bodySite | CodeableConcept | 0..1 | Observed body part |
method | CodeableConcept | 0..1 | How it was done |
specimen | Reference | 0..1 | Specimen used for this observation |
device | Reference | 0..1 | (Measurement) Device |
referenceRange | BackboneElement | 0..* | Provides guide for interpretation |
hasMember | Reference | 0..* | Related resource that belongs to the Observation group |
derivedFrom | Reference | 0..* | Related measurements the observation is made from |
component | BackboneElement | 0..* | Component results |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
amino-acid-change | string | HGVS Protein Change |
based-on | reference | Reference to the service request. |
category | token | The classification of the type of observation |
code | token | Multiple Resources: AllergyIntolerance: Code that identifies the allergy or intolerance ; Condition: Code for the condition ; DeviceRequest: Code for what is being requested/ordered ; DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result ; FamilyMemberHistory: A search by a condition code ; List: What the purpose of this list is ; Medication: Returns medications for a specific code ; MedicationAdministration: Return administrations of this medication code ; MedicationDispense: Returns dispenses of this medicine code ; MedicationRequest: Return prescriptions of this medication code ; MedicationStatement: Return statements of this medication code ; Observation: The code of the observation type ; Procedure: A code to identify a procedure ; ServiceRequest: What is being requested/ordered |
code-value-concept | composite | Code and coded value parameter pair |
code-value-date | composite | Code and date/time value parameter pair |
code-value-quantity | composite | Code and quantity value parameter pair |
code-value-string | composite | Code and string value parameter pair |
combo-code | token | The code of the observation type or component type |
combo-code-value-concept | composite | Code and coded value parameter pair, including in components |
combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components |
combo-data-absent-reason | token | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. |
combo-value-concept | token | The value or component value of the observation, if the value is a 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) |
component-code | token | The component code of the observation type |
component-code-value-concept | composite | Component code and component coded value parameter pair |
component-code-value-quantity | composite | Component code and component quantity value parameter pair |
component-data-absent-reason | token | The reason why the expected value in the element Observation.component.value[x] is missing. |
component-value-concept | token | The value of the component observation, if the value is a 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) |
data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. |
date | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made |
derived-from | reference | Related measurements the observation is made from |
device | reference | The Device that generated the observation data. |
dna-variant | string | HGVS DNA variant |
encounter | reference | Multiple Resources: Composition: Context of the Composition ; DeviceRequest: Encounter during which request was created ; DiagnosticReport: The Encounter when the order was made ; DocumentReference: Context of the document content ; Flag: Alert relevant during encounter ; List: Context in which list created ; NutritionOrder: Return nutrition orders with this encounter identifier ; Observation: Encounter related to the observation ; Procedure: Encounter created as part of ; RiskAssessment: Where was assessment performed? ; ServiceRequest: An encounter in which this request is made ; VisionPrescription: Return prescriptions with this encounter identifier |
focus | reference | The focus of an observation when the focus is not the patient of record. |
gene-amino-acid-change | string | HGNC gene symbol and HGVS Protein change |
gene-dnavariant | string | HGNC gene symbol and HGVS DNA Variant |
gene-identifier | token | HGNC gene symbol and identifier |
has-member | reference | Related resource that belongs to the Observation group |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
method | token | The method used for the observation |
part-of | reference | Part of referenced event |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
performer | reference | Who performed the observation |
specimen | reference | Specimen used for this observation |
status | token | The status of the observation |
subject | reference | The subject that the observation is about |
value-concept | token | The value of the observation, if the value is a CodeableConcept |
value-date | date | The value of the observation, if the value is a date or period of time |
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) |
value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text |
Reference
Official FHIR R4 spec: Observation.
Maturity: Trial Use 5 (FMM 5).