Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Class Diagram

MeasurementLab Report

Display

Measurements Test results appear in the Health > Measurements Laboratory 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

Tests

Read

 

 

/Observation

Measurements

Tests

/

v2-beta/measurements/[patientId]

v1/tests/results/forPatient/byTestIds
/v2-beta/tests/

measurements

results

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

Update

R01/lab

 

Measurements

/v1/measurements

 

Delete

R01/lab

Tests

Entity:

Measurement

Lab Report

External ID

String

An ID provided by the sender. This ID allows a sender to modify the data point.

ORC-3.1 (

ORU R01

ORU R01/lab)
OBR-3.1 (

ORU R01

ORU R01/lab)

Not shown

Name

Shown.

Entity: Measurement

Enterer Location String

The name

A description 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.

 

location of the person who entered the request.

ORC-13.9 (ORU R01/lab)

Shown.

Received Timestamp Timestamp

When the lab received the specimen.

OBR-14 (ORU R01/lab)

Shown.

Discipline String

The diagnostic service.

OBR-24 (ORU R01/lab)

Shown.

Facility to provide code set with display name mappings.

Entity: Lab Result - Extends: Data Point

Service String

The overarching service of the lab results.

OBR-4.2 (ORU R01/lab)
OBR-4.5 (ORU R01/lab)

 

 

Code CodeableConcept

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.

For a textual lab report:

OBR-4 (ORU R01/lab)

Else for an individual lab result:

OBX-3 (ORU R01/lab)

 

 

Timestamp Timestamp

The clinically relevant timestamp of the lab result.

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

Observation.effectiveDateTime

Shown.

 

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.

OBX-5.1 (ORU R01/lab)

 

Shown.

 

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.

OBX-5.1 (ORU R01/lab)

 

Shown.

 

Unit2

 

Comments String

The units of the second value.

OBR

Any comments associated with the lab result.

NTE-3.1 (ORU R01/lab)
OBX-5.1 (ORU R01/lab)

 

Shown.

 

Timestamp

Timestamp

The timestamp when the measurement was taken.

Range Low Number

The lowest expected value for this lab result.

OBX-7.1 (ORU R01/lab)

 

Shown.

 

Range Low Inclusive Boolean

Whether or not the Range Low value is inclusive.

OBX-

14

7.1 (ORU R01/lab)

 

Shown.

 

Value

Range High Number

The

value of the measurement

highest expected value for this lab result.

OBX-

5

7.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. This is not a second reading of the first value.

 

Range High Inclusive Boolean

Whether or not the Range High value is inclusive.

OBX-7.1 (ORU R01/lab)

 

Shown.

 

Textual Range String

A textual range is used to indicate the expected outcome for a non-numeric test result.

OBX-7.1 (ORU R01/lab)

 

Shown.

 

Comparator Enum

  • GREATER_OR_EQUAL

  • LESS_OR_EQUAL

  • GREATER

  • LESS

OBX-5.1 (ORU R01/lab)

 

Shown.

 

Value Non-Numeric

String

The value of the measurement if it is not numeric.

 

 

Delay Number

The number of days for which the content of the data point should be hidden from the patient and carers.

OBX-13 (ORU R01/lab)

A placeholder is shown to the patient and carers, letting them know when the content will be displayed.

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

Facade (STU3)

Aggregated (R4)

Summary of interactions

Create

R01/lab

Read

 

 

 

Update

R01/lab

 

 

Delete

Entity: Local Test Type

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

  • TEXT

  • POSNEG

  • NUMERIC

  • VARIES

 

 

 

Entity: LOINC Test Type

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

  • TEXT

  • POSNEG

  • NUMERIC

  • VARIES

Entity: Common LOINC Panel Form

ID Number

An ID for this Common LOINC Panel Form.

Name String

The name of the panel.