Class Diagram
Display
Measurements Test results appear in the Health > Measurements Laboratory page of the patient's record.
Please see the manual for more information.
Entity:
...
Lab Result - Extends: Data Point
Entity: Lab Report
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
External ID | String | An ID provided by the sender. This ID allows a sender to modify the data point. |
|
| ||
Enterer Location | String | A description of the location of the person who entered the request. |
|
| ||
Received Timestamp | Timestamp | When the lab received the specimen. |
|
| ||
Discipline | String | The diagnostic service. |
|
|
| HL7 API | FHIR API | Web | Custom REST API | |||
Facade (STU3) | Aggregated (R4) | ||||||
Summary of interactions | |||||||
Read |
|
Write |
Entity: Measurement
Name
String
The name of the type of measurement.
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.
Timestamp
Timestamp
The timestamp when the measurement was taken.
|
/v1/measurements
/v1/measurements/[measurementId]
/v2-beta/measurements/[patientId]
Entity: Measurement Report
External ID
String
An ID provided by the sender.
Not shown.
| |||||||
Entity: Lab Result | |||||||
Service | String | The overarching service of the lab results. |
| Lab result listings page |
| ||
Test Code | String | The code of the test that was performed. This captures the raw value as provided by the input source, for example from an HL7 message. It is not populated when the user enters a result directly into the PKB web UI, which asks them to select a type from a dropdown. |
|
| |||
Test Coding System | String | The coding system of the test that was performed. This captures the raw value as provided by the input source, for example from an HL7 message. It is not populated when the user enters a result directly into the PKB web UI, which asks them to select a type from a dropdown. |
|
| |||
Timestamp | Timestamp | The clinically relevant timestamp of the lab result. | Lab result details page |
| |||
Value | Number | The result value. This will not always be populated. If the result does not parse as a number, or if numeric values are not valid for this test type, then Value Text will be populated instead. Alternatively, if an HL7 message contained the single textual report content pattern, then the text of that report will be populated in the Comments attribute, rather than the Value. |
| Lab results details page |
| ||
Value Text | String | The textual result value. This will not always be populated. If a numeric Value has been assigned then the textual representation is not stored. |
| Lab results details page |
| ||
Comments | String | Any comments associated with the lab result. |
| Lab result details page |
| ||
Range Low | Number | The lowest expected value for this lab result. |
| Lab result details page |
| ||
Range Low Inclusive | Boolean | Whether or not the Range Low value is inclusive. |
|
| |||
Range High | Number | The highest expected value for this lab result. |
| Lab result details page |
| ||
Range High Inclusive | Boolean | Whether or not the Range High value is inclusive. |
|
| |||
Textual Range | String | A textual range is used to indicate the expected outcome for a non-numeric test result. |
| Lab results details page |
| ||
Comparator | Enum |
|
|
Lab results details page |
|
Delay | Number | The |
number of days for which the content of the data point should be hidden from the patient and carers. |
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. This is not a second reading of the first value.
Shown.
Value Non-Numeric
String
Lab result details page A placeholder is shown to the patient and carers, letting them know when the content will be displayed. |
Entity: Local Test Type
| HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) | ||
Summary of interactions | ||||||
Read |
|
|
|
| ||
Write |
|
|
| |||
Attributes | ||||||
ID | Number | An ID for this Local Test Type. |
|
|
|
|
Source Organisation | Ref : [[Organisation.Public ID]] | The organisation which sent this lab result. |
|
|
|
|
Test Code | String | The test code. |
|
|
|
|
Test Coding System | String | The coding system from which the test code was drawn. |
|
|
|
|
Units | String | The units for the test. |
|
|
|
|
Test Name | String | The display name provided for the most recently received test result of this type. |
|
|
|
|
Service Name | String | The display name provided for the service (a.k.a. panel) which contained the most recently received test result of this type. |
|
|
|
|
Expected Value Type | Enum |
|
|
|
|
|
Entity: LOINC Test Type
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
ID | Number | An ID for this LOINC Test Type. |
|
|
| |
LOINC Code | String | The LOINC code. |
|
|
| |
Units | String | The units for the test. |
|
|
| |
Name | String | The display name of the test. |
|
|
| |
Expected Value Type | Enum |
|
|
|
|
Entity: Common LOINC Panel Form
Attribute | Type | Description | HL7 API | FHIR API (Facade) | Custom REST API | Web (Patient) |
ID | Number | An ID for this Common LOINC Panel Form. |
|
|
| |
Name | String | The name of the panel. |
|
|
|