PHC-Hub logo  PHC Hub Administrator User Guide (v. March 2018)

Sample HL7 Messages

The following are examples of HL7 messages:

Sample Message Type Sample Message
VXU - 2.3.1

MSH|^~\&|EPIC|^LINDAS TEST ORGANIZATION|||||VXU^V04^VXU_V04|225|P|2.5.1||||AL|PID|1||E46749^^^^MR^||DOE^JOHN^C^JR^^^L|SMITH|20140515|M|SMITH^JOHN|2106-3^WHITE^HL70005|115 MAINSTREET^^GOODTOWN^KY^42010^USA^L^010||^PRN^PH^^^270^6009800||EN^ENGLISH^HL70296||||523968712|||2186-5^NOT HISPANIC OR LATINO^HL70012||||||||N|
PD1|||LINDAS TEST ORGANIZATION^^SIISCLIENT818|^^^^^^^^^^^^MR|||||||02^Reminder/recall-any method^HL70215|||||A^Active^HL70441|20150202^20150202 NK1|1|DOE^MARY|MTH^MOTHER^HL70063|
PV1||R||||||||||||||||||V02^20150202|
ORC|RE||9645^SIISCLIENT001||||||20150202111146|2001^HARVEY^MARVIN^K| RXA|0|1|20150202|20150202|20^DTaP^CVX^90700^DTAP^CPT|.5|ML^mL^ISO+||00^New immunization record^NIP001|JONES^MARK|^^^SIISCLIENT818||||A7894-2|20161115|PMC^SANOFI PASTEUR^MVX||||ARXR|ID^INTRADERMAL^HL70162|LD^LEFT DELTOID^HL70163
OBX|1|CE|64994-7^VACCINE FUNDING PROGRAM ELIGIBILITY CATEGORY^LN|1| V02^MEDICAID^HL70064||||||F|||20150202|||VXC40^ELIGIBILITY CAPTURED AT THE IMMUNIZATION LEVEL^CDCPHINVSOBX|2|CE|30956-7^VACCINE TYPE^LN|2|88^FLU^CVX||||||F|||20150202102525 OBX|3|TS|29768-9^Date vaccine information statement published^LN|2|20120702||||||FOBX|4|TS|29769-7^Date vaccine information statement presented^LN|2|20120202||||||F
RXA|0|1|20141215|20141115|141^influenza, SEASONAL 36^CVX^90658^Influenza Split^CPT|999|||01^HISTORICAL INFORMATION – SOURCE UNSPECIFIED^ NIP001||||||||||||A

VXU - 2.5.1

MSH|^~\&|EPIC|SIISCLIENT818^LINDAS TEST ORGANIZATION|^SIIS||20150202115044||VXU^V04^VXU_V04|225|P|2.5.1||||AL|PID|1||E46700^^^^MR^||DOE^JOHN^C^JR^^^L|SMITH|20140515|M|SMITH^JOHN|2106-3^WHITE^HL70005|115 MAINSTREET^^GOODTOWN^KY^42010^USA^L^010||^PRN^PH^^^270^6009800||EN^ENGLISH^HL70296||||523968712|||2186-5^NOT HISPANIC OR LATINO^HL70012||||||||N|
PD1|||||||||||02^Reminder/recall-any method^HL70215|||||A^Active^HL70441|20150202^20150202 NK1|1|DOE^MARY|MTH^MOTHER^HL70063|
ORC|RE||9645^SIISCLIENT818||||||20150202111146|2001^HARVEY^MARVIN^K|RXA|0|1|20150202|20150202|20^DTaP^CVX^90700^DTAP^CPT|.5|ML^mL^ISO+ ||00^New immunization record^NIP001|JONES^MARK|^^^SIISCLIENT818||||A7894-2|20161115|PMC^SANOFI PASTEUR^MVX||||A RXR|ID^INTRADERMAL^HL70162|LD^LEFT
OBX|1|CE|64994-7^VACCINE FUNDING PROGRAM ELIGIBILITY CATEGORY^LN|1| V02^MEDICAID^HL70064||||||F|||20150202|||VXC40^ELIGIBILITY CAPTURED AT THE IMMUNIZATION LEVEL^CDCPHINVS
OBX|2|CE|30956-7^VACCINE TYPE^LN|2|88^FLU^CVX||||||F|||20150202102525 OBX|3|TS|29768-9^Date vaccine information statement published^LN|2|20120702||||||F OBX|4|TS|29769-7^Date vaccine information statement presented^LN|2|20120202||||||F
RXA|0|1|20141215|20141115|141^influenza, SEASONAL 36^CVX^90658^Influenza Split^CPT|999|||01^HISTORICAL INFORMATION – SOURCE UNSPECIFIED^ NIP001||||||||||||A

ACK

MSH|^~\&|^^|DOE^^|DCC^^|DOE^^|20050829141336||ACK^|1125342816253.100000055|P|2.3.1|
MSA|AE|00000001|Patient id was not found, must be of type 'MR'|||^^HL70357|
ERR|PID^1^3^^^HL70357|

VXQ

MSH|^~\&|DBO^QSInsight^L|QS4444|5.0^QSInsight^L||20030828104856+0000||VXQ^V01|QS444437861000000042|P|2.3.1|||NE|AL|
QRD|20030828104856+0000|R|I|QueryID01|||5|000000001^Bucket^Pail^^^^^^^^^^MR|VXI|SIIS|
QRF|QS4444|20030828104856+0000|20030828104856+0000||100000001~19460401~~~~~~~~~~1 Somewhere Lane Boulevard^Indianapolis^IN~10000|

QCK

MSH|^~\&|5.0^QSInsight^L|^^|DBO^QSInsight^L|QS4444^^|20051019154952||QCK^|1129754992182.100000002|P|2.3.1|
MSA|AA|QS444437861000000042|No patients found for this query|
QAK||NF|

VXX

MSH|^~\&|5.0^QSInsight^L|^^|DBO^QSInsight^L|QS4444^^|20051019163235||VXX^V02|1129757555111.100000025|P|2.3.1|
MSA|AA|QS444437861000000042||
QRD|20030828104856|R|I|QueryID01|||5|10^SNOW^MARY^^^^^^^^^^SR|VXI^Vaccine Information^HL70048|SIIS|
QRF|QS4444|20030828104856|20030828104856||100000001~20021223|
PID|1||41565^^^^SR~2410629811:72318911||SNOW^MARY^^^^^L||20021223|F|||2 NORTH WAY RD^^MOORESVILLE^INDIANA^46158^^M||(317)123-4567^^PH||EN^English^HL70296|||||||||||||||N|
PID|2||28694^^^^SR~2663391364:111111111||FROG^KERMIT^^^^^L||20021223|
NK1|1|PIGGY^MISS|GRD^Guardian^HL70063|

VXR

MSH|^~\&|5.0^QSInsight^L|^^|DBO^QSInsight^L|QS4444^^|20051019163315||VXR^V03|1129757595953.100000029|P|2.3.1|
MSA|AA|QS444437861000000042||
QRD|20030828104856|R|I|QueryID01|||5|41565^SNOW^MARY^^^^^^^^^^SR|VXI^Vaccine Information^HL70048|SIIS|
QRF|QS4444|20030828104856|20030828104856||100000001~20021223|
PID|1||41565^^^^SR~2410629811:72318911||FROG^KERMIT^^^^^L||20021223|F|||3 SOUTH WAY RD^^MOORESVILLE^INDIANA^46158^^M||(317)222-1234^^PH||EN^English^HL70296|||||||||||||||N|PD1|||^^^^^^SR|^^^^^^^^^^^^SR|||||||02^Reminder/recall -any method^HL70215|||||A^Active^HL70441|
PV1||R|

ORU

MSH|^~\&|LinkLogic-2149|2149001^BMGPED|CHIRPS-Out|BMGPED|20060915210000||ORU^R01 |1473973200100600|P|2.3|||NE|NE
PID|1||00000-0000000|000000|AAAAAAAA^AAAAAA^A||00000000|M||U|00000 A AA AA AAA^^AAAAAA^AA^00000 ||(000)000-0000|||S|||000-00-0000
PV1|1|O|^^^BMGPED||||dszczepaniak
OBR|1|||5^Preload|||20060915095920|||||||||donaldduck||ZZ
OBX|1|ST|CPT-90707.2^MMR #2||given||||||R|||20040506095950
OBX|2|ST|CPT-90737.4^HEMINFB#4||given||||||R|||19931103100050
OBX|3|ST|CPT-90707.1^MMR #1||given||||||R|||19931103095950
OBX|4|ST|CPT-90731.3^HEPBVAX#3||given||||||R|||19930712100120
OBX|5|ST|CPT-90731.2^HEPBVAX#2||given||||||R|||19930112100120
OBX|6|ST|CPT-90737.3^HEMINFB#3||given||||||R|||19930112100050
OBX|7|ST|CPT-90731.1^HEPBVAX#1||given||||||R|||19921027100120
OBX|8|ST|CPT-90737.2^HEMINFB#2||given||||||R|||19921027100050
OBX|9|ST|CPT-90737.1^HEMINFB#1||given||||||R|||19920826100050

QBP

MSH|^~\&||GA0000||MA0000|199705221605||QBP^Q11^QBP_Q11|19970522GA40|T|2.5.1|||NE|AL|||||Z34^CDCPHINVS|
QPD|Z34^Request Immunization History^CDCPHINVS|19970522GA05|25^^^STATE_IIS^MR|FLOYD^FRANK^R^^^^L|MALLARD^F|20030123|M|8444 N. 90th Street^Suite 100^Scottsdale^AZ^85258^USA^L|^PRN^PH^^^480^7458554
RCP|I|20^RD|R

RSP - Exact Match

MSH|^~\&|^^|MA0000^^|^^|GA0000^^|20111105122535||RSP^K11^RSP_K11|1320521135996.100000002|T|2.5.1|||||||||Z32^CDCPHINVS^^|
MSA|AA|19970522GA40||
QAK|||Z34^Request Immunization History^HL70471|
QPD|Z34^Request Immunization History^HL70471|19970522GA05||FLOYD^FRANK^^^^^L|MALIFICENT|20030123|M|L|
PID|1||25^^^^SR~0001||FLOYD^FRANK^^^^^L||20030123|M|||612 S WRIGHT CT^^KENNEWICK^WASHINGTON^99366^United States^M||(509)421-0355^^PH^^^509^4210355^|||||||||||||||||N|
PD1|||^^^^^^SR|21^MATT^SHAKY^K^^^^^^^^^SR~1679652135|||||||02^Reminder/recall -any method^HL70215|||||A^Active^HL70441|
NK1|1|FLOYD^MALIFICENT|GRD^Guardian^HL70063|
PV1||R|
ORC|RE||25.34.20100723|
RXA|0|999|20100723|20100723|83^Hep A, ped/adol, 2 dose^CVX^90633^Hep A 2 dose - Ped/Adol^CPT~34^Hep A 2 dose - Ped/Adol^STC0292|
999|||00^New immunization record^NIP001||IRMS-1000||||AHAVB379AA||SKB^GlaxoSmithKline^HL70227||||A|20111105122536|
RXR|IM^Intramuscular^HL70162|LT^Left Thigh^HL70163|
OBX|1|CE|VFC-STATUS^VFC Status^STC||V02||||||F|
OBX|1|CE|30963-3^Vaccine purchased with^LN||PBF^Public funds^NIP008||||||F|
OBX|1|CE|VFC-STATUS^VFC Status^STC||||||||F|
OBX|1|DT|29768-9^date vaccine information statement published^LN||20100120||||||F|
OBX|1|DT|29769-7^date vaccine information statement presented^LN||20100723||||||F|
ORC|RE||25.34.20100728|

RSP - Multiple Matches

MSH|^~\&|^^|MA0000^^|^^|GA0000^^|20111104153354||RSP^K11^RSP_K11|1320446034070.100000002|T|2.5.1|||||||||Z31^CDCPHINVS^^|
MSA|AA|19970522GA40||
QAK|||Z34^Request Immunization History^HL70471|
QPD|Z34^Request Immunization History^HL70471|19970522GA05||^JOHN^^^^^L|Que^MALIF^^^^^M|20030123|M|L|
PID|1||25^^^^SR||FLOYD^FRANK^^^^^L||20030123|
PD1|||^^^^^^SR|^^^^^^^^^^^^SR|
NK1|1|FLOYD^MALIFICENT|GRD^Guardian^HL70063|
PID|2||85^^^^SR||HENRY^JOHN^^^^^L||20011010|
PD1|||^^^^^^SR|^^^^^^^^^^^^SR|
NK1|1|^MARY|GRD^Guardian^HL70063|
PID|3||26^^^^SR||KENNEDY^JOHN^FITZGERALD^^^^L||19900607|
PD1|||^^^^^^SR|^^^^^^^^^^^^SR|
NK1|1|KENNEDY^JACQUELINE^LEE|GRD^Guardian^HL70063|

RSP - With Forecast Information

MSH|^~\&|^^|MA0000^^|^^|GA0000^^|20111105122535||RSP^K11^RSP_K11|1320521135996.100000002|T|2.5.1|||||||||Z32^CDCPHINVS^^|
MSA|AA|19970522GA40||
QAK|||Z34^Request Immunization History^HL70471|
QPD|Z34^Request Immunization History^HL70471|19970522GA05||FLOYD^FRANK^^^^^L|MALIFICENT|20030123|M|L|
PID|1||25^^^^SR~0001||FLOYD^FRANK^^^^^L||20030123|M|||612 S WRIGHT CT^^KENNEWICK^WASHINGTON^99366^United States^M||(509)421-0355^^PH^^^509^4210355^|||||||||||||||||N|
PD1|||^^^^^^SR|21^MATT^SHAKY^K^^^^^^^^^SR~1679652135|||||||02^Reminder/recall -any method^HL70215|||||A^Active^HL70441|
NK1|1|FLOYD^MALIFICENT|GRD^Guardian^HL70063|
PV1||R|
ORC|RE||25.34.20100723|
RXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|
OBX|1|CE|30956-7^vaccine type^LN||0^DTP/aP^CVX||||||F|
OBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F|
OBX|1|NM|30973-2^Dose number in series^LN||4||||||F|
OBX|1|TS|30980-7^Date vaccination due^LN||20121206||||||F|
OBX|1|TS|30981-5^Earliest date to give^LN||20121206||||||F|
OBX|1|TS|59777-3^Latest date next dose should be given^LN||20161101||||||F|
OBX|1|TS|59778-1^Date dose is overdue^LN||20130106||||||F|
OBX|1|CE|59783-1^Status in immunization series^LN||U^Up to Date^STC0002||||||F|
ORC|RE||9999|
RXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|
OBX|1|CE|30956-7^vaccine type^LN||0^Hib^CVX||||||F|
OBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F|
OBX|1|NM|30973-2^Dose number in series^LN||1||||||F|
OBX|1|TS|30980-7^Date vaccination due^LN||20100102||||||F|
OBX|1|TS|30981-5^Earliest date to give^LN||20091214||||||F|
OBX|1|TS|59777-3^Latest date next dose should be given^LN||20141101||||||F|
OBX|1|TS|59778-1^Date dose is overdue^LN||20100202||||||F|
OBX|1|CE|59783-1^Status in immunization series^LN||P^Past Due^STC0002||||||F|
ORC|RE||9999|
RXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|
OBX|1|CE|30956-7^vaccine type^LN||0^MCV4^CVX||||||F|
OBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F|
OBX|1|NM|30973-2^Dose number in series^LN||1||||||F|
OBX|1|TS|30980-7^Date vaccination due^LN||20201102||||||F|
OBX|1|TS|30981-5^Earliest date to give^LN||20201102||||||F|
OBX|1|TS|59777-3^Latest date next dose should be given^LN||20641101||||||F|
OBX|1|TS|59778-1^Date dose is overdue^LN||20211102||||||F|
OBX|1|CE|59783-1^Status in immunization series^LN||U^Up to Date^STC0002||||||F|
ORC|RE||9999|
RXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|
OBX|1|CE|30956-7^vaccine type^LN||0^Pneumococcal^CVX||||||F|
OBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F|
OBX|1|NM|30973-2^Dose number in series^LN||1||||||F|
OBX|1|TS|30980-7^Date vaccination due^LN||20100102||||||F|
OBX|1|TS|30981-5^Earliest date to give^LN||20091214||||||F|
OBX|1|TS|59777-3^Latest date next dose should be given^LN||20151001||||||F|
OBX|1|TS|59778-1^Date dose is overdue^LN||20100202||||||F|
OBX|1|CE|59783-1^Status in immunization series^LN||P^Past Due^STC0002||||||F|

RSP - With Contraindications

MSH|^~\&||MA0000||GA0000|19970901||VXU^V04|19970522MA53|T|2.3.1|||NE|AL|
PID|||1234^^^^SR^~1234-12^^^^LR^~3872^^^^MR~221345671^^^^SS^~430078856^^^^MA^||KENNEDY^JOHN^FITZGERALD^JR^^^L| BOUVIER^^^^^^M|19900607|M|KENNEDY^BABYBOY^^^^^^B|2106-3^WHITE^HL70005|123 MAIN ST^APT 3B^LEXINGTON^MA^00210^^M^MSA CODE^MA034~345 ELM ST^^BOSTON^MA^00314^^BDL~^^^^^^BR^^MA002||(617)555-1212^PRN^PH^^^617^5551212^^||EN^ENGLISH^ HL70296^^^|||||||N^NOT HISPANIC OR LATINO^HL70189^2186-5^NOT HISPANIC OR LATINO^CDCRE1|CHILDREN'S HOSPITAL|
PD1|||CHILDREN'S CLINIC ^L^1234^^^^FI^LEXINGTON HOSPITAL&5678&XX|12345^WELBY^MARCUS^^^DR^MD^^^L^^^DN|||||||03^REMINDER/RECALL - NO CALLS^HL70215|Y|19900607|||A|19900607|19900607|
NK1|1|KENNEDY^JACQUELINE^LEE|MTH^MOTHER^HL70063||||||||||||||||||||||||||||||898666725^^^^SS|
NK1|2|KENNEDY^JOHN^FITZGERALD|FTH^FATHER^HL70063||||||||||||||||||||||||||||||822546618^^^^SS|
PV1||R|||||||||||||||A|||V02^19900607~H02^19900607|
RXA|0|1|19900607|19900607|08^HEPB-PEDIATRIC/ADOLESCENT^CVX^90744^HEPB-PEDATRIC/ADOLESCENT^CPT|.5|ML^^ISO+||03^HISTORICAL INFORMATION - FROM PARENT'S WRITTEN RECORD^NIP0001|^JONES^LISA|^^^CHILDREN'S HOSPITAL||5|MCG^^ISO+|MRK12345|199206|MSD^MERCK^MVX|
RXA|0|4|19910907|19910907|50^DTAP-HIB^CVX^90721^DTAP-HIB^CPT|.5|ML^^ISO+||00^NEW IMMUNIZATION RECORD^NIP0001|1234567890^SMITH^SALLY^S^^^^^^^^^VEI~1234567891^O'BRIAN^ROBERT^A^^DR^MD^^^^^^OEI|^^^CHILD HEALTHCARE CLINIC^^^^^101 MAIN STREET^^BOSTON^MA||||W46932777|199208|PMC^PASTEUR MERIEUX CONNAUGHT^MVX|||CP|A|19910907120030|
RXR|IM^INTRAMUSCULAR^HL70162|LA^LEFT ARM^HL70163|
RXA|0|5|19950520|19950520|20^DTAP^CVX|.5|ML^^ISO+|||1234567891^O'BRIAN^ROBERT^A^^DR|^^^CHILD HEALTHCARE CLINIC^^^^^101 MAIN STREET^^BOSTON^MA||||W22532806|19950705|PMC^PASTEUR MERIEUX CONNAUGHT^MVX|
RXR|IM^INTRAMUSCULAR^HL70162|LA^LEFT ARM^HL70163|
OBX|1|CE|30963-3^Vaccine purchased with^LN||PBF^Public funds^NIP008||||||F|
OBX|2|CE|VFC-STATUS^VFC Status^STC||V02||||||F|
OBX|3|TS|29768-9^DATE VACCINE INFORMATION STATEMENT PUBLISHED^LN|1|19950520||||||F|||20100920
OBX|4|TS|29769-7^DATE VACCINE INFORMATION STATEMENT PRESENTED ^LN|1|19950520||||||F|||20100920
RXA|0|0|20090531132511|20090531132511|3^MMR^CVX|0||||^Sticker^Nurse|^^^DCS_DC||||||
OBX|1|CE|30945-0^Vaccination contraindication/precaution^LN|1|26^allergy to thimerasol(anaphylactic)^STC||||||F|||20090415
RXA|0|1|20090531132511|20090531132511|3^MMR^CVX|999||||^Sticker^Nurse|^^^DCS_DC||||||||8

 


STC | One logo