HISO 10030.2 Electronic Pharmaceutical Messaging Standard
Total Page:16
File Type:pdf, Size:1020Kb
Electronic Pharmaceutical Messaging Standard HISO 10030.2 To be used in conjunction with HISO 10030.1 Electronic Pharmaceutical Business Processes Standard Copyright information This document has been approved as a standard for the New Zealand health and disability sector by the Health Information Standards Organisation (HISO), a sub-committee of HISAC. The copyright owner of this document is the Health Information Strategy Action Committee (HISAC), which is a ministerial committee appointed by the Minister of Health. HISO work on this document may be reproduced in any number of copies and in any format or medium provided: • the content is not changed; • the material is not sold; • the material is not used to promote or endorse any product or service; • the material is not used in an inappropriate or a misleading context having regard to the nature of the material; • any disclaimers included on the published information are reproduced on the material; • a copyright acknowledgment to the Health Information Strategy Action Committee is included. Permission to reproduce HISAC work does not extend to include any work identified in this document as the copyright material of a party other than HISAC. Authorisation to reproduce such material must be obtained from the copyright holders concerned. Published in November 2008 by HISAC PO Box 5013, Wellington, New Zealand ISBN 978-0-478-31780-0 (Online) This document is available on the HISAC website: http://www.hisac.govt.nz Electronic Pharmaceutical Messaging Standard v1 November 2008 2 Contents 1 ............... Introduction ......................................................................................................................................... 13 1.1 Background ....................................................................................................................................... 13 1.2 Application......................................................................................................................................... 13 1.3 Backward Compatibility..................................................................................................................... 14 1.4 Scope ................................................................................................................................................ 14 1.5 Privacy and Security ......................................................................................................................... 15 1.6 Interpretation ..................................................................................................................................... 15 2 ............... HL7 Overview...................................................................................................................................... 16 2.1 Separators......................................................................................................................................... 16 2.2 Field Content - Blanks and Nulls....................................................................................................... 17 2.3 Use of Escape Sequences in Test Fields ......................................................................................... 17 2.4 Conventions ...................................................................................................................................... 20 3 ............... Messages Related to Use-Cases ....................................................................................................... 21 3.1 Supported Messages Overview ........................................................................................................ 21 3.2 Message Exchange Principles.......................................................................................................... 21 3.3 Exchange of Messages in an ePharmacy Context ........................................................................... 22 3.4 Use-Case Messages......................................................................................................................... 25 4 ............... Electronic Pharmaceutical Messages ................................................................................................. 44 4.1 Usage Notes for Pharmacy/Treatment Messages............................................................................ 44 4.2 OMP – Prescription Order Message (Event O09)............................................................................. 44 4.3 ORP – Pharmacy Order Response Message (Event O10) .............................................................. 49 4.4 RGV – Administration Order Message (Event O15) ......................................................................... 50 4.5 RRG – Administration Order Response Message (Event O16)........................................................ 52 4.6 RDS – Dispensing Notification Message (Event O13)...................................................................... 53 4.7 RRD – General Order Response Message (Event ^O14) ................................................................ 56 4.8 RDE – Unsolicited Observation Message (Event O11) .................................................................... 57 4.9 RRE – Acknowledgment (Event O12)............................................................................................... 59 4.10 RAS – Treatment Administration Message (Event O17) ........................................................... 60 4.11 RRA – Treatment Administration Response Message (Event O18).......................................... 62 4.12 Queries for Immunisation Records (QRF Segments)................................................................ 63 4.13 VXQ – Vaccine Query Message (Event V01)............................................................................ 64 4.14 VXX – Response to Vaccine Query Returning Multiple PID Matches Message (Event V02) ... 65 4.15 VXR – Vaccine Record Message (Event V03) .......................................................................... 66 4.16 VXU – Unsolicited Vaccine Update Message (Event V04)........................................................ 67 4.17 ACK – Acknowledgment (Event R01)........................................................................................ 68 4.18 QBP/RSP – Query by Parameter and Segment Response....................................................... 69 5 ............... Supplementary Information................................................................................................................. 70 5.1 Conventions ...................................................................................................................................... 70 5.2 PCC - Patient Category..................................................................................................................... 70 5.3 FSC – Funding Status Code ............................................................................................................. 71 5.4 END – Endorsement Codes.............................................................................................................. 71 5.5 ACC – Accident Information.............................................................................................................. 72 5.6 ALRT – Administration Alerts and Warnings..................................................................................... 75 5.7 ATT – Attachments ........................................................................................................................... 76 6 ............... Query by Parameter and Segment Response.................................................................................... 77 6.1 Query Development Methodology .................................................................................................... 77 6.2 Query Specification Format............................................................................................................... 77 6.3 Response Format.............................................................................................................................. 78 6.4 Query/Response Conformance Statement ....................................................................................... 78 6.5 Using the Conformance Statement................................................................................................... 79 7 ............... Query To HMX Requesting an Order.................................................................................................. 83 7.1 Order Retrieval.................................................................................................................................. 83 7.2 Prescription Order Retrieval Conformance Statement...................................................................... 83 7.3 New Zealand Parameters ................................................................................................................. 86 8 ............... Query To SIR Requesting Medication Profile ..................................................................................... 87 8.1 Order Retrieval.................................................................................................................................. 87 9 ............... Segment Definition.............................................................................................................................. 95 9.1 Conventions .....................................................................................................................................