HL7 Version 2.5.1 Implementation Guide: Immunization …

1 HL7 Version Implementation guide : Immunization Messaging (Release ) 3/1/2014 Page 1 HL7 Version Implementation guide for Immunization MessagingRelease 10/1/2014 Page Intentionally Blank HL7 Version Implementation guide : Immunization Messaging (Release ) 10/1/2014 Page 2 Publication History of Previous Versions: Implementation guide for Immunization Data Transactions using Version of the Health Level Seven (HL7) Standard Protocol Version Date Version June 1999 Version September 2003 Version June 2006 Publication History of HL7 Version Implementation guide for Immunization history Revision Date Author Release 5/1/2010 Rob Savage Release 8/15/2010 Rob Savage Release 2/15/2011 Rob Savage Release 8/15/2011 Rob Savage Release 8/1/2012 Rob Savage Release for comment 3/11/2014 Rob Savage Release 10/1/2014 Rob Savage A list of changes may be found at the end of Implementation guide .

2 Or information about HL7, contact: Health Level Seven 3300 Washtenaw Avenue, Suite 227 Ann Arbor, MI 48104-4250 Phone: (734) 677-7777 Fax: (734) 677-6622 E- Mail: Website: For information about the American Immunization Registry Association, visit For information about this guide , contact: Rob Savage Warren Williams Immunization Information Systems Support Branch, Immunization Services Division, National Center for Immunization and Respiratory Diseases, Centers for Disease Control and Prevention Phone: (404) 639-8245 Fax: (404) 639-8171 Website: HL7 Version Implementation guide : Immunization Messaging (Release ) 10/1/2014 Page 3 Table of Contents TABLE OF CONTENTS TABLE OF CONTENTS .. 1 INDEX OF TABLES.

3 8 TABLE OF FIGURES .. 1 1. INTRODUCTION .. 2 Intended Audience .. 3 Scope .. 3 Organization and Flow .. 4 2. ACTORS, GOALS, AND MESSAGING TRANSACTIONS .. 7 Actors and Goals .. 7 High-Level View of Use Use Case descriptions .. 11 Use Case 1 Send Immunization History .. 11 Use Case 2 Request Complete Immunization History ..12 Use Case 3 Request Evaluated History and Forecast ..12 Use Case 4 Send Demographic Data ..13 Use Case 5--Acknowledge Receipt ..13 Use Case 6 Report Error ..13 Messaging in the Context of the Business Process ..13 Core Data Elements of an Immunization History ..15 Key technical Decisions ..16 Pre-Adoption Of Some Features Of HL7 Ve r s i o n ..16 Use of Vocabulary Standards ..16 Processing Mode ..17 Message Profiles.

4 17 Conventions ..17 3. HL7 MESSAGING INFRASTRUCTURE .. 18 Keywords ..18 HL7 definitions ..18 Basic Message Processing Rules ..20 Message Acknowledgement ..20 Encoding Rules for Sending ..20 Determining Usage of Segments, Fields and Components ..22 Usage Conformance Testing Recommendations ..22 Usage ..23 Definition Of Conditional Usage ..23 Sending And Receiving Application Conformance Requirements ..23 Message Element Attributes ..26 4. HL7 DATA TYPES .. 29 Data Types Used In This Implementation guide ..29 CE -- Coded Element (most uses) ..31 CE_TX -- Coded Element (text only in RXA-9) ..32 CQ -- Composite Quantity with Units ..33 CWE -- Coded With Exceptions ..34 HL7 Version Implementation guide : Immunization Messaging (Release ) 10/1/2014 Page i Table of Contents CX -- Extended Composite ID With Check Digit.

5 36 DT -- Date ..38 DT_D -- Date with precision to day ..38 DTM -- EI -- Entity Identifier ..40 ERL -- Error Location ..41 FN -- Family Name ..43 FT Formatted Text ..43 HD -- Hierarchic Designator ..44 ID -- Coded Values for HL7 Tables ..45 IS -- Coded Values for User Defined Tables ..45 LA2 -- Location with Address Variation MSG -- Message Type ..47 NM -- Numeric ..48 PT -- Processing Type ..49 SAD -- Street Address ..49 SI -- Sequence Id ..50 ST String ..50 TS -- Time Stamp ..51 TS_M -- Time Stamp to Month ..51 TS_NZ -- Time Stamp No Time Zone ..52 TS_Z -- Time Stamp with Time Zone ..53 VID -- Version Id ..54 XAD -- Extended Address ..55 XCN - Extended Composite ID Number and Name for Persons.

6 57 XON - Extended Composite Name and ID Number and Name for Organizations ..60 XPN -- Extended Person Name ..61 XPN_M -- Extended Person Name Maiden Name ..63 XTN - Extended Telecommunication Number ..65 5. PROFILE Z22-SEND UNSOLICITED Immunization UPDATE USING A VXU .. 68 Introduction: ..68 Interaction Definition: ..68 Dynamic Definition: ..69 Static Definition Message Level: ..71 Static Definition Segment Level ..73 IN1 Insurance Segment ..73 MSH Message Header Segment ..78 NK1 Next of Kin Segment ..84 NTE Note OBX Observation Result Segment ..89 ORC Order Request Segment ..98 PD1 Patient Demographic Segment ..103 PID Patient Identifier Segment ..107 PV1 Patient Visit Segment .. 114 RXA-- Pharmacy/Treatment Administration Segment.

7 114 RXR-- Pharmacy/Treatment Route 6. PROFILE Z23 RETURN AN ACKNOWLEDGEMENT .. 124 Introduction: ..124 Interaction Definition: ..124 Dynamic Definition: ..125 Static Definition- Message Level ..127 HL7 Version Implementation guide : Immunization Messaging (Release ) 10/1/2014 Page ii Table of Contents Static Definition Segment Level: ..128 ERR Error Segment ..128 MSA Message Acknowledgement Segment ..131 MSH Message Header Segment ..131 7. PROFILE Z34 - REQUEST A COMPLETE Immunization HISTORY .. 135 Introduction: ..135 Interaction Definition: ..137 Dynamic Definition: ..138 Static Definition - Message Level: ..141 Static Definition Segment Level: ..142 MSH - Message Header Specification ..142 QPD Input Parameter Specification.

8 145 RCP Response Control Parameter Segment ..150 8. PROFILE Z32 RESPONSE PROFILE RETURN COMPLETE Immunization HISTORY 153 Introduction: ..153 Interaction Definition ..153 Dynamic Definition ..153 Static Definition Message Level ..154 Static Definition -- Segment Level ..156 ERR Error Segment ..156 IN1 Insurance Segment ..158 MSA Message Acknowledgement Segment ..163 MSH - Message Header Specification ..164 NK1 Next of Kin Segment ..167 NTE Note OBX Observation Result Segment ..172 ORC Order Request Segment ..177 PD1 Patient Demographic Segment ..181 PID Patient Identifier Segment ..184 PV1 Patient Visit Segment ..189 QAK Query Acknowledgement Segment ..189 QPD Input Parameter Specification ..190 RXA-- Pharmacy/Treatment Administration Segment.

9 191 RXR-- Pharmacy/Treatment Route 9. PROFILE Z31 -- RETURN A LIST OF CANDIDATES PROFILE .. 197 Introduction: ..197 Interaction Definition ..197 Dynamic Definition ..197 Static Definition Message Level ..197 Segment Level Profile ..199 ERR Error Segment ..199 MSA Message Acknowledgement Segment ..201 MSH - Message Header Specification ..202 NK1 Next of Kin Segment ..205 QPD Input Parameter Specification ..209 PID Patient Identification Segment .. 211 10. PROFILE Z33 --RETURN AN ACKNOWLEDGEMENT WITH NO PERSON RECORDS .. 215HL7 Version Implementation guide : Immunization Messaging (Release ) 10/1/14 Page iii Table of Contents Introduction: ..215 Interaction Definition ..215 Dynamic Definition ..216 Static Definition Message Level.

10 217 Static Definition -- Segment Level ..218 ERR Error Segment ..218 MSA Message Acknowledgement Segment ..220 MSH - Message Header Specification ..221 QPD Input Parameter Specification ..223 11. PROFILE Z44--REQUEST EVALUATED Immunization HISTORY AND FORECASTQUERY 225 Introduction ..225 Interaction Definition ..228 Dynamic Definition ..228 Static Definition - Message Level: ..231 Static Definition Segment Level ..232 ERR Error Segment ..232 MSA Message Acknowledgement Segment ..234 MSH - Message Header Specification ..235 QPD Input Parameter Specification ..237 RCP Response Control Parameter Field Description and Commentary ..244 12. PROFILE Z42 -- RETURN EVALUATED HISTORY AND FORECAST .. 245 Introduction ..245 Interaction Definition.