HL7 v2 Artefacts

NHS England North West GMSA - IHE Laboratory Testing Workflow (LTW)
0.0.1 - ci-build United Kingdom flag

DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

NHS England North West GMSA - IHE Laboratory Testing Workflow (LTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Message Definitions
- OML_O21 Laboratory Order
- ORU_R01 Unsolicited transmission of an observation message
Segments
- MSH
- PID
- PV1
- ORC
- OBR
- NTE
- DG1
- OBX
- SPM
Data Types
- CE
- CX
- EI
- PL
- NDL
- XCN
- XON
HL7 v2 to FHIR Message Conversion
Example: Example Instances
- OML_O21 Laboratory Order
- ORU_R01 Unsolicited transmission of an observation message

Message Definitions

OML_O21 Laboratory Order

(and ORM_O01 General Order)

References

EPIC HL7 v2 See Outgoing Ancillary Orders (EPR to RIE)
MEDITECH HL7 v2

Message

Segment HL7	Optionality	Notes
MSH	1..1
PID	1..1
PV1	0..1	PV1 should be populated if PV1-19 Visit Number is known
ORDER	1..*
- ORC	1..*
- OBSERVATION REQUEST	1..*
– OBR	1..*
– NTE	0..*
– DG1	0..*
– OBSERVATION	0..*
— OBX	0..*
- SPECIMEN	0..*	Conditional - required for complete order
– SPM	0..1

ORU_R01 Unsolicited transmission of an observation message

References

Digital Health and Care Wales - HL7 ORU_R01 2.5.1 Implementation Guide
- See Appendix A – Using ORU to Publish PDF Reports
HL7 Version 2.5.1 Implementation Guide: Lab Results Interface (LRI), Release 1 from May 2017 includes Data Standards
EPIC HL7 v2 See Discrete Genomic Results (RIE to EPIC EPR)

Message

Segment HL7	Optionality	Notes
MSH	1..1
PID	1..1
PV1	0..1	PV1 should be populated if PV1-19 Visit Number is known
ORDER OBSERVATION	1..*
- ORC	1..*
- OBR	1..*
– OBSERVATION	1..*
– OBX	1..*

Segments

MSH

This is based on the definition of MSH from NHS England HL7 v2 ADT Message Specification

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
MSH-1	Field Separator		R			`
MSH-2	Encoding Characters		R		^~\&
MSH-3	Sending Application		R		iGene
MSH-4	Sending Facility	HD	R	ODS Code	699X0
MSH-5	Receiving Application	HD	R		EPIC
MSH-6	Receiving Facility		R	ODS Code	R0A
MSH-7	Date/Time Of Message		R		20170126143602
MSH-9	Message Type		R		ORU^R01^ORU_R01
MSH-10	Message Control ID		R		2017012614360280000
MSH-11	Processing ID		R		P
MSH-12	Version ID		R		2.5.1
MSH-13	Accept AcknowledgmentType		R		AL

PID

This is based on the definition of PID from NHS England HL7 v2 ADT Message Specification

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
PID-1	Set ID-PID		R		1
PID-3	Patient Identifier List	CX	R	NHS Number Medical Record Number.	633^^^R0A^MR~9449305552^^^NHS^NH
PID-5	Patient Name		R		CHISLETT^Octavia^^Miss
PID-7	Date/Time of Birth		R		20080920
PID-8	Administrative Sex		R		F
PID-11	Patient Address		R		1 RAVENSFIELD GARDENS^^EPSOM^SURREY^KT19 0ST
PID-13	Phone Number - Home		R		01656 123123^PRN^PH~07927655295^ORN^CP^NET^X.400^abc@home.com~01656 123123~01656123123^PRN^PH^^^abc@home.com~01656123123^PRN^PH
PID-32	Identity Reliability Code		O	Mandatory if the the NHS Number tracing status is not known.	01

PV1

The PV1 segment should represent the ordering organisations encounter/PV1, i.e. the one that created the order.

This is based on the definition of PV1 from NHS England HL7 v2 ADT Message Specification

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
PV1-1	Set ID - PV1	PL	R		1
PV1-3	Assigned Patient Location		R		^^^R0A09^^^^^^^R0A ^^^P1S8J^^^^^^^699X0
PV1-8	Referring Doctor	XCN	R	Practitioner Identifier	C3456789^Darwin^Samuel^^^Dr^^^GMC
PV1-10	Hospital Service		R	Service	311
PV1-19	Visit Number	CX	O - SHOULD	Visit Number	12345^^^R0A

ORC

This is based on the definition of ORC from DHCW ORU_R01 Message Specification.

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
ORC-2	Placer Order Number	EI	R	Placer Order Number	1601737^R0A^150^L
ORC-3	Filler Order Number	EI	R	Filler Order Number	1001166717^699X0^^255^ISO
ORC-4	Placer Group Number	EI	R	Placer Group Number	1001166717^699X0^^255^ISO
ORC-5	Order Status		O
ORC-9	Date/Time of Transaction		O
ORC-12	Ordering Provider	XCN	R	Practitioner Identifier	C3456789^Darwin^Samuel^^^Dr^^^GMC
ORC-21	Ordering Facility Name	XON	R	Organisation Code

OBR

This is based on the definition of OBR from DHCW ORU_R01 Message Specification.

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
OBR-1	Set ID - OBR		R		1
OBR-2	Placer Order Number	EI	R	Placer Order Number	1601737^ R0A^150^L
OBR-3	Filler Order Number	EI	R	Filler Order Number	1001166717^699X0^^255^ISO
OBR-4	Universal Service Identifier		R	Genomic Test Directory	R240.1^Diagnostic testing for known variant(s)^England-GenomicTestDirectory
OBR-6	Requested Date/Time		R for OML_O21		20170126135745
OBR-7	Observation Date/Time		R for ORU_R01		20170126135745
OBR-16	Ordering Provider		R	Practitioner Identifier	C3456789^Darwin^Samuel^^^Dr^^^GMC
OBR-22	Results Rpt/Status Chng -Date/Time		R		20170126135745
OBR-32	Principal Result Interpreter	NDL	O - SHOULD	DiagnosticReport.resultsInterpreter[primaryReporter]
OBR-33	Assistant Result Interpreter	NDL	O - SHOULD	DiagnosticReport.resultsInterpreter[secondaryReporter]
OBR-34	Technician	NDL	O - SHOULD	DiagnosticReport.performer[operator]

NTE

Multiple NTE should be converted to a single FHIR Annotation using markdown

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
NTE-1	Set ID - NTE
NTE-2	Source of Comment
NTE-3	Comment
NTE-4	Comment Type

DG1

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
DG1-3	Diagnosis Code	CE
DG1-4	Diagnosis Description

OBX

This is based on the definition of OBX from DHCW ORU_R01 Message Specification.

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
OBX-1	Set ID – OBX		R		1
OBX-2	Value Type		R		ED
OBX-3	Observation Identifier	CE	R	Document Entry Type	1054161000000101^Genetic report^SNM
OBX-5	Observation Value	ED	R		MOL^IM^PDF^Base64^JVBERI0X…
OBX-11	Observation Result Status		R		F
OBX-14	Date/Time of the Observation		O - SHOULD		20190514102417+0000

SPM

This is based on the definition of OBX from DHCW ORU_R01 Message Specification.

Field HL7	Fieldname	Optionality	Example Values
SPM-2	Specimen ID	O	1
SPM-3	Specimen Parent IDs	O
SPM-4	Specimen Type	O	119325001^Skin specimen^SNM
SPM-8	Specimen Source Site	O	299706009^Bone structure of wrist and/or hand^SNM
SPM-9	Specimen Source Site Modifier	O	7771000^Left^SNM
SPM-17	Specimen Collection Date/Time	O
SPM-18	Specimen Received Date/Time	O
SPM-20	Specimen Availability	O
SPM-30	Accession ID	O

Data Types

This applies to HL7 v2 ORU_R01 feeds to the RIE.

ORC-3, ORC-12 (XCN) and ORC-21 (XON) SHALL be populated.

CE

Coded Element. UK SNOMED CT is preferred and may be mandatory depending on use, for example for OXB Type ED, it will be required.

Example

SNOMED

1054161000000101^Genetic report^SNM

LOINC (from HL7 International)

53577-3^Reason for study^LN 51967-8^Genetic disease(s) assessed^LN 48018-6^Gene studied^LN

CX

Extended Composite ID with Check Digit CX.1 - Id Number, CX-4 - Assigning authority and CX.5 - Identifier Type Code are mandatory

Example

NHS Number

9449305552^^^NHS^NH

Medical Record Number

633^^^R0A^MR

EI

Entity Identifier. EI.1 - Entity Identifier and EI.2 - Namespace Id are mandatory

Example

Manchester University NHS Foundation Trust

1601737^R0A

North West GLH Hub

1001166717^699X0

PL

This is based on the definition of PL from NHS England HL7 v2 ADT Message Specification SHOULD be followed and SHALL be used in ORC-12. In addition, this includes of PL.11 to hold organisation ODS code.

The ODS Site Code SHALL belong to the ODS Code. This is to help avoid data issues in this codesystem.

Field HL7	Fieldname	Data Type	Optionality	Table and Notes	Example Values
PL.4	Facility	HD	R	Organisation Site Code	R0A09
PL.11	Assigning Authority For Location	HD	R	Organisation Code	R0A

NDL

This is based on the definitions of NDL from Royal College of Radiologists

Field HL7	Fieldname	Data Type	Optionality	Table and Notes
NDL-1.CNN.1	Id Number	ST	O	Practitioner Identifier
NDL-1.CNN.2	Family Name	ST	O	Surname
NDL-1.CNN.3	Given Name	ST	O	Forename
NDL-7	Facility	HD	O	Organisation Code

XCN

Extended Composite ID Number and Name for Persons. The definition of XCN from NHS England HL7 v2 ADT Message Specification SHOULD be followed and SHALL be used in ORC-12.

Example

GMC Code

C3456789^Darwin^Samuel^^^Dr^^^GMC

XON

Extended Composite Name and Identification Number for Organizations. The definition of XON from NHS England HL7 v2 ADT Message Specification SHOULD be followed and SHALL be used in ORC-21.

Example

MANCHESTER UNIVERSITY NHS FOUNDATION TRUST^^R0A^^^ODS

HL7 v2 to FHIR Message Conversion

Example: Example Instances

OML_O21 Laboratory Order

MSH|^~\&|EPIC|R0A|iGene|699X0|20190514102527+0200||OML^O21^OML_O21|9612365d-52a4-4fab-87e7-8a09d753f095|T|2.5.1|||AL
PID|1||633^^^R0A^MR~9449305552^^^NHS^NH||CHISLETT^Octavia^^Miss||20080920|F|||1 RAVENSFIELD GARDENS^^EPSOM^SURREY^KT19 0ST
PV1|1|N|^^^R0A09^^^^^^^R0A|||||C3456789^Darwin^Samuel^^^Dr^^^GMC||311|||||||||12345^^^R0A
ORC|NW|1601737^R0A|1001166717^699X0||SC||||20170126143602|||C3456789^Darwin^Samuel^^^Dr^^^GMC|||||||||MANCHESTER UNIVERSITY NHS FOUNDATION TRUST^^R0A^^^ODS
OBR|1|1601737^R0A||R240.1^Diagnostic testing for known variant(s)^England-GenomicTestDirectory|||20190514102000+0200|||SCC|O|||20190514102000+0200||C3456789^Darwin^Samuel^^^Dr^^^GMC||||||20190514102417+0200
OBX|1|ED|721965002^Laboratory order^SNM||MOL^IM^PDF^Base64^JVBERi0x...||||||F
SPM|1|25GEN-029GN00001^R0A||||||||||||||||||Y

ORU_R01 Unsolicited transmission of an observation message

MSH|^~\&|iGene|699X0|EPIC|R0A|20190514102527+0200||ORU^R01^ORU_R01|5051095-201905141025|T|2.5.1|||AL
PID|1||633^^^R0A^MR~9449305552^^^NHS^NH||CHISLETT^Octavia^^Miss||20080920|F|||1 RAVENSFIELD GARDENS^^EPSOM^SURREY^KT19 0ST
PV1|1|N|^^^R0A09^^^^^^^R0A|||||C3456789^Darwin^Samuel^^^Dr^^^GMC||311|||||||||12345^^^R0A
ORC|RE|1601737^R0A|1001166717^699X0||CM||||20170126143602|||C3456789^Darwin^Samuel^^^Dr^^^GMC|||||||||MANCHESTER UNIVERSITY NHS FOUNDATION TRUST^^R0A^^^ODS
OBR|1|1601737^R0A|1001166717^699X0|R240.1^Diagnostic testing for known variant(s)^England-GenomicTestDirectory|||20190514102000+0200|||SCC|O|||20190514102000+0200||C3456789^Darwin^Samuel^^^Dr^^^GMC||||||20190514102417+0200
OBX|1|ED|1054161000000101^Genetic report^SNM||MOL^IM^PDF^Base64^JVBERi0x...||||||F

<prev

top

next>

IG © 2024+ Manchester University NHS Foundation Trust. Package north-west.england.nhs.uk#0.0.1 based on FHIR 4.0.1. Generated 2025-04-18
Links: Table of Contents | QA Report | New Issue | Issues Version History | | Propose a change external