HL7 Version 2.5.1 Implementation Guide: Immunization

2y ago
12 Views
2 Downloads
3.74 MB
406 Pages
Last View : 2m ago
Last Download : 3m ago
Upload by : Genevieve Webb
Transcription

HL7 Version 2.5.1Implementation Guidefor Immunization MessagingRelease 1.510/1/2014HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page 1

Page Intentionally BlankHL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/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.5 for comment3/11/2014Rob SavageRelease 1.510/1/2014Rob SavageA list of changes may be found at the end of Implementation Guide.or 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) 10/1/2014Page 3

Table of ContentsTABLE OF CONTENTSTABLE OF CONTENTS . 1INDEX OF TABLES. 8TABLE OF FIGURES . 11. INTRODUCTION . 2Intended Audience . 3Scope . 3Organization and Flow . 42. ACTORS, GOALS, AND MESSAGING TRANSACTIONS . 7Actors and Goals . 7High-Level View of Use Cases.10Use Case Descriptions . 11Use Case 1—Send Immunization History . 11Use Case 2—Request Complete Immunization History.12Use Case 3—Request Evaluated History and Forecast .12Use Case 4—Send Demographic Data .13Use Case 5--Acknowledge Receipt .13Use Case 6—Report Error .13Messaging in the Context of the Business Process .13Core Data Elements of an Immunization History .15Key Technical Decisions .16Pre-Adoption Of Some Features Of HL7 Version 2.7.1 .16Use of Vocabulary Standards .16Processing Mode .17Message Profiles.17Conventions .173. HL7 MESSAGING INFRASTRUCTURE . 18Keywords .18HL7 definitions.18Basic Message Processing Rules .20Message Acknowledgement .20Encoding Rules for Sending .20Determining Usage of Segments, Fields and Components .22Usage Conformance Testing Recommendations .22Usage .23Definition Of Conditional Usage .23Sending And Receiving Application Conformance Requirements .23Message Element Attributes .264. HL7 DATA TYPES . 29Data Types Used In This Implementation Guide .29CE -- Coded Element (most uses) .31CE TX -- Coded Element (text only in RXA-9) .32CQ -- Composite Quantity with Units .33CWE -- Coded With Exceptions .34HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014Page i

Table of ContentsCX -- Extended Composite ID With Check Digit .36DT -- Date .38DT D -- Date with precision to day .38DTM -- Date/Time.39EI -- Entity Identifier .40ERL -- Error Location .41FN -- Family Name .43FT – Formatted Text .43HD -- Hierarchic Designator .44ID -- Coded Values for HL7 Tables .45IS -- Coded Values for User Defined Tables .45LA2 -- Location with Address Variation 2.46MSG -- Message Type .47NM -- Numeric .48PT -- Processing Type .49SAD -- Street Address .49SI -- Sequence Id .50ST – String.50TS -- Time Stamp .51TS M -- Time Stamp to Month .51TS NZ -- Time Stamp No Time Zone .52TS Z -- Time Stamp with Time Zone .53VID -- Version Id .54XAD -- Extended Address .55XCN - Extended Composite ID Number and Name for Persons .57XON - Extended Composite Name and ID Number and Name for Organizations .60XPN -- Extended Person Name .61XPN M -- Extended Person Name – Maiden Name .63XTN - Extended Telecommunication Number .655. PROFILE Z22-SEND UNSOLICITED IMMUNIZATION UPDATE USING A VXU . 68Introduction: .68Interaction Definition: .68Dynamic Definition: .69Static Definition—Message Level: .71Static Definition—Segment Level.73IN1—Insurance Segment .73MSH—Message Header Segment .78NK1—Next of Kin Segment .84NTE—Note Segment.88OBX—Observation Result Segment .89ORC—Order Request Segment .98PD1—Patient Demographic Segment .103PID—Patient Identifier Segment .107PV1—Patient Visit Segment . 114RXA-- Pharmacy/Treatment Administration Segment . 114RXR-- Pharmacy/Treatment Route Segment.1226. PROFILE Z23 RETURN AN ACKNOWLEDGEMENT . 124Introduction: .124Interaction Definition: .124Dynamic Definition: .125Static Definition- Message Level .127HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014Page ii

Table of ContentsStatic Definition—Segment Level: .128ERR—Error Segment .128MSA—Message Acknowledgement Segment .131MSH—Message Header Segment .1317. PROFILE Z34 - REQUEST A COMPLETE IMMUNIZATION HISTORY . 135Introduction: .135Interaction Definition: .137Dynamic Definition: .138Static Definition - Message Level: .141Static Definition – Segment Level: .142MSH - Message Header Specification.142QPD Input Parameter Specification .145RCP – Response Control Parameter Segment .1508. PROFILE Z32 RESPONSE PROFILE – RETURN COMPLETE IMMUNIZATION HISTORY 153Introduction: .153Interaction Definition .153Dynamic Definition .153Static Definition – Message Level.154Static Definition -- Segment Level .156ERR—Error Segment .156IN1—Insurance Segment .158MSA—Message Acknowledgement Segment .163MSH - Message Header Specification.164NK1—Next of Kin Segment .167NTE—Note Segment.171OBX—Observation Result Segment .172ORC—Order Request Segment .177PD1—Patient Demographic Segment .181PID—Patient Identifier Segment .184PV1—Patient Visit Segment .189QAK—Query Acknowledgement Segment .189QPD Input Parameter Specification .190RXA-- Pharmacy/Treatment Administration Segment .191RXR-- Pharmacy/Treatment Route Segment.1959. PROFILE Z31 -- RETURN A LIST OF CANDIDATES PROFILE . 197Introduction: .197Interaction Definition .197Dynamic Definition .197Static Definition – Message Level.197Segment Level Profile .199ERR—Error Segment .199MSA—Message Acknowledgement Segment .201MSH - Message Header Specification.202NK1—Next of Kin Segment .205QPD Input Parameter Specification .209PID – Patient Identification Segment . 21110. PROFILE Z33 --RETURN AN ACKNOWLEDGEMENT WITH NO PERSON RECORDS . 215HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/14Page iii

Table of ContentsIntroduction: .215Interaction Definition .215Dynamic Definition .216Static Definition – Message Level.217Static Definition -- Segment Level .218ERR—Error Segment .218MSA—Message Acknowledgement Segment .220MSH - Message Header Specification.221QPD Input Parameter Specification .22311. PROFILE Z44--REQUEST EVALUATED IMMUNIZATION HISTORY AND FORECASTQUERY PROFILE. 225Introduction .225Interaction Definition .228Dynamic Definition .228Static Definition - Message Level: .231Static Definition—Segment Level.232ERR—Error Segment .232MSA—Message Acknowledgement Segment .234MSH - Message Header Specification.235QPD Input Parameter Specification .237RCP Response Control Parameter Field Description and Commentary .24412. PROFILE Z42 -- RETURN EVALUATED HISTORY AND FORECAST . 245Introduction .245Interaction Definition .245Dynamic Definition .245Static Definition --Message Level .246Static Definition -- Segment Level .248MSH - Message Header Specification.248OBX—Observation Result Segment .250ORC—Order Request Segment .255PID—Patient Identifier Segment .259QAK—Query Acknowledgement Segment .264QPD Input Parameter Specification .265RXA-- Pharmacy/Treatment Administration Segment .266RXR-- Pharmacy/Treatment Route Segment.27013. BATCH FILE SPECIFICATIONS . 272Sending Messages in a Batch .272BHS—Batch Header Segment.274Conformance Statement .275BHS field definitions .275BTS—Batch Trailer Segment .276BTS field definitions .276FHS—File Header Segment .277Conformance Statement: .277FHS field definitions .278FTS—File Trailer Segment .278CHANGE HISTORY DETAILS . 1HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014Page iv

Table of ContentsRelease 1.1. 1Release 1.2. 1Release 1.3. 2Release 1.4. 4Release 1.5. 5APPENDIX A: . 1CODE 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 . 2User-defined Table 0010 - Physician ID.

Jan 05, 2014 · HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 3/1/2014 Page 1 HL7 Version 2.5.1 Implementation Guide for Immunization Messaging

Related Documents:

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