HL7 implementation in HK (by HA)

HL7 Implementation Guide For Hospital Authority Prepared by: EM(HI) and IS4 Team ITD, Hospital Authority Version 1.1.4 Dec 2004 HL7 Implementation Guide Dec 2004 TABLE OF CONTENTS TABLE OF CONTENTS ...................................................................................................................... 2 LIST OF TABLES ................................................................................................................................. 5 AMENDMENT HISTORY ................................................................................................................... 6 1 INTRODUCTION ......................................................................................................... 7 1.1 1.2 1.3 1.4 2 OBJECTIVES ..................................................................................................................... 7 INTENDED READERS ........................................................................................................ 7 SCOPE .............................................................................................................................. 7 RELATED GUIDANCE AND PREREQUISITE ........................................................................ 7 MESSAGE...................................................................................................................... 8 2.1 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.3 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8 2.3.9 2.4 2.4.1 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.4.7 2.4.8 2.4.9 2.4.10 2.4.11 2.4.12 GENERAL ......................................................................................................................... 8 HA DEFINED DATA TYPE ................................................................................................. 8 HAOPID – HA Operator Identity .....................................................................................8 HAPN – HA Patient Name................................................................................................9 HAAD – HA Patient Address ............................................................................................9 HAPL – HA Assigned Patient Location ..........................................................................10 HA DEFINED TABLE ....................................................................................................... 10 HA0001 – Institution Code Table ...................................................................................10 HA0002 – Cluster Code Table ........................................................................................10 HA0003 – Hospital and General Outpatient Clinic Code Table .................................... 11 HA0004 – Patient Name Type Code Table......................................................................14 HA0005 – District Code Table........................................................................................14 HA0006 – Assigning Facility Code Table .......................................................................15 HA0007 –Identifier Type Code Table..............................................................................15 HA0008 –Entity ID Code Table ......................................................................................15 HA0009 – LOINC and HA Entity ID Mapping Table .....................................................16 PATIENT ADMINISTRATION TRIGGER EVENT DESCRIPTIONS ......................................... 17 ADTÂ01 Admit/Visit Notification ................................................................................17 ADTÂ02 Transfer a Patient ........................................................................................18 ADTÂ03 Discharge/End Visit......................................................................................18 ADTÂ04 Register a Patient .........................................................................................19 ADTÂ05 Pre-admit a Patient ......................................................................................20 ADTÂ08 Update Patient Information .........................................................................20 ADTÂ11 Cancel Admit/Visit Notification ....................................................................21 ADTÂ12 Cancel Transfer ............................................................................................22 ADTÂ13 Cancel Discharge/End Visit .........................................................................22 ADTÂ18 Merge Patients .............................................................................................23 QRYÂ19/ADRÂ19 Patient Query ..............................................................................24 ADTÂ21 Patient Goes on a ‘Leave of Absence’ .........................................................24 Prepared by EM(HI) and IS4 Team, ITD Page 2 HL7 Implementation Guide 2.4.13 2.4.14 2.4.15 2.4.16 2.4.17 2.4.18 2.5 2.5.1 2.5.2 2.5.3 2.5.4 2.6 2.6.1 2.6.2 2.6.3 2.6.4 2.7 2.7.1 2.7.2 2.7.3 2.8 2.8.1 2.9 2.10 2.11 2.12 2.13 2.14 2.14.1 3 Dec 2004 ADTÂ22 Patient Returns from a ‘Leave of Absence’ ..................................................25 ADTÂ28 Add Personal Information............................................................................25 ADTÂ40 Merge Patient – Patient Identifier List ........................................................26 ADTÂ45 Move Visit Information.................................................................................27 ADTÂ46 Change Patient ID .......................................................................................27 ADTÂ47 Change Patient Identifier List ......................................................................28 ORDER ENTRY EVENT DESCRIPTIONS ........................................................................... 28 ORMÔ01 & ORRÔ02 General Order Message (Excluding Supply, Pharmacy and Dietary)...........................................................................................................................28 ORMÔ01^RDO_O01 General Order Message (Pharmacy only).............................29 RDEÔ01 & RREÔ02 Pharmacy/treatment encoded order message ...........................30 RDSÔ01 & RRDÔ02 Pharmacy/treatment dispense message ..................................31 OBSERVATION REPORTING EVENT DESCRIPTIONS ......................................................... 33 ORU^R01 Unsolicited Transmission of an Observation Message ...............................33 QRY^R02 Query for results of observation (R02/R04 record oriented results) ............33 QRY^R02 Query for results of observation (R02/R05 – display oriented results)........34 UDM^R06 Unsolicited Transmission of an Observation Message (Display oriented results) ............................................................................................................................35 SCHEDULING EVENT DESCRIPTIONS.............................................................................. 36 SRM/SRR^S01 Request New Appointment Booking and response .................................36 SRM/SRR^S04 Request Appointment Cancellation and response ..................................38 SQM/SQR^S25 Schedule Query Message and response.................................................40 QUERY EVENT DESCRIPTIONS ....................................................................................... 41 QRY/DSR – original mode display query – immediate response (event Q01)................41 PATIENT CARE EVENT DESCRIPTIONS............................................................................ 42 PATIENT REFERRAL EVENT DESCRIPTIONS .................................................................... 42 FINANCIAL MANAGEMENT EVENT DESCRIPTIONS ........................................................ 42 MASTER FILES EVENT DESCRIPTIONS ........................................................................... 42 MEDICAL RECORDS/INFORMATION MANAGEMENT EVENT DESCRIPTIONS .................. 42 NETWORK MANAGEMENT EVENT DESCRIPTION ........................................................... 42 NMQ/NMR Network Management Query Message .....................................................42 MESSAGE SEGMENT ............................................................................................... 44 3.1 3.1.1 3.1.2 3.1.3 3.1.4 3.1.5 3.1.6 3.1.7 3.1.8 3.1.9 3.1.10 3.1.11 3.1.12 GENERAL ....................................................................................................................... 44 MSH Message Header Segment .....................................................................................45 MSA Message Acknowledgement Segment .....................................................................47 EVN Event Type Segment................................................................................................48 PID Patient Identification Segment ................................................................................49 PV1 Patient Visit Segment ..............................................................................................54 NK1 Next of Kin Segment ...............................................................................................59 MRG Merge Patient Information Segment .....................................................................62 Observation Report (OBR) Segment...............................................................................64 Observation (OBX) Segment ..........................................................................................68 Common Order (ORC) Segment .....................................................................................69 Original-style Query Definition Segment (QRD) ...........................................................71 Original-style Query Filter Segment (QRF) ...................................................................71 Prepared by EM(HI) and IS4 Team, ITD Page 3 HL7 Implementation Guide 3.1.13 3.1.14 3.1.15 3.1.16 3.1.17 3.1.18 3.1.19 3.1.20 3.1.21 3.1.22 3.1.23 Dec 2004 Query Acknowledgement (QAK) Segment ......................................................................72 Display Data (DSP) Segment .........................................................................................73 Pharmacy/Treatment Order (RXO) Segment .................................................................73 Pharmacy Route (RXR) Segment ...................................................................................74 Pharmacy Component (RXC) Segment..........................................................................75 Pharmacy Encoded Order (RXE) Segment ....................................................................75 Pharmacy Dispense (RXD) Segment .............................................................................77 Appointment Request (ARQ) Segment ...........................................................................78 Resource Group (RGS) Segment.....................................................................................79 Schedule Activity (SCH) Segment ...................................................................................80 Status Change (NSC) Segment........................................................................................81 4 LOWER LEVEL PROTOCOL .................................................................................. 82 5 GLOSSARY OF TERMS ............................................................................................ 83 5.1 6 ABBREVIATIONS USED IN THIS DOCUMENT .................................................................... 83 REFERENCE .............................................................................................................. 84 APPENDIX A ....................................................................................................................................... 85 APPENDIX B ....................................................................................................................................... 98 Prepared by EM(HI) and IS4 Team, ITD Page 4 HL7 Implementation Guide Dec 2004 LIST OF TABLES HA0001 – Institution Code Table .......................................................................................................... 10 HA0002 – Cluster Code Table................................................................................................................ 11 HA0003 – Hospital & GOPC Code Table .............................................................................................. 11 HA0004 – Patient Name Type Code Table ............................................................................................ 14 HA0005 – District Code Table .............................................................................................................. 15 HA0006 – Assigning Facility Code Table ............................................................................................. 15 HA0007 –Identifier Type Code Table ................................................................................................... 15 HA0008 – Entity ID Table..................................................................................................................... 16 HA0009 – LOINC and Entity ID Mapping Table ................................................................................. 16 Explanation of Segment Field ............................................................................................................... 44 Message Header (MSH) Segment ......................................................................................................... 45 Message Acknowledgment (MSA) Segment ......................................................................................... 48 Event Type (EVN) Segment .................................................................................................................. 48 Patient Identification (PID) Segment .................................................................................................... 49 Patient Visit (PV1) Segment .................................................................................................................. 54 Next of Kin (NK1) Segment.................................................................................................................. 59 Merge Patient Information (MRG) Segment ......................................................................................... 62 Observation Report (OBR) Segment ..................................................................................................... 64 Observation (OBX) Segment ................................................................................................................ 68 Common Order (ORC) Segment ........................................................................................................... 69 Original-style Query Definition (QRD) Segment ................................................................................. 71 Original-style Query Filter (QRF) Segment .......................................................................................... 72 Display (DSP) Segment ......................................................................................................................... 73 Pharmacy/Treatment Order (RXO) Segment ....................................................................................... 73 Pharmacy Route Order (RXR) Segment .............................................................................................. 75 Pharmacy Component (RXC) Segment ................................................................................................ 75 Pharmacy Encoded Order (RXE) Segment .......................................................................................... 76 Pharmacy Dispense Order (RXD) Segment ......................................................................................... 77 A.1.1 Field to field mapping table........................................................................................... 85 A.1.2 Transaction Type to Events Mapping Table ................................................................... 92 A.2.1 Field to field mapping table........................................................................................... 93 A.3.1 Request Information ...................................................................................................... 95 A.3.2 Result Information ......................................................................................................... 96 Delimiter values of HL7 Message ......................................................................................................... 98 Prepared by EM(HI) and IS4 Team, ITD Page 5 HL7 Implementation Guide Dec 2004 AMENDMENT HISTORY Version No. 1.0.0 1.1.0 Date of Amendment Dec 2002 May 2003 1.1.1 Aug 2003 1.1.2 Dec 2003 1.1.3 Mar 2004 1.1.4 Prepared by Description IS5, IT Department of HA Initial Version IS5, IT Department of HA 1. Add 10 new trigger events to Sections 2.4, 2.5, 2.6 and 2.8 2. Change the title of A19 3. Add 9 new segment definitions to Section 3.1 4. Add 2 mapping tables for GCR/GRR in Appendix I A.3 IS4, IT Department of HA 1. Change the project team code from IS5 to IS4 2. Add Lower Level Protocol Section IS4, IT Department of HA 1. Fix the example bug for Patient Address and Location 2. Fix the bug for Cluster Code Table 3. Update Hospital Code Table 4. Add Entity ID Code Table 5. Add LOINC and Entity ID Mapping Table 6. Amend HA defined Data Type 7. Amend HA0004 Table 8. Added MSA Segment IS4, IT Department of HA 1. Add substitution of special char on Appendix II Apr 2004 IS4, IT Department of HA 1. Fix PID5 HAPN Format May 2004 CD1&IS4, IT Department of HA Dec 2004 IS4, IT Department of HA 1. Format Document to comply with HA SDLC Documentation Standard 2. Add New HL7 Messages ADTÂ40, SRM^S01, SRM^S04, NMQ, NMR and Segments QAK, ARQ, RGS, SCH, NSC 3. Remove an extra field in the HAPN example Prepared by EM(HI) and IS4 Team, ITD 1. Update Hospital Code Table to Hospital & GOPC Code Table 2. Add Note in ORC, OBR, OBX segment for Laboratory Order and Result Page 6 HL7 Implementation Guide Dec 2004 1 INTRODUCTION 1.1 Objectives The objective of HL7 Reference Guide for Hospital Authority (HA) provides the guideline on implementation of Health Level Seven (HL7) Version 2.3.1 standard on HA. It acts as an electronic data communication protocol at the application level for heterogeneous systems serving HA. The implementation of HL7 on this reference matches with the current business environment of HA. 1.2 Intended Readers This document is aimed at all parties involving electronic data communication including Information Technology Division Managers and their staffs, Hospital Users, User Consultation Group (UCG) members and corresponding external vendors, suppliers and trading parties. It may also be of interest to Business / User Managers and Project Team’s System Managers. 1.3 Scope This Reference defines the implementation of the HL7 Version 2.3.1 protocol, for the exchange of on-line, real-time HL7 messages among heterogeneous systems in the HA systems. Specifically, this document contains  reference information including reference documents and definitions  trigger event descriptions e.g. A01 Admit/visit notification  message segments e.g. Patient Identification (PID) Segment.  examples of triggers The specification provides interpretation and guidance on which HL7 trigger events, segments and data elements are mandatory (required), optional, or conditional (required, based on a condition), and gives relevant usage notes. This specification will continue to be further developed in the future to cope with any new development in HA. 1.4 Related Guidance and Prerequisite This document is not intended to be a standalone document. The reader should be familiar with the general requirements of HL7 Standard and should also have a good understanding of the HA System. Prepared by EM(HI) and IS4 Team, ITD Page 7 HL7 Implementation Guide Dec 2004 2 MESSAGE 2.1 General A trigger is simply a recognised event that will cause a HL7 Message to be formatted and sent. In HL7, the message structure is dependent upon the Trigger Event being represented. An unsolicited message is one that is sent as a result of some sort of activity within the sending system, while a solicited message is one that was sent in response to a HL7 message requesting the information. It is assumed that the sending systems will produce transactions only after performing the relevant validation checks to confirm that data integrity has been maintained Most trigger events are served by the ADT unsolicited update and the General Immediate ACK response. Both admitted and non-admitted patient trigger events are generated using most of the same trigger event codes. The meaning or interpretation of the trigger event depends on the type of patient For the events, messages, data types or code tables that have not defined in this document, please refer to HL7 Version 2.3.1 specification. 2.2 HA Defined Data Type HL7 Version 2.3.1 defines various data type (Referred to Chapter 2 HL7 Version 2.3.1). On this reference, most of them are utilized on elements of different segments. However, in order to ally with the real health care environment in HA, some new data types are defined to substitute particular data types of elements on some segments. 2.2.1 HAOPID – HA Operator Identity The type provides the identification of a staff in the healthcare system of Hospital Authority inherited from XCN. Format: Components: < Operator Code (ST)>^< Operator Family Name (ST)>^< Operator Given Name (ST)>^^^^^^^ < Operator Type (ID)>^^^^< HospitalCode (ID)> Example: (i) Operator Code is ‘CHWONG’ (ii) Operator Family Name is ‘WONG’ (iii) Operator Given Name is ‘CHI KONG’ (iv) Operator Type is ‘LABTECH’ Prepared by EM(HI) and IS4 Team, ITD Page 8 HL7 Implementation Guide Dec 2004 (v) Hospital Code is ‘UCH’ |CHWONG^WONG^CHI KONG^^^^^^^LABTECH^^^ÛCH| 2.2.2 HAPN – HA Patient Name The type provides the name of patient under the Healthcare system of HA and is inherited from XPN. The corresponded HA defined tables of element Patient Name Type is HA0004. Including Name Type (Name Type Code) from below: -English Patient Name (EN), -Chinese Patient Name (CN), -1st Chinese Character Code (CCC_1), -2nd Chinese Character Code (CCC_2), -3rd Chinese Character Code (CCC_3), -4th Chinese Character Code (CCC_4), -5th Chinese Character Code (CCC_5), -6th Chinese Character Code (CCC_6) Format: Components: <Patient Family Name (ST)>^<Patient GivenName (ST)>^^^^<Patient Name type (IS)> Example: (i) English Patient Family Name is ‘CHAN’ (ii) English Patient Given Name is ‘TAI MAN’ (iii) Chinese Patient Name is ‘’ (iv) 1st Chinese Character Code is ‘1111’ (v) 2nd Chinese Character Code is ‘2322’ (vi) 3rd Chinese Character Code is ‘3333’ (vii) 4rhChinese Character Code is ‘4444’ (viii) 5rhChinese Character Code is ‘5555’ (ix ) 6rhChinese Character Code is ‘6666’ |CHAN^TAI MAN^^^ÊN~^^^^^CN~1111^^^^^CCC_1~2222^^^^^CCC_2~3333^^^^^CCC_3~4444^^^^^CCC_4~55 55^^^^^CCC_5~6666^^^^^CCC_6| 2.2.3 HAAD – HA Patient Address The type provides the address of patient under the Healthcare system of HA and is inherited from XAD. The corresponded HA defined tables of element District Code is HA0005. Format: Components: <Room (ST)>^<Floor (ST)>^<Block (ST)>^<Building (ST)>^<District Code (IS)> Example: (i) Room is ‘A’ Prepared by EM(HI) and IS4 Team, ITD Page 9 HL7 Implementation Guide Dec 2004 (ii) Floor is ‘5’ (iii) Block ‘1’ (iv) Building is ‘ABC Court, 18 Garden Road’ (v) District is ‘MLV’ |A^5^1ÂBC Court,18 Garden Road^MLV| 2.2.4 HAPL – HA Assigned Patient Location The type provides the assigned location of an admitted patient under the Healthcare system of HA and is inherited from PL. Format: Components: <Specialty Code (ST)>:< Sub-specialty Code (ST)>^<Ward Code (CE)>^<Bed Number (ST)> Example: (i) Bed Code is ‘5’ (ii) Ward Code is ‘A10’ (iii) Specialty Code is ‘ICU’ (iv) Sub-Specialty Code is ‘KG’ |ICU:KGÂ10^5| 2.3 HA Defined Table Some tables are defined for the corresponding elements with IS data type. 2.3.1 HA0001 – Institution Code Table The table defines the code value of the institution. HA0001 – Institution Code Table Code Description HA Hospital Authority DH Department of Health 2.3.2 HA0002 – Cluster Code Table The table defines the code value of the clusters. Prepared by EM(HI) and IS4 Team, ITD Page 10 HL7 Implementation Guide Dec 2004 HA0002 – Cluster Code Table Code Description HKEC Hong Kong East Cluster HKWC Hong Kong West Cluster KCC Kowloon Central Cluster KEC Kowloon Eastern Cluster KWC Kowloon Western Cluster NTEC New Territories Eastern Cluster NTWC New Territories Western Cluster 2.3.3 HA0003 – Hospital and General Outpatient Clinic Code Table The table defines the code value of the hospitals and general outpatient clinic. HA0003 – Hospital & GOPC Code Table Code Description AHN Alice Ho Miu Ling Nethersole Hospital BBH Bradbury Hospice BH Hong Kong Buddhist Hospital CHC Cheshire Home, Chung Hom Kok CHS Cheshire Home, Shatin CMC Caritas Medical Centre CPH Castle Peak Hospital DKC The Duchess of Kent Children's Hospital FYK Tung Wah Group of Hospitals - Fung Yiu King Hospital GH Grantham Hospital HHH Haven of Hope Hospital HKE Hong Kong Eye Hospital KCH Kwai Chung Hospital KH Kowloon Hospital KWH Kwong Wah Hospital NDH North District Hospital NLH Nam Long Hospital Prepared by EM(HI) and IS4 Team, ITD Page 11 HL7 Implementation Guide Dec 2004 OLM Our Lady of Maryknoll Hospital PMH Princess Margaret Hospital POH Pok Oi Hospital PWH Prince of Wales Hospital PYN Pamela Youde Nethersole Eastern Hospital QEH Queen Elizabeth Hospital QMH Queen Mary Hospital RH Ruttonjee Hospital SH Shatin Hospital SJH St. John Hospital SLH Siu Lam Hospital TKO Tseung Kwan O Hospital TMH Tuen Mun Hospital TPH Tai Po Hospital TSK Tang Shiu Kin Hospital TWE Tung Wah Eastern Hospital TWH Tung Wah Hospital TYH Tsan Yuk Hospital UCH United Christian Hospital WCH Wong Chuk Hang Hospital WTS TWGHs Wong Tai Sin Hospital YCH Yan Chai Hospital abg Anne Black Health Centre General Outpatient Clinic ajc Aberdeen Jockey Club General Outpatient Clinic alc Ap Lei Chau General Outpatient Clinic cdg Central District Health Centre General Outpatient Clinic chg Cheung Hong General Outpatient Clinic ckg Central Kowloon Health Centre General Outpatient Clinic csw Cheung Sha Wan Jockey Club General Outpatient Clinic cwg Chai Wan Health Centre General Outpatient Clinic ekc East Kowloon General Outpatient Clinic flc Fanling Family Medicine Centre hhg Hung Hom General Outpatient Clinic phk Ha Kwai Chung General Outpatient Clinic htg Ho Tung Dispensary General Outpatient Clinic kbg Kowloon Bay Health Centre General Outpatient Clinic Prepared by EM(HI) and IS4 Team, ITD Page 12 HL7 Implementation Guide Dec 2004 ktg Kam Tin General Outpatient Clinic ktj Kennedy Town Jockey Club General Outpatient Clinic ukt Kwun Tong Jockey Club Health Centre General Outpatient Clinic lkk Shun Tak Fraternal Association Leung Kau Kui General Outpatient Clinic lkm Lee Kee Memorial Dispensary General Outpatient Clinic lpc Li Po Chun Health Centre General Outpatient Clinic ltg Lam Tin General Outpatient Clinic ltr Lady Trench General Outpatient Clinic lyg Lek Yuen Health Centre General Outpatient Clinic mos Ma On Shan Health Centre General Outpatient Clinic mwg Mui Wo General Outpaitent Clinic mwy Mrs Wu York Yu Health Centre General Outpatient Clinic nkc North Kwai Chung General Outpatient Clinic nlg North Lamma General Outpatient Clinic nsg Nam Shan Health Centre General Outpatient Clinic ntk Ngau Tau Kok Jockey Club General Outpatient Clinic pcg Peng Chau General Outpatient Clinic rbg Robert Black Health Centre General Outpatient Clinic skc South Kwai Chung General Outpatient Clinic skm Shek Kip Mei Health Centre General Outpatient Clinic skw Sok Kwu Wan General Outpatient Clinic psk Shau Kei Wan Jockey Club General Outpatient Clinic slg Shun Lee General Outpatient Clinic spd Stanley Public Dispensary General Outpatient Clinic stg Sha Tin General Outpatient Clinic stk Sha Tau Kok General Outpatient Clinic swh Sai Wan Ho Health Centre General Outpatient Clinic nsw Shek Wu Hui Jockey Club General Outpatient Clinic tcg Tung Chung General Outpatient Clinic tkl Ta Kwu Ling General Outpatient Clinic pnr Tseung Kwan O (Po Ning Road) General Outpatient Clinic tmg Tuen Mun General Outpatient Clinic toj Tai O Jockey Club General Outpaitent Clinic Prepared by EM(HI) and IS4 Team, ITD Page 13 HL7 Implementation Guide Dec 2004 tpj Tai Po Jockey Club General Outpatient Clinic tsw Tin Shui Wai Health Centre General Outpatient Clinic tyt Tsing Yi Town General Outpatient Clinic vpg Violet Peel Health Centre General Outpatient Clinic whc Wu Hong General Outpatient Clinic wkg West Kowloon Health Centre General Outpatient Clinic wsc Wong Siu Ching General Outpatient Clinic wtg Wan Tsui General Outpatient Clinic wth Wang Tau Hom Jockey Club General Outpatient Clinic wyy Wu York Yu Health Centre General Outpatient Clinic yck Yuen Chau Kok General Outpatient Clinic ylj Yuen Long Jockey Club Health Centre General Outpatient Clinic yly Yuen Long Madam Yung Fung Shee Health Centre General Outpatient Clinic qym Yau Ma Tei Jockey Club General Outpatient Clinic 2.3.4 HA0004 – Patient Name Type Code Table The table defines the code value of the different patient name type. HA0004 – Patient Name Type Code Table Code Description EN English Name CN Chinese Name CCC_1 1st Chinese Character CCC_2 2nd Chinese Character CCC_3 3rd Chinese Character CCC_4 4th Chinese Character CCC_5 5th Chinese Character CCC_6 6th Chinese Character 2.3.5 HA0005 – District Code Table The table defines the code value of the different district and following table list out some example of Prepared by EM(HI) and IS4 Team, ITD Page 14 HL7 Implementation Guide Dec 2004 district code. HA0005 – District Code Table Code Description MK Mongkok TST Tsim Sha Tsui MLV Mid Level 2.3.6 HA0006 – Assigning Facility Code Table The table defines the code value of the different Assigning Facility Code. HA0006 – Assigning Facility Code Table Code Description HA Hospital Authority GOVT Government 2.3.7 HA0007 –Identifier Type Code Table The table defines the code value of the different Identifier Type Code. The following values are added into HL7 v2.3.1 User-defined table #0203 – Identifier type. HA0007 –Identifier Type Code Table Code Description HKID Hong Kong Identity PATKEY Patient Key DOCNO Other Document No. REFNO Reference MRN Medical Record Number CASE Case No. 2.3.8 HA0008 –Entity ID Code Table The table defines the code value of the ALL HA Entity (e.g. Laboratory Test, Examination Result, etc). The entity ID will mainly appear at OBR-4 (Universal Service ID) and OBX-3 (Observation Identifier) Prepared by EM(HI) and IS4 Team, ITD Page 15 HL7 Implementation Guide Dec 2004 batteries for HA internal system message transfer. The following table list out some samples of Entity ID and its description. The full list can be obtained from Heath Informatics section of HA ITD. HA0008 – Entity ID Table Entity ID Description 1996 Anti-Varicella Zoster Virus 2003 Anti-HTLV 52 Albumin, SPE 1342 Cadmium, Urine, Creatinine Ratio 1347 CKMB/CK Index 834 Ketone Bodies, Urine 2.3.9 HA0009 – LOINC and HA Entity ID Mapping Table HA adopt Logical Observation Identifiers Names and Codes (LOINC) as OFFICIAL Request and Observation Result coding scheme for external communication (System or Equipment) and mainly use at OBR-4 (Universal Service ID) and OBX-3 (Observation Identifier) batteries. For the detail of LOINC, please refer URL http://www.loinc.org. The following table list out some samples of the mapping between LOINC with HA Entity ID and its description. The full list can be obtained from Heath Informatics section of HA ITD HA0009 – LOINC and Entity ID Mapping Table Entity ID LOINC Description 1996 10860-5 Anti-Varicella Zoster Virus 2003 22363-6 Anti-HTLV 52 2863-9 Albumin, SPE 1342 13828-9 Cadmium, Urine, Creatinine Ratio 1347 12187-1 CKMB/CK Index 834 2514-8 Ketone Bodies, Urine Prepared by EM(HI) and IS4 Team, ITD Page 16 HL7 Implementation Guide Dec 2004 2.4 Patient Administration Trigger Event Descriptions 2.4.1 ADTÂ01 Admit/Visit Notification a) Description The A01 trigger event is to be used for admitted patients only. It is generated as a result of the patient undergoing the admission process of a health care facility, which assigns the patient to a bed. It signals the beginning of a patient's stay in a health care facility. b) Usage Notes It is important that the ‘patient id’ (see PID-3), ‘visit number’ (see PV1-19) and the ‘servicing facility’ (see PV1-39) are populated as these form the basis of uniquely identifying each visit within a health care facility. Refer to the PID Segment definition for more information. Trigger A11 cancels an A01. c) Trigger Structure ADT ADT Message MSH Message Header EVN Event Type PID Patient Identification  [ PD1 ] Additional Demographics [ { NK1 } ] Next of Kin / Associated Parties PV1 Patient Visit [ PV2 ] Patient Visit – Additional Info. [ { DB1 } ] Disability Information [ { OBX } ] Observation / Result [ { AL1 } ] Allergy Information [ { DG1 } ] Diagnosis Information [ DRG ] Diagnosis Related Group [ { PR1 Procedures [ { ROL } ] Role } ] [ { GT1 } ] Guarantor [ { IN1 Insurance [ IN2 ] Insurance Additional Info. [ IN3 ] Insurance Add'l Info – Cert. } ] [ ACC ] Accident Information [ UB1 ] Universal Bill Information [ UB2 ] Universal Bill 92 Information ACK MSH MSA [ ERR ] General Acknowledgment Message Header Message Acknowledgment Error   would be utilized by Hospital Authority system Prepared by EM(HI) and IS4 Team, ITD Page 17 HL7 Implementation Guide Dec 2004 2.4.2 ADTÂ02 Transfer a Patient a) Description The A02 trigger event is generated as a result of the patient changing his or her assigned physical location. This is only used for admitted patients. b)Usage Notes The new patient location appears in data element 'assigned patient location' (see PV1-3), while the old patient location appears in data element 'prior patient location' (see PV1-6). The date and time of the change of location is recorded in ‘event occurred’ (see EVN-6). Trigger A12 cancels an A02. Temporary changes in inpatient location to clinics or the like, may be better represented as A09 (Patient departing – tracking) and A10 (Patient arriving – tracking). A02 should be restricted to locations that affect the Patient Administration System in terms of bed census status. c) Trigger Structure ADT MSH EVN PID [ PD1 ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] ADT Message Message Header Event Type Patient Identification Additional Demographics Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.3 ADTÂ03 Discharge/End Visit a) Description The A03 trigger event signals the end of the patient's stay in the health care facility. For an admitted patient, the A03 trigger event is generated as a result of recording the discharge date indicating that the patient is no longer in the facility. For a non-admitted patient, the A03 trigger event is sent as a result of recording the completion of the non-admitted visit to the health care facility. b) Usage Notes For an admitted patient, the patient's location prior to discharge should be entered in data element 'assigned patient location' (see PV1-3). For a non-admitted patient, the visit and date/time can be entered in data element 'discharge date/time' (see PV1-45). Trigger A13 cancels an A03. c) Trigger Structure ADT MSH EVN PID [ PD1 ] PV1 [ PV2 ] ADT Message Message Header Event Type Patient Identification Additional Demographics Patient Visit Patient Visit – Additional Info. Prepared by EM(HI) and IS4 Team, ITD Page 18 HL7 Implementation Guide Dec 2004 [ { DB1 } ] [ { DG1 } ] [ DRG ] [ { PR1 [ { ROL } ] } ] [ { OBX } ] Disability Information Diagnosis Information Diagnosis Related Group Procedures Role ACK MSH MSA [ ERR ] General Acknowledgment Message Header Message Acknowledgment Error Observation / Result  would be utilized by Hospital Authority system 2.4.4 ADTÂ04 Register a Patient a) Description The A04 trigger event is generated when a patient has been registered as a non-admitted patient. That is, the patient is not yet admitted to a health care facility. b) Usage Notes The visit start date/time is entered in data element 'admit date/time' (see PV1-44). c) Trigger Structure ADT MSH EVN PID  [ PD1 ]  [ { NK1 } ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] [ { AL1 } ] [ { DG1 } ] [ DRG ] [ { PR1 [ { ROL } ] } ] [ { GT1 } ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ ACC ] [ UB1 ] [ UB2 ] ADT Message Message Header Event Type Patient Identification Additional Demographics Next of Kin / Associated Parties Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result Allergy Information Diagnosis Information Diagnosis Related Group Procedures Role Guarantor Insurance Insurance Additional Info. Insurance Add'l Info – Cert. Accident Information Universal Bill Information Universal Bill 92 Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system Prepared by EM(HI) and IS4 Team, ITD Page 19 HL7 Implementation Guide Dec 2004 2.4.5 ADTÂ05 Pre-admit a Patient a) Description The A05 trigger event is generated when a patient undergoes pre-admission process where episode details are collected in preparation for the patients visit or stay in a healthcare facility. This event can also be used to pre-register a non-inpatient. b) Usage Notes c) Trigger Structure ADT ADT Message MSH EVN PID  [ PD1 ]  [ { NK1 } ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] [ { AL1 } ] [ { DG1 } ] [ DRG ] [ { PR1 [ { ROL } ] } ] [ { GT1 } ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ ACC ] [ UB1 ] [ UB2 ] Message Header Event Type Patient Identification Additional Demographics Next of Kin / Associated Parties Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result Allergy Information Diagnosis Information Diagnosis Related Group Procedures Role ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error Guarantor Insurance Insurance Additional Info. Insurance Add'l Info – Cert. Accident Information Universal Bill Information Universal Bill 92 Information  would be utilized by Hospital Authority system 2.4.6 ADTÂ08 Update Patient Information a) Description The A08 trigger event is generated as a result of patient information being changed. This will include all events that are not specifically identified by some other trigger, e.g. A02 trigger event for change to location. A08 is used when visit information is being updated. (Note: A31 is used when only demographic details are to be updated.) b) Usage Notes It is anticipated that separate triggers will be generated for separate events. For example, changes to clinical or financial status require date and time of change. However, this does not preclude an A08 trigger event being sent with multiple changed fields, including both demographics and visit details. c) Trigger Structure Prepared by EM(HI) and IS4 Team, ITD Page 20 HL7 Implementation Guide ADT MSH EVN PID  [ PD1 ]  [ { NK1 } PV1 [ PV2 ] [ { DB1 } [ { OBX } [ { AL1 } [ { DG1 } [ DRG ] [ { PR1 [ { } ] [ { GT1 } [ { IN1 [ IN2 ] [ IN3 ] } ] [ ACC ] [ UB1 ] [ UB2 ] Dec 2004 ADT Message Message Header Event Type Patient Identification Additional Demographics ] Next of Kin / Associated Parties Patient Visit Patient Visit – Additional Info. ] Disability Information ] Observation / Result ] Allergy Information ] Diagnosis Information Diagnosis Related Group Procedures ROL } ] Role ] Guarantor Insurance Insurance Additional Info. Insurance Add'l Info – Cert. Accident Information Universal Bill Information Universal Bill 92 Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.7 ADTÂ11 Cancel Admit/Visit Notification a) Description The A11 trigger event is generated as a result of the patient's admission or visit being cancelled. For admitted patients, it is sent to either cancel an erroneous A01 (admit a patient) trigger event or for non-admitted patients, it is sent to either cancel an erroneous A04 (register a patient) trigger event. b) Usage Notes The A11 trigger is generated to delete a previously sent admission (A01) or registration (A04). (Note: How a Receiving System processes an A11 trigger may vary depending upon its internal architecture, in some instances a Receiving System will not accept cancellation of an admission which has events associated. Appropriate triggers must be sent to cancel each admitted event before transmitting the A11.) c) Trigger Structure ADT MSH EVN PID [ PD1 ] PV1 [ PV2 ] [ { DB1 } ] ADT Message Message Header Event Type Patient Identification Additional Demographics Patient Visit Patient Visit – Additional Info. Disability Information Prepared by EM(HI) and IS4 Team, ITD Page 21 HL7 Implementation Guide Dec 2004 [ { OBX } ] [ { DG1 } ] Observation / Result Diagnosis Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.8 ADTÂ12 Cancel Transfer a) Description The A12 trigger event is generated following cancellation of an admitted patient location transfer. It is sent to either cancel an erroneous A02 (transfer a patient) trigger event or because of a decision not to transfer a patient. b) Usage Notes The location of the patient before the original transfer should be recorded in data element 'assigned patient location' (see PV1-3). c) Trigger Structure ADT MSH EVN PID [ PD1 ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] [ DG1 ] ADT Message Message Header Event Type Patient Identification Additional Demographics Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result Diagnosis Information ACK General Acknowledgment MSH 7MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.9 ADTÂ13 Cancel Discharge/End Visit a) Description The A13 trigger event is generated as the result of a discharge/separation needing to be cancelled, for an admitted or non-admitted visit. It is sent to either cancel an erroneous A03 (discharge/end visit) trigger event or because of a decision not to discharge the patient or end the patient visit. b) Usage Notes After the cancellation has been processed, the location of the patient should be in data element 'assigned patient location' (see PV1-3). Before the erroneous A03 trigger event, the patient's previous location should be in data element 'prior patient location' (see PV1-6). c) Trigger Structure ADT ADT Message Prepared by EM(HI) and IS4 Team, ITD Page 22 HL7 Implementation Guide MSH EVN PID [ PD1 ] [ { NK1 } ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] [ { AL1 } ] [ { DG1 } ] [ DRG ] [ { PR1 [ { ROL } ] } ] [ { GT1 } ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ ACC ] [ UB1 ] [ UB2 ] Dec 2004 Message Header Event Type Patient Identification Additional Demographics Next of Kin / Associated Parties Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result Allergy Information Diagnosis Information Diagnosis Related Group Procedures Role Guarantor Insurance Insurance Additional Info. Insurance Add'l Info – Cert. Accident Information Universal Bill Information Universal Bill 92 Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.10 ADTÂ18 Merge Patients a) Description The A18 trigger event is generated when two patients, previously registered separately, need to be merged. b) Usage Notes The A18 Event is retained for backward compatibility with previous versions of HL7 only. The more specific A34, A35, A36, A39, A40, A41 or A42 events should be used in preference to the A18 event. c) Trigger Structure ADT ADT Message MSH EVN PID  [ PD1 ] Message Header Event Type Patient Identification Additional Demographics MRG PV1 Merge Information Patient Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system Prepared by EM(HI) and IS4 Team, ITD Page 23 HL7 Implementation Guide Dec 2004 2.4.11 QRYÂ19/ADRÂ19 Patient Query a) Description The A19 trigger event is generated because one system requests patient details from another system. b) Usage Notes The implications of this trigger event are that the sending and receiving systems can at least understand and support query accept/response messages and syntax. The query criteria supported is a site determination as is the reply content. c) Trigger Structure QRY Patient Query Message Header Query Definition Query Filter MSH QRD [ QRF ] ADR MSH MSA PID [ PD1 ] [ { NK1 PV1 [ PV2 ] [ { DB1 [ { OBX [ { AL1 [ { DG1 [ DRG ] [ { ADR Message Message Header Message Acknowledgment Patient Identification Additional Demographics } ] Next of Kin / Associated Parties Patient Visit Patient Visit – Additional Info. } ] Disability Information } ] Observation / Result } ] Allergy Information } ] Diagnosis Information Diagnosis Related Group PR1 Procedures [ { ROL } ] Role } ] [ { GT1 } ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ ACC ] [ UB1 ] [ UB2 ] Guarantor Insurance Insurance Additional Info. Insurance Add'l Info – Cert. Accident Information Universal Bill Information Universal Bill 92 Information  would be utilized by Hospital Authority system 2.4.12 ADTÂ21 Patient Goes on a ‘Leave of Absence’ a) Description The A21 trigger event is generated to notify that an admitted patient has gone on a leave of absence. It is used for systems where a patient is still recorded as being admitted in the ward (i.e. they are expected to return), and puts that patient's current admission on suspension. b) Usage Notes The HL7 Version 2.3 protocol does not provide a trigger event to cancel the A21 trigger event. To cancel 'patient goes on leave of absence', use the A22 trigger event (patient returns from 'leave of absence') with event date and time the same as the A21 trigger event to be cancelled. c) Trigger Structure Prepared by EM(HI) and IS4 Team, ITD Page 24 HL7 Implementation Guide Dec 2004 ADT ADT Message MSH EVN PID [ PD1 ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] Message Header Event Type Patient Identification Additional Demographics Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result ACK General Acknowledgment MSH MSA Message Header Message Acknowledgment [ ERR ]  Error  would be utilized by Hospital Authority system 2.4.13 ADTÂ22 Patient Returns from a ‘Leave of Absence’ a) Description The A22 trigger event is generated to notify that a patient has returned from a leave of absence. It is used for systems where a bed is still assigned to the patient who has his or her current admission on suspend/hold and is returning to the hospital. It removes the state of suspension from the patient's admission. b) Usage Notes The HL7 Version 2.3 protocol does not provide a trigger event to cancel the A22 trigger event. To cancel 'patient returns from leave of absence', use the A21 trigger event (patient goes on 'leave of absence') with event date and time the same as the A22 trigger event to be cancelled. c) Trigger Structure ADT ADT Message MSH EVN PID [ PD1 ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] Message Header Event Type Patient Identification Additional Demographics Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.14 ADTÂ28 Add Personal Information a) Description The A28 trigger event is to be used when adding a new person. Prepared by EM(HI) and IS4 Team, ITD Page 25 HL7 Implementation Guide Dec 2004 b) Usage Notes The A28 trigger event refers to persons, a person not necessarily being restricted to the patient definition. For example, guarantor, potential future patient, financial benefactor are not necessarily patients, but may still be recorded as persons. The person identifiers provided do not have to hold a medical record number assigned by a healthcare facility. The A28 is not intended to replace the other visit level trigger events such as A01, A02, A03 etc… Patient Administration events should be communicated using the standard triggers as described elsewhere even though the A28 supports optional visit level segments. c) Trigger Structure ADT ADT Message MSH EVN PID  [ PD1 ]  [ { NK1 } ] PV1 [ PV2 ] [ { DB1 } ] [ { OBX } ] [ { AL1 } ] [ { DG1 } ] [ DRG ] [ { PR1 [ { ROL } ] } ] [ { GT1 } ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ ACC ] [ UB1 ] [ UB2 ] Message Header Event Type Patient Identification Additional Demographics Next of Kin / Associated Parties Patient Visit Patient Visit – Additional Info. Disability Information Observation / Result Allergy Information Diagnosis Information Diagnosis Related Group Procedures Role ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error Guarantor Insurance Insurance Additional Info. Insurance Add'l Info – Cert. Accident Information Universal Bill Information Universal Bill 92 Information  would be utilized by Hospital Authority system 2.4.15 ADTÂ40 Merge Patient – Patient Identifier List a) Description The A40 trigger event is generated when information of one patient is separated into two identifies. The MRG segment contains the identifiers to be merged with the correct identifier of the same “identifier type code” in the PID segment. b) Usage Notes The identifiers involved in identifying the patients may or may not have accounts, which may or may not have visits. An A40 event is intended for merging the subordinate identifiers specified in the MRG segment; any other subordinate identifiers are ignored. c) Trigger Structure ADT MSH EVN { PID ADT Message Message Header Event Type Patient Identification Prepared by EM(HI) and IS4 Team, ITD Page 26 HL7 Implementation Guide Dec 2004 [ PD1 ] Additional Demographics MRG [ PV1 ] } Merge Information Patient Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error  would be utilized by Hospital Authority system 2.4.16 ADTÂ45 Move Visit Information a) Description The A45 trigger event is generated when either the PV1-19 Visit Number or PV1-50 Alternate Visit Number visit is moved from one patient account number to another. b) Usage Notes The A45 trigger event indicates the visit has moved from one patient account to another. The visit to be moved is identified in either the MRG-5 Prior Visit Number or MRG-6 Prior Alternate Visit Number, the incorrect patient account number is given in MRG-3 Prior Patient Account Number. The correct patient account number is given in the PID-18 Patient Account Number field. Refer to Section 3.5.2 Merging patient/person information of the HL7 Standard for more information. c) Trigger Structure ADT MSH EVN PID [PD1] { MRG  PV1 } ADT Message Message Header Event Type Patient Identification Additional Demographics Merge Information Patient Visit ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error 2.4.17 ADTÂ46 Change Patient ID a) Description The A46 trigger event is generated when there has been a change at the external patient identifier level. b) Usage Notes . The A46 trigger event is retained for backward compatibility with previous versions of HL7, the A47 event should be used in preference to the A46. The A46 event is used to correct the PID-2 Patient Id Value, the incorrect identifier value is given in MRG-4 Prior Patient ID while the correct value is given in PID-2 Patient ID. . Refer to Section 3.5.2 Merging patient/person information of the HL7 Standard for more information. c) Trigger Structure Prepared by EM(HI) and IS4 Team, ITD Page 27 HL7 Implementation Guide Dec 2004 ADT ADT Message MSH EVN  PID [PD1] MRG Message Header Event Type Patient Identification Additional Demographics Merge Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error   would be utilized by Hospital Authority system 2.4.18 ADTÂ47 Change Patient Identifier List a) Description The A47 trigger event is generated when there has been a change at the internal patient identifier level. b) Usage Notes . The A47event is used to correct the PID-3 Patient Identifier List, the incorrect identifier value is given in MRG-1 Prior Patient Identifier list while the correct value is given in PID-3 Patient Identifier List. Refer to Section 3.5.2 Merging patient/person information of the HL7 Standard for more information. c) Trigger Structure ADT MSH EVN  PID [PD1] MRG ADT Message Message Header Event Type Patient Identification Additional Demographics Merge Information ACK General Acknowledgment MSH MSA [ ERR ] Message Header Message Acknowledgment Error   would be utilized by Hospital Authority system 2.5 Order Entry Event Descriptions 2.5.1 ORMÔ01 & ORRÔ02 General Order Message (Excluding Supply, Pharmacy and Dietary) Prepared by EM(HI) and IS4 Team, ITD Page 28 HL7 Implementation Guide Dec 2004 a) Description The O01 trigger event is generated to communicate information about an order. Its Application Level Acknowledgment is the ORRÔ02 event message. b) Usage Notes The structure of the O01 message will vary depending upon the order category. HL7 has specified different structures for Supply, Pharmacy and Dietary orders. The structure described following is for orders other than Supply, Pharmacy or Dietary orders. c) Trigger Structure ORM General Order Message MSH [ { NTE } ] [ PID [ PD1 ] [ { NTE } ] [ PV1 ] [ PV2 ] [ { IN1 [ IN2 ] [ IN3 ] } ] { ORC [ OBR [ { NTE } ] Message Header Notes and Comments Patient Identification Additional Demographics Notes and Comments Patient Visit Patient Visit – additional information Insurance Insurance - additional information Insurance – additional information [ { DG1 } ] [ { OBX [ { NTE } ] ] ] { [ CTI ] } [BLH] Order Control Order Observation Notes and Comments Diagnosis Observation Result Notes and Comments Clinical trial; Billing Segment } ORRÔ02 General Order Acknowledgment MSH MSA [ ERR ] [ { NTE } ] [ [ PID ] [ { NTE } ] { ORC [ OBR [ { NTE } ] [ { DG1 } ] [ { OBX [ { NTE } ] ] ] [ { CTI } ] } Message header Message acknowledgment Error Notes and comments Patient Identification Notes and comments Common Order Order Observation Notes and Comments Diagnosis Observation Result Notes and Comments Clinical trial;  would be utilized by Hospital Authority system  2.5.2 ORMÔ01^RDO_O01 General Order Message (Pharmacy only) a) Description The O01 (RDO_O01 Abstract Structure Id) trigger event is generated when ordering pharmacy. Prepared by EM(HI) and IS4 Team, ITD Page 29 HL7 Implementation Guide Dec 2004 b) Usage Notes The MSH-9 Message Type Message structure Id subcomponent will be valued with the value “RDO_O01”. c) Trigger Structure ORM General Order Message MSH [ { NTE } ] [ PID [ PD1 ] [ { NTE } ] [ PV1 ] [ PV2 ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ GT1 ] [ { AL1 } ] ] { ORC [ RXO [ { NTE } ] { RXR } [ { RXC [ { NTE } ] ] [ { OBX [ { NTE } ] } ] ] [ BLG ] } } Message Header Notes and Comments Patient Identification Additional Demographics Notes and Comments Patient Visit Patient Visit – additional information Insurance Insurance - additional information Insurance – additional information Guarantor Allergy information ACK General Acknowledgment MSH MSA [ ERR ] [ { NTE } ] [ [ PID ] [ { NTE } ] { ORC [ RXO [ { NTE } ] { RXR } [ { RXC } ] [ { NTE } ] ] } ] Message header Message acknowledgment Error Notes and comments Order Control Pharmacy/treatment Order Notes and Comments Pharmacy/Treatment Route Pharmacy/Treatment Component Notes and Comments Observation result Notes and Comments Billing Segment Patient Identification Notes and comments Common Order Parmacy/Treatment Order Notes and Comments Pharmacy/Treatment Route Pharmacy/Treatment Component Notes and Comments  would be utilized by Hospital Authority system 2.5.3 RDEÔ01 & RREÔ02 Pharmacy/treatment encoded order message a) Description The RDE trigger event communicates the pharmacy or treatment’s application encoding of the pharmacy/treatment order. Prepared by EM(HI) and IS4 Team, ITD Page 30 HL7 Implementation Guide Dec 2004 b) Usage Notes c) Trigger Structure RDOÔ01 Pharmacy/Treatment Encoded Message MSH [ { NTE } ] [ PID [ PD1 ] [ { NTE } ] [ PV1 ] [ PV2 ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ GT1 ] [ { AL1 } ] ] { ORC [ RXO [ { NTE } ] { RXR } [ { RXC [ { NTE } ] ] ] Message Header Notes and Comments Patient Identification Additional Demographics Notes and Comments Patient Visit Patient Visit – additional information Insurance Insurance - additional information Insurance – additional information Guarantor Allergy information RXE { RXR } [ { RXC } ] { OBX [ { NTE } ] } { [ CT1 ] } Order Control Pharmacy/treatment Order Notes and Comments Pharmacy/Treatment Route Pharmacy/Treatment Component Notes and Comments Pharmacy/Treatment encoded order Pharmacy/Treatment Route Pharmacy/Treatment component Observation result Notes and Comments Clinical Trial Identification } RREÔ02 Pharmacy Encoded Order Acknowledgment MSH MSA [ ERR ] [ { NTE } ] [ [ PID ] [ { NTE } ] { ORC [ RXE { RXR } [ { RXC } ] ] } ] Message header Message acknowledgment Error Notes and comments Patient Identification Notes and comments Common Order Parmacy/Treatment Order Pharmacy/Treatment Route Pharmacy/Treatment Component  would be utilized by Hospital Authority system 2.5.4 RDSÔ01 & RRDÔ02 Pharmacy/treatment dispense message Prepared by EM(HI) and IS4 Team, ITD Page 31 HL7 Implementation Guide Dec 2004 a) Description The RDS trigger event communicates each instance of dispensing a drug or treatment to fill an existing order or orders. Its Application Level acknowledgement is the RRD trigger event. b) Usage Notes The ORC must have the filler order number and order control code RE. c) Trigger Structure RDSÔ01 Pharmacy/Treatment Dispense Message MSH [ { NTE } ] [ PID [ PD1 ] [ { NTE } ] [ PV1 ] [ PV2 ] [ { IN1 [ IN2 ] [ IN3 ] } ] [ GT1 ] [ { AL1 } ] ] { ORC [ RXO [ { NTE } ] { RXR } [ { RXC [ { NTE } ] ] ] [ RXE { RXR } [ { RXC } ] ] Message Header Notes and Comments Patient Identification Additional Demographics Notes and Comments Patient Visit Patient Visit – additional information Insurance Insurance - additional information Insurance – additional information Guarantor Allergy information RXD { RXR } [ { RXC } ] { OBX [ { NTE } ] } Order Control Pharmacy/treatment Order Notes and Comments Pharmacy/Treatment Route Pharmacy/Treatment Component Notes and Comments Pharmacy/Treatment encoded order Pharmacy/Treatment Route Pharmacy/Treatment component Pharmacy/Treatment dispense Pharmacy/Treatment Route Pharmacy/Treatment component Observation result Notes and Comments } RRDÔ02 Pharmacy/Treatment Dispense Acknowledgment MSH MSA [ ERR ] [ { NTE } ] [ [ PID ] [ { NTE } ] { ORC [ RXD { RXR } [ { RXC } ] ] } ] Message header Message acknowledgment Error Notes and comments Patient Identification Notes and comments Common Order Parmacy/Treatment Dispense Pharmacy/Treatment Route Pharmacy/Treatment Component  would be utilized by Hospital Authority system Prepared by EM(HI) and IS4 Team, ITD Page 32 HL7 Implementation Guide Dec 2004 2.6 Observation Reporting Event Descriptions 2.6.1 ORU^R01 Unsolicited Transmission of an Observation Message a) Description The R01 trigger event is used to signal a create or update of an observation to a patient. b) Usage Notes The R01 trigger indicates record-oriented result reporting. c) Trigger Structure ORU Observational Results (Unsolicited)  MSH { [  PID [PD1] [{NTE}]  [PV1 [PV2]] ] { [ORC]  OBR {[NTE]} {  [OBX] {[NTE]} } {[CTI]} } } [DSC] Message Header ACK Acknowledgment MSH MSA [ ERR ] Message header Message acknowledgment Error Patient Identification Additional Demographics Notes and Comments Patient Visit Patient Visit - Additional Info Order common Observations Report ID Notes and comments Observation/Result Notes and comments Clinical Trial Identification Continuation Pointer  would be utilized by Hospital Authority system 2.6.2 QRY^R02 Query for results of observation (R02/R04 record oriented results) a) Description The R02 trigger event is used to query for patient results. b) Usage Notes The QRY^R02 trigger event is used to initiate a query for results, the receiving system responds with the QRF^R04 message type. The R02/R04 pairing is used for record-oriented results reporting. c) Trigger Structure Prepared by EM(HI) and IS4 Team, ITD Page 33 HL7 Implementation Guide Dec 2004 ORY Observational Results (Unsolicited) MSH QRD QRF Message header Query Definition Query Filter ACK Acknowledgment MSH MSA QRD [ QRF ] Message header Message acknowledgment Query Definition Query Filter PID [ { NTE } ] Patient Identification Notes and Comments { [ ] { [ORC] OBR {[NTE]} { [OBX] {[NTE]} } {[CTI]} } } [ERR] [QAK] [DSC] Order common Observations Report ID Notes and comments Observation/Result Notes and comments Clinical Trial Identification Error Query Acknowledgement Continuation Pointer  would be utilized by Hospital Authority system 2.6.3 QRY^R02 Query for results of observation (R02/R05 – display oriented results) a) Description The R02 trigger event is used to query for patient results. b) Usage Notes The QRY^R02 trigger event is used to initiate a query for results, the receiving system responds with the QRF^R04 message type. The R02/R05 pairing is used for display-oriented results reporting. c) Trigger Structure ORY Observational Results (Unsolicited) MSH QRD QRF Message header Query Definition Query Filter ACK Acknowledgment MSH MSA QRD [ QRF ] Message header Message acknowledgment Query Definition Query Filter PID [ { NTE } ] Patient Identification Notes and Comments { [ ] { [ORC] OBR Order common Observations Report ID Prepared by EM(HI) and IS4 Team, ITD Page 34 HL7 Implementation Guide {[NTE]} { [OBX] {[NTE]} } {[CTI]} } } [ERR] [QAK] [DSC] Dec 2004 Notes and comments Observation/Result Notes and comments Clinical Trial Identification Error Query Acknowledgement Continuation Pointer  would be utilized by Hospital Authority system 2.6.4 UDM^R06 Unsolicited Transmission of an Observation Message (Display oriented results) a) Description The R06 trigger event is used to signal a create or update of an observation to a patient. b) Usage Notes The R06 trigger indicates display-oriented result reporting and is used in conjunction with the “UDM” (Unsolicited Display Message) event code. c) Trigger Structure UDM Observational Results (Unsolicited) MSH { [ PID [PD1] [{NTE}]  [PV1 [PV2]] ] { [ORC]  OBR {[NTE]} {  [OBX] {[NTE]} } {[CTI]} } } [DSC] Message header ACK Acknowledgment MSH MSA Message header Message acknowledgment Patient Identification Additional Demographics Notes and Comments Patient Visit Patient Visit - Additional Info Order common Observations Report ID Notes and comments Observation/Result Notes and comments Clinical Trial Identification Continuation Pointer  would be utilized by Hospital Authority system Prepared by EM(HI) and IS4 Team, ITD Page 35 HL7 Implementation Guide Dec 2004 2.7 Scheduling Event Descriptions 2.7.1 SRM/SRR^S01 Request New Appointment Booking and response a) Description The S01 trigger event is sent by a placer application to a filler application to request that a new appointment be booked. The filler application returns an acknowledgment to the placer application upon successfully receiving the trigger event. b) Usage Notes c) Trigger Structure SRM Schedule Request Message MSH Message Header 2 ARQ Appointment Request Information 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 [ { PID Patient Identification 3 [ PV1 ] Patient Visit 3 [ PV2 ] Patient Visit - Additional Info 3 [ { OBX } ] Observation/Result 4 [ { DG1 } ] Diagnosis 6 } ] { RGS Resource Group Segment 10 [ { AIS Appointment Information - Service 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] [ { AIG Appointment Information - General Resource 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] [ { AIL Appointment Information - Location Resource 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] [ { AIP Appointment Information - Personnel Resource 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] } Prepared by EM(HI) and IS4 Team, ITD Page 36 HL7 Implementation Guide Dec 2004 ACK Acknowledgment MSH Message header MSA Message acknowledgment  would be utilized by Hospital Authority system SRR Scheduled Request Response MSH Message Header MSA Message Acknowledgment [ ERR ] Error Information [ SCH Schedule Activity Information [ { NTE } ] Notes and Comments [ { PID Patient Identification [ PV1 ] Patient Visit [ PV2 ] Patient Visit - Additional Info [ { DG1 } ] Diagnosis } ]  { RGS Resource Group Segment [ { AIS [ { NTE } ] Appointment Information - Service Notes and Comments } ] [ { AIG [ { NTE } ] Appointment Information - General Resource Notes and Comments } ] [ { AIL [ { NTE } ] Appointment Information - Location Resource Notes and Comments } ] [ { AIP [ { NTE } ] Appointment Information - Personnel Resource Notes and Comments } ] } ] ACK Acknowledgment MSH Message header MSA Message acknowledgment Prepared by EM(HI) and IS4 Team, ITD Page 37 HL7 Implementation Guide Dec 2004  would be utilized by Hospital Authority system 2.7.2 SRM/SRR^S04 Request Appointment Cancellation and response a) Description The S04 trigger event is sent by a placer application to a filler application to request that an existing appointment be cancelled. The filler application returns an acknowledgment to the placer application upon successfully receiving the trigger even. b) Usage Notes c) Trigger Structure SRM Schedule Request Message MSH Message Header 2 ARQ Appointment Request Information 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 [ { PID Patient Identification 3 [ PV1 ] Patient Visit 3 [ PV2 ] Patient Visit - Additional Info 3 [ { OBX } ] Observation/Result 4 [ { DG1 } ] Diagnosis 6 } ] { RGS Resource Group Segment 10 [ { AIS Appointment Information - Service 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] [ { AIG Appointment Information - General Resource 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] [ { AIL Appointment Information - Location Resource 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] [ { AIP Appointment Information - Personnel Resource 10 [ APR ] Appointment Preferences 10 [ { NTE } ] Notes and Comments 2 } ] } Prepared by EM(HI) and IS4 Team, ITD Page 38 HL7 Implementation Guide Dec 2004 ACK Acknowledgment MSH Message header MSA Message acknowledgment  would be utilized by Hospital Authority system SRR Scheduled Request Response MSH Message Header MSA Message Acknowledgment [ ERR ] Error Information [ SCH Schedule Activity Information [ { NTE } ] Notes and Comments [ { PID Patient Identification [ PV1 ] Patient Visit [ PV2 ] Patient Visit - Additional Info [ { DG1 } ] Diagnosis } ]  { RGS Resource Group Segment [ { AIS [ { NTE } ] Appointment Information - Service Notes and Comments } ] [ { AIG [ { NTE } ] Appointment Information - General Resource Notes and Comments } ] [ { AIL [ { NTE } ] Appointment Information - Location Resource Notes and Comments } ] [ { AIP [ { NTE } ] Appointment Information - Personnel Resource Notes and Comments } ] } ] ACK Acknowledgment MSH Message header MSA Message acknowledgment Prepared by EM(HI) and IS4 Team, ITD Page 39 HL7 Implementation Guide Dec 2004  would be utilized by Hospital Authority system 2.7.3 SQM/SQR^S25 Schedule Query Message and response a) Description The S25 trigger event is sent by a querying application to request information about some aspect of the Scheduling system (e.g. OPAS) b) Usage Notes It is assumed that the sending and receiving system have agreed on how to interpret the QRD and QRF Segments. Refer to HL7 Chapter 5 Query. c) Trigger Structure SQM^S25 Schedule Query Message MSH QRD [ QRF ] [ ARQ [ APR ] [ PID ] { RGS [ { AIS [ APR } ] [ { AIG [ APR } ] [ { AIL [ APR } ] [ AIP [ APR } ] } Message Header Query Definition Query Filter Appointment Request Appointment Preference Patient Identification Resource Group Segment ] Appointment Information – Service Appointment Preference/ ] Appointment Information – General Resource Appointment Preference ] Appointment Information – Location Resource Appointment Preference ] Appointment Information – Personnel Appointment Preference SQR^S25 MSH MSA [ ERR ] QAK [ { SCH [ { NTE } ] [ PID [ PV1 ] [ PV2 ] [ DG1 ] ] { RGS General Acknowledgment Message Header Message Acknowledgement Error Query Acknowledgment Schedule Header Notes and Comments Patient Identification Patient Visit Patient Visit – additional information Diagnosis Resource Group Segment Prepared by EM(HI) and IS4 Team, ITD Page 40 HL7 Implementation Guide Dec 2004 [ { AIS [ { NTE } ] Appointment Information – Service Notes and Comments AIG [ { NTE } ] Appointment Information – General Resource Notes and Comments AIP [ { NTE } ] Appointment Information – Personnel Resource Notes and Comments AIL [ { NTE } ] Appointment Information – Location Notes and Comments } ] [ { } ] [ { } ] [ { } ] } } ]   would be utilized by Hospital Authority system 2.8 Query Event Descriptions 2.8.1 QRY/DSR – original mode display query – immediate response (event Q01) a) Description The Q01 trigger event is sent for immediate response. b) Usage Notes The QRF and QRD segments from the QRY are echoed back in the response. The DSC segment contains the continuation pointer, if it is not null (DSC-1-continuation pointer). c) Trigger Structure QRY Query Message MSH QRD [ QRF ] [ DSC ] Message Header Query Definition Query Filter Continuation Pointer DSR Display Response Message MSH MSA [ [ QRD [ [ [ ERR ] QAK ] QRF ] DSP ] DSC ] Message Header Message Acknowledgment Error Query Acknowledgment Query Definition Query Filter Display Data Continuation Pointer Prepared by EM(HI) and IS4 Team, ITD Page 41 HL7 Implementation Guide Dec 2004  would be utilized by Hospital Authority system 2.9 Patient Care Event Descriptions Refer to official HL7 document. To be customized by HA. 2.10 Patient Referral Event Descriptions Refer to official HL7 document. To be customized by HA. 2.11 Financial Management Event Descriptions Refer to official HL7 document. To be customized by HA. 2.12 Master Files Event Descriptions Refer to official HL7 document. To be customized by HA. 2.13 Medical Records/Information Management Event Descriptions Refer to official HL7 document. To be customized by HA. 2.14 Network Management Event Description 2.14.1 NMQ/NMR Network Management Query Message a) Description The NMQ trigger event makes system-level requests for information or action to another system. b) Usage Notes c) Trigger Structure NMQ Network Management Query MSH Message Header  [QRD Query Definition [QRF]] Query Filter 2 {[NCK] Network System Clock C Prepared by EM(HI) and IS4 Team, ITD Page 42 HL7 Implementation Guide [NST] Dec 2004 Network Statistics C  [NSC]} Network Status Change NMR Network Management Response MSH Message Header MSA Message Acknowledgement Error [ERR]  [QRD] {[NCK] [{NTE}] [NST] [{NTE}]  [NSC] [{NTE}] } Query Definition System Clock Notes and Comments Statistics Notes and Comments Network Status Change Notes and Comments Prepared by EM(HI) and IS4 Team, ITD Page 43 HL7 Implementation Guide Dec 2004 3 MESSAGE SEGMENT 3.1 General The message segment determines the included elements included and their attributes. Explanation of Segment Field Field Name Description Seq Sequence The sequence number of the data element within the segment Len Length The maximum number of characters DT Data Type Referred to HL7 Version 2.3.1 Clause 2.8 Must be one of following Opt Optionality Rp# Repetition Tbl# Table HL7 Element Name Element Name ‘R’ -Required ‘C’ – Conditional ‘O’ – Optional ‘B/X’ – Backward Compatibility Must be one of following ‘Y’ – repetition is indefinite or site – determined Any integer number – number time of repetition ‘’ – not for repetition The number of HL7 Version 2.3.1 table that defines the values of the data element. These values should be followed unless otherwise indicated The descriptive name for data element Important note for HL7 implementation on HA Notes Notes for HA Prepared by EM(HI) and IS4 Team, ITD Omitted - means put nothing on the field Null - put ‘’ on the field ‘’ - used for quoting the value Page 44 HL7 Implementation Guide Dec 2004 3.1.1 MSH Message Header Segment The following applies: (a) Function The MSH segment contains the intent, source, destination, and some specifics of the syntax of a message. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Message Header (MSH) Segment Seq 1 Len 1 DT ST Opt Rp/# Tbl# R Item# 00001 HL7 Element Name Field separator Notes Value: Must be ||| | (i.e. ASCII 124) 2 4 ST R 00002 Encoding characters Value: Must be |^~\&| ^ (i.e. ASCII 94) – as component separator ~ (i.e. ASCII 126) – as repetition separator \ (i.e. ASCII 92) – as escape separator & (i.e. ASCII 38) – as subcomponent separator 3 180 HD O 00003 Sending application Format: <namespace ID (IS)>^<universal ID (ST)>^<universal ID type (ID)> -universal ID type referred to HL7 v2.3.1 Table #0301 Example: |cmslab^ha.org.hk^L| 4 180 HD R 00004 Sending facility Format: <namespace ID (IS)>^<universal ID (ST)>^<universal ID type (ID)> -universal ID type referred to HL7 v2.3.1 Table #0301 Example: |uchlab0012^ha.org.hk^DNS| 5 180 HD O 00005 Receiving application Format: <namespace ID (IS)>^<universal ID (ST)>^<universal ID type (ID)> -universal ID type referred to HL7 v2.3.1 Table #0301 Prepared by EM(HI) and IS4 Team, ITD Page 45 HL7 Implementation Guide Seq 6 Len 180 DT HD Opt Dec 2004 Rp/# Tbl# R Item# 00006 HL7 Element Name Receiving facility Notes Format: <namespace ID (IS)>^<universal ID (ST)>^<universal ID type (ID)> -universal ID type referred to HL7 v2.3.1 Table #0301 7 26 TS O 00007 Date/time of message System data and time Format: YYYYMMDDhhmmss.sss 8 40 ST O 00008 Security Omitted 9 7 CM R 00009 Message type Transaction Type Format: <message type (ID)>^<trigger event (ID)> -message type referred to HL7 v2.3.1 Table #0076 -trigger event referred to HL7 v2.3.1 Table #0003 Example: |ADTÂ01| 10 20 ST R 00010 Message control ID Unique identifier used to relate the response to the initial message. 11 3 PT R 00011 Processing ID Decide whether to process the message as defined in HL7 Application processing rule Format: <processing ID (ID)>^<processing mode (ID)> -processing ID referred to HL7 v2.3.1 Table #0103 P-Production T-Training D-Debugging -processing mode referred to HL7 v2.3.1 Table #0207 A – Archive R – Restore from archive I – Initial Load Null Value – Current processing Example: |P| 12 8 ID R 0104 00012 Version ID Value: Must be |2.3.1| 13 15 NM O 00013 Sequence number Non null values implies the sequence number protocol is in use 14 180 ST O 00014 Continuation pointer This field is used to define continuations in application-specific ways Prepared by EM(HI) and IS4 Team, ITD Page 46 HL7 Implementation Guide Seq 15 Len 2 DT ID Opt Dec 2004 Rp/# O Tbl# Item# 0155 00015 HL7 Element Name Accept acknowledgment type Notes Identifies the conditions under which accept acknowledgments are required to be returned in response to this message. AL – Always NE – Never ER – Error/reject conditions only SU – Successful completion only Example: |AL| 16 2 ID O 0155 00016 Application acknowledgment type Contains the conditions under which application acknowledgments are required to be returned in response to this message AL – Always NE – Never ER – Error/reject conditions only SU – Successful completion only Example: |AL| 17 2 ID O 00017 Value: Country code Must be |HKG| 18 6 ID O Y/3 0211 00692 Value: Character set Must be |UNICODE| 19 20 60 20 CE ID O O 00693 0356 01317 Principal language of message Value: Alternate character set handling scheme Omitted Must be |CHT| 3.1.2 MSA Message Acknowledgement Segment The following applies: (a) Function The MSA segment contains information sent while acknowledging another message. (b) Data elements and usage Acknowledgement Type Acknowledgement Code Positive Receipt Acknowledgement CA Negative Receipt Acknowledgement CE Positive Process Acknowledgement AA Negative Process Acknowledgement AE Prepared by EM(HI) and IS4 Team, ITD Page 47 HL7 Implementation Guide Dec 2004 Message Acknowledgment (MSA) Segment Seq Len 1 2 DT ID Opt R Rp/# Tbl# 0008 Item# 00018 Element name Acknowledgment code Notes Any one acknowledge code of table 3.1.2 (b) Example: AA 2 20 ST R 00010 Message control ID 3 80 ST O 00020 Text message 4 15 NM O 00021 Expected sequence number 5 1 ID B/X 00022 Delayed acknowledgment type 6 100 CE O 00023 Error condition 0102 Unique trigger identifier 3.1.3 EVN Event Type Segment The following applies: (a) Function The EVN segment is used to communicate necessary trigger event information to receiving applications. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Event Type (EVN) Segment Seq Len DT Opt 1 3 ID B/X 2 26 TS R Rp/# Tbl# 0003 Item# Element name Notes 00099 Event type code Omitted 00100 Recorded Date/Time of event Event recorded data and time Format: YYYYMMDDhhmmss.sss 3 26 TS O 00101 Date/Time planned event Event planned data and time Format: YYYYMMDDhhmmss.sss 4 3 IS O 0062 Prepared by EM(HI) and IS4 Team, ITD 00102 Event reason code Omitted Page 48 HL7 Implementation Guide Seq 5 Len 60 DT XCN Opt O Dec 2004 Rp/# Tbl# Item# Y 00103 0188 Element name Operator ID Notes (HA convention) Including one or more from below: HAOPID -User Code, -User Family Name, -User Given Name, -User Type, -Hospital Code Format: Components: <User Code (ST)>^<User Family Name (ST)>^<User Given Name (ST)> ^^^^^^^^ < User Type (ID)>^^^^<HospitalCode (ID)> Example: (i) User Code is ‘CHWONG’ (ii) User Family Name is ‘WONG’ (iii) User Given Name is ‘CHI KONG’ (iv) User Type is ‘LABTECH’ (v) Hospital Code is ‘UCH’ |CHWONG^WONG^CHI KONG^^^^^^^ LABTECH^^^ÛCH| 6 26 TS O 01278 Event occurred Contains the date/time that the event actually occurred Format: YYYYMMDDhhmmss.sss 3.1.4 PID Patient Identification Segment (a) Function The PID segment is used by all applications as the primary means of communicating patient identification information. This segment contains permanent patient identifying and demographic information that, for the most part, is not likely to change frequently. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Patient Identification (PID) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element Name Notes 1 4 SI O 00104 Set ID-Patient ID A number for identification of the transaction on message stream e.g. for the first occurrence of the segment, the sequence number shall be one 2 20 CX O 00105 Patient ID (external ID) Omitted Prepared by EM(HI) and IS4 Team, ITD Page 49 HL7 Implementation Guide Seq 3 Len 20 DT CX Dec 2004 Opt Rp/# R Y Tbl# Item# HL7 Element Name 00106 Patient Identifier list l Notes (HA convention) Including one or more from below: Identity Name (Identifier Type Code) -Hong Kong Identity (HKID), -Patient Key (PATKEY), -Other Document No (DOCNO), -Reference (REFNO), -Medical Record Number (MRN) Add above type into User-defined table 0203 - Identifier type, referred to Table HA0007 Format: Components: <ID (ST)>^<check digit (ST)>^<code identifying the check digit scheme employed(ID)>^< assigning authority (HD)> ^<identifier type code (IS)>^< assigning facility(HD) -assigning facility referred to HA Defined Table HA0006 -identifier type code referred to HA Defined Table HA0007 Example: Hong Kong Identity is ’A123456(3)’ Patient Key is ’87654321’ |A1234563^^^^HKID^GOVT~87654321 ^^^^PATTKEY^HA~^^^^DOCNO^HA~^^^ ^REFNO^HA~^^^^MRN^HA| 4 20 CX O Y Prepared by EM(HI) and IS4 Team, ITD 00107 Alternate patient ID Omitted Page 50 HL7 Implementation Guide Seq 5 Len 48 DT XPN Dec 2004 Opt Rp/# C Y Tbl# Item# 00108 HL7 Element Name Patient name HAPN Notes (HA convention) Including one or more Name Type (Name Type Code) from below: -English Patient Name (EN), -Chinese Patient Name (CN), -1st Chinese Character Code (CCC_1), -2nd Chinese Character Code (CCC_2), -3rd Chinese Character Code (CCC_3), -4th Chinese Character Code (CCC_4), -5th Chinese Character Code (CCC_5), -6th Chinese Character Code (CCC_6) Format: Components: <Patient Family Name (ST)>^<Patient GivenName (ST)>^^^^^<Patient Name type (IS)> Example: (i) English Patient Family Name is ‘CHAN’ (ii) English Patient Given Name is ‘TAI MAN’ (iii) Chinese Patient Name is ‘’ (iv) 1st Chinese Character Code is ‘1111’ (v) 2nd Chinese Character Code is ‘2322’ (vi) 3rd Chinese Character Code is ‘3333’ (vii) 4rhChinese Character Code is ‘4444’ (viii) 5rhChinese Character Code is ‘5555’ (ix ) 6rhChinese Character Code is ‘6666’ |CHAN^TAI MAN^^^^ÊN~^^^^^^CN~1 111^^^^^^CCC_1~2222^^^^^^CCC_2~ 3333^^^^^^CCC_3~4444^^^^^^CCC_4 ~5555^^^^^^CCC_5~6666^^^^^^CCC_ 6| 6 48 XPN O 00109 Mother's Maiden Name Omitted 7 26 TS C 00110 Date of birth (HA convention) -Date of birth Format: YYYYMMDD 8 1 IS C 0001 00111 Sex (HA convention) -Sex Code F – Female M – Male U – Unknown O - Other Example: Sex is Male |M| 9 48 XPN O Y Prepared by EM(HI) and IS4 Team, ITD 00112 Patient alias Omitted Page 51 HL7 Implementation Guide Seq 10 Len 80 DT CE Opt Dec 2004 Rp/# C Tbl# Item# 0005 00113 HL7 Element Name Race Notes (HA convention) -Race Code Example: Race is British |BR^BRITISH| 11 106 XAD O Y 00114 Patient address HAAD (HA convention) Including one or more from below: -Room, -Floor, -Block, -Building, -District Code Format: Components: <Room (ST)>^<Floor (ST)>^<Block (ST)>^ <Building (ST)>^<District Code (IS)> - District Code referred to HA Defined Table HA0005 Example: (i) Room is ‘A’ (ii) Floor is ‘5’ (iii) Block ‘1’ (iv) Building is ‘ABC Court, 18 Garden Road’ (v) District is ‘MLV’ |A^5^1ÂBC Court,18 Garden Road^MLV| 12 4 IS O Prepared by EM(HI) and IS4 Team, ITD 00115 County code Omitted Page 52 HL7 Implementation Guide Seq 13 Len 40 DT XTN Dec 2004 Opt Rp/# O Y Tbl# Item# 00116 HL7 Element Name Phone number- Home Notes (HA convention) Including one or more from below: -Home Phone Number, -Other Phone Number 1, -Other Phone extension 1, -Other Phone Number 2, -Other Phone extension 2 Format: Components: <Phone Number (ST)>^^^^^^^^<Phone extension (ST)> Example: (i) Home Phone No is ‘27110000’ (ii) Other Phone No 1 is ‘27111234’ (Iii) Other Phone Ext 1 is ‘EXT1234’ (Iv) Other Phone No 2 is ‘94549451’ (v) Other Phone Ext 2 is ‘’ |27110000~27111234^^^^^^^ÊXT 1234~94549451| 14 40 XTN O 15 60 CE O 16 1 CE C Y 00117 Phone number- Business Omitted 0296 00118 Language-Patient Omitted 0002 00119 Marital status (HA convention) -Martial Status Code A –Separated D – Divorced M – Married S – Single W - Widowed Example: Status is Married |M| 17 3 CE O 0006 00120 Religion (HA convention) -Religion Code 18 20 CX O 00121 Patient account number Omitted 19 16 ST C 00122 SSN Number- Patient Omitted 20 25 DLN O 00123 Driver's licence number-Patient Omitted 21 20 CX O 00124 Mother's identifier Omitted 22 3 CE O 00125 Ethnic group Omitted 23 60 ST C 00126 Birthplace Omitted 24 2 ID O 00127 Multiple birth indicator Omitted 25 2 NM O 00128 Birth order Omitted Y 0189 0136 Prepared by EM(HI) and IS4 Team, ITD Page 53 HL7 Implementation Guide Seq Len DT Dec 2004 Opt Rp/# Y Tbl# Item# HL7 Element Name Notes 0171 00129 Citizenship Omitted 0172 00130 Veteran's military status Omitted 26 4 IS O 27 60 CE O 28 80 CE O 00739 Nationality Omitted 29 26 TS O 00740 Patient Death Date and Time (HA convention) -Patient Death Date Format: YYYYMMDDhhmmss 30 1 ID O 0136 00741 Patient Death Indicator (HA convention) -Patient Death Code 3.1.5 PV1 Patient Visit Segment The following applies: (a) Function The PV1 segment is used by Registration/ADT applications to communicate information on a visit specific basis. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Patient Visit (PV1) Segment Seq 1 Len 4 DT SI Opt Rp/# Tbl# Item# O 00131 HL7 Element Name Set ID-Patient visit Notes Value: Must be |1| 2 1 IS R 0004 00132 Patient class (HA convention) -Case Type E – Emergency I – Inpatient O - Outpatient Example: Patient type is out-patient |O| Prepared by EM(HI) and IS4 Team, ITD Page 54 HL7 Implementation Guide Seq 3 Len 80 DT PL Dec 2004 Opt Rp/# Tbl# Item# C 00133 HAPL HL7 Element Name Assigned patient location Notes (HA convention) Including one or more from below: -Bed No -Ward Code, -Specialty Code, -Sub-specialty Code Format: Components: <Specialty Code (ST)>:< Sub-specialty Code (ST)>^<Ward Code (CE)>^<Bed Number (ST)> Example: (i) Bed Code is ‘5’ (ii) Ward Code is ‘A10’ (iii) Specialty Code is ‘ICU’ (iv) Sub-Specialty Code is ‘KG’ |ICU:KGÂ10^5| 4 2 IS C 5 20 CX 6 80 PL 0007 00134 Admission type Omitted O 00135 Pre-admit number Omitted C 00136 Prior patient location (HA convention) HAPL Including one or more from below: -Bed No -Ward Code, -Specialty Code, -Sub-specialty Code Format: Components: <Specialty Code (ST)>:< Sub-specialty Code (ST)>^<Ward Code (CE)>^<Bed Number (ST)> Example: (i) Bed Code is ‘5’ (ii) Ward Code is ‘A10’ (iii) Specialty Code is ‘ICU’ (iv) Sub-Specialty Code is ‘KG’ |ICU:KGÂ10^5| Prepared by EM(HI) and IS4 Team, ITD Page 55 HL7 Implementation Guide Seq 7 Len 60 DT XCN Dec 2004 Opt Rp/# Tbl# Item# O 00137 Y 0010 HL7 Element Name Attending doctor Notes (HA convention) Including one or more from below: HAOPID -Doctor Code, -Doctor Family Name, -Doctor Given Name, -Doctor Type, -Hospital Code Format: Components: <Doctor Code (ST)>^<Doctor Family Name (ST)>^<Doctor Given Name (ST)>^^^^^^^<Doctor Type (ID)> ^^^^<HospitalCode (ID)> Example: (i) Doctor Code is ‘CHWONG’ (ii) Doctor Family Name is ‘WONG’ (iii) Doctor Given Name is ‘CHI KONG’ (iv) Doctor Type is ‘LABTECH’ (v) Hospital Code is ‘UCH’ |CHWONG^WONG^CHI KONG^^^^^^^ LABTECH^^^ÛCH| 8 60 XCN C Y 0010 00138 Referring doctor Omitted 9 60 XCN O Y 0010 00139 Consulting doctor Omitted 10 3 IS O 0069 00140 Hospital service Omitted 11 80 PL O 00141 Temporary location Omitted 12 2 IS O 0087 00142 Pre-admit test indicator Omitted 13 2 IS O 0092 00143 Readmission indicator Omitted 14 3 IS C 0023 00144 Admit source Omitted 15 2 IS O 0009 00145 Ambulatory status Omitted 16 2 IS O 0099 00146 VIP indicator Omitted 17 60 XCN O 0010 00147 Admitting doctor Omitted 18 2 IS C 0018 00148 Patient type Omitted Y Y Prepared by EM(HI) and IS4 Team, ITD Page 56 HL7 Implementation Guide Seq 19 Len 20 DT CX Dec 2004 Opt Rp/# Tbl# Item# R 00149 HL7 Element Name Visit number Notes (HA convention) -Case No (CASE) Add above type into User-defined table 0203 - Identifier type, referred to Table HA0007 Format: Components: <ID (ST)>^^^^<identifier type code (IS)>^< assigning facility(HD) Example: Case number is ‘HN1234567’ |HN1234567^^^^CASE^HA| 20 50 FC C 21 2 IS 22 2 23 Y 0064 00150 Financial class Omitted O 0032 00151 Charge price indicator Omitted IS O 0045 00152 Courtesy code Omitted 2 IS O 0046 00153 Credit rating Omitted 24 2 IS O Y 0044 00154 Contract code Omitted 25 8 DT O Y 00155 Contract effective date Omitted 26 12 NM O Y 00156 Contract amount Omitted 27 3 NM O Y 00157 Contract period Omitted 28 2 IS O 0073 00158 Interest code Omitted 29 1 IS O 0110 00159 Transfer to bad debt code Omitted 30 8 DT O 00160 Transfer to bad debt date Omitted 31 10 IS O 00161 Bad debt agency code Omitted 32 12 NM O 00162 Bad debt transfer amount Omitted 33 12 NM O 00163 Bad debt recovery amount Omitted 34 1 IS O 00164 Delete account indicator Omitted 35 8 DT O 00165 Delete account date Omitted 36 3 IS C 00166 Discharge disposition (HA convention) 0021 0111 0112 -Discharged Code Example: Discharged Code is “DISC” |DISC| Prepared by EM(HI) and IS4 Team, ITD Page 57 HL7 Implementation Guide Seq 37 Len 25 DT CE Dec 2004 Opt Rp/# Tbl# Item# HL7 Element Name O 00167 Discharged to location Y/5 0113 Notes (HA convention) -Destination Code Format: Components: <Discharge Location (IS)>^<Effective Datetime (TS in YYYYMMDDhhmmss.sss) Example: (i) destination code is ICU07 (ii) effective date is 2003-12-10 23:45:12.123 |ICU07^20031210234512.123| 38 2 CE O 0114 00168 Diet type Omitted 39 4 IS O 0115 00169 Servicing facility (HA convention) 11 HAHOSPID -Servicing facility Example: Servicing facility is “UCHAE” |UCHAE| 40 1 IS O 0116 00170 Bed status Omitted 41 2 IS O 0117 00171 Account status Omitted 42 80 PL O 00172 Pending location Omitted 43 80 PL O 00173 Prior temporary location Omitted 44 26 TS C 00174 Admit date/time Omitted 45 26 TS C 00175 Discharge date/time (HA convention) -Discharged Date Time Format: YYYYMMDDhhmmss.sss 46 12 NM O 00176 Current patient balance Omitted 47 12 NM O 00177 Total charge Omitted 48 12 NM O 00178 Total adjustments Omitted 49 12 NM O 00179 Total payments Omitted 50 20 CX O 0203 00180 Alternate visit ID Omitted 51 1 IS O 0326 01226 Visit indicator Omitted 52 60 XCN O 0010 01224 Other healthcare provider Omitted Y Prepared by EM(HI) and IS4 Team, ITD Page 58 HL7 Implementation Guide Dec 2004 3.1.6 NK1 Next of Kin Segment The following applies: (a) Function The NK1 segment is used to communicate Next of Kin Information. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Next of Kin (NK1) Segment Prepared by EM(HI) and IS4 Team, ITD Page 59 HL7 Implementation Guide Seq 1 Len 4 DT SI Dec 2004 Opt Rp/# Tbl# Item# R 00190 HL7 Element Name Set ID – NK1 Notes Values : Must be ‘1’ 2 48 XPN O Y 00191 Name (HA Convention) -English NOK Family Name (EPN), -English NOK Given Name (EPN) Format: Components: <Patient NOK Name (ST)>^<NOK GivenName (ST)>^^^^<NOK Name type (IS)> Example: (i) English NOK Family Name is ‘CHAN’ (ii) English NOK Family Name is ‘TAI MAN’ |CHAN^TAI MAN^^^^ÊN| 3 60 CE O 0063 00192 Relationship (HA convention) Format: Components: <Relation Code (ST)> Example: |DA | 4 106 XAD O Y HAAD 00193 Address (HA convention) Including one or more from below: -NOK Room, -NOK Floor, -NOK Block, -NOK Building, -NOK District Code Format: Components: <Room (ST)>^<Floor (ST)>^<Block (ST)>^ <Building (ST)>^<District Code (IS)> Example: (i) Room is ‘A’ (ii) Floor is ‘5’ (iii) Block ‘1’ (iv) Building is ‘ABC Court, 18 Garden Road’ (v) District is ‘MLV’ |A^5^1ÂBC Court,18 Garden Road^MLV| Prepared by EM(HI) and IS4 Team, ITD Page 60 HL7 Implementation Guide Seq 5 Len 40 DT XTN Dec 2004 Opt Rp/# Tbl# Item# O 00194 Y HL7 Element Name Phone number Notes (HA convention) Including one or more from below: -NOK Home Phone Number, -NOK Other Phone Number 1, -NOK Other Phone extension 1, -NOK Other Phone Number 2, -NOK Other Phone extension 2 Format: Components: <Home Phone (ST)>^^^^^^^^<Phone Extension (ST)> Example: (i) Home Phone No is ‘27110000’ (ii) Other Phone No 1 is ‘27111234’ (Iii) Other Phone Ext 1 is ‘EXT1234’ (Iv) Other Phone No 2 is ‘94549451’ (v) Other Phone Ext 2 is ‘’ |27110000~27111234^^^^^^^ÊXT12 34~94549451| 6 40 XTN O 7 60 CE O 8 8 DT 9 8 10 Y 00195 Business Phone number Omitted 00196 Contact Role Omitted O 00197 Start Date Omitted DT O 00198 End Date Omitted 60 ST O 00199 NOK /associated parties job title Omitted 11 20 JCC O 00200 NOK/associated parties job code/class Omitted 12 20 CX O 00201 NOK/associated parties employee number Omitted 13 60 XON O 00202 Organization name Omitted 14 80 CE O 0002 00119 Marital Status Omitted 15 1 IS O 0001 00111 Sex Omitted 16 26 TS O 00110 Date/time of Birth Omitted 17 2 IS O Y 0223 00755 Living dependency Omitted 18 2 IS O Y 0009 00145 Ambulatory Status Omitted 19 80 CE O Y 0171 00129 Citizenship Omitted 20 60 CE O 0296 00118 Primary Language Omitted 21 2 IS O 0220 00742 Living arrangement Omitted 22 80 CE O 0215 00743 Publicity indicator Omitted 23 1 ID O 0136 00744 Protection indicator Omitted 24 2 IS O 0231 00745 Student indicator Omitted 25 80 CE O 0006 00120 Religion Omitted 0131 Y Prepared by EM(HI) and IS4 Team, ITD Page 61 HL7 Implementation Guide Seq Len DT Dec 2004 Opt Rp/# Tbl# Item# 00746 Mothers Maiden Name Omitted HL7 Element Name Notes 26 48 XPN O 27 80 CE O 0212 00739 Nationality Omitted 28 80 CE O 0189 00125 Ethnic Group Omitted 29 80 CE O Y 0222 00747 Contact reason Omitted 30 48 XPN O Y 00748 Contact person name Omitted 31 40 XTN O Y 00749 Contact person’s phone number Omitted 32 106 XAD O Y 00750 Contact person’s address Omitted 33 32 CX O Y 00751 NOK/associated party’s identifiers (HA convention) Format: Components: <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed(ID)> ^ < assigning authority (HD)> ^ <identifier type code (IS)> ^ < assigning facility(HD) -assigning facility referred to HA Defined Table HA0006 -identifier type code referred to HA Defined Table HA0007 Example: Hong Kong Identity is ’ A123456(7)’ |A1234567^^^^HKID^GOVT| 34 2 IS O 0311 00752 Job status Omitted 35 80 CE O 0005 00113 Race Omitted 36 2 IS O 0295 00753 Handicap Omitted 37 16 ST O 00754 Contact person social security number Omitted 3.1.7 MRG Merge Patient Information Segment The following applies: (a) Function The MRG segment is used to transmit details of links or merges. (b) Data elements and usage notes below. For relevant data elements and usage notes, see tables Merge Patient Information (MRG) Segment Prepared by EM(HI) and IS4 Team, ITD Page 62 HL7 Implementation Guide Seq 1 Len 20 DT CX Opt R Dec 2004 Rp/# Tbl# Y Item# 00211 Element name Prior Patient ID – Internal Notes (HA convention) Including one or more from below: Identity Name (Identifier Type Code) -Hong Kong Identity (HKID), -Patient Key (PATKEY), -Other Document No (DOCNO), -Reference (REFNO), -Medical Record Number (MR) Add above type into User-defined table 0203 - Identifier type, referred to Table HA0007 Example: Hong Kong Identity is ’ A123456(3)’ Patient Key is ’87654321’ | A1234563^^^^HKID^GOVT~87654321 ^^^^PATKEY^HA| 2 20 CX O 3 20 CX 4 20 5 20 Y 00212 Prior Alternate Patient ID O 00213 Prior Patient Account Number CX O 00214 Prior Patient ID – External CX O 01279 Prior Visit Number (HA convention) -Case No (CASE) Add above type into User-defined table 0203 - Identifier type, referred to Table HA0007 Format: Components: <ID (ST)>^<check digit (ST)>^<code identifying the check digit scheme employed(ID)>^< assigning a uthority (HD)>^<identifier type code (IS)>^< assigning facility(HD) Example: Case number is ‘HN1234567’ |HN1234567^^^^CASE^HA| 6 20 CX O Prepared by EM(HI) and IS4 Team, ITD 01280 Prior Alternate Visit ID Page 63 HL7 Implementation Guide Seq 7 Len 48 DT XPN Opt Dec 2004 Rp/# Tbl# O Item# Element name 01281 Prior Patient Name HAPN Notes (HA convention) Including one or more Name Type (Name Type Code) from below: -English Patient Name (EPN), -Chinese Patient Name (CPN), -1st Chinese Character Code (CCC_1), -2nd Chinese Character Code (CCC_2), -3rd Chinese Character Code (CCC_3), -4th Chinese Character Code (CCC_4), -5th Chinese Character Code (CCC_5), -6th Chinese Character Code (CCC_6) Format: Components: <Patient Family Name (ST)>^<Patient GivenName (ST)>^^^^<Patient Name type (IS)> Example: (i) English Patient Family Name is ‘CHAN’ (ii) English Patient Given Name is ‘TAI MAN’ (iii) Chinese Patient Name is ‘’ (iv) 1st Chinese Character Code is ‘1111’ (v) 2nd Chinese Character Code is ‘2322’ (vi) 3rd Chinese Character Code is ‘3333’ (vii) 4rhChinese Character Code is ‘4444’ (viii) 5rhChinese Character Code is ‘5555’ (ix ) 6rhChinese Character Code is ‘6666’ |CHAN^TAI MAN^^^^ÊPN~^^^^^^CPN ~1111^^^^^^CCC_1~2222^^^^^^CCC_ 2~3333^^^^^^CCC_3~4444^^^^^^CCC _4~5555^^^^^^CCC_5~6666^^^^^^CC C_6| 3.1.8 Observation Report (OBR) Segment The following applies: (a) Function The OBR segment identifies the observation set represented by the following observations. (b) Data elements and usage notes For the meaning of daggered (+), starred (*) items and those with #, please refer to Section 7.3.1.0 OBR field definition of the HL7 Standard for more information. For relevant data elements and usage notes, see tables below. Observation Report (OBR) Segment Prepared by EM(HI) and IS4 Team, ITD Page 64 HL7 Implementation Guide DT Opt Rp/# Dec 2004 Seq Len Tbl# Item# HL7 Element name 1 4 SI C 00237 Set ID – OBR 2 22 EI C 00216 Placer Order Number Notes (HA convention) LIS Order/Result Information: HA Request Number GCR/GRR Result Information: 3 22 EI 4 200 CE C 00217 Filler Order Number + R 00238 Universal Service ID - GCRS Request Number (OBR-2-2) - Function Code (OBR-2-2) (HA convention) LIS Order/Result Information: HA standard orderable test code (OBR-4-1) GCR/GRR Request/Result Information: 5 2 ID X 00239 Priority - Test Code (OBR-4-1) - Test Description (OBR-4-2) (HA convention) LIS Order/Result Information: Urgency (1-5) 6 26 TS X 00240 1- Urgent 2- Non-urgent 3- T&S 4- Desperate 5- Reserve for OT Requested Date/Time (HA convention) GCR/GRR Result Information: - Creation Date Time 7 26 TS C 00241 Observation Date/Time # (HA convention) LIS Order/Result Information: Collect Date/Time 8 26 TS O 00242 Observation End Date/Time # 9 20 CQ O 00243 Collection Volume * (HA convention) LIS Order/Result Information: Volume collected Prepared by EM(HI) and IS4 Team, ITD Page 65 HL7 Implementation Guide Seq Len 10 60 DT XCN Opt Rp/# O Y Dec 2004 Tbl# Item# 00244 HL7 Element name Collector Identifier * Notes (HA convention) GCR/GRR Result Information: - Request By 11 1 ID O 12 60 CE 13 300 ST 0065 00245 Specimen Action Code O 00246 Danger Code O 00247 Relevant Clinical Info. (HA convention) LIS Order/Result Information: Clinical Information, Test information, Admit Diagnosis 14 26 TS C 15 300 CM O 0070 00248 Specimen Received Date/Time * 00249 Specimen Source * (HA convention) LIS Order/Result Information: Specimen Site 16 80 XCN O Y 00226 Ordering Provider (HA convention) LIS Order/Result Information: Request Doctor 17 40 XTN O 18 60 ST 19 60 20 Y/2 00250 Order Callback Phone Number O 00251 Placer Field 1 ST O 00252 Placer Field 2 60 ST O 00253 Filler Field 1 + 21 60 ST O 00254 Filler Field 2 + 22 26 TS C 00255 Results Rpt/Status Chng – Date/Time 23 40 CM O 00256 Charge to Practice + 24 10 ID O 0074 00257 Diagnostic Serv Sect ID 25 1 ID C 0123 00258 Result Status + 26 400 CM O 00259 Parent Result + 27 200 TQ O Y 00221 Quantity/Timing 28 150 XCN O Y/5 00260 Result Copies To 29 150 CM O 00261 Parent * (HA convention) LIS Order/Result Information: To be used for Culture and Sensitivity 30 20 ID 31 300 CE O O 0124 Y Prepared by EM(HI) and IS4 Team, ITD 00262 Transportation Mode 00263 Reason for Study Page 66 HL7 Implementation Guide Seq Len DT 32 200 CM Opt Rp/# Dec 2004 Tbl# O Item# 00264 HL7 Element name Principal Result Interpreter + Notes (HA convention) LIS Order/Result Information: Sign By GCR/GRR Result Information: - Doctor Name (OBR-32-1-2) - Title (OBR-32-1-2) Format : “Doctor Name (Title)” - 33 200 CM O Y 00265 Assistant Result Interpreter + Sign Datetime (OBR-32-2) (HA convention) LIS Order/Result Information: Authorize By 34 200 CM O Y 00266 Technician + (HA convention) LIS Order/Result Information: Enter By 35 200 CM O Y 00267 Transcriptionist + (HA convention) LIS Order/Result Information: Enter By GCR/GRR Result Information: - Report Location (OBR-35-4) 36 26 TS O 00268 Scheduled Date/Time + 37 4 NM O 01028 Number of Sample Containers * 38 60 CE O Y 01029 Transport Logistics of Collected Sample * 39 200 CE O Y 01030 Collector’s Comment * (HA convention) LIS Order/Result Information: Request Comment, Test Comment 40 60 CE O 41 30 ID O 42 1 ID O 43 200 CE O 01031 Transport Arrangement Responsibility 0224 01032 Transport Arranged 0225 01033 Escort Required 01034 Planned Patient Transport Comment Y Prepared by EM(HI) and IS4 Team, ITD Page 67 HL7 Implementation Guide Dec 2004 3.1.9 Observation (OBX) Segment The following applies: (a) Function fragment. The OBX segment is used to transmit a single observation or observation (b) Data elements and usage notes below. For relevant data elements and usage notes, see tables Observation (OBX) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 10 SI O 00569 Set ID – OBX 2 2 CE C 00570 Value Type 3 590 CE R 00571 Observation Identifier Note (HA convention) LIS Order/Result Information: Test code (LOINC) GCR/GRR Request/Result Information: - Request Information : Description (OBX-3-2) 4 20 ST 5 600 RS2 C C Y 00572 Observation Sub-ID 00573 Observation Value (HA convention) LIS Order/Result Information: Test Result GCR/GRR Request/Result Information: - Request Information : Value 6 60 CE O 00574 Units 7 10 ST O 00575 References Range 8 5 ID O 00576 Abnormal Flags 9 5 NM O 00577 Probability 10 2 ID O 0080 00578 Nature of Abnormal Test 11 1 ID R 0085 00579 Observ Result Status 12 26 TS O 00580 Date Last Obs Normal Values 13 20 ST O 00581 User Defined Access Checks 14 26 TS O 00582 Date/Time of the Observation Y/5 Y 0078 Prepared by EM(HI) and IS4 Team, ITD Page 68 HL7 Implementation Guide Seq Len 15 60 DT CE Opt Dec 2004 Rp/# Tbl# O Item# 00583 HL7 Element name Producer’s ID Note (HA convention) LIS Order/Result Information: (e.g. DH) 16 80 XCN O 00584 Responsible Observer (HA convention) LIS Order/Result Information: Sign By 17 60 CE O Y 00936 Observation Method 3.1.10 Common Order (ORC) Segment The following applies: (a) Function The ORC segment is used to send information that is common to all orders. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Common Order (ORC) Segment Seq Len DT Opt 1 2 ID R 2 22 EI C Rp/# Tbl# Item# HL7 Element name Notes 0119 00215 Order Control 00216 Placer Order Number (HA convention) LIS Order/Result Information: HA Request Number GCR/GRR Request/Result Information: 3 22 EI C - GCRS Request Number (ORC-2-1) - Function Code (ORC-2-2) 00217 Filler Order Number (HA convention) LIS Order/Result Information: DH Request Number 4 22 EI O 00218 Placer Group Number (HA convention) LIS Order/Result Information: To be used for DFT Prepared by EM(HI) and IS4 Team, ITD Page 69 HL7 Implementation Guide Seq 5 Len 2 DT ID Opt Dec 2004 Rp/# Tbl# O Item# HL7 Element name 0038 00219 Order Status Notes (HA convention) LIS Order/Result Information: Request Status from DH 6 1 ID O 0121 00220 Response Flag 7 200 TQ O 00221 Timing/Quantity 8 200 CM O 00222 Parent (HA convention) LIS Order/Result Information: To be used for Culture and Sensitivity 9 26 TS O 00223 Date/time of transaction (HA convention) GCR/GRR Request/Result Information: - Creation Date Time 10 120 XCN O 00224 Entered By (HA convention) LIS Order/Result Information: Nurse GCR/GRR Request Information: - Request By 11 120 XCN O 00225 Verified By (HA convention) LIS Order/Result Information: Request Doctor 12 120 XCN O 00226 Ordering provider (HA convention) LIS Order/Result Information: Request Doctor 13 80 PL 00227 Enterer’s location O (HA convention) GCR/GRR Request/Result Information: - Request Location 14 40 XTN O 2 00228 Call back phone number 15 26 TS O 00229 Order effective date/time 16 200 CE O 00230 Order control reason code 17 60 CE O 00231 Entering organization (HA convention) LIS Order/Result Information: e.g. HA Prepared by EM(HI) and IS4 Team, ITD Page 70 HL7 Implementation Guide Seq Len DT Dec 2004 Opt Rp/# Tbl# Item# HL7 Element name 18 60 CE O 00232 Entering device 19 120 XCN O 00233 Action by Notes 3.1.11 Original-style Query Definition Segment (QRD) The following applies: (a) Function The QRD segment is used to define a query. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Original-style Query Definition (QRD) Segment Seq Len DT Opt 1 26 TS R 2 1 ID R Rp/# Tbl# Item# HL7 Element name Notes 00025 Query Date/Time 0106 00026 Query Format Code Value = T (tabular) if multiple records are expected to be returned. Value = R (record) if a single record is expected to be returned. 3 1 ID R 0091 00027 Query Priority 4 10 ST R 00028 Query ID 5 1 ID O 0107 00029 Deferred Response Type 6 26 TS O 00030 Deferred Response Date/Time 7 10 CQ O 8 60 XCN O Y 9 60 CE R Y 10 60 CE O Y 00034 What Department Data Code 11 20 ST O Y 00035 What Data Code Value Qual. 12 1 ID O Value: I (immediate) 0126 00031 Quantity Limited Request 00032 Who Subject Filter 0048 00033 What Subject Filter 0108 00036 Query Results Level 3.1.12 Original-style Query Filter Segment (QRF) The following applies: Prepared by EM(HI) and IS4 Team, ITD Page 71 HL7 Implementation Guide Dec 2004 (a) Function The QRF segment is used to further refine the content of an original style query. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Original-style Query Filter (QRF) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name Y 00037 Where Subject Filter 1 20 ST R 2 26 TS O 00038 When Data Start Date/Time 3 26 TS O 00039 When Data End Date/Time 4 60 ST O Y 00040 What User Qualifier 5 60 CE O Y 00041 Other QRY Subject Filter 6 12 ID O Y 0156 00042 Which Date/Time Qualifier 7 12 ID O Y 0157 00043 Which Date/Time Status Qualifier 8 12 ID O Y 0158 00044 Date/Time Selection Qualifier 9 60 TQ O Notes 00694 When Quantity/Timing Qualifier 3.1.13 Query Acknowledgement (QAK) Segment The following applies: (a) Function The QAK segment is used to hold response information to a query. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Seq Len DT Opt 1 32 ST C 2 60 ID O Rp/# Tbl# 0208 Prepared by EM(HI) and IS4 Team, ITD Item# HL7 Element name 00696 Query Tag 00708 Query Response Status Notes Page 72 HL7 Implementation Guide Dec 2004 3.1.14 Display Data (DSP) Segment The following applies: (a) Function The DSP segment is used when sending data that has been formatted ready for display. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Display (DSP) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 4 SI O 00061 Set ID – DSP 2 4 SI O 00062 Display level 3 300 TX R 00063 Data Line 4 2 ST O 00064 Logical Break Point 5 20 TX O 00065 Result ID Notes 3.1.15 Pharmacy/Treatment Order (RXO) Segment The following applies: (a) Function The RXO segment is the master pharmacy/treatment order segment. (b) Data elements and usage notes The RXO Segment contains order data not specific to components or additives. For relevant data elements and usage notes, see RXO table below. Pharmacy/Treatment Order (RXO) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 100 CE C 00292 Requested Give Code 2 20 NM C 00293 Requested Give amount – minimum 3 20 NM O 00294 Requested Give amount – maximum 4 60 CE C 00295 Requested Give Units 5 60 CE O 00296 Requested Dosage form Prepared by EM(HI) and IS4 Team, ITD Notes Page 73 HL7 Implementation Guide Seq Len DT Opt Dec 2004 Rp/# Tbl# Item# HL7 Element name 6 200 CE O Y 00297 Provider’s Pharmacy/ Treatment instructions 7 200 CE O Y 00298 Provider’s Administration instructions 8 200 CM O 9 1 ID O 10 100 CE O 00301 Requested dispense code 11 20 NM O 00302 Requested dispense amount 12 60 CE O 00303 Requested dispense units 13 3 NM O 00304 Number of refills 14 60 XCN C Y 00305 Ordering Provider’s DEA Number 15 60 XCN C Y 00306 Pharmacists/Treatm ent Suppliers verifier ID 16 1 ID O 17 20 ST C 00308 Request Give Per (Time Unit) 18 20 NM O 01121 Requested Give Strength 19 60 CE O 01122 Requested Give Strength Units 20 200 CE O 21 6 ST O 01218 Requested Give Rate Amount 22 60 CE O 01219 Requested Give Rate Units 23 10 CQ O 00329 Total Daily Dose Notes 00299 Deliver to location 0161 00300 Allow substitutes 0136 00307 Needs Human Review Y 01123 Indication 3.1.16 Pharmacy Route (RXR) Segment The following applies: (a) Function The RXR segment communicates the alternative combination of route, site, administration device and administration method. (b) Data elements and usage notes The pharmacy and/or nursing staff has a choice between the routes based on either professional judgment or administration provided by the physician. For relevant data elements and usage notes, see tables below. Prepared by EM(HI) and IS4 Team, ITD Page 74 HL7 Implementation Guide Dec 2004 Pharmacy Route Order (RXR) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 60 CE R 0162 00309 Route 2 60 CE O 0163 00310 Site 3 60 CE O 0164 00311 Administration device 4 60 CE O 0165 00312 Administration method Notes 3.1.17 Pharmacy Component (RXC) Segment The following applies: (a) Function The RXC segment communicates the components (base and all additives) of a compound drug or an IV solution where there is not a coded Universal Service ID for the ordered drug/treatment. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Pharmacy Component (RXC) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 1 ID R 2 100 CE R 00314 Component Code 3 20 NM R 00315 Component Amount 4 60 CE R 00316 Component Units 5 20 NM O 01124 Component Strength 6 60 CE O 01125 Component Strength Units Notes 0166 00313 RX Component type 3.1.18 Pharmacy Encoded Order (RXE) Segment The following applies: (a) Function The RXE segment communicates information about the pharmacy application’s encoding of the order. Prepared by EM(HI) and IS4 Team, ITD Page 75 HL7 Implementation Guide Dec 2004 (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Pharmacy Encoded Order (RXE) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 200 TQ R 2 100 CE R 3 20 NM R 00318 Give amount – Minimum 4 20 NM O 00319 Give amount – Maximum 5 60 CE O 00320 Give Units 6 60 CE O 00321 Give Dosage Form 7 200 CE O 8 200 CM C 00299 Deliver to location 9 1 ID O 0167 00322 Substitution status 10 20 NM C 00323 Dispense amount 11 60 CE C 00324 Dispense units 12 3 NM O 00304 Number of refills 13 60 XCN C 00305 Ordering provider’s DEA number 14 60 XCN O 00306 Pharmacist verifier ID 15 20 ST R 00325 Prescription number 16 20 NM C 00326 Number of refills remaining 17 20 NM C 00327 Number of refills/doses dispensed 18 26 TS C 00328 Date/Time of most recent refill or does dispensed 19 10 CQ C 00329 Total daily dose 20 1 ID O 21 200 CE O 22 20 ST C 00331 Give per (time unit) 23 6 ST O 00332 Give rate amount Notes 00221 Quantity/timing 0292 00317 Give Code 00298 Provider’s administration instructions Y 0136 00307 Needs Human review Y Prepared by EM(HI) and IS4 Team, ITD 00330 Pharmacy special dispensing instructions Page 76 HL7 Implementation Guide Seq Len DT Opt Dec 2004 Rp/# Tbl# Item# HL7 Element name 24 60 CE O 00333 Give rate units 25 20 NM O 01126 Give strength 26 60 CE O 01127 Give strength units 27 200 CE O 28 20 NM O 29 60 CE 30 2 ID Y Notes 01128 Give indication 01220 Dispense package size 01221 Dispense package size units O 0321 01222 Dispense package method 3.1.19 Pharmacy Dispense (RXD) Segment The following applies: (a) Function The RXD segment communicates dispense information for a given supply of therapeutic product. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Pharmacy Dispense Order (RXD) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 4 NM R 2 100 CE R 3 26 TS R 00336 Date/time dispensed 4 20 NM R 00337 Actual dispense amount 5 60 CE C 00338 Actual dispense units 6 60 CE O 00339 Actual dosage form 7 20 ST C 00325 Prescription number 8 20 NM C 00326 Number of refills remaining 9 200 ST C 10 200 XCN O 11 1 ID O Notes 00334 Dispense sub-ID counter 0292 00335 Dispense/give code Y 00340 Dispense notes 00341 Dispensing provider 0167 00322 Substitution status Prepared by EM(HI) and IS4 Team, ITD Page 77 HL7 Implementation Guide Seq Len DT Opt Dec 2004 Rp/# Tbl# Item# HL7 Element name 12 10 NM O 00329 Total daily dose 13 200 CM C 01303 Dispense to location 14 1 ID O 15 200 CE O 16 20 NM O 01132 Actual strength 17 60 CE O 01133 Actual strength unit 18 20 ST O Y 01129 Substance lot number 19 26 TS O Y 01130 Substance expiration date 20 60 CE O Y 01131 Substance manufacturer name 21 200 CE O Y 01123 Indication 22 20 NM O 01220 Dispense package size 23 60 CE O 01221 Dispense package size unit 24 2 ID O 0321 01222 Dispense package unit Notes 0136 00307 Needs human review Y 00330 Pharmacy/treatment supplier’s special dispensing instructions 3.1.20 Appointment Request (ARQ) Segment The following applies: (a) Function The ARQ segment defines a request for booking an appointment. It is used in transactions sent from an application acting in the role of a placer. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Appointment Request (ARQ) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 75 EI R 0860 Placer Appointment ID 2 75 EI C 0861 Filler Appointment ID 3 5 NM C 00862 Occurrence Number 4 22 EI O 0218 Placer Group Number 5 200 CE O 0864 Schedule ID Prepared by EM(HI) and IS4 Team, ITD Notes Page 78 HL7 Implementation Guide 6 200 CE O 7 200 CE O 8 200 CE O 9 20 NM 10 200 11 Dec 2004 00865 Request Event Reason 0276 00866 Appointment Reason 0277 00867 Appointment Type O 0868 Appointment Duration CE O 0869 Appointment Duration Units 53 DR O 0870 Requested Start Date/Time Range 12 5 ST O 0871 Priority – ARQ 13 100 RI O 0872 Repeating Interval 14 5 ST O 00873 Repeating Interval Duration 15 48 XCN R Y 00874 Placer Contact Person 16 40 XTN O Y 00875 Placer Contact Phone Number 17 106 XAD O Y 00876 Placer Contact Address 18 80 PL O 00877 Placer Contact Location 19 48 XCN R Y 00878 Entered by Person 20 40 XTN O Y 00879 Entered by Phone Number 21 80 PL O 00880 Entered by Location 22 75 EI O 00881 Parent Placer Appointment ID 23 75 EI O 00882 Parent Filler Appointment ID Y 3.1.21 Resource Group (RGS) Segment The following applies: (a) Function The RGS segment is used to identify relationships between resources identified for a schedule event. This segment can be used together within a scheduled event, or to describe some other relationship between resources. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Resource Group (RGS) Segment Prepared by EM(HI) and IS4 Team, ITD Page 79 HL7 Implementation Guide Seq 1 Len 4 DT SI Opt Dec 2004 Rp/# Tbl# R Item# 01203 HL7 Element Name Notes Set ID- RGS 3.1.22 Schedule Activity (SCH) Segment The following applies: (a) Function The RGS segment is used to identify relationships between resources identified for a schedule event. This segment can be used together within a scheduled event, or to describe some other relationship between resources. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Schedule Activity (SCH) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 1 75 EI C 00860 Placer Appointment ID 2 75 EI C 00861 Filler Appointment ID 3 5 NM C 00862 Occurrence Number 4 22 EI O 00218 Placer Group Number 5 200 CE O 00864 Schedule ID 6 200 CE R 00883 Event Reason 7 200 CE O 0276 00866 Appointment Reason 8 200 CE O 0277 00867 Appointment Type 9 20 NM O 00868 Appointment Duration 10 200 CE O 00869 Appointment Duration Units 11 200 TQ R 00884 Appointment Timing Quantity 12 48 XCN O 13 40 XTN O 14 106 XAD O 15 80 PL O 16 38 XCN R Y Y Y Y Prepared by EM(HI) and IS4 Team, ITD 00874 Placer Contact Person 00875 Placer Contact Phone Number 00876 Placer Contact Address 00877 Placer Contact Location 00885 Filler Contact Person Notes ^^^System date and time Format: ^^^YYYYMMDDhhmm Page 80 HL7 Implementation Guide 17 40 XTN O 18 106 XAD O 19 80 PL O 20 48 XCN R Dec 2004 Y Y 00886 Filler Contact Phone Number 00887 Filler Contact Address 00888 Filler Contact Location 00878 Entered by person 3.1.23 Status Change (NSC) Segment The following applies: (a) Function The status change segment can be used to request start-up, shut-down, and/or migration (to a different cpu or, file-server/file-system) of a particular application. It can also be used in an unsolicited update from one system to another to announce the start-up, shut-down, or migration of an application. (b) Data elements and usage notes For relevant data elements and usage notes, see tables below. Status Change (NSC) Segment Seq Len DT Opt Rp/# Tbl# Item# HL7 Element name 0333 01188 Network Change Type 1 4 IS R 2 30 ST O 01189 Current CPU 3 30 ST O 01190 Current Fileserver 4 30 ST O 01191 Current Application 5 30 ST O 01192 Current Facility 6 30 ST O 01193 New CPU 7 30 ST O 01194 New Fileserver 8 30 ST O 01195 New Application 9 30 ST O 01196 New Facitlity 10 200 CE O 0869 Appointment Duration Units Prepared by EM(HI) and IS4 Team, ITD Notes Page 81 HL7 Implementation Guide Dec 2004 4 LOWER LEVEL PROTOCOL The Lower Level Protocol (LLP) requirements for Hospital Authority are based on the use of TCP/IP socket stream as the base communications protocol. It is a mandatory requirement that any healthcare application proposed for use by Hospital Authority implements TCP/IP as the transport protocol. In the HL7 LLP environment a Start and an End character mark the beginning and end of a message. This allows other transport protocols to break a message into packets for transmission and then allow the re-assembly of the message again from the packets. For example, using TCP socket stream to send to machine name “HAHL7” port name “234” <SB>data<CR> segments<CR> <EB><CR> where <CR>=0x0D, <SB>=0x0B, <EB>=0x1C Prepared by EM(HI) and IS4 Team, ITD Page 82 HL7 Implementation Guide Dec 2004 5 GLOSSARY OF TERMS 5.1 Abbreviations used in this document HA HL7 ITD LOINC Hospital Authority Health Level 7 Information Technology Department Logical Observation Identifiers Names and Codes Prepared by EM(HI) and IS4 Team, ITD Page 83 HL7 Implementation Guide Dec 2004 6 REFERENCE   HL7 Standard Specification V2.3.1, Apr 1999 XML Encoding Rules for HL7 v2 Messages, Jun 2003 Prepared by EM(HI) and IS4 Team, ITD Page 84 HL7 Implementation Guide Dec 2004 APPENDIX A HA System Field and Event Mapping For the table listed below, the ‘Column name’ is the column of source table, and ‘HL7 Segment-Seg’ is used to indicate the corresponding HL7 segment and sequence.. For example, in Seq 1, hospital_code maps with MSH-4, it means that hospital_code field in source table should map to Seq 4 of Message Header (MSH), i.e. ‘Sending Facility’. Similarly, PID-5 means Seq 5 of Patient Identification segment, i.e. ‘Patient Name’. Please refer to section 3 about the detail of message segment. A.1 Patient Admission System (HPI/CPI, HKPMI) A.1.1 Field to field mapping table Seq Column Name 1 2 3 Remarks hospital_code transaction_datetime HL7 SegmentSeq EVN-2 transaction_type MSH-9 This field is used to determine the event type based on transaction type mapping table, for example, A01, A02, A03 and etc.. Moreover, ‘transaction_type’ is also used on MSH-9 as message type. In format YYYYMMDDhhmmss.sss The component of MSH-9 is <message type> ^ <trigger event> ^ <message structure>. The <message type> must be ‘ADT’ in this demonstration. The <trigger event> can be found out by using this transaction type and the transaction type mapping table. For example, if this transaction type is ‘100’, then event should be ‘A01’ or ‘A04’; if ‘130’, then ‘A03’; if ‘140’, then ‘A02’. The <message structure> can be found out by using the message structure mapping table. For example, if transaction type is ‘140’, then trigger event should be ‘A02’. By Prepared by EM(HI) and IS4 Team, ITD Page 85 HL7 Implementation Guide Dec 2004 using the message structure mapping table, we should know that the structure should be ‘ADT_A02’. If this transaction type is ‘140’ (Mass transfer/bed assignment), then MSH-9 must be ADTÂ02ÂDT_A02 4 hkid PID-3 where ADT is message type which is hardcoded here; where A02 is the trigger event which can be determined by transaction_type field; where ADT_A02 is the message structure which can be determined by message structure mapping table. All these fields are put under the PID-3 which is a repeatable component.       hkid patient_key other_document_no reference medical_record_number case_no PID-3 is a component field which have following format <ID>^<check digit>^<coding scheme>^<assigning authority>^<identifier type code>^<assigning facility> We would set check digit, coding scheme, assigning authority, identifier type code and assigning facility as NULL, so the PID-3 is simplified as <ID>. The ID field is coded as containing two parts which are separated by semi-colon. The first part is the code identifier, the second part is the actual code. For example. if hkid of a patient is A123456, then the PID-3 should be hkid:A123456. Other possible identifier are,  ‘HKID’ for the field hkid  ‘PKey’ for the field patient_key  ‘Doc’ for the field other_document_no Prepared by EM(HI) and IS4 Team, ITD Page 86 HL7 Implementation Guide Dec 2004    5 patient_key PID-3 ‘Ref’ for the field reference ‘MRN’ for the field medical_record_number ‘CaseNo’ for the field case_no (Be reminded that at least hkid or case_no contain valid value in a patient record, i.e. both of them can’t be NULL at the same time.) Since PID-3 is repeatable and, hkid or case_no must exist, so this field should be separated by HL7 repeat separator ‘~’. For example, if hkid and patient_key of a patient are ‘A123456’ and ‘00036800’ correspondingly, then the PID-3 should be HKID:A123456~PKey:00036800 6 patient_name PID-5 (Where ~ is repeat separator) For example, if patient_name is ‘Chan Tai Man’, then the PID-5 should be Chan Tai Man Although patient name in HL7 consists of family name, given name, middle name, suffix, prefix and etc, we just require the whole name in this field. 7 8 9 10 Sex Dob exact_dob_flag ccc_1 PID-8 PID-7 PID-5 In format YYYYMMDD This is Chinese character code. For example, the code for Chan Tai Main is ‘1728’, ‘0251’ and ‘3843’, so ccc_1 is ‘1728’; ccc_2 is ‘0251’; ccc_3 is ‘3843’; ccc_4 is ‘’; ccc_5 is ‘’; ccc_6 is ‘’ If Chinese name exist in the field chi_name, then the Chinese name and all the ccc code should be put under the PID-5 as a repeated component. The format of PID-5 is shown below. <family name> & <last name> ^ <given name> ^ <middle name> ^ <suffix> ^ <prefix> ^ <degree> ^ Prepared by EM(HI) and IS4 Team, ITD Page 87 HL7 Implementation Guide Dec 2004 <name type code> ^ <name representation code> For the Chinese name, please transform as follow, <chi_name>^^^^^^^<I:ccc_1:ccc_2: ccc_3:ccc_4:ccc_5:ccc_6> (Where ‘I’ stand for Ideographic representation) For example, if patient ‘Chan Tai Man’ have a Chinese name ‘XXX’ with Chinese code ‘1728’, ‘0251’ and ‘3843’, then PID-5 should be, Chan Tai Main~XXX^^^^^^Î:1728:0251:384 3::: 11 12 13 14 15 16 ccc_2 ccc_3 ccc_4 ccc_5 ccc_6 chi_name PID-5 PID-5 PID-5 PID-5 PID-5 PID-5 17 18 19 20 21 22 23 marital_status race_code other_document_no reference medical_record_number remark building PID-16 PID-10 PID-3 PID-3 PID-3 PID-11 (Where ~ is repeat separator, so PID-5 contain two names, the first is English name and the other is the special formatted Chinese name.) Please refer to Seq 10 Please refer to Seq 10 Please refer to Seq 10 Please refer to Seq 10 Please refer to Seq 10 Chinese name of a patient. Please refer to Seq 10 Please refer to Seq 4 Please refer to Seq 4 Please refer to Seq 4 PID-11 is a component to represent patient address which have following format. <street address> ^ <other designation> ^ <city> ^ <state> ^ <postal code> ^ <country> ^ <address type> ^ <other geographic designation> ^ <country code> ^ <census tract> ^ <address representation code> We would treat the <street address> as the first line of address, and that <other designation> is the second line. Prepared by EM(HI) and IS4 Team, ITD Page 88 HL7 Implementation Guide Dec 2004 In the first line, it includes room, floor, building and block. The second line include the district_code. For example, if a patient address is Rm 1517 (room), Fl 15 (floor), Blk A (block), ABC Center (building), PYN (district_code), then <street address>, i..e first line, should include the fields room, floor, block and building with comma as separator. <other designation>, i.e. second line, should include the district_code only. Hence, the patient address in PID-11 format should be 24 25 26 27 28 29 room floor block district_code religion_code home_phone_no PID-11 PID-11 PID-11 PID-11 PID-13 1517, 15, A, ABC Center^PYN Please refer to Seq. 23 Please refer to Seq. 23 Please refer to Seq. 23 Please refer to Seq. 23 PID-13 is a repeatable component, so patient can provide a number of contact number, mobile number, email, beeper and etc. The format is [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code > ^ <telecommunication equipment type > ^ <email address > ^ <country code> ^ <area/city code> ^ <phone number > ^ <extension> ^ <any text> Since we always have 8-digits phone number in Hong Kong, so the first US style phone number field will not be used. The phone number will be put in <phone number>. If extension exist, then it should put under <extension> For example, if <home_phone_no> is ‘25151234’, other_phone_no_1 is ‘25154567’, other_phone_ext_1 is ‘123’, other_phone_no_2 is ‘90901234’ and other_phone_ext_2 is ‘’, then PID-13 should be Prepared by EM(HI) and IS4 Team, ITD Page 89 HL7 Implementation Guide 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 other_phone_no_1 other_phone_ext_1 other_phone_no_2 other_phone_ext_2 death_indicator death_date death_code card_holder priority major_nok nok_name nok_hkid nok_relation_code nok_building nok_room nok_floor nok_block nok_district_code nok_home_phone nok_other_phone_no_1 nok_other_phone_ext_1 nok_other_phone_no_2 nok_other_phone_ext_2 case_no admission_datetime source_indicator source_code patient_type discharge_code discharge_datetime 60 61 62 destination_code doctor_code case_type Dec 2004 PID-13 PID-13 PID-13 PID-13 PID-30 PID-29 NK1-33 PID-3 PV1-36 PV1-37 and PV1-45 PV1-37 PV1-2 ^^^^^^25151234~^^^^^^25154567^ 123~^^^^^^90901234 Please refer to Seq 29 Please refer to Seq 29 Please refer to Seq 29 Please refer to Seq 29 In format YYYYMMDD HKID of ‘next of kin’ Please refer to Seq 4 and Seq 5. In format YYYYMMDDhhmmss This is used to indicate the type of this case. Valid values are listed below Case Type HL7 Value Desc. A E Emergency I I Inpatient O O Outpatient Null P Preadmit 63 64 65 66 67 68 69 security_count case_access_code pmi_access_code ambulance_no police_case labour_case ae_case_type Prepared by EM(HI) and IS4 Team, ITD - Page 90 HL7 Implementation Guide 70 71 72 Dba_flag follow_up_datetime ward_code Dec 2004 PV1-3 PV1-3 is the ‘Assigned Patient Location’. The format can be simpified as below. <Point of care> ^ <room> ^ < bed> <room> is equivalent to this ward_code, <bed> is equivalent to bed_no. For the <Point of care>, it should include the specialty_code and sub_specialty_code with semi-colon as separator. For example, if specialty_code is ICU, and sub_specialty_code is “TRA”, ward_code is 4C and bed_no is 17A, then PV1-3 should be 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 specialty_code Sub_specialty_code Bed_no ward_class transfer_datetime Old_patient_key Old_name Old_hkid Old_sex Old_dob Old_ward_class Old_ward_code Old_specialty_code Old_bed_no Old_doctor_code pp_code update_hospital PV1-3 PV1-3 PV1-3 EVN-5 ICU:TRA^4C^17A Please refer to Seq 72 Please refer to Seq 72 Please refer to Seq 72 EVN-5 can be simplied as <ID>^<Operator Name> Please put the update_hospital as <ID> and update_by as <Operation Name> For example, if update_hospital is ‘PWH’ and update_by is ‘cheungwsj’, then EVN-5 should be 90 91 92 93 94 update_by update_dtm source_system success_indicator upload_status Prepared by EM(HI) and IS4 Team, ITD EVN-5 EVN-3 - PWH^cheungwsj Please refer to Seq 89. In format YYYYMMDDhhmmss Page 91 HL7 Implementation Guide 95 A.1.2 source_system_dtm Dec 2004 MSH-7 In format YYYYMMDDhhmmss Transaction Type to Events Mapping Table Txn Type Description HL7 Event Remarks 010 PMI Registration A28 030 031 Update Patient Demographic Data Change HKID A08 A47 040 Move episodes A45 050 100 Update NOK Demographic Data Patient Registration 121 130 131 132 133 134 135 136 137 13A 140 160 170 200 210 Update Admission Registration Mass Discharges (to conv. hospital) Mass Discharges (Death) Mass Discharges (Home + follow up) Mass Discharges (Home) Mass Discharges (to accute hospital) Mass Discharges (DAMA) Mass Discharges (Missing) Mass Discharges (Untraceble) Mass Discharges (Others) Mass transfer / Bed assignment Trial Discharge Return from Trial Discharge Cancellation of Admission Cancellation of Discharges (to conv. hospital) Cancellation of Discharges (Death) Cancellation of Discharges (Home + follow up) Cancellation of Discharges (Home) Cancellation of Discharges (to accute hospital) Cancellation of Discharges (DAMA) Cancellation of Discharges (Missing) Cancellation of Discharges (Untraceble) Cancellation of Discharges (Others) Cancellation of Transfer A08 A01 or A04 If case_type of the record is ‘I’ (for inpatient), then A01, otherwise, A04 A08 A03 A03 A03 A03 A03 A03 A03 A03 A03 A02 A21 A22 A11 A13 211 212 213 214 215 216 217 21A 220 230 240 300 Cancellation of Trial Discharge Cancellation of return from Trial Discharge A&E Registration Prepared by EM(HI) and IS4 Team, ITD From A05 to A28 in revision 1. From A46 to A47 in revision 1. From A47 to A45 in revision 1. A13 A13 A13 A13 A13 A13 A13 A13 A12 From A13 to A12 in revision 1. A13 A13 A04 Page 92 HL7 Implementation Guide 330 331 332 333 334 335 336 337 339 340 350 351 352 353 354 355 356 357 359 Dec 2004 Discharge of A&E patient (to conv. A03 hospital) Discharge of A&E patient (Death) A03 Discharge of A&E patient (Home + follow A03 up) Discharge of A&E patient (Home) A03 Discharge of A&E patient (to accute A03 hospital) Discharge of A&E patient (DAMA) A03 Discharge of A&E patient (Missing) A03 Discharge of A&E patient (Untraceble) A03 Discharge of A&E patient (Discharge to A03 same hospital) A&E Register Update A08 Cancellation of A&E Discharge (to conv. A13 hospital) Cancellation of A&E Discharge (Death) A13 Cancellation of A&E Discharge (Home + A13 follow up) Cancellation of A&E Discharge (Home) A13 Cancellation of A&E Discharge (to accute A13 hospital) Cancellation of A&E Discharge (DAMA) A13 Cancellation of A&E Discharge (Missing) A13 Cancellation of A&E Discharge A13 (Untraceble) Cancellation of A&E Discharge A13 (Discharge to same hospital) A.2 OBIS (Draft) A.2.1 Field to field mapping table Seq Column Name 1 Patient ID HL7 SegmentSeq PID-3 Remarks All these fields are put under the PID-3 which is a repeatable component.       Prepared by EM(HI) and IS4 Team, ITD hkid patient_key other_document_no reference medical_record_number case_no Page 93 HL7 Implementation Guide Dec 2004 PID-3 is a component field which have following format <ID>^<check digit>^<coding scheme>^<assigning authority>^<identifier type code>^<assigning facility> 2 hospital_code MSH-4 Mean the source hospital, i.e. the result provider. Example: PWH 3 datetime OBR-6 In format YYYYMMDDhhmmss.sss 4 ward_code PV1-3 PV1-3 is the ‘Assigned Patient Location’. The format can be simplified as below. <Point of care> ^ <room> ^ < bed> <room> is equivalent to this ward_code, <bed> is equivalent to bed_no. For the <Point of care>, it should include the specialty_code and sub_specialty_code with semi-colon as separator. For example, if specialty_code is ICU, and sub_specialty_code is “TRA”, ward_code is 4C and bed_no is 17A, then PV1-3 should be 5 6 7 8 specialty_code sub_specialty_code bed_no case_no PV1-3 PV1-3 PV1-3 PID-3 or PV1-19 9 10 11 Source System Provider (UserID) Status MSH-2 OBX-15 OBX-11 12 Source Reference (Remark) Test Type NTE-3 13 Prepared by EM(HI) and IS4 Team, ITD OBX-3 ICU:TRA^4C^17A Please refer to Seq 4 Please refer to Seq 4 Please refer to Seq 4 For message does not contain HKID or patient_key, fill the case_no into PID-3. Example “CaseNo:HN991234567” Or else, fill into PV1-19 “HN991234567” e.g. OBIS e.g. CS1A Following HL7 Table 0085 Observation result status codes interpretation. e.g. F = Final Result D = Delete C = Change P = Preliminary results This NTE segment should follow OBR Follow HL7 standard formart: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> Page 94 HL7 Implementation Guide Dec 2004 e.g. 32411-1^NEONATAL APGAR.COLOR 5M POST BIRTH^LN for LONIC code 32411-1 test type 14 15 Result Unit OBX-5 OBX-6 A.3 Mapping for GCR/GRR to HL7 fields A.3.1 Request Information Seq Column Name 1 HKID HL7 SegmentSeq PID-3 Remarks All these fields are put under the PID-3 which is a repeatable component.       2 3 Patient Key Case Number PID-3 PV1-19 4 Patient Name PID-5 hkid patient_key other_document_no reference medical_record_number case_no PID-3 is a component field which have following format <ID>^<check digit>^<coding scheme>^<assigning authority>^<identifier type code>^<assigning facility> Please refer to Seq 1 For message does not contain HKID or Patient Key, fill the Case Number into PV1-19. Example “HN991234567” For example, if patient_name is ‘Chan Tai Man’, then the PID-5 should be Chan Tai Man Although patient name in HL7 consists of family name, given name, middle name, suffix, prefix and etc, we just require the whole name in this field. 5 6 Sex Date of Birth Prepared by EM(HI) and IS4 Team, ITD PID-8 PID-7 In format YYYYMMDD Page 95 HL7 Implementation Guide 7 8 9 10 11 12 Receiving Hospital Code Requesting Hospital Code GCRS Request Number Request By Request Location Report Location 13 14 15 16 17 Creation Date Time Function Code Test Code Test Description Request Information – Description Request Information – Value 18 A.3.2 Result Information Seq Column Name 1 HKID Dec 2004 MSH-6 MSH-4 ORC-2-1 ORC-10 ORC-13 OBR-354 ORC-9 ORC-2-2 OBR-4-1 OBR-4-2 OBX-3-2 OBX-5 HL7 SegmentSeq PID-3 Remarks All these fields are put under the PID-3 which is a repeatable component.       2 3 Patient Key Case Number PID-3 PV1-19 4 Patient Name PID-5 hkid patient_key other_document_no reference medical_record_number case_no PID-3 is a component field which have following format <ID>^<check digit>^<coding scheme>^<assigning authority>^<identifier type code>^<assigning facility> Please refer to Seq 1 For message does not contain HKID or Patient Key, fill the Case Number into PV1-19. Example “HN991234567” For example, if patient_name is ‘Chan Tai Man’, then the PID-5 should be Chan Tai Man Although patient name in HL7 consists of family name, given name, Prepared by EM(HI) and IS4 Team, ITD Page 96 HL7 Implementation Guide Dec 2004 middle name, suffix, prefix and etc, we just require the whole name in this field. 5 6 7 8 9 Sex Date of Birth Requesting Hospital Code Receiving Hospital Code GCRS Request Number 10 11 12 Request By Request Location Creation Date Time 13 Function Code 14 Doctor Name 15 Title 16 Sign Datetime 17 Report Location 18 19 20 Test Code Test Description Request Information Description Request Information Value 21 Prepared by EM(HI) and IS4 Team, ITD PID-8 PID-7 MSH-6 MSH-4 ORC-2-1/ OBR-2-2 ORC-10 ORC-13 ORC-9/O BR-6 ORC-2-2/ OBR-2-2 OBR-321-2 OBR-321-2 OBR-322 OBR-354 OBR-4-1 OBR-4-2 OBX-3-2 In format YYYYMMDD In format “Doctor Name (Title)” Please refer to Seq 14 OBX-5 Page 97 HL7 Implementation Guide Dec 2004 APPENDIX B Delimiter values of HL7 Message Delimiter Segment Terminator Suggested Value Encoding Character Position <cr> hex 0D - Field Separator | - Component Separator ^ 1 Subcomponent Separator & 4 Repetition Separator ~ 2 Escape Character \ 3 Prepared by EM(HI) and IS4 Team, ITD Usage Character Substitution Terminates a segment record. This value cannot be changed by implementors. Separates two adjacent data fields within a segment. It also separates the segment ID from the first data field in each segment. Separates adjacent components of data fields where allowed. Separates adjacent subcomponents of data fields where allowed. If there are no subcomponents, this character may be omitted. Separates multiple occurrences of a field where allowed. Escape character for use with any field represented by an ST, TX or FT data type, or for use with the data (fourth) component of the ED data type If no escape characters are used in a message, this character may be omitted. However, it must be present if subcomponents are used in the message. \Z0D\ \F\ \S\ \T\ \R\ \E\ Page 98

HL7 implementation in HK (by HA)

Related documents

Products

Support

HL7 implementation in HK (by HA)

Related documents

Add this document to collection(s)

Add this document to saved

Suggest us how to improve StudyLib