---
title: "Entity: Measurement"
canonical: "https://wiki.patientsknowbest.com/space/api/3743186970/Entity%3A%20Measurement"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Measurement](https://miro.com/app/board/uXjVMNUR6dU=/?share_link_id=393815908594)</u>

# Display

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

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fmeasurements&sa=D&sntz=1&usg=AOvVaw0lL3D9y2U8-QUm8LA9tpla)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fmeasurements&sa=D&sntz=1&usg=AOvVaw0lL3D9y2U8-QUm8LA9tpla)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create | [R01/lab](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory) |  |  | [Measurements](https://manual.patientsknowbest.com/patient/measurements) | [/v1/measurements](https://sandbox.patientsknowbest.com/api/index.html#!/Measurements/createMeasurement_1)  
[/v2-beta/measurements/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Measurements/createOrUpdateMeasurementsForPatient_1) |
| Read |  |  |  | [Measurements](https://manual.patientsknowbest.com/patient/measurements) | [/v2-beta/measurements/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Measurements/getMeasurementOfPatient_1)  
[/v2-beta/measurements](https://sandbox.patientsknowbest.com/api/index.html#!/Measurements/getMeasurements_1) |
| Update |  |  |  |  | [/v1/measurements](https://sandbox.patientsknowbest.com/api/index.html#!/Measurements/createMeasurement_1)  
[/v2-beta/measurements/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Measurements/createOrUpdateMeasurementsForPatient_1) |
| Delete | [R01/lab](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory) |  |  | [Measurements](https://manual.patientsknowbest.com/patient/measurements) | [/v1/measurements/[measurementId]](https://sandbox.patientsknowbest.com/api/index.html#/Measurements) |
| **Entity: Measurement Report** |
| **External ID** `String`<br>An ID provided by the sender. | [ORC-3.1 (ORU R01/lab)](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory)  
[OBR-3.1 (ORU R01/lab)](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory) |  |  | Not shown. |  |
| **Entity: Measurement - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Timestamp** `Timestamp`<br>The timestamp when the measurement was taken. | [OBR-7.1 (ORU R01/lab)](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory)  
[OBX-14.1 (ORU R01/lab)](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory) |  |  | Shown. |  |
| **Value** `Number`<br>The value of the measurement. | [OBX-5.1 (ORU R01/lab)](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory) |  |  | Shown. |  |
| **Value2** `Number`<br>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)](https://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory) |  |  | Shown. |  |
| **Value Non-Numeric** `String`<br>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`<br>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`<br>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`<br>The name of the type of measurement. |  |  |  | Shown. |  |
| **Api Reference** `String`<br>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](https://sandbox.patientsknowbest.com/json/v2-beta/measurements/apiRefs). |  |  |  | Not shown. |  |
| **Code System** `String`<br>The code system used. |  |  |  | Not shown. |  |
| **Code of Whole** `String`<br>The code representing the overall measurement. |  |  |  | Not shown. |  |
| **Code** `String`<br>The code of the first value, if this is a multi-valued measurement. |  |  |  | Not shown. |  |
| **Code2** `String`<br>The code of the second value, if this is a multi-valued measurement. |  |  |  | Not shown. |  |
| **Unit** `String`<br>The units of the value. |  |  |  | Shown. |  |
| **Unit2** `String`<br>The units of the second value. |  |  |  | Shown. |  |
| **Category** `Enum`<br>- 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`<br>The code of the measurement. |  |  |  |  |  |
| **Code System** `String`<br>The coding system from which the code was drawn. |  |  |  |  |  |
| **Display Text** `String`<br>A display name for this code. |  |  |  |  |  |
| **Privacy Label **`Enum`<br>- GENERAL_HEALTH
- MENTAL_HEALTH
- SEXUAL_HEALTH
- SOCIAL_CARE |  |  |  |  |  |