MINNESOTA IMMUNIZATION INFORMATION CONNECTION
MIIC HL7 2.5.1 Specifications Guide
Submitting VXU Messages
This document is for organizations interested in reporting immunization data to the Minnesota Immunization
Information Connection (MIIC) through Health Level 7 (HL7) messaging, and in meeting Stage 1 and Stage 2 Meaningful
Use: Immunization Information Systems. It is based on the Centers for Disease Control and Prevention (CDC) “HL7
Version 2.5.1: Implementation Guide for Immunization Messaging,” Release 1.4.
For general guidance on HL7 immunization messaging, see the CDC implementation guide referenced above at IIS Health
Level 7 (HL7) Implementation (http://www.cdc.gov/vaccines/programs/iis/technical-guidance/hl7.html).
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
Table of Contents
INTRODUCTION
3
Purpose ........................................................................................................................................................................... 3
HL7 Usage Codes ............................................................................................................................................................. 3
General Guidelines .......................................................................................................................................................... 3
Code Tables and References ........................................................................................................................................... 4
DETAILED SEGMENT LISTINGS
5
MSH – Message Header Segment ................................................................................................................................... 5
PID – Patient Identifier Segment..................................................................................................................................... 6
PD1 – Patient Demographic Segment ............................................................................................................................. 9
NK1 – Next of Kin/Associated Parties ........................................................................................................................... 10
ORC – Order Request Segment ..................................................................................................................................... 13
RXA – Pharmacy Administration ................................................................................................................................... 14
RXR – Pharmacy/Treatment Route ............................................................................................................................... 17
OBX – Observation Result Segment .............................................................................................................................. 17
PV1 – Patient Visit Information..................................................................................................................................... 20
SAMPLE MESSAGE
21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
Introduction
Purpose
The purpose of this document is to provide a concise guide to the Health Level 7 (HL7) 2.5.1 Unsolicited Vaccination
Record Update (VXU) messages accepted by the Minnesota Immunization Information Connection (MIIC). HL7 is a
standard messaging protocol used to exchange data between health care data systems. Organizations based in
Minnesota must follow the specifications outlined here to send their data to MIIC’s production environment.
All organizations interested in starting or enhancing a data interface with MIIC should complete the “MIIC Data Exchange
Worksheet” at Process for Working on Data Exchange with MIIC
(www.health.state.mn.us/divs/idepc/immunize/registry/hp/dataprocess.html).
HL7 Usage Codes
Usage
R
Specifications
Data fields marked ‘R’ are required and must be submitted to MIIC.
RE
Data fields marked ‘RE’ are required, but may be empty, and should be submitted if information is
available and field is applicable. MIIC strongly recommends the collection and submission of these
data elements to ensure good data de-duplication and data quality in MIIC.
Data fields marked ‘C’ are conditional, which means that they are required if a field that they are
related to contains a specific value.
Data fields marked ‘O’ are optional. Data may be sent if you have them, but MIIC may not process
them.
C
O
X
Data fields marked ‘X’ are deprecated and data should not be sent in this portion of the message.
Please DO NOT include Social Security Number in messages sent to MIIC.
General Guidelines
When sending messages, either for multiple vaccinations on a single client, or a single vaccination in a message please
be sure to follow the HL7 format below. You can see a sample message at the end of this guide for reference.
Segment
MSH
PID
PD1
NK1
Begin Order
Group
Cardinality
[1..1]
[1..1]
[0..1]
[0..*]
[0..*]
Usage
R
R
RE
RE
Comment
Every message begins with an MSH.
Every VXU has one PID segment.
Every PID segment in VXU may have one or fewer PD1 segment(s).
The PID segment in a VXU may have zero or more NK1 segment(s).
Each VXU may have zero or more Order Groups (not actually
displayed as a segment in the message)
ORC
[1..1]
R
The order group in a VXU must have one ORC segment.
(11/15) Page 3 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
RXA
[1..1]
R
RXR
OBX
[0..1]
[0..*]
RE
RE
End Order Group
Each ORC segment in a VXU must have one RXA segment. Each RXA
requires an ORC segment.
Every RXA segment in a VXU may have zero or one RXR segment(s).
Every RXA segment in a VXU may have zero or more OBX
segment(s).
(not actually displayed as a segment in the message)
MIIC specifications that were updated for this version of the MIIC HL7 guide:
Data Element
MSH-4
MSH-10
MSH-11
PID-11
PID-23
RXA-9
RXA-17
RXA-18
RXR-1
Data Element Name
Sending Facility
Message Control ID
Processing ID
Patient Address
Birth Place
Administered Notes
Substance Manufacturer Name
Substance Refusal Reason
Route
Previous Usage
R
R
R
R
RE
R
C(R/O)
CE(R/X)
R
New Usage
RE
RE
RE
RE
O
RE
C(RE/O)
RE
RE
Code Tables and References
Code tables referenced in this document can be found on the Minnesota Department of Health (MDH) website at MIIC
Codes for Data Submission and Exchange (www.health.state.mn.us/divs/idepc/immunize/registry/hp/codes.html). Code
tables and relevant mappings are also available on the CDC website at Immunization Information Systems (IIS): Code
Sets (http://www.cdc.gov/vaccines/programs/iis/code-sets.html). See Submitting and Exchanging Data with MIIC
(www.health.state.mn.us/divs/idepc/immunize/registry/hp/data.html) for additional information on MIIC specifications,
Meaningful Use Incentives and MIIC, HL7 transport options, and MIIC-accepted code sets.
(11/15) Page 4 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
Detailed Segment Listings
MSH – Message Header Segment
Identifies the owner (provider) of information sent, the receiver (MIIC), HL7 message type, and HL7 message version.
MSH Segment (Required Segment)
Field Description
Usage Comment
1
Field separator
R
The character to be used as the field separator for the rest
of the message (|).
2
Encoding characters
R
Four characters in the following order: the component
separator, repetition separator, escape character, and
subcomponent separator (^~\&).
3
Sending application
RE
MIIC recommends submission and will process.
Code Table
User-Defined
0361
4
Sending facility
RE
MIIC organization code (short name). Facility-specific code
provided by MDH for each clinic.
• Designates the clinic location where the vaccine
MIIC-assigned
was recorded.
code
• Provider HL7 data submissions to MIIC must include
ALL site-specific organization codes. This is
important for reporting, follow-up and outreach. If
left blank, data will be attributed to the sending
organization, affecting access, vaccination rates for
owning sites, and data quality.
5
Receiving application
RE
MIIC
6
Receiving facility
RE
MIIC
7
Date/time of message
R
YYYYMMDDHHMM (e.g., 201207010822)
8
Security
O
MIIC disregards
9
Message type
R
Unsolicited Vaccination Update (VXU^V04^VXU_V04)
Message control ID
RE
10
Unique ID for message – usually test case number + 100
This is used in responses to help match the original
message with its response.
(11/15) Page 5 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
MSH Segment (Required Segment)
Field Description
Usage Comment
11
Processing ID
RE
Always use ‘P’ for production.
If left blank, it will default to ‘P.’
12
Version ID
R
‘2.5.1’
13
Sequence number
O
MIIC disregards
14
Continuation pointer
O
MIIC disregards
15
Accept
RE
acknowledgement type
MIIC recommends submission
16
Application
RE
acknowledgement type
Value shall be AL-always, NE-Never, ER-Error/reject only, SU
successful completion only
HL7-Defined
• MIIC recommends using ‘AL’ or ‘ER.’
0155
• If ‘NE’ is used, errors and rejected messages will go
(constrained)
unnoticed.
• If left blank, MIIC will auto-populate with ‘AL.’
17
Country code
O
MIIC disregards
18
Character Set
O
MIIC disregards
19
Principal Language of
Message
O
MIIC disregards
20
Alternate Character Set
O
Handling
MIIC disregards
21
Message Profile
Identifier
MIIC disregards; Applicable only to query (QBP) and
response (RSP)
O
Code Table
HL7-Defined
0155
Example:
MSH|^~\&|TestEHRApplication|MIIC|MIIC|MIIC|201405130822||VXU^V04^VXU_V04|test1100|P|2.5.1|||AL|AL
PID – Patient Identifier Segment
The Patient Identification segment includes client identifiers such as name, date of birth, address, etc.
PID Segment (Required Segment)
Field Description
1
Set ID – PID
Usage Comment
RE
Code Table
This field contains the number that identifies this
transaction. For the first occurrence of the segment, the
(11/15) Page 6 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
PID Segment (Required Segment)
Field Description
Usage Comment
Code Table
sequence number shall be one, for the second occurrence,
the sequence number shall be two, etc.
2
Patient ID
X
MIIC disregards
3
Patient identifier list
R
Medical record; stored as chart number in MIIC.
(ID^^^^MR^^^^^^)
4
Alternate patient ID –
PID
X
MIIC disregards
R
Last Name and First Name are required.
• MIIC does not accept placeholder names such as
“Baby” and “Baby Boy.”
(Last^First^Middle^Suffix^^^^)
5
Patient name
User-Defined
0203
This is used in client de-duplication.
6
Mother’s maiden name RE
(Mother’s maiden last^Mother’s maiden first^^^^^^)
MIIC strongly recommends collection and submission of this
data element however if sent this must contain both a first
and last name to be acceptable.
7
Date of birth
Client’s birth date (YYYYMMDD).
R
8
Administrative sex (SelfRE
reported gender)
Client’s gender (F- Female, M-Male, UUnknown/Undifferentiated).
User-Defined
MIIC strongly recommends collection and submission of this 0001
data element.
9
Patient alias
X
MIIC disregards
10
Race
RE
Client’s race
User-Defined
MIIC strongly recommends collection and submission of this 0005
data element.
Client’s address; Incoming address is assumed as the
patient’s primary address.
(Street address^other address^city^state^zip
code^^^^county_code^^)
11
Patient Address
RE
12
County code
X
County code belongs in address field in this version
13
Phone number
RE
Client’s phone number (^PRN^PH^^^555^5555555)
14
Phone number –
business
O
MIIC disregards
15
Primary language
O
MIIC disregards
(11/15) Page 7 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
PID Segment (Required Segment)
Field Description
Usage Comment
16
Marital status
O
MIIC disregards
17
Religion
O
MIIC disregards
18
Patient account number O
MIIC disregards
19
SSN number – patient
MIIC DISREGARDS; DO NOT SEND.
20
Driver’s license number
X
– patient
MIIC disregards
21
Mother’s identifier
X
MIIC disregards
22
Ethnic group
RE
23
Birth place
O
24
Multiple birth indicator RE
X
Code Table
Client’s ethnicity
User-Defined
MIIC strongly recommends collection and submission of this 0189
data.
MIIC disregards
(Y/N/blank). Use ‘Y’ to indicate the client was born in a
multiple birth.
25
Birth order
If PID-24 (Multiple Birth Indicator) is valued “Y “
C
(RE/O) Use ‘1’ for the first born, ‘2’ for the second etc.
26
Citizenship
O
MIIC disregards
27
Veterans military status O
MIIC disregards
28
Nationality
O
MIIC disregards
29
Patient death date
If PID-30 (Patient Death Indicator) is valued “Y”
C
(RE/X) Date of death if client is deceased (YYYYMMDD).
30
Patient death indicator RE
Use ‘Y’ for Yes, ‘N’ for No and ‘blank’ if unknown
HL7-Defined
0136
HL7-Defined
0136
Example:
PID|1||12345678^^^^MR||Mouse^Mickey^J^III^^^|cat^martha|20060504|M||2106-3^White^
HL70005|12345 testing ave^^St.
Peter^MN^56082^^^^MN103||^PRN^PH^^^555^5555555|||||||||2186-5^not Hispanic or
Latino^CDCREC||N||||||N
(11/15) Page 8 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
PD1 – Patient Demographic Segment
The patient additional demographic segment contains additional information related to the client. The PD1 segment is
optional; if used, Publicity Code, Protection Indicator, and Registry Status should be sent. These influence whether the
person wants to receive recall/reminder notices, include indicating whether the person wants his/her data protected,
and the person’s current status in the registry.
PD1 Segment (Optional Segment)
If used, Publicity Code, Protection Indicator, and Registry Status should be sent.
Field Description
Usage Comment
1
Living dependency
O
MIIC disregards
2
Living arrangement
O
MIIC disregards
3
Patient primary facility O
MIIC disregards
4
Patient primary care
provider name and ID
number.
O
MIIC disregards
5
Student indicator
O
MIIC disregards
6
Handicap
O
MIIC disregards
7
Living will code
O
MIIC disregards
8
Organ donor code
O
MIIC disregards
9
Separate bill
O
MIIC disregards
10
Duplicate patient
O
MIIC disregards
11
Publicity Code
RE
Controls whether recall/reminder notices are sent
Default value is ‘02’ (reminder/recall – any method).
Code Table
User-Defined
0215
Controls visibility of records to other organizations
12
Protection indicator
RE
•
Default value is blank.
HL7-Defined
• Y - Yes, protect the data. Client (or guardian) has indicated 0136
that the information shall be protected. (Do not share
data.)
(11/15) Page 9 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
PD1 Segment (Optional Segment)
If used, Publicity Code, Protection Indicator, and Registry Status should be sent.
Field Description
Usage Comment
Code Table
• N - No, it is not necessary to protect data from other
clinicians. Client (or guardian) has indicated that the
information does not need to be protected. (Sharing is OK)
If PD1-12 (Protection Indicator) is valued
13
Protection Indicator
Effective Date
C
(RE/X)
14
Place of Worship
O
MIIC disregards
15
Advance Directive Code O
MIIC disregards
16
Immunization registry
status
RE
•
•
•
•
•
A - Active
I - Inactive—Unspecified
L - Inactive-Lost to follow-up (cannot contact)
M - Inactive-Moved or gone elsewhere (transferred)
P - Inactive-Permanently inactive (do not re-activate or
add new entries to this record)
• U - Unknown
User-Defined
0441
O – Other (has been removed, DO NOT USE)
C
(RE/X)
If the PD1-16 (Registry Status) field is valued.
17
Immunization registry
status effective date
18
Publicity Code Effective C
(RE/X)
Date
19
Military Branch
O
MIIC disregards
20
Military Rank/Grade
O
MIIC disregards
21
Military Status
O
MIIC disregards
If the PD1-11 (Publicity Code) field is valued.
Example:
PD1|||||||||||02|N|20140513|||A|20140513|20140513
NK1 – Next of Kin/Associated Parties
The NK1 segment contains information about the client’s next of kin and other associated or related parties. The NK1
segment is optional; if used, fields 1-5 should be sent.
(11/15) Page 10 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
NK1 Segment (Optional Segment)
If used, fields 1-5 should be sent.
Field Description
Usage Comment
1
Set ID – NK1
R
Sequential numbers. Use ‘1’ for the first NK1 within the
message, ‘2’ for the second, and so forth.
2
Name
R
Name of the responsible person who cares for the client.
(Next of kin last^next of kin first^^^^^^)
R
Relationship of the responsible person to the client. If no
relationship is sent, it will default to Self.
(SPO^Spouse^HL70063)
3
Relationship
4
Address
RE
Responsible person’s mailing address.
(Street address^other address^city^state^zip
code^^^^county_code^^)
5
Phone number
RE
Responsible person’s phone number.
(^PRN^PH^^^555^5555555)
6
Business phone number O
MIIC disregards
7
Contact role
O
MIIC disregards
8
Start date
O
MIIC disregards
9
End date
O
MIIC disregards
10
Next of kin/AP job title O
MIIC disregards
11
Next of kin/AP job
code/class
O
MIIC disregards
12
Next of kin/AP
employee number
O
MIIC disregards
13
Organization name
O
MIIC disregards
14
Marital status
O
MIIC disregards
15
Sex
O
MIIC disregards
16
Date/time of birth
O
MIIC disregards
17
Living dependency
O
MIIC disregards
Code Table
User-Defined
0063
(11/15) Page 11 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
NK1 Segment (Optional Segment)
If used, fields 1-5 should be sent.
Field Description
Usage Comment
18
Ambulatory status
O
MIIC disregards
19
Citizenship
O
MIIC disregards
20
Primary language
O
MIIC disregards
21
Living arrangement
O
MIIC disregards
22
Publicity code
O
MIIC disregards
23
Protection indicator
O
MIIC disregards
24
Student indicator
O
MIIC disregards
25
Religion
O
MIIC disregards
26
Mother’s maiden name O
MIIC disregards
27
Nationality
O
MIIC disregards
28
Ethnic group
O
MIIC disregards
29
Contact reason
O
MIIC disregards
30
Contact person’s name O
MIIC disregards
31
Contact person’s
telephone number
O
MIIC disregards
32
Contact person’s
address
O
MIIC disregards
33
Next of kin/AP’s
identifiers
O
MIIC disregards
34
Job status
O
MIIC disregards
35
Race
O
MIIC disregards
Code Table
(11/15) Page 12 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
NK1 Segment (Optional Segment)
If used, fields 1-5 should be sent.
Field Description
Usage Comment
36
Handicap
O
MIIC disregards
37
Contact person social
security #
O
MIIC disregards
38
Next of Kin Birth Place
O
MIIC disregards
39
VIP Indicator
O
MIIC disregards
Code Table
Example:
NK1|1|MOUSE^MINNIE|SPO^Spouse^HL70063|12345 testit ave^^St.
Peter^MN^56082^^^^MN103|^PRN^PH^^^555^5555555
ORC – Order Request Segment
Each RXA needs to be associated with an ORC.
ORC Segment (Required Segment)
Each RXA needs to be associated with an ORC.
Field Description
Usage Comment
1
Order Control
R
Always use the code “RE”
2
3
4
5
6
7
8
9
10
11
12
13
Placer Order
Number
Filler Order Number
RE
Placer Group
Number
Order Status
Response Flag
Quantity/Timing
Parent
Date/Time of
Transaction
Entered by
Verified by
Ordering Provider
Enterer’s Location
O
Uniquely identifies this order among all orders
sent by a provider organization that filled the
order
• If RXA is conveying information on an
immunization which was not given (e.g. refusal)
the filler order number shall be 9999.
MIIC disregards
O
O
X
O
O
MIIC disregards
MIIC disregards
MIIC disregards
MIIC disregards
MIIC disregards
R
RE
O
RE
O
Code Table
HL7 0119
(constrained)
•
MIIC disregards
MIIC disregards
(11/15) Page 13 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
14
Call Back Phone
Number
15
Order Effective
Data/Time
16
Order Control Code
Reason
17
Entering
Organization
18
Entering Device
19
Action by
20
Advanced
Beneficiary Notice
Code
21
Ordering Facility
Name
22
Ordering Facility
Address
23
Ordering Facility
Phone Number
24
Ordering Provider
Address
25
Order Status
Modifier
26
Advanced
Beneficiary Notice
Override Reason
27
Filler’s Expected
Availability
Date/Time
28
Confidentiality Code
29
Order Type
30
Enterer
Authorization Mode
31
Parent Universal
Service Identifier
Example:
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
O
O
MIIC disregards
MIIC disregards
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
MIIC disregards
O
O
O
MIIC disregards
MIIC disregards
MIIC disregards
O
MIIC disregards
ORC|RE||IZ-783278^NDA|||||||54321^Dog^Goofy||12345^Duck^Donald
RXA – Pharmacy Administration
The RXA segment carries pharmacy administration data such as the date of vaccination, type of vaccine administered,
vaccine lot number, and vaccine manufacturer. Each RXA must be preceded by ORC segment.
(11/15) Page 14 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
RXA Segment (Required Segment)
Each RXA needs to be associated with an ORC.
Field Description
Usage
Comment
R
•
Always use ‘0’
•
Always use ‘1’
1
Give sub-ID counter
2
Administration sub-ID
counter
R
3
Date/time start of
administration
R
4
Date/time end of
administration
Code Table
This should not be used for indicating dose number, which
belongs in an OBX.
Date the vaccine was given. (YYYYMMDD)
Date the vaccine was given. (YYYYMMDD)
RE
If RXA-4 (Date time of admin end) is populated, then it
SHALL be the same as Start time (RXA-3)
Identifies the vaccine administered. CVX codes should be
used in the first triplet to code this field. The second triplet
HL7-Defined
could be used to represent the same vaccine using a
0292
different coding system, such as CPT.
(141^Influenza^CVX^90658^Flu 3+ yrs^CPT)
5
Administered code
R
6
Administered amount
R
7
Administered units
CE
(R/O)
If Administered Amount is not valued “999”
8
Administered dosage
form
O
MIIC disregards
9
Administration notes
RE
10
Administering provider RE
Identifies the name of the person physically administering
the vaccine.
11
Administered-at
location
MIIC will use this field to store the site where the vaccine
was administered (for historical vaccinations).
12
Administered per (time
O
unit)
MIIC disregards
13
Administered strength
MIIC disregards
RE
O
Quantity of vaccine administered in milliliters.
If not known or meaningful, use “999.”
Use ‘00’ to indicate a vaccine administered by the clinic.
Use ‘01’-‘08’ to indicate a historical immunization.
If left blank it will default to ‘01’.
UCUM
NIP-Defined 001
(11/15) Page 15 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
RXA Segment (Required Segment)
Each RXA needs to be associated with an ORC.
Field Description
14
15
Administered strength
units
Substance lot number
Usage
Comment
O
MIIC disregards
C
(R/O)
•
Code Table
If value in RXA-9.1 (Administration Notes) is valued
“00”, then this field is required.
Manufacturer’s lot number for the vaccine (String with
length of 20)
16
17
Substance expiration
date
Substance
manufacturer name
C
(YYYYMMDD)
(RE/O) If the RXA-15 (lot number) is valued.
If the date is before the administration date the vaccination will be
rejected.
C
• If the value in RXA-9.1 (Administration Notes) is valued “00”,
(RE/O) Manufacturer of vaccine administered. Manufacturer ID, text
description, coding system. (SKB^GlaxoSmithKline^MVX)
Use ‘00’ to indicate vaccine was refused.
An entry in this field indicates that the patient did not
take the substance. The vaccine that was offered should
be recorded in RXA-5, Do not record contraindications,
immunities or reactions in this field.
18
Substance refusal
reason
RE
19
Indication
O
MIIC disregards
20
Completion status
RE
If RXA-20 is valued “CP” or “PA” then RXA-9.1 (admin notes)
SHALL be valued one of the codes listed in NIP001 in the
first repetition of this field.
21
Action code-RXA
RE
‘A’ (Add) or ‘D’ (Delete) or ‘U’ (Update – treated as Add by
MIIC). If no value is sent MIIC treats this as an ‘A’ value.
22
System entry date /time O
(YYYYMMDD)
23
Administered Drug
Strength Volume
O
MIIC disregards
24
Administered Drug
O
Strength Volume Units
MIIC disregards
25
Administered Barcode
Identifier
O
MIIC disregards
26
Pharmacy Order Type
O
MIIC disregards
HL7-Defined
0227
MVX
NIP-Defined 002
HL7 0323
Example:
RXA|0|1|20120916|20120916|141^Influenza^CVX^90658^FluLaval >= 3
yrs^CPT|1|mL||00||||||ABC1234|20201201|SKB^GlaxoSmithKline^MVX||||A
This is an example of a vaccine refusal:
RXA|0|1|20120815||03^MMR^CVX|999||||||||||||00^Parental Refusal^NIP002||RE
(11/15) Page 16 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
RXR – Pharmacy/Treatment Route
The RXR segment indicates the route and site of vaccine administration.
RXR Segment (Optional Segment)
Field Description
Usage Comment
Code Table
1
Route
RE
Route of vaccine administration. (E.g., IM^^^^^)
HL7-Defined
0162
2
Site
RE
Site of vaccine administration. (E.g., RA^^^^^)
HL7-Defined
0163
3
Administration device
O
MIIC disregards
4
Administration method O
MIIC disregards
5
Routing instruction
O
MIIC disregards
6
Administration Site
Modifier
O
MIIC disregards
Example:
RXR|IM|RA
OBX – Observation Result Segment
In VXU, this segment is associated with the RXA or immunization record.
The basic format is a question (OBX-3) and an answer (OBX-5).
OBX Segment (Optional)
Field Description
Usage
Comment
1
Set ID-OBX
R
Sequential numbers; Use ‘1’ for the first OBX within the
message, ‘2’ for the second, and so forth
2
Value type
R
This field contains the format of the observation value in
OBX.
3
Observation Identifier
R
To send contraindications:
• Contains a unique identifier for the observation. The
format is that of the Coded Element (CE).
|30945-0^contraindication^LN|
Code Table
HL70125
(constrained)
LOINC is
standard coding
for this field if an
appropriate
(11/15) Page 17 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
OBX Segment (Optional)
Field Description
Usage
Comment
•
Code Table
This indicates what this observation refers to. It poses LOINC code
exists.
the question that is answered by OBX-5. Value sets:
NIP003
To send vaccine-level funding eligibility:
• Contains a unique identifier for the observation. The
format is that of the Coded Element (CE).
|64994-7^funding pgm eligibility^LN|
• This indicates what this observation refers to. It poses
the question that is answered by OBX-5. Value sets:
NIP003
To send history of disease with presumed immunity:
• Contains a unique identifier for the observation. The
format is that of the Coded Element (CE).
|59784-9^Disease with presumed immunity^LN|
• This indicates what this observation refers to. It poses
the question that is answered by OBX-5. Value sets:
NIP003
4
Observation sub-ID
R
Used to link related components of an observation. Each
component of the observation would share an Observation
sub-id.
To send contraindications or medical exemptions:
Values are dependent on the value type specified in OBX-2
and the observation identifier specified in OBX-3. Example: NIP-Defined 002
|M4^Medical exemption: Influenza^NIP|
5
Observation value
R
To send vaccine-level funding eligibility:
Contains value for program funding code for this shot.
Derived from screening at this visit or special program
funding.
Example:
|V04^VFC eligible NA/AN^HL70064|
To send history of Varicella with presumed immunity:
|38907003^Varicella infection^SCT|
6
Units
NIP-Defined 004
See also
MIIC-Defined:
Immunity,
Medical
Exemption,
Contraindication
s and
Precautions
HL7-Defined 0064
MIIC-version
If OBX-2(Value Type) is valued “NM” or “SN”.
C
(R/RE) Refers to units for the value in OBX-5; the value shall be
from the ISO+ list of units.
(11/15) Page 18 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
OBX Segment (Optional)
Field Description
Usage
Comment
7
Reference ranges
O
MIIC disregards
8
Abnormal flags
O
MIIC disregards
9
Probability
O
MIIC disregards
10
Nature of abnormal test O
MIIC disregards
11
Observe result status
Always use ‘F’
12
Effective Date of
O
Reference Range Values
MIIC disregards
13
User defined access
checks
O
MIIC disregards
14
Date/time of the
observation
RE
YYYYMMDD
15
Producer’s reference
O
MIIC disregards
16
Responsible observer
O
MIIC disregards
17
Observation method
R
If OBX-3.1 is “64994-7” for sending “funding program
eligibility”, then this field is used to distinguish between
eligibility that is captured at the visit level versus at the
immunization event level
C(R/O)
Example:
Code Table
HL7-Defined
0085
CDCPHINVSFunding Eligibility
Observation
Method (IIS)
|VXC40^per immunization^CDCPHINVS|
This will always be at the “per immunization” level in
MIIC.
18
Equipment Instance
Identifier
O
MIIC disregards
19
Date/Time of the
Analysis
O
MIIC disregards
20
Reserved for
Harmonization with
v2.6
O
MIIC disregards
21
Reserved for
Harmonization with
v2.6
O
MIIC disregards
(11/15) Page 19 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
OBX Segment (Optional)
Field Description
Usage
Comment
22
Reserved for
Harmonization with
v2.6
O
MIIC disregards
23
Performing
Organization Name
O
MIIC disregards
24
Performing
Organization Address
O
MIIC disregards
25
Performing
Organization Medical
Director
O
MIIC disregards
Code Table
Example:
This is a contraindication example.
OBX|1|CE|30945-0^contraindication^LN|1|M4^Medical exemption: Influenza^NIP||||||F|||20120916
This is a vaccine-level funding eligibility example.
OBX|2|CE|64994-7^funding pgm eligibility^LN|2|V04^VFC eligible NA/AN^HL70064||||||F||
|20130916|||VXC40^per immunization^CDCPHINVS|
This is a history of disease example.
OBX|1|CE|59784-9^Disease with presumed immunity^LN|1|38907003^Varicella infection^SCT||||||F|||20130916
PV1 – Patient Visit Information
No longer supported.
• Use of this segment for the purpose of reporting client eligibility for a funding program at the visit level is not
supported by this guide.
• This information is now captured in OBX segment (refer to segment above for details).
(11/15) Page 20 of 21
MIIC HL7 2.5.1 SPECIFICATIONS GUIDE
Sample Message
MSH|^~\&|TestEHRApplication|testSite|MIIC|MIIC|201405130822||VXU^V04^VXU_V04|test1100|P|2.5.1|||AL|AL
PID|1||12345678^^^^MR||Mouse^Mickey^J^III^^^|cat^martha|20060504|M||2106-3^White^HL70005|12345
testing ave^^St. Peter^MN^56082^^^^MN103||^PRN^PH^^^555^5555555|||||||||2186-5^Not Hispanic or
Latino^CDCREC||N||||||N PD1|||||||||||02|N|20140513|||A|20140513|20140513
NK1|1|MOUSE^MINNIE|SPO^Spouse^HL70063|12345 testit ave^^St.
Peter^MN^56082^^^^MN103|^PRN^PH^^^555^5555555
ORC|RE||IZ-783278^NDA|||||||54321^Dog^Goofy||12345^Duck^Donald
RXA|0|1|20120916|20120916|141^Influenza^CVX^90658^FluLaval >= 3
yrs^CPT|1|mL||00||||||ABC1234|20201201|SKB^GlaxoSmithKline^MVX||||A
RXR|IM|RA
OBX|1|CE|30945-0^contraindication^LN|1|M4^Medical exemption: Influenza^NIP||||||F|||20120916
OBX|2|CE|64994-7^funding pgm eligibility^LN|2|V04^VFC eligible NA/AN^HL70064||||||F||
|20130916|||VXC40^per immunization^CDCPHINVS|
ORC|RE||9999^CDC
RXA|0|1|20110215||998^No vaccine administered^CVX|999||||||||||||||NA
OBX|1|CE|59784-9^Disease with presumed immunity^LN|1|38907003^Varicella infection^SCT||||||F|||20110215
ORC|RE||9995|||||||54321^Dog^Goofy||12345^Duck^Donald
RXA|0|1|20120815||03^MMR^CVX|999||||||||||||00^Parental Refusal^NIP002||RE
Minnesota Department of Health
Minnesota Immunization Information Connection
PO Box 64975, St. Paul, MN 55164-0975
651-201-5207
[email protected]
To obtain this information
in a different format, call:
651-201-5207.
(11/15) Page 21 of 21