OML (LFDv2)

Deprecation warning:

This specification has been deprecated. Please view the OML (V3) message specification for the most recent OML specs.

Introduction

This document describes the technical specifications of the ZorgDomein HL7 V2.5.1 OML (LFDv2) message. This message is used for sending diagnostic requests.

The subsequent sections describe the contents of these segments. The abbreviation ‘Elem.nr’ denotes the element number. Options of a specific field within a segment implies that multiple options can be supplied by repeating the field. Exception: OBR-4, where multiple options can be supplied by repeating the segment. In any case, all available options will be supplied in the message.

ZorgDomein adheres to the message structure and the required fields as specified in the international HL7 V2.5.1 specifications.

In this document, the term ‘acting referrer’ describes the person that used ZorgDomein and actually referred the patient. The term ‘responsible referrer’ describes the person that is responsible for that referral. The two often relate to the same person.

If the ZorgDomein content consists of a value between two double quotes, that value is the fixed value of that specific element.

Segment specifications

MSH - Message Header

Elem.nr.	Field name	ZorgDomein content
1	Field Separator	“\|”.
2	Encoding Characters	“^~\&”.
3.1	Sending Application	“ZorgDomein”.
5.1	Receiving Application	Name of the receiving application.
6.1	Receiving Facility	Name of the receiving facility.
7.1	Date/Time Of Message	Date/time of message creation. Format: yyyyMMddHHmmss+HHmm.
9.1	Message Type	“OML”.
9.2		“O21”.
9.3		“OML_O21”.
10	Message Control ID	Unique message identifier.
11.1	Processing ID	“P”.
12.1	Version ID	“2.5.1”.
17	Country Code	“NLD”.
18	Character Set	“8859/1”.

PID - Patient Identification

Elem.nr.	Field name	ZorgDomein content
1	Set ID - PID	“1”.
Option: Patient’s BSN
3.1	Patient Identifier List	The patient’s BSN.
3.4.1		“NLMINBIZA”.
3.5		“NNNLD”.
Option: XIS patient ID
3.1	Patient Identifier List	XIS patient ID.
3.4.1		The AGB-code of the facility.
3.5		“PI”.
The option “XIS patient ID” supplies all available patient IDs by repeating this field.
Option: ZorgDomein patient ID
3.1	Patient Identifier List	ZorgDomein patient ID.
3.4.1		“ZorgDomein”.
3.5		“PI”.
Option: ZorgDomein number
3.1	Patient Identifier List	ZorgDomein number. Format: ZDnnnnnnnnn, where each n denotes a digit.
3.4.1		“ZorgDomein”.
3.5		“VN”.
5.1.1	Patient Name	The patient’s full surname.
5.1.2		Prefix of surname in PID-5.1.3.
5.1.3		The patient’s own surname (without prefix).
5.1.4		Prefix of surname in PID-5.1.5.
5.1.5		The patient’s spouse surname (without prefix).
5.2		The patient’s first initial.
5.3		The patient’s second and further initials, separated by spaces.
5.7		“L”.
7.1	Date/Time ofBirth	The patient’s date of birth. Format: yyyyMMdd.
8	Administrative Sex	If the patient’s sex is male: “M”. If the patient’s sex is female: “F”. If the patient’s sex is not specified: “O”. If the patient’s sex is unknown: “U”.
11.1.1	Patient Address	Combination of PID-11.1.2, PID-11.1.3, and PID-11.2.
11.1.2		The patient’s home street name.
11.1.3		The patient’s home dwelling number.
11.2		The patient’s home other designation.
11.3		The patient’s home city name.
11.5		The patient’s home postal code.
11.6		The patient’s home country code.
11.7		“M”.
Option: Patient’s phone number
13.1	Phone Number - Home	The patient’s phone number.
13.2		“PRN”.
13.3		“PH”.
Option: Patient’s mobile phone number
13.1	Phone Number - Home	The patient’s mobile phone number.
13.2		“ORN”.
13.3		“CP”.
31	Identity Unknown Indicator	If the referrer’s verification of the BSN is unknown: “Y”. Else: “N”.
32	Identity Reliability Code	“NNNLD”.
The current referrer’s XIS interfaces does not include whether the BSN is verified by the responsible referrer or not. Until the verification of the BSN is supported, PID-31 always supplies: “Y” and PID-32: “NNNLD”.

PV1 - Patient Visit

Elem.nr.	Field name	ZorgDomein content
1	Set ID - PV1	“1”.
2	Patient Class	“O”.
51	Visit Indicator	“V”.

PV2 - Patient Visit - Additional Information

Elem.nr.	Field name	ZorgDomein content
3.1	Admit Reason	Code of health care product.
3.2		Name of health care product.
3.3		“99zda”.

IN1 - Insurance

Elem.nr.	Field name	ZorgDomein content
1	Set ID - IN1	“1”.
2.2	Insurance Plan ID	“null”.
3.1	Insurance Company ID	If UZOVI number is present: UZOVI number. Else: “0”.
3.4.1		If UZOVI number is present: “VEKTIS”. Else: “LOCAL”.
3.5		If UZOVI number is present: “UZOVI”.
4.1	Insurance Company Name	The patient’s insurance company name.
36	Policy Number	The patient’s policy number.

ORC - Common Order

Elem.nr.	Field name	ZorgDomein content
1	Order Control	In case of new order/service: “NW”. In case of cancel order/service request: “CA”. In case of replacement order: “RO”. In case of change order/service request: “XO”.
2.1	Placer Order Number	ZorgDomein number with sequence number. Format: ZDnnnnnnnnn_nn, where each n denotes a digit. The underscore is followed by the sequence number, which is unique within the message, starting from 01.
3.1	Filler Order Number	Order number of the receiving facility.
4.1	Placer Group Number	ZorgDomein number. Format: ZDnnnnnnnnn, where each n denotes a digit.
9.1	Date/Time of Transaction	Date/time of diagnostic request initiation. Format: yyyyMMddHHmmss+HHmm.
10.1	Entered By	The acting referrer’s AGB-code.
10.2.1		The acting referrer’s full surname.
10.3		The acting referrer’s initials.
10.9.1		If ORC-10.1 contains a value: “VEKTIS”.
12.1	Ordering Provider	The responsible referrer’s AGB-code.
12.2.1		The responsible referrer’s full surname.
12.3		The responsible referrer’s initials.
12.9.1		“VEKTIS”.
13.4.1	Enterer’s Location	Name of the acting referrer’s practice.
13.4.2		AGB-code of the acting referrer’s practice.
13.9		Name of the acting referrer’s location.
Option: Phone number for results
14.1	Call Back Phone Number	Phone number for results.
14.2		“WPN”.
14.3		“PH”.
Option: Fax number for results
14.1	Call Back Phone Number	Fax number for results.
14.2		“WPN”.
14.3		“FX”.
15	Order Effective Date/Time	If ORC-1 contains the value “CA”, “RO” or “XO”: Updated date/time of diagnostic request. Format: yyyyMMddHHmmss+HHmm.
17.1	Entering Organization	The AGB-code of the acting referrer’s practice.
17.2		The name of the acting referrer’s practice.
17.3		“VEKTIS”.
19.1	Action By	The responsible updater’s AGB-code.
19.2.1		The responsible updater’s full surname.
19.3		The responsible updater’s initials.
19.9.1		If ORC-19.1 contains a value: “VEKTIS”.
21.1	Ordering Facility Name	The name of the responsible referrer’s practice.
21.3		The AGB-code of the responsible referrer’s practice.
21.6.1		“VEKTIS”.

TQ1 - Time/Quantity

Elem.nr.	Field name	ZorgDomein content
1	Set ID - TQ1	Sequence number unique within message for TQ1 segment. Initial value: “1”. Equal to respective OBR-1 value.
7.1	Start date/time	Requested date for sampling. If TQ1-8.1 also has a value, it explicitly concerns the earliest the date for sampling. Format: yyyyMMddHHmmss+HHmm.
8.1	End date/time	Latest date for sampling. Format: yyyyMMddHHmmss+HHmm.
9.1	Priority	If the acting referrer wishes the results to be called in or faxed: “S”. Else: “R”.
11	Text instruction	Instructions for the collect employee.

OBR - Observation Request

Elem.nr.	Field name	ZorgDomein content
1	Set ID - OBR	Sequence number unique within message for OBR segment. Initial value: “1”. Equal to respective TQ1-1 value.
2.1	Placer Order Number	ZorgDomein number with sequence number. Format: ZDnnnnnnnnn_nn, where each n denotes a digit. The underscore is followed by the sequence number, which is unique within the message, starting from 01.
3.1	Filler Order Number	Order number of the receiving facility.
Option: Diagnostic test
4.1	Universal Service Identifier	Code of diagnostic test.
4.2		Name of diagnostic test.
4.3		If OBR-4.1 contains ZorgDomein defined codes: “99zda”. If OBR-4.1 contains user defined codes: “99zdl”. Else: Global standard code (see table 0396 of the international HL7 V2.5.1 specifications).
For each diagnostic test that is selected by the referrer, this option is provided in the message. Exception: see “Option: Diagnostic test group” mentioned below.
Option: Diagnostic test group
4.1	Universal Service Identifier	Code of diagnostic test group.
4.2		Name of diagnostic test group.
4.3		If OBR-4.1 contains ZorgDomein defined codes: “99zda”. If OBR-4.1 contains user defined codes: “99zdl”.
When the selected diagnostic test group solely consists of required diagnostic tests, this option is provided in the message instead of multiple “Option: Diagnostic test”. All respective information regarding the included diagnostic tests is deduplicated and included in the message.
7.1	Observation Date/Time	Date/time the observation/collection was initiated. Format: yyyyMMddHHmmss+HHmm.
8.1	Observation End Date/Time	Date/time the observation/collection was completed. Format: yyyyMMddHHmmss+HHmm.
10.1	Collector Identifier	The collect employee’s ZorgDomein health care provider ID or AGB-code.
10.2.1		The collect employee’s full surname.
10.3		The collect employee’s initials.
10.9.1		If OBR-10.1 contains a value: “99zda” or “VEKTIS”.
11	Specimen Action Code	If home sampling is requested: “L”. Else: “O”.
13	Relevant Clinical Information	Names of problem groups that include the diagnostic test, as selected by the acting referrer.
16.1	Ordering Provider	The responsible referrer’s AGB-code.
16.2.1		The responsible referrer’s full surname.
16.3		The responsible referrer’s initials.
16.9.1		“VEKTIS”.
Option: Phone number for results
17.1	Order Callback Phone Number	Phone number for results.
17.2		“WPN”.
17.3		“PH”.
Option: Fax number for results
17.1	Order Callback Phone Number	Fax number for results.
17.2		“WPN”.
17.3		“FX”.
28.1	Result Copies To	Code as entered by the acting referrer to send copy to.
28.2.1		Name of person as entered by the acting referrer to send copy to.
28.9.1		If OBR-28.1 contains a value: “VEKTIS”.
39.2	Collector’s Comment	The collect employee’s comment.

OBX - Observation/Result

Elem.nr.	Field name	ZorgDomein content
1	Set ID - OBX	Sequence number unique within the combination of respective ORC, OBR, and OBX segments. Initial value: “1”.
2	Value Type	If OBX-5.2 contains string data: “ST”. If OBX-5.2 contains formatted text: “FT”. If OBX-5.2 contains a date: “DT”. If OBX-5.2 contains encapsulated data: “ED”. If OBX-5.2 contains coded entry: “CE”.
3.1	Observation Identifier	Code of question.
3.2		Label of question.
3.3		If OBX-3.1 contains a value: If OBX-3.1 contains ZorgDomein defined codes: “99zda”. If OBX-3.1 contains user defined codes: “99zdl”. Else: Global standard code (see table 0396 of the international HL7 V2.5.1 specifications).
5.1	Observation Value	Code of answer/option to the question.
5.2		Value of answer/option to the question.
5.3		If OBX-5.1 contains a value: If OBX-5.1 contains ZorgDomein defined codes: “99zda”. If OBX-5.1 contains user defined codes: “99zdl”. Else: Global standard code (see table 0396 of the international HL7 V2.5.1 specifications).
OBX-5 is repeated in case of multiple answers to a single question.
6.1	Units	Unity of the value of answer/option to the question.
7	References Range	The range to which the answer/option to the question is restricted.
11	Observation Result Status	“F”.

SPM - Specimen

Elem.nr.

Field name

ZorgDomein content

Set ID - SPM

Sequence number unique within the combination of respective ORC, OBR, and SPM segments. Initial value: “1”.

4.1

Specimen Type

Code of specimen source.

4.2

Name of specimen source.

4.3

If SPM-4.1 contains ZorgDomein defined codes: “99zda”.
If SPM-4.1 contains user defined codes: “99zdl”.
Else: Global standard code (see table 0396 of the international HL7 V2.5.1 specifications).

17.1.1

Specimen Collection Date/Time

Date/time the observation was initiated.
Format: yyyyMMddHHmmss+HHmm.

17.2.1

Date/time the observation was completed.
Format: yyyyMMddHHmmss+HHmm.

List of possible specimen source names & codes on SPM segment

A fixed set of specimen source codes and names can be expected in SPM-4.1 and SPM-4.2. See the table below for an overview of these codes and names.

Code of specimen source	Name of specimen source
BLD	Bloed
UR	Urine
STL	Feces
ORH	Overig
USPEC	Microbiologie

SAC - Specimen Container

Elem.nr.	Field name	ZorgDomein content
3.1	Container Identifier	Code of container.
3.2	Container Identifier	Name of container.

Version history

Date	Description
25-3-2016	Initial formal publication
25-3-2016	Change in OBR-7, OBR-8, SAC-7.1, SPM-17.1, and SPM-17.2.
4-4-2016	Change in PID-13.2, OBR-4, and OBR-7.
4-4-2016	Structural change in document. Change in OBX segment.
22-4-2016	Change in MSH-10.
29-4-2016	Textual corrections.
4-5-2016	Change in PID-3, IN1-3, ORC-14.2, OBR-17.2, and ORC-10
10-5-2016	Change in IN1-3.
12-5-2016	Change in PID-3, IN1-3, and OBR-10.
24-5-2016	Added exception OBR-4 to introduction. Change in SPM-1 and SPM-2.1.1.
25-5-2016	Change in ORC-2.1, ORC-2.1, and the SPM specimen source table.
26-5-2016	Clarified multiple options mechanics in introduction. Change in PID-3.
1-6-2016	Change in “Effect of order manager on OBX segment” table.
15-6-2016	Change in OBR-7.1 Added OBR-8.1.
28-6-2016	Change in the description below OBR-4 (Diagnostic test group). Clarified the description below PID-3 (XIS patient ID).
7-7-2016	Added OBR-16.
22-8-2016	Added format to OBR-7.1, OBR-8.1, SPM-17.1.1, and SPM-17.2.
5-9-2016	Deleted PID-13 “Option: Patient’s email address”.
13-10-2016	Change in PID-3, PID-11.7 and IN1-3. Added PID-31 and PID-32.
9-3-2017	Removed OBR-4 “Option: Health care product”. Added PV1-51. Added PV2-3. Removed SPM-2. Change in OBX-5. Textual corrections.
14-7-2017	Removed predetermined codes for the Ordermanager.
31-1-2024	Added TQ1-8.1 specification and extra comment for TQ1-7.1
1-2-2024	Removed invalid specification for empty BSN in PID-3