Search

HL7 V2.4 ORU (PDF) specifications

Introduction

This document describes the technical specifications of the ZorgDomein HL7 V2.4 ORU (PDF) message. This message contains metadata about a request form or referral letter and the form or letter itself in PDF format. The message model describes the structure of this message.

The subsequent section further describes the contents of these segments. The abbreviation ‘Elem.nr’ denotes the element number.

ZorgDomein adheres to the required fields as specified in the international HL7 V2.4 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 specification

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 Date/Time Of Message Date/time of message creation. Format: yyyyMMddHHmmss+HHmm.
9.1 Message Type “ORU”.
9.2 “R01”.
10 Message Control ID In case of Patient Conversation export: Unique message identifier.
Else: ZorgDomein number. Format: ZDnnnnnnnn, where each n denotes a digit.
11.1 Processing ID “P”.
12.1 Version ID “2.4”.

PID - Patient Identification

Elem.nr. Field name ZorgDomein content
1 Set ID - PID “1”.
3.1 Patient Identifier List Two options, depending on presence. A overrides B:
A) CS-Zorgportaal patient ID.
B) The patient’s BSN.
3.4.1 If PID-3.1 option A: “ZIS”.
Else: “NLMINBIZA”.
3.5 If PID-3.1 option A: “PI”.
Else: “NNNLD”.
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 Date/Time of Birth 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”.
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 “H”.
13.1 Phone Number - Home The patient’s phone number.

PV1 - Patient Visit

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

ORC - Common Order

Elem.nr. Field name ZorgDomein content
1 Order Control “NW”.
2.1 Placer Order Number In case of Patient Conversation export: Unique message identifier.
Else: ZorgDomein number. Format: ZDnnnnnnnn, where each n denotes a digit.
9 Date/Time Of Message Date/time of message creation. Format: yyyyMMddHHmmss+HHmm
10.1 Entered By The acting referrer’s AGB code.
10.2.3 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 is known.
12.2.3 The responsible referrer’s full surname.
12.3 The responsible referrer’s initials.
12.9.1 “VEKTIS”.
14.1 Call Back Phone Number The phone number of the practice.

OBR - Observation Request

Elem.nr. Field name ZorgDomein content
1 Set ID - OBR “1”.
2.1 Placer Order Number In case of Patient Conversation export: Unique message identifier.
Else: ZorgDomein number. Format: ZDnnnnnnnn, where each n denotes a digit.
4.1 Universal Service Identifier In case of Patient Conversation export: "PO".
Else: Code of cluster.
4.2 In case of Patient Conversation export: "Patiëntoverleg".
Else: Name of specialism.
4.3 “ZORGDOMEIN”.
7 Observation Date/Time Date/time of respective logistic referral. Format: yyyyMMddHHmmss+HHmm.
16.1 Ordering Provider The responsible referrer’s AGB code.
16.2.3 The responsible referrer’s full surname.
16.3 The responsible referrer’s initials.
16.9.1 “VEKTIS”.

OBX(1) - Observation/Result

Elem.nr. Field name ZorgDomein content
1 Set ID - OBX “1”.
2 Value Type “NM”.
3.1 Observation Identifier Three options, depending on what type of document the message contains:
A) If referral letter: “VB”.
B) If diagnostic request or questionnaire: “AF”.
C) If patient conversation chat log: “PO”.
3.3 “123”.
11 Observation Result Status “F”.

OBX(2) - Observation/Result

Elem.nr. Field name ZorgDomein content
1 Set ID - OBX “2”.
2 Value Type “ED”.
3.1 Observation Identifier In case of Patient Conversation export: "PO".
Else: Code of reason of referral.
3.2 In case of Patient Conversation export: "Patiëntoverleg".
Else: The leaf node of the reason of referral.
3.3 “ZORGDOMEIN”.
5.2 Observation Value “application”.
5.3 “pdf”.
5.4 “Base64”.
5.5 If OBX(1)-3.1 option A: referral letter in PDF format, encoded in Base64.
If OBX(1)-3.1 option B: diagnostic request or questionnaire in PDF format, encoded in Base64.
11 Observation Result Status “F”.

OBX(3) - Observation/Result

Elem.nr. Field name ZorgDomein content
1 Set ID - OBX “3”.
2 Value Type “FT”.
3.1 Observation Identifier Code of health care product.
3.2 Name of health care product.
3.3 “ZORGDOMEIN”.
11 Observation Result Status “F”.

Version history

Version Date Author Description
1.0 10-3-2016 Gido Duif -
1.1 23-3-2016 Gido Duif Change in OBX-11. Structural change in segment specifications tables.
1.2 22-4-2016 Gido Duif Change in OBX(1)-3.1 and OBX(2)-5.5.
1.3 29-4-2016 Gido Duif Textual corrections.
1.4 26-4-2017 Gido Duif Added OBX(1)-11 and OBX(3)-11. Added option “PO” to OBX(1)-3.1.
1.5 19-6-2018 Gido Duif Added Patient Conversation functionality: change in MSH-10, ORC-2.1, OBR-2.1, OBR-4, and OBX(2)-3.1.