ORU R01 Scope - (Send Lab Results)

ORU R01 Scope - (Send Lab Results)

ORU R01: Send Test Results To PKB

Overview

This message can be used to send measurements , pathology results and radiology reports to PKB, but the below will focus on the requirements for pathology lab result data.

Laboratory results

Laboratory results will appear in the "Tests" tab in the PKB web interface. A single laboratory report (a.k.a. order) can contain multiple profiles (a.k.a. panels), each of which is reported in its own OBR group.

A "content pattern" indicates how PKB will interpret the contents of your message. This provides additional guidance over and above the syntactic requirements of individual segments.

PKB supports two different content patterns for OBR groups. When a (non-radiology) report is received, we will inspect each OBR group to determine which content pattern has been provided.

Single textual laboratory report

PKB uses the following criteria to determine if the OBR group contains a single textual laboratory report:

  • There are 1 or more OBX segments, which together contain at least 2 lines of text

  • Each OBX segment declares a textual data type (TX, FT, ST)

  • All the OBX segments have matching test IDs (OBX-3.1 and OBX-3.3, case sensitive)

The test code information for a textual laboratory report is taken from the OBR segment (OBR-4).

The OBX segments are treated as lines within the report, and do not maintain their own identity. The contents of the OBR group will be kept together, and displayed as originally provided.

NTE segments will be treated as lines of the report, just like OBX segments; their contents will appear in the same location as provided.

Note: when sending a single textual laboratory report, some metadata fields will only be taken from the first OBX segment. Importantly, if you wish to apply a patient delay this must be provided in the first OBX segment.

Collection of individual test results and measurements

If an OBR group does not contain a single textual laboratory report, then it is assumed to contain a collection of individual test results, each of which is provided in its own OBX segment.

The test code information for an individual result is taken from the OBX segment (OBX-3). Test results are considered to be meaningful even outside the context of the report in which they were provided.

The comments for each test result will be the union of the comments (NTE segments) provided for the OBR group and the comments (NTE segments) provided for the test result specifically.

PKB processes content of this form in an OBX-centric manner. That is, PKB extracts the test results from the report and does not guarantee to display them alongside the other test results with which they were originally provided.

Sometimes, the same test result might be reported as part of more than one profile. This is valid, providing that each OBX segment appears no more than once in any given OBR group. However, since PKB does not include the profile as part of the result identity then all except the first instance of the OBX segment will be silently ignored. It is not valid to provide different results for the same test ID in different profiles within a given laboratory order.

Relevant Entities

Please click through to the Data Model to explore the presentation of these entities in the web interface.

[[Lab Report]]

Matched on: [[Lab Report.External ID]] as derived from ORC-3.1 or OBR-3.1

When matched: Associated [[Lab Result]] entries are individually matched. Note: if a [[Lab Result]] that was previously provided with the [[Lab Report]] is omitted from this [[Lab Report]], the [[Lab Result]] will be left unmodified. It will not be deleted.

Particular care should be given to panels: if a panel is provided with a status of R then all [[Lab Result]] entries previously stored for the corresponding [[Lab Report]] will be marked as deleted, regardless of whether they were previously included in the panel being redacted or whether they are provided in the current message. If the message contains multiple panels where some but not all have a status of R, then PKB will first delete all results associated with the report ID before following the usual create or update workflow for lab results provided in panels that do not have a status of R.

When not matched: New [[Lab Report]] created.

[[Lab Result]]

Matched on: Results are matched on the test ID (OBX-3, or OBR-4 for textual reports). The test ID is matched only on the first and third components (code and code system), and matching is case sensitive.

When matched: If PKB detects a meaningful difference between the provided and existing lab result content, then the existing [[Lab Result]] is replaced in its entirety with the values provided in this message. A partial update is not performed.

Note: that the existence of more than one version of a given lab result is what determines whether PKB displays a correction indicator in the web interface. The correction indicator is not driven by the status value declared by the sender (e.g. OBX-11), and sending more than one message for a given lab order is not guaranteed to trigger the correction indicator since PKB dedupes updates that do not meaningfully change the content of the lab result.

When not matched: New [[Lab Result]] created.

[[Local Test Type]]

Matched on: The test type is identified by the Source Organisation (to ensure no namespace clashes) along with test code, test coding system and units (all matched case sensitively).

When matched: If an existing [[Local Test Type]] is found, it will be updated with the latest Test Name if it differs from what is currently stored. In this way, callers are able to update the display name for their local test types.

When not matched: A new [[Local Test Type]] is created.

[[Measurement Report]]

Matched on: [[Measurement Report.External ID]] as derived from ORC-3.1 or OBR-3.1

When matched: Unlike lab results, measurements in a report are not individually matched for corrections. However, similar to lab reports, if a panel has status R, then any measurements with a matching report ID will be deleted.

When not matched: New [[Measurement Report]] created.

[[Measurement]]

Matched on: There is no unique identifier on a [[Measurement]] submitted via HL7, so they cannot be updated individually.

When matched: N/A

When not matched: New [[Measurement]] created.

Definition

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model
(Lab Reports)

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model
(Lab Reports)

MSH

 

 

 

 

Message header. This conforms to PKB's standard definition.

 

 

PID

 

 

 

 

Patient identification. This conforms to PKB's standard definition.

 

 

[ PV1 ]

 

 

 

 

This is used to include the Hospital Service Code of the observations

 

 

 

PV1-10

O

 

 

Hospital service. See our notes on code sets for more information on our handling of coded data.

 

PV1-10 contributes to privacy label assignment.

 

 

 

 

PV1-10.1

Hospital service code

 

[[Lab Report->Lab Result.Specialty]]

{
[ ORC ]

 

 

 

 

Common order

 

 

 

ORC-3

C

 

 

Filler order number.

At least one of either ORC-3.1 or OBR-3.1 must be provided. It is an error for these values to differ.

 

 

 

 

 

 

ORC-3.1

Filler order number

MYORDER0001

[[Lab Report.External ID]]

if OBR-3 was not provided

 

ORC-13

O

 

 

Enterer's Location

 

 

 

 

 

 

ORC-13.9

Description

Laboratory 1

[[Lab Report.Enterer Location]]

OBR

 

 

 

 

Observation request

 

 

 

OBR-3

C

 

 

Filler order number.

At least one of either ORC-3.1 or OBR-3.1 must be provided. It is an error for these values to differ.

 

 

 

 

 

 

OBR-3.1

Filler order number

MYORDER0001

[[Lab Report.External ID]]

 

OBR-4

C

 

 

Universal service identifier.

See our notes on code sets for more information on our handling of coded data.

For textual reports, these values override the ones in OBX-3, and as such OBR-4.1 is mandatory.

 

If a textual report content pattern

The test type processing uses OBR-4 instead of OBX-3.

Components 1-6 of OBR-4 will be saved into [[Lab Report->Lab Result.Code]].

Note that this will mean the service name and the test name might be the same for some textual reports.

 

 

 

 

OBR-4.1

Service ID

LAB100

The privacy label lookup based on service code is performed regardless of which content pattern was provided.

Then additionally:

If a textual report
Stored in

[[Lab Report->Lab Result->Local Test Type.Test Code]]

Else

Ignored.

 

 

 

 

OBR-4.2

Service name

FBC

[[Lab Report->Lab Result.Service]]

and

[[Lab Report->Lab Result->Local Test Type.Service Name]]

Note: the Local Test Type only stores the most recently provided service name.

 

 

 

 

OBR-4.3

Service coding system

WinPath

If a textual report

Stored in

[[Lab Report->Lab Result->Local Test Type.Test Coding System]]

Else

Ignored.

 

 

 

 

OBR-4.5

Alternative service name

Full Blood Count

Used instead of OBR-4.2 if OBR-4.2 was not provided.

 

OBR-7

C

 

 

Observation timestamp.

This will be used only if there is no timestamp in OBX-14. It is an error for neither to be provided.

 

 

 

 

 

 

OBR-7.1

Observation timestamp

201505191657

[[Lab Report->Lab Result.Timestamp]]

if OBX-14 was not provided

 

OBR-14

O

 

 

Received timestamp.

 

 

 

 

 

 

OBR-14.1

Received timestamp

201505191521

[[Lab Report->Received Timestamp]]

 

OBR-16

O

 

 

Ordered by.

If present, at least the family name must be given.

 

[[Lab Report->Lab Result->Source.Source Text]]

 

 

 

 

OBR-16.2

Family name

Foster

 

 

 

 

 

OBR-16.3

Given name

John

 

 

 

 

 

OBR-16.4

Middle names

Harry

 

 

 

 

 

OBR-16.6

Title

Dr

 

 

OBR-24

O

 

 

Laboratory discipline.

 

 

 

 

 

 

OBR-24.1

Laboratory discipline.

ICU

[[Lab Report->Discipline]]

 

OBR-25

O

 

 

Result status.

If a value of R is provided: any lab results received previously for this report ID will be marked as deleted. OBX segments are not required and will be ignored.
Otherwise: the report is processed as documented.

Note: if the report contains multiple panels where some but not all have a status of R, then PKB will first delete all results associated with the report ID before following the usual create or update workflow for lab results provided in panels that do not have a status of R.

 

 

 

 

 

 

OBR-25.1

Result status

F

 

{ [ NTE ] }

 

 

 

 

NTE segments can be used to include comments. NTE segments immediately following the OBR segment will be considered to apply to all results in this message.

 

 

 

NTE-3

O

 

NTE-3.1

Comment

 

 

 

 

 

 

 

Comment

This is a comment.

These OBR-level comments will be written to

[[Lab Report->Lab Result.Comments]]

Any OBX-level comments will be appended to the OBR-level comments.

{
OBX

 

 

 

 

Observation or result

 

 

 

OBX-2

R

 

 

Value type.

OBX segments with these value types are silently ignored: AD, CP, DT, DTM, ED, MO, PN, RP, TM, TN, XAD, XCN, XON, XPN, XTN

For SN, a numeric value must be provided in OBX-5.2.

For all other value types, note that:
[[Lab Report->Lab Result.Value]] will be set if the supplied value can be parsed as a number, regardless of the declared value type
[[Lab Report->Lab Result.Value Text]] will be set if the result is non-numeric
[[Lab Report->Lab Result.Comments]] will be set if this is a textual report

 

 

 

 

 

 

OBX-2.1

Value type

NM

 

Patients Know Best Wiki Hub | Deploy | Developer | Trust Centre | Manual | Research | Education | Release Notes

© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.

This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.