Page Comparison

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

Tests

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

Update

R01/lab

Delete

R01/lab

Tests

Entity: 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/lab)
OBR-3.1 (ORU R01/lab)

Shown.

Enterer Location String

A description of the 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)

Test Code String 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.

OBR-4.1 (ORU R01/lab:textual)
OBX-3.1 For a textual lab report:

OBR-4 (ORU R01/lab)

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.

OBR-4.3 (ORU R01/lab:textual)
OBX-3.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.

Comments String

Any comments associated with the lab result.

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

Shown.

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-7.1 (ORU R01/lab)

Shown.

Range High Number

The highest expected value for this lab result.

OBX-7.1 (ORU R01/lab)

Shown.

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.

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.