Observation

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

Endpoints

Interaction

HTTP

URL

Supported Parameters

Permitted User Types

Description

Examples

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

/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

[[Data Point.Privacy Label]] code mappings (PKB → FHIR):

  • 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

 

Observation.code

(as for lab result)

(as for lab result)

 

Observation.subject

A Reference to the Patient.

  • 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]]