HL7 Version 1 Implementation Guide for Immunization Messaging Page Intentionally Blank Last Reviewed Feb 2016
Download 4.83 Kb. Pdf ko'rish
|
|
Page Intentionally Blank Last Reviewed Feb 2016 Publication History of Previous Versions: Implementation Guide for Immunization Data Transactions using Version 2.3.1 of the Health Level Seven (HL7) Standard Protocol Version Date Version 2.0 June 1999 Version 2.1 September 2003 Version 2.2 June 2006 Publication History of HL7 Version 2.5.1 Implementation Guide for Immunization Messaging. Revision history Revision Date Author Release 1.0 5/1/2010 Rob Savage Release 1.1 8/15/2010 Rob Savage Release 1.2 2/15/2011 Rob Savage Release 1.3 8/15/2011 Rob Savage Release 1.4 8/1/2012 Rob Savage A list of changes may be found at the end of Implementation Guide. For 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: hq@hl7.org Website: http://www.hl7.org For information about the American Immunization Registry Association, visit http://www.immregistries.org For information about this Guide, contact: Rob Savage rbsavage@cdc.gov Warren Williams wxw4@cdc.gov 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: http://www.cdc.gov/vaccines/programs/iis/index.html Table of Contents 1. INTRODUCTION ...............................................................................................................1 I NTENDED A UDIENCE ............................................................................................. 1 S COPE .................................................................................................................. 2 O RGANIZATION AND F LOW ..................................................................................... 3 2. ACTORS, GOALS, AND MESSAGING TRANSACTIONS .........................................................6 A CTORS AND G OALS ............................................................................................. 6 H IGH -L EVEL V IEW OF U SE C ASES .......................................................................... 9 U SE C ASE D ESCRIPTIONS .................................................................................... 11 U SE C ASE 1—S END I MMUNIZATION H ISTORY ............................................ 11 U SE C ASE 2—R ECEIVE I MMUNIZATION H ISTORY ....................................... 12 U SE C ASE 3—R EQUEST I MMUNIZATION H ISTORY ...................................... 12 U SE C ASE 4—R ETURN I MMUNIZATION H ISTORY ........................................ 14 U SE C ASE 4A—F IND C ANDIDATE C LIENTS ................................................ 15 U SE C ASE 5--A CCEPT REQUESTED HISTORY : ............................................ 18 U SE C ASE 6—S END D EMOGRAPHIC D ATA ................................................ 19 U SE C ASE 7—A CCEPT D EMOGRAPHIC D ATA ............................................. 19 U SE C ASE 8--A CKNOWLEDGE R ECEIPT ..................................................... 20 U SE C ASE 9—R EPORT E RROR ................................................................. 21 M ESSAGING IN THE C ONTEXT OF THE B USINESS P ROCESS .................................... 21 C ORE D ATA E LEMENTS OF AN I MMUNIZATION H ISTORY ......................................... 23 K EY T ECHNICAL D ECISIONS ................................................................................. 24 P RE -A DOPTION O F S OME F EATURES O F HL7 V ERSION 2.7.1 ..................... 24 U SE O F V OCABULARY S TANDARDS ........................................................... 24 S NAPSHOT M ODE .................................................................................... 25 F IELD L ENGTH A ND T RUNCATION .............................................................. 25 C ONVENTIONS ......................................................................................... 25 3. HL7 MESSAGING INFRASTRUCTURE ............................................................................... 27 K EYWORDS ......................................................................................................... 27 HL7 DEFINITIONS ................................................................................................ 27 B ASIC M ESSAGE C ONSTRUCTION R ULES ............................................................. 30 E NCODING R ULES FOR S ENDING .............................................................. 30 E NCODING R ULES FOR R ECEIVING ............................................................ 30 I MPLICATIONS OF THE E NCODING R ULES ................................................... 31 D ETERMINING U SAGE OF S EGMENTS , F IELDS AND C OMPONENTS ............... 32 USAGE CONFORMANCE TESTING RECOMMENDATIONS ........................... 32 U SAGE .................................................................................................... 32 D EFINITION O F C ONDITIONAL U SAGE ........................................................ 33 S ENDING A ND R ECEIVING A PPLICATION C ONFORMANCE R EQUIREMENTS .... 33 M ESSAGE E LEMENT A TTRIBUTES ......................................................................... 36 4. HL7 DATA TYPES............................................................................................................ 39 D ATA T YPES FOR IIS U SE .................................................................................... 39 CE -- C ODED E LEMENT ( MOST USES ) ........................................................ 41 CE_TX -- C ODED E LEMENT ( TEXT ONLY IN RXA-9) ................................... 42 CQ -- C OMPOSITE Q UANTITY WITH U NITS .................................................. 43 CWE -- C ODED W ITH E XCEPTIONS ........................................................... 44 CX -- E XTENDED C OMPOSITE ID W ITH C HECK D IGIT .................................. 46 DT -- D ATE .............................................................................................. 48 DTM -- D ATE /T IME ................................................................................... 49 EI -- E NTITY I DENTIFIER ............................................................................ 49 ERL -- E RROR L OCATION ......................................................................... 51 FN -- F AMILY N AME .................................................................................. 52 FT – F ORMATTED T EXT ............................................................................ 53 HD -- H IERARCHIC D ESIGNATOR ............................................................... 53 ID -- C ODED V ALUES FOR HL7 T ABLES ..................................................... 55 IS -- C ODED V ALUES FOR U SER D EFINED T ABLES ..................................... 56 LA2 -- L OCATION WITH A DDRESS V ARIATION 2 .......................................... 56 MSG -- M ESSAGE T YPE ........................................................................... 57 NM -- N UMERIC ....................................................................................... 59 PT -- P ROCESSING T YPE .......................................................................... 59 SAD -- S TREET A DDRESS ........................................................................ 60 SI -- S EQUENCE I D ................................................................................... 60 ST – S TRING ........................................................................................... 60 TS -- T IME S TAMP .................................................................................... 61 VID -- V ERSION I D ................................................................................... 61 XAD -- E XTENDED A DDRESS .................................................................... 62 XCN - E XTENDED C OMPOSITE ID N UMBER AND N AME FOR P ERSONS ......... 65 XON - E XTENDED C OMPOSITE N AME AND ID N UMBER AND N AME FOR O RGANIZATIONS ...................................................................................... 68 E XTENDED P ERSON N AME (XPN) ............................................................. 70 XTN - E XTENDED T ELECOMMUNICATION N UMBER ..................................... 72 5. SEGMENTS AND MESSAGE DETAILS ............................................................................... 75 BHS—B ATCH H EADER S EGMENT ........................................................................ 81 BHS FIELD DEFINITIONS ........................................................................... 83 BTS—B ATCH T RAILER S EGMENT ........................................................................ 83 BTS FIELD DEFINITIONS ............................................................................ 84 ERR—E RROR S EGMENT ..................................................................................... 84 ERR FIELD DEFINITIONS : .......................................................................... 86 EVN - E VENT T YPE S EGMENT .............................................................................. 87 EVN FIELD DEFINITIONS ........................................................................... 87 FHS—F ILE H EADER S EGMENT ............................................................................ 88 FHS FIELD DEFINITIONS ........................................................................... 90 FTS—F ILE T RAILER S EGMENT ............................................................................ 90 IN1—I NSURANCE S EGMENT (IN2, IN3) ................................................................ 90 MSA—M ESSAGE A CKNOWLEDGEMENT S EGMENT ................................................ 91 MSA FIELD DEFINITIONS ........................................................................... 91 MSH—M ESSAGE H EADER S EGMENT ................................................................... 92 MSH FIELD DEFINITIONS ........................................................................... 95 NK1—N EXT OF K IN S EGMENT ............................................................................. 99 NK1 FIELD DEFINITIONS .......................................................................... 102 NTE—N OTE S EGMENT ...................................................................................... 104 NTE FIELD DEFINITIONS ......................................................................... 104 OBX—O BSERVATION R ESULT S EGMENT ........................................................... 104 OBX FIELD DEFINITIONS ......................................................................... 108 ORC—O RDER R EQUEST S EGMENT ................................................................... 114 C ONFORMANCE S TATEMENT : .................................................................. 117 ORC FIELD DEFINITIONS ......................................................................... 118 PD1—P ATIENT D EMOGRAPHIC S EGMENT .......................................................... 120 PD1 FIELD DEFINITIONS .......................................................................... 122 PID—P ATIENT I DENTIFIER S EGMENT ................................................................. 125 PID FIELD DEFINITIONS ........................................................................... 129 PV1—P ATIENT V ISIT S EGMENT ......................................................................... 132 QAK—Q UERY A CKNOWLEDGEMENT S EGMENT .................................................. 132 QAK FIELD DEFINITIONS ......................................................................... 133 QPD – Q UERY P ARAMETER D EFINITION ............................................................. 134 QPD FIELD DEFINITIONS ......................................................................... 134 RCP – R ESPONSE C ONTROL P ARAMETER S EGMENT .......................................... 135 C ONFORMANCE S TATEMENT : .................................................................. 136 RCP FIELD DEFINITIONS ......................................................................... 137 RXA-- P HARMACY /T REATMENT A DMINISTRATION S EGMENT ................................ 137 RXA FIELD DEFINITIONS ......................................................................... 142 RXR-- P HARMACY /T REATMENT R OUTE S EGMENT .............................................. 146 RXR FIELD DEFINITIONS ......................................................................... 147 6. MESSAGES FOR TRANSMITTING IMMUNIZATION INFORMATION ................................. 148 I NTRODUCTION .................................................................................................. 148 S END I MMUNIZATION H ISTORY --VXU .................................................................. 148 R EQUESTING I NFORMATION (I MMUNIZATION H ISTORY ) – QBP ............................. 150 R ESPOND TO R EQUEST FOR I NFORMATION – RSP ............................................... 150 R EQUESTING A N I MMUNIZATION H ISTORY FROM A NOTHER S YSTEM VXQ ............. 151 T HE USE OF VXQ IS NOT SUPPORTED FOR 2.5.1 IMMUNIZATION MESSAGING . ............................................................................................................. 151 A CKNOWLEDGING A M ESSAGE --ACK ................................................................. 151 S ENDING D EMOGRAPHIC I NFORMATION – VXU OR ADT ...................................... 152 Download 4.83 Kb. Do'stlaringiz bilan baham: 
|