Entity: Measurement

Owned by Tom Pick (Unlicensed)
Last updated: Jan 22, 2024
2 min read

Class Diagram

Measurement

Display

Measurements appear in the Health > Measurements page of the patient's record.

Please see the manual for more information.

Mappings

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

R01/lab

 

 

Measurements

/v1/measurements
/v2-beta/measurements/[patientId]

Read

 

 

 

Measurements

/v2-beta/measurements/[patientId]
/v2-beta/measurements

Update

 

 

 

 

/v1/measurements
/v2-beta/measurements/[patientId]

Delete

R01/lab

 

 

Measurements

/v1/measurements/[measurementId]

Entity: Measurement Report

External ID String

An ID provided by the sender.

ORC-3.1 (ORU R01/lab)
OBR-3.1 (ORU R01/lab)

 

 

Not shown.

 

Entity: Measurement - Extends: Data Point

Timestamp Timestamp

The timestamp when the measurement was taken.

OBR-7.1 (ORU R01/lab)
OBX-14.1 (ORU R01/lab)

 

 

Shown.

 

Value Number

The value of the measurement.

OBX-5.1 (ORU R01/lab)

 

 

Shown.

 

Value2 Number

The second value, if relevant. This is intended to allow two related measurements to be grouped together, e.g. diastolic and systolic blood pressure.

OBX-5.1 (ORU R01/lab)

 

 

Shown.

 

Value Non-Numeric String

The value of the measurement if it is not numeric.

 

 

 

Measurements that support non-numeric values can be entered but will not be shown.

 

Code CodeableConcept

If this measurement is linked to a Coded Measurement Type, then this CodeableConcept will contain the original code information that was used to perform the match.

 

 

 

Not shown.

 

Unit String

If this measurement is linked to a Coded Measurement Type, then this value will contain the units that were provided with the measurement.

 

 

 

 

 

Entity: PKB-Defined Measurement Type

Name String

The name of the type of measurement.

 

 

 

Shown.

 

Api Reference String

A textual identifier for this type. The assigned apiRef values are included in the PKB-Defined Measurement Type list which can be fetched from our Custom REST API.

 

 

 

Not shown.

 

Code System String

The code system used.

 

 

 

Not shown.

 

Code of Whole String

The code representing the overall measurement.

 

 

 

Not shown.

 

Code String

The code of the first value, if this is a multi-valued measurement.

 

 

 

Not shown.

 

Code2 String

The code of the second value, if this is a multi-valued measurement.

 

 

 

Not shown.

 

Unit String

The units of the value.

 

 

 

Shown.

 

Unit2 String

The units of the second value.

 

 

 

Shown.

 

Category Enum

  • BMI

  • VITAL_SIGNS

  • STRENGTH

  • BREATHING

  • CHILDHOOD

  • NUTRITION

  • FITNESS

  • ROUTINE

  • SLEEP

  • PREGNANCY

  • DRUG_ALCOHOL

  • OTHER

  • PHYSICAL_HEALTH_CHECK

 

 

 

Measurements from the PHYSICAL_HEALTH_CHECK category cannot be added via the Add measurements screen.

 

Entity: Coded Measurement Type

Code String

The code of the measurement.

 

 

 

 

 

Code System String

The coding system from which the code was drawn.

 

 

 

 

 

Display Text String

A display name for this code.

 

 

 

 

 

Privacy Label Enum

  • GENERAL_HEALTH

  • MENTAL_HEALTH

  • SEXUAL_HEALTH

  • SOCIAL_CARE

 

 

 

 

 

Â