HL7 Version 2.5.1 Implementation Guide: Immunization Messaging
Appendix B: Guidance on Usage and Example MessagesHL7 Version 2.5.1Implementation Guidefor Immunization MessagingRelease
Page Intentionally BlankHL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page 2
Publication History of Previous Versions:Implementation Guide for Immunization Data Transactions using Version 2.3.1 of the Health Level Seven(HL7) Standard ProtocolVersionDateVersion 2.0June 1999Version 2.1September 2003Version 2.2June 2006Publication History of HL7 Version 2.5.1 Implementation Guide forImmunization Messaging.Revision historyRevisionDateAuthorRelease 1.05/1/2010Rob SavageRelease 1.18/15/2010Rob SavageRelease 1.22/15/2011Rob SavageRelease 1.38/15/2011Rob SavageRelease 1.48/1/2012Rob SavageRelease 1.53/11/2014Rob SavageA list of changes may be found at the end of Implementation Guide.For information about HL7, contact:For information about this Guide, contact:Health Level Seven3300 Washtenaw Avenue, Suite 227Ann Arbor, MI 48104-4250Phone: (734) 677-7777Fax: (734) 677-6622Rob Savagerbsavage@cdc.govWarren Williamswxw4@cdc.govE-Mail: hq@hl7.orgWebsite: http://www.hl7.orgFor information about the AmericanImmunization Registry Association, visithttp://www.immregistries.orgImmunization Information Systems SupportBranch, Immunization Services Division,National Center for Immunization andRespiratory Diseases,Centers for Disease Control and PreventionPhone: (404) 639-8245Fax: (404) 639-8171Website: lHL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page 3
Table of ContentsTABLE OF CONTENTSTABLE OF CONTENTS . 1INDEX OF TABLES. 8TABLE OF FIGURES . 111. INTRODUCTION . 1Intended Audience . 1Scope . 1Organization and Flow . 32. ACTORS, GOALS, AND MESSAGING TRANSACTIONS . 5Actors and Goals . 5High-Level View of Use Cases. 8Use Case Descriptions .10Use Case 1—Send Immunization History .10Use Case 2—Request Immunization History . 11Use Case 3—Request Evaluated History and Forecast .12Use Case 4—Send Demographic Data .14Use Case 5--Acknowledge Receipt .14Use Case 6—Report Error .15Messaging in the Context of the Business Process .15Core Data Elements of an Immunization History .18Key Technical Decisions .18Pre-Adoption Of Some Features Of HL7 Version 2.7.1 .18Use Of Vocabulary Standards .19Processing Mode .19Message Profiles.19Conventions .193. HL7 MESSAGING INFRASTRUCTURE . 20Keywords .20HL7 definitions.20Basic Message Processing Rules .22Message Acknowledgement .22Encoding Rules for Sending .22Determining Usage of Segments, Fields and Components .24Usage Conformance Testing Recommendations .24Usage .24Definition Of Conditional Usage .25Sending And Receiving Application Conformance Requirements .25Message Element Attributes .284. HL7 DATA TYPES . 31Data Types for IIS Use .31CE -- Coded Element (most uses) .33CE TX -- Coded Element (text only in RXA-9) .34CQ -- Composite Quantity with Units .35CWE -- Coded With Exceptions .36HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page i
Table of ContentsCX -- Extended Composite ID With Check Digit .38DT -- Date .40DTM -- Date/Time.40EI -- Entity Identifier .41ERL -- Error Location .42FN -- Family Name .44FT – Formatted Text .45HD -- Hierarchic Designator .45ID -- Coded Values for HL7 Tables .46IS -- Coded Values for User Defined Tables .47LA2 -- Location with Address Variation 2.47MSG -- Message Type .49NM -- Numeric .50PT -- Processing Type .50SAD -- Street Address .51SI -- Sequence Id .51ST – String.52TS -- Time Stamp .52VID -- Version Id .53XAD -- Extended Address .54XCN - Extended Composite ID Number and Name for Persons .56XON - Extended Composite Name and ID Number and Name for Organizations .59XPN -- Extended Person Name .60XTN - Extended Telecommunication Number .635. SEGMENTS AND MESSAGE DETAILS . 65BHS—Batch Header Segment.70Conformance Statement .71BHS field definitions .71BTS—Batch Trailer Segment .72BTS field definitions .72ERR—Error Segment .73EVN - Event Type Segment .75EVN field definitions .76FHS—File Header Segment .77Conformance Statement: .77FHS field definitions .78FTS—File Trailer Segment .78IN1—Insurance Segment .78IN1 Field Definitions .83IN2 – Insurance Additional Information Segment .84IN3 Insurance Additional Information, Certification Segment .84MSA—Message Acknowledgement Segment .85MSA field definitions .85MSH—Message Header Segment .86Base Conformance Statements: .88VXU Conformance Statement: .89QBP Conformance Statement: .89RSP Conformance Statement: .89ACK Conformance Statement: .89MSH field definitions .89NK1—Next of Kin Segment .93NK1 field definitions .97HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page ii
Table of ContentsNTE—Note Segment.97NTE field definitions .98OBX—Observation Result Segment .98OBX field definitions .102Application Conformance Statement:.104ORC—Order Request Segment .107Conformance Statement: . 110ORC field definitions . 111PD1—Patient Demographic Segment . 112PD1 field definitions. 114PID—Patient Identifier Segment . 116Conformance Statement: .120PID field definitions .120PV1—Patient Visit Segment .123QAK—Query Acknowledgement Segment .124QAK field definitions .124QPD – Query Parameter Definition .125QPD field definitions .125RCP – Response Control Parameter Segment .126Conformance Statement: .127RCP field definitions .128RXA-- Pharmacy/Treatment Administration Segment .128Conformance Statement: .132RXA field definitions .132RXR-- Pharmacy/Treatment Route Segment.135RXR field definitions .1366. MESSAGES FOR TRANSMITTING IMMUNIZATION INFORMATION . 138Introduction .138Send Immunization History--VXU .138Requesting Information (Immunization History) – QBP.140Respond to Request for Information– RSP .141Requesting An Immunization History from Another System Using VXQ .142The use of VXQ is not supported for 2.5.1 immunization messaging. .142Acknowledging a Message--ACK .142Sending Demographic Information – VXU or ADT.143Sending Messages in a Batch .1457. QUERY AND RESPONSE PROFILES (QBP/RSP) . 147Introduction: .147Request Immunization History Query Profile –Z34 CDCPHINVS .149Use Case: .151Query Grammar .152Response Grammar .154Query Segment Level Profile .155Field Level Profile .158Dynamic Definition .163Response Profile – Return Complete Immunization History (Z32 CDCPHINVS) .165Message Level Profile .165Segment Level Profile .167Response Profile -- Return a List of Candidates Profile -- Z31 CDCPHINVS .169Use Case: .170Response Grammar – Return Candidate List (Z31) .171HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page iii
Table of ContentsStatic Definition .171Dynamic Definition .178Response Profile --Return an acknowledgement with no person records-- Z33 CDCPHINVS .179Use Case: .181Response Grammar – Return Acknowledgement (Z33 CDCPHINVS) .184Static Definition .184Request Evaluated Immunization History and Forecast Query Profile – Z44 CDCPHINVS .187Use Case .189Query Grammar .190Response Grammar – Return Evaluated Immunization History and Forecast (Z42 CDCPHINVS) .191Static Definition .192Dynamic Definition .201Response Profile -- Return Evaluated History and Forecast (Z42 CDCPHINVS) .202Message Level Profile .202Segment Level Profile .204CHANGE HISTORY DETAILS . 206APPENDIX A:CODE TABLES . 1User-defined Table 0001 - Sex . 1HL7-defined Table 0003 - Event type . 2User-defined Table 0004 - Patient class . 2User-defined Table 0005 - Race . 2HL7-defined Table 0008 - Acknowledgment code . 3User-defined Table 0010 - Physician ID. 3HL7-defined Table 0061 - Check digit scheme . 3User-defined Table 0063 - Relationship . 4User-defined Table 0064 - Financial class . 4HL7-defined Table 0076 - Message type . 5HL7-defined Table 0078 - Abnormal flags . 6HL7-defined Table 0085 - Observation result status codes interpretation . 6User Defined Table 0086 - Plan ID . 6HL7-defined Table 0091 - Query priority. 6HL7-defined Table 0102 - Delayed acknowledgment type . 6HL7-defined Table 0103 - Processing ID . 7HL7-defined Table 0104 - Version ID . 7HL7-defined Table 0105 - Source of comment . 7HL7-defined Table 0119 - Order Control Codes . 7HL7-defined Table 0126 - Quantity limited request . 7HL7-defined Table 0136 - Yes/No indicator . 7HL7-defined Table 0155 - Accept/Application acknowledgment conditions . 8HL7-defined Table 0162 - Route of administration . 8HL7-defined Table 0163 - Administrative site . 9User-defined Table 0189 - Ethnic Group .10HL7-defined Table 0190 - Address type .10HL7-defined Table 0200 - Name type . 11HL7-defined Table 0201 - Telecommunication use code . 11HL7-defined Table 0202 - Telecommunication equipment type .12User-defined Table 0203 - Identifier type.12User-defined Table 0204 - Organizational name type .18HL7-defined Table 0207 - Processing mode .18User-defined Table 0208 - Query response status .18HL7-defined Table 0211 - Alternate character sets.18HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page iv
Table of ContentsUser-defined Table 0215 - Publicity code .19User-defined Table 0220 - Living arrangement .19HL7-defined Table 0227 - Manufacturers of vaccines (code MVX) .19User-defined Table 0288 - Census tract .23User-
HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014 Page 3 Publication History of Previous Versions: Implementation Guide for Immunization Data Transactions using Version 2.3.1 of the Health Level Seven (HL7) Standard Protocol
HL7 Messaging Tool - EHR Vendor All new products will be listed under Your Product List. To start validating products go to the Validating EHR Projects/Versions section under Validating HL7 Messages. Validating HL7 Messages This section will go into detail on how to validate each EHR Product, Group HL7 Messages, and Practice HL7 Messages.
(EHR) system, and creating a data model for that database is challenging due to the EHR system's special nature. Because of complexity, spatial, sparseness, interrelation, temporal, . Entry PACS Billing HL7 & DICOM HL7 HL7 HL7 HL7 HL7 IJCSI International Journal of Computer Science Issues, Vol. 9, Issue 5, No 1, September 2012
This is the first HL7 interface that MCIR has developed. Query and other bidirectional interface options will be developed soon and will be documented in an updated version of this document. How to Format Data MCIR currently supports the following versions of HL7 formatted messages: HL7 v2.5.1 Preferred format. HL7 v2.3.1 Supported format
HL7 C-CDA v1.1 MU 2014 HL7 C-CDA v2.0 HL7 C-CDA v2.1 MU 2015 2011 Edition/Stage 1 MU 2014 Edition/Stage 2 MU: – HL7 Implementation Guide for CDA Release 2: IHE Health Story Consolidation, DSTU Release 1.1 (US Realm) Draft Standard for Trial Use – HL7 Implementat
Co-Chair, HL7 Clinical Quality Information Workgroup . Kanwarpreet Sethi - Lantana Consulting Group Co-Chair, HL7 Clinical Quality Information Workgroup Presented at HIMSS17 - HL7 Educational Sessions Orlando, Florida February 20, 2017 . Health IT Enabled Quality Measurement and Improvement: The HL7 Clinical Quality Information Workgroup
The HL7 2.5.1 Standard contains the order and structure of data fields in . This Florida Department of Health specification guide should not be used as a tutorial for either HL7 or electronic interfaces, in general. The reader and laboratory trading partners are expected to have a basic understanding of interface concepts, HL7, and electronic .
6.5.2015 DHSS HESS HL7 Implementation Guide Release 1.3 7 2 General HESS Message Infrastructure 2.1 Basic HL7 Terms Table 2.1 Basic HL7 Terms Term Definition Message A message is the entire unit of data transferred between systems in a single transmission. It is a series of segments in a defined sequence, with a message type
HL7 Finland (est.1995): long history in HL7 messages and IGs, active technical committees, integrated IHE and personal health SIGs, etc. One of the very first implementation of HL7 CDA (2004-5) . an embedded PDF meets the requirements of Specialized IGs
