ZorgDomein HL7 V2.4 SRM (2016) Specifications

Transcription

1 ZorgDomein HL7 V2.4 SRM (2016) Specifications Schedule Request Message 2017 V1.4

2 Version history Version Date Author Description Gido Duif Gido Duif Change in AIS Gido Duif Removed ARQ-20 Option: Mobile phone number of the practice Gido Duif Removed ARQ-16 Option: Mobile phone number of the practice Gido Duif Added appointment cancellation request conditions to ARQ-6. 2

3 Introduction This document describes the technical specifications of the ZorgDomein HL7 V2.4 SRM (2016) message. This message contains data that is used for the logistical planning of a patient referral. The subsequent section further describes 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. 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.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. Index Segment Description Page MSH Message Header 4 ARQ Appointment Request Information 4 PID Patient Identification 6 RGS Resource Group Segment 8 AIS Appointment Information - Service 8 AIG Appointment Information - General Resource 8 AIL Appointment Information - Location Resource 9 AIP Appointment Information - Personnel Resource 9 3

4 Segment specifications MSH segment 1 Field Separator. 2 Encoding ^~\&. Characters 3.1 Sending ZorgDomein. Application 5.1 Receiving Name of the receiving application. Application 6.1 Receiving Name of the receiving facility. Facility 7.1 Date/Time Of Message Date/time of message creation. Format: yyyymmddhhmmss+hhmm. 9.1 Message Type SRM. 9.2 If message contains new appointment request: S01. If message contains appointment cancellation request: S SRM_S Message Control Unique message identifier. ID 11.1 Processing ID P Version ID Country NLD. 18 Character Set 8859/1. ARQ segment 1.1 Placer Appointment ID ZorgDomein number. Format: ZDnnnnnnnn, where each n denotes a digit. 6.1 Request Event Reason If message contains new appointment request: of reason of referral. If message contains appointment cancellation request: of reason of cancellation. 6.2 If message contains new appointment request: Reason of referral. If message contains appointment cancellation request: Reason of cancellation zda. 7.1 Appointment of health care product. 7.2 Reason Name of health care product zda. 4

5 8.1 Appointment of type of referral. 8.2 Type Type of referral zda Requested Start Date/Time Start of range of requested date. Based on referral date plus the access time. Format: yyyymmdd Range End of range of requested date. Based on date in ARQ plus 30 days. Format: yyyymmdd. 12 Priority-ARQ If message contains an emergency appointment: S. Else: R Placer Contact The responsible referrer s AGB-code Person The responsible referrer s full surname The responsible referrer s initials VEKTIS. Option: Phone number of the practice 16.1 Placer Contact The phone number of the practice Phone Number PH. Option: Fax number of the practice 16.1 Placer Contact The fax number of the practice Phone Number FX Placer Contact Address Combination of ARQ , ARQ and ARQ The street name of the practice The dwelling number of the practice The other designation of the practice The city name of the practice The postal code of the practice The country code of the practice Placer Contact Name of the responsible referrer s practice Location AGB-code of the responsible referrer s practice Name of the responsible referrer s location Entered By Person If the acting referrer s AGB-code is known: the acting referrer s AGB-code. Else: two double quotation marks ( ) The acting referrer s full surname The acting referrer s initials If ARQ-19.1 contains a value: VEKTIS. Option: Phone number of the practice 20.1 Entered By The phone number of the practice Phone Number PH. 5

6 Option: Fax number of the practice 20.1 Entered By The fax number of the practice Phone Number FX Entered By Name of the acting referrer s practice Location AGB-code of the acting referrer s practice Name of the acting referrer s location. PID segment 1 Set ID - PID 1. Option: Patient s BSN 3.1 Patient Identifier The patient s BSN List NLMINBIZA. 3.5 NNNLD. This option is always supplied in the message. When the BSN is not available, PID-3.1 is left blank. Option: XIS patient ID 3.1 Patient Identifier XIS patient ID List 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 ZorgDomein patient ID List ZorgDomein. 3.5 PI. Option: ZorgDomein number 3.1 Patient Identifier List ZorgDomein number. Format: ZDnnnnnnnn, where each n denotes a digit ZorgDomein. 3.5 VN Patient Name The patient s full surname Prefix of surname in PID The patient s own surname (without prefix) Prefix of surname in PID 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. 6

7 7.1 Date/Time of The patient s date of birth. Format: yyyymmdd. Birth 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 Patient Address Combination of PID , PID and PID The patient s home street name The patient s home dwelling number The patient s home other designation The patient s home city name The patient s home postal code The patient s home country code M. Option: Patient s phone number 13.1 Phone Number - The patient s phone number Home PRN PH. Option: Patient s mobile phone number 13.1 Phone Number - The patient s mobile phone number Home ORN CP. 31 Identity Unknown Indicator If the referrer s verification of the BSN is unknown: Y. Else: N. 32 Identity Reliability 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. RGS segment 1 Set ID - RGS 1. 2 Segment Action U. 7

8 AIS segment 1 Set ID - AIS 1. 2 Segment U. Action 3.1 Universal of supply element. 3.2 Service Name of supply element. 3.3 Identifier If AIS-3.1 contains ZorgDomein defined codes: 99zda. If AIS-3.1 contains user defined codes: 99zdl. Else: Global standard code (see table 0396 of the international HL7 V2.5.1 specifications). 5 Start Date/Time 0. Offset 6.1 Start Date/Time m. Offset Units 9 Allow No. Substitution 11.2 Placer Supplemental Service Information Extra service information as requested by the referrer. AIG segment 1 Set ID - AIG 1. 2 Segment U. Action 3.1 Resource ID of cluster. 3.2 Name of cluster zda. 4.1 Resource Type Two double quotation marks ( ). 9 Start Date/Time 0. Offset 10.1 Start Date/Time m. Offset Units 13 Allow Substitution No. 8

9 AIL segment 1 Set ID - AIL 1. 2 Segment Action U Location of the selected facility s location Resource ID Name of the selected facility s location. 4.1 Location Type- Two double quotation marks ( ). AIL 7 Start Date/Time 0. Offset 8.1 Start Date/Time m. Offset Units 11 Allow Substitution No. AIP segment 1 Set ID - AIP 1. 2 Segment Action U. 3.1 Personnel Resource ID AGB-code of the specialist as requested by the acting referrer. 3.2 Name of the specialist as requested by the acting referrer. 3.9 If AIP-3.1 contains a value: VEKTIS. 4.1 Resource Role Two double quotation marks ( ). 7 Start Date/Time 0. Offset 8.1 Start Date/Time m. Offset Units 11 Allow Substitution No.