---
title: "Observation"
canonical: "https://wiki.patientsknowbest.com/space/api/3363864676/Observation"
format: markdown
---
[https://www.hl7.org/fhir/STU3/observation.html](https://www.hl7.org/fhir/STU3/observation.html)

## Status

In development. API spec subject to change.

## Overview

The Observation resource type captures multiple PKB data types, such as laboratory results, measurements and symptoms.

## Relevant PKB entities

- [[[Lab Result]]](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363700789)
- [[[Measurement]]](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363700789)
- [[[Symptom]]](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363700789)

## Endpoints

|  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- |
| Interaction | HTTP | URL | Supported Parameters | Permitted User Types | Description | Examples |
| [search](https://www.hl7.org/fhir/STU3/http.html#search) | GET | /Observation | - **category.** Required. Multi-value support: none. Modifier support: none.
- **patient.** Required. Multi-value support: none. Modifier support: [<type>].
- **date.**   Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le]. | - Patient
- Professional | Retrieve observations for a given patient, optionally restricted by date range. | /Observation?category=http://fhir.patientsknowbest.com/codesystem/observation-category|LABORATORY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01<br>/Observation?category=http://fhir.patientsknowbest.com/codesystem/observation-category|LABORATORY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=ge2018-07-01&date=le2018-07-31 |

## Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| FHIR | PKB (Lab Result) | PKB (Measurement) | PKB (Symptom) | Notes |
| Resource id | [[Lab Result.Data Point ID]] | [[Measurement.Data Point ID]] | [[Symptom.Data Point ID]] |  |
| Resource meta | - meta: Meta
  - lastUpdated = [[Data Point.Persisted Timestamp]]
  - security: Coding
    - system =  "[http://fhir.patientsknowbest.com/codesystem/privacy-label](http://fhir.patientsknowbest.com/codesystem/privacy-label)"
    - code = [[Data Point.Privacy Label]]<br>[[Data Point.Privacy Label]] code mappings (PKB → FHIR):<br>- GENERAL_HEALTH → GENERAL_HEALTH
- MENTAL_HEALTH → MENTAL_HEALTH
- SEXUAL_HEALTH → SEXUAL_HEALTH
- SOCIAL_CARE → SOCIAL_CARE | (as for lab result) | (as for lab result) |  |
| Observation.status | "unknown" | (as for lab result) | (as for lab result) |  |
| Observation.category | - category: CodeableConcept
  - coding: Coding
    - code = "LABORATORY"
    - display = "Laboratory"
    - system =  "[http://fhir.patientsknowbest.com/codesystem/observation-category](http://fhir.patientsknowbest.com/codesystem/observation-category)” | - category: CodeableConcept
  - coding: Coding
    - code =  "MEASUREMENT"
    - display =  "Measurement"
    - system =  "[http://fhir.patientsknowbest.com/codesystem/observation-category](http://fhir.patientsknowbest.com/codesystem/observation-category)" | - category: CodeableConcept
  - coding: Coding
    - code =  "SYMPTOM"
    - display =  "Symptom"
    - system =  "[http://fhir.patientsknowbest.com/codesystem/observation-category](http://fhir.patientsknowbest.com/codesystem/observation-category)" |  |
| Observation.code | - extension[0]: Extension
  - url = "[http://hl7.org/fhir/StructureDefinition/data-absent-reason](http://hl7.org/fhir/StructureDefinition/data-absent-reason)"
  - valueCode = "unknown" | (as for lab result) | (as for lab result) |  |
| Observation.subject | A Reference to the Patient.<br>- subject: Reference
  - reference = the relative URL of the Patient
  - display = [[User.Title]] [[User.Given Name]] [[User.Family Name]] | (as for lab result) | (as for lab result) |  |
| Observation.effectiveDateTime | [[Lab Result.Timestamp]] | [[Measurement.Timestamp]] | [[Symptom.Timestamp]] |  |