Versions Compared

Key

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

...

Segment

Field

Opt

RP/#

Component

Description

Example

Data Model

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 relevant Hospital Service Code.

PV1-10

O

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

PV1-10.1

Hospital service code

[[Radiology Report.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

[[Radiology Report.External ID]]
if OBR-3 was not provided

ORC-13

O

Enterer's Location

ORC-13.9

Description

Laboratory 1

[[Radiology 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

[[Radiology Report.External ID]]

OBR-4

R

Universal service identifier.

This is used to set the title of the report. The message will be rejected if neither OBR-4.2 nor OBR-4.5 contains a name.

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

OBR-4.2

Service name

CHEST XRAY

[[Radiology Report.Title]]

OBR-4.5

Alternative service name

XRAY (CHEST)

[[Radiology Report.Title]]
if OBR-4.2 was not provided

OBR-7

R

This is mandatory for radiology reports.

OBR-7.1

Observation timestamp

201505191657

[[Radiology Report.Timestamp]]

OBR-16

O

Ordered by.

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

[[Radiology Report->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-25

O

Result status.

If a value of R is provided: any radiology reports 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.

OBR-25.1

Result status

F

{ [ NTE ] }

NTE segments can be used to include comments.

NTE-3

O

NTE-3.1

Comment

Comment

This is a comment.

These OBR-level comments are set in

[[Radiology Report.Description]]

{
OBX

Observation or result

OBX-2

R

Value type. Radiology messages only support: FT, TX or ED.

OBX-2.1

Value type

ED

OBX-3

R

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

OBX-3.2

Test name

CHEST XRAY

[[Radiology Report->Attachment.Filename]]

will be set if an attachment is created. If a test name was not provided, then the attachment filename is set to

radiology<timestamp_in_millis>.<lowercase_OBX-5.3>

OBX-3.5

Alternative test name

XRAY (CHEST)

[[Radiology Report->Attachment.Filename]]

will be set if an attachment is created and OBX-3.2 was not provided. If a test name was not provided, then the attachment filename is set to

radiology<timestamp_in_millis>.<lowercase_OBX-5.3>

OBX-5

R

Test result value. Field contents vary based on value type (OBX-2.1).

For ED values we only support the following OBX-5.2/OBX-5.3 combinations:

  • TEXT/HTML

  • APPLICATION/PDF

  • IM/*

OBX-5.1

Application (if OBX-2.1 = ED); Value (otherwise)

APP

If the OBX does not contain an image attachment, then this value is appended to

[[Radiology Report.Description]]

OBX-5.2

Data type (if OBX-2.1 = ED)

IM

OBX-5.3

Sub-data type (if OBX-2.1 = ED)

TIFF

[[Radiology Report->Attachment.Media Type]]

OBX-5.4

Encoding (if OBX-2.1 = ED)

Base64

OBX-5.5

Value (if OBX-2.1 = ED)

JVi0xLjMKJeTjz ...

For ED data, this value is set in

[[Radiology Report->Attachment.Content]]

after being decoded according to OBX-5.4

OBX-11

R

Result status. Only values of F and C will be processed. Values of I, O, P or X (which indicate pending or no results) are silently ignored, whilst any other values will cause an error.

OBX-11.1

Result status

F

OBX-13

O

Custom access rules. Currently supported: "{patientDelay:NUMBERdays}" with any whole number in place of "NUMBER" (no spaces). The patient will see that a radiology report has arrived, but the result value will not be revealed until the set number of days past the date/time of observation have passed. If this field is not specified the patient will be able to see their report immediately.

Note: if this report contains multiple OBX segments, the delay must be provided in the first.

OBX-13.1

Custom access rules

{patientDelay:3days}

{ [ NTE ] }
}

NTE segments can be used to include comments.

NTE-3

O

Comment

NTE-3.1

Comment

This is a comment.

Finally, any OBX-level comments are also appended to

[[Radiology Report.Description]]

...