HL7v2 Implementation Guide

Last Updated 05/06/2024

Search:


Index	Segment	Set	Component	Title	Mobile application requirement	User entry requirement	Comment

Index	Segment	Set	Component	Title	Mobile application requirement	User entry requirement	Comment
Index	Segment	Set	Component	Title	Mobile application requirement	User entry requirement	Comment
1	MSH	1	1	Field separator	Required		"\|"
2	MSH	1	2	Encoding characters	Required		"^~\&"
3	MSH	1	3.1	Sending system namespace	Required		{name of App, <20 char}
4	MSH	1	3.2	Sending system OID	Required		See 'Sender-specific fields'
5	MSH	1	3.3	Sending system OID type	Required		"ISO"
6	MSH	1	4.1	Sending facility name	Required		See 'Sender-specific fields'
7	MSH	1	4.2	Sending facility ID	Required		See 'Sender-specific fields'
8	MSH	1	4.3	Sending facility ID type	Required		"CLIA"
9	MSH	1	5.1	Receiving system namespace	Required		See 'Receiver-specific fields'
10	MSH	1	5.2	Receiving system OID	Required		See 'Receiver-specific fields'
11	MSH	1	5.3	Receiving system OID type	Required		"ISO"
12	MSH	1	6.1	Receiving facility name	Required		See 'Receiver-specific fields'
13	MSH	1	6.2	Receiving facility ID	Required		See 'Receiver-specific fields'
14	MSH	1	6.3	Receiving facility ID type	Required		"ISO"
15	MSH	1	7	Date and time of message	Required		{"YYYYMMDDHHMMSS+ZZZZ" (where ZZZZ is the time zone offset); For example: \|19760704010159-0500\| is1:01:59 on July 4,1976in the Eastern Standard Time zone (USA)}
16	MSH	1	9.1	Message Code	Required		"ORU"
17	MSH	1	9.2	Trigger Event	Required		"R01"
18	MSH	1	9.3	Message structure	Required		"ORU_R01"
19	MSH	1	10	Message control ID	Required		{Date_SpecimenID}
20	MSH	1	11.1	Processing ID	Required		"T" during testing or"P"once in production
21	MSH	1	12.1	Version ID	Required		"2.5.1"
22	MSH	1	15	Accept acknowledgement type	Required		"NE"
23	MSH	1	16	Application Acknowledgment Type	Required		"NE"
24	MSH	1	21	Message Profile Identifier	Required		"PHLabReport-NoAck^ELR251R1_Rcvr_Prof^2.16.840.1.113883.9.11^ISO"
25	SFT	1	1	Software Vendor Organization	Required
26	SFT	1	2	Software Certified Version or Release Number	Required
27	SFT	1	3	Software Product Name	Required
28	SFT	1	4	Software Binary ID	Required
29	SFT	1	6	Software Install Date	Include if available		{YYYYMMDD}
30	SFT	2	1	Software Vendor Organization	Conditional		MakeMyTestCount.org only: "MMTC"
31	SFT	2	2	Software Certified Version or Release Number	Conditional		MakeMyTestCount.org only: Code for embedding organization
32	SFT	2	3	Software Product Name	Conditional		MakeMyTestCount.org only: domain name where embedded
33	SFT	2	4	Software Binary ID	Conditional		MakeMyTestCount.org only: "Binary ID Unknown"
34	PID	1	1	Set ID	Required		"1"
35	PID	1	3.1	Patient ID	Required		Unique ID assigned to patient by App provider Must be 100 characters or less
36	PID	1	3.4.2	Patient ID assigner	Required		See 'Sender-specific fields'(same as MSH-3.2)
37	PID	1	3.4.3	Patient ID assigner ID type	Required		"ISO"
38	PID	1	3.5	Patient ID Type	Required		"PI"
39	PID	1	5.1	Patient last name	Required to ask user	Optional	If excluded or not available, use "~^^^^^^S".
40	PID	1	5.2	Patient first name	Required to ask user	Optional	If excluded or not available, do not populate.
41	PID	1	5.3	Patient middle name	Required to ask user	Optional	If excluded or not available, do not populate.
42	PID	1	7	Patient DOB	Required to ask user	Optional	{YYYYMMDD}
43	PID	1	8	Patient sex	Required to ask user	Optional	https://terminology.hl7.org/5.1.0/CodeSystem-v2-0001.html
44	PID	1	10.1	Patient race code	Required to ask user	Optional	https://terminology.hl7.org/ValueSet-v2-0005.html
45	PID	1	10.2	Patient race description	Conditional		When PID-10.1 is valued: https://terminology.hl7.org/ValueSet-v2-0005.html
46	PID	1	10.3	Patient race code system	Conditional		When PID-10.1 is valued: "HL70005"
47	PID	1	10.7	Patient race code system version	Conditional		When PID-10.1 is valued: "2.5.1"
48	PID	1	11.1	Patient street address	Required to ask user	Optional
49	PID	1	11.2	Patient street address 2	Required to ask user	Optional
50	PID	1	11.3	Patient city	Required to ask user / Obtain from zip code	Optional
51	PID	1	11.4	Patient state	Required to ask user	Optional
52	PID	1	11.5	Patient zip code	Required to ask user	Required
53	PID	1	11.9	Patient County	Required to ask user / Obtain from zip code	Optional	https://phinvads.cdc.gov/vads/ViewValueSet.action?id=FA221794-C665-E811-98FD-0017A477041A
54	PID	1	13.3	Patient phone telecom equipment code	Required to ask user	Optional	"PH" for phone number, "Internet" for email address Default to "PH" if user does not enter phone number or email address
55	PID	1	13.4	Patient email	Required to ask user	Optional
56	PID	1	13.6	Patient phone area code	Required to ask user	Optional	{nnn} Default to "111" if user does not enter phone number or email address
57	PID	1	13.7	Patient local phone	Required to ask user	Optional	{NNNNNNN} Default to "1111111" if user does not enter phone number or email address
58	PID	1	22.1	Patient ethnicity code	Required to ask user	Optional	https://terminology.hl7.org/5.1.0/CodeSystem-v2-0189.html
59	PID	1	22.2	Patient ethnicity description	Conditional		When PID-22.1 is valued: https://terminology.hl7.org/5.1.0/CodeSystem-v2-0189.html
60	PID	1	22.3	Patient ethnicity code system	Conditional		When PID-22.1 is valued: "HL70189"
61	PID	1	22.7	Patient ethnicity code system version	Conditional		When PID-22.1 is valued: "2.5.1"
62	ORC	1	1	Order control	Required		"RE"
63	ORC	1	3.1	Filler Order Number	Required		{Same as SPM2.2.1} Must be 100 characters or less
64	ORC	1	3.3	Filler Order Number Assigner OID	Required		See 'Sender-specific fields'(same as MSH-3.2)
65	ORC	1	3.4	Filler Order Number assigner ID type	Required		"ISO"
66	ORC	1	12.1	Ordering provider ID	Required for Prescription		{NPI}
67	ORC	1	12.2	Ordering provider last name	Required for Prescription		{Ordering provider last name}
68	ORC	1	12.3	Ordering provider first name	Required		See 'Test Specific HL7v2 Field Values Tool'
69	ORC	1	12.9.2	Ordering provider ID assigner OID	Conditional		When ORC-12.1 is valued: "2.16.840.1.113883.4.6"
70	ORC	1	12.9.3	Ordering provider ID assigner type	Conditional		When ORC-12.1 is valued: "ISO"
71	ORC	1	12.13	Ordering provider ID type	Conditional		When ORC-12.1 is valued: "NPI"
72	ORC	1	21.1	Ordering facility name	Required		See 'Test Specific HL7v2 Field Values Tool'
73	ORC	1	22.1	Ordering facility street	Conditional		{PID11.1} for OTC, {ORC24.1} for prescription
74	ORC	1	22.2	Ordering facility street 2	Conditional		{PID11.2} for OTC, {ORC24.2} for prescription
75	ORC	1	22.3	Ordering facility city	Conditional		{PID11.3} for OTC, {ORC24.3} for prescription
76	ORC	1	22.4	Ordering facility state	Conditional		{PID11.4} for OTC, {ORC24.4} for prescription
77	ORC	1	22.5	Ordering facility zip	Required		{PID11.5} for OTC, {ORC24.5} for prescription
78	ORC	1	22.9	Ordering facility county	Conditional		{PID11.9} for OTC, {ORC24.9} for prescription
79	ORC	1	23.6	Ordering facility phone area code	Required		{PID13.6} for OTC, {ORC14.6} for prescription
80	ORC	1	23.7	Ordering facility local phone	Required		{PID13.7} for OTC, {ORC14.7} for prescription
81	ORC	1	24.1	Ordering provider street	Required for Prescription
82	ORC	1	24.2	Ordering provider street 2	Optional
83	ORC	1	24.3	Ordering provider city	Required for Prescription
84	ORC	1	24.4	Ordering provider state	Required for Prescription
85	ORC	1	24.5	Ordering provider zip	Required for Prescription
86	ORC	1	24.9	Ordering provider county	Optional
87	OBR	1	1	Set ID	Required		"1"
88	OBR	1	3.1	Filler Order Number	Required		{Same as SPM-2.2.1} Must be 100 characters or less
89	OBR	1	3.3	Filler Order Number Assigner OID	Required		See 'Sender-specific fields'(same as MSH-3.2)
90	OBR	1	3.4	Filler Order Number assigner ID type	Required		"ISO"
91	OBR	1	4.1	Test ordered code	Required		See 'Test Specific HL7v2 Field Values Tool'
92	OBR	1	4.2	Test ordered description	Required		See 'Test Specific HL7v2 Field Values Tool'
93	OBR	1	4.3	Test ordered code system	Required		"LN"
94	OBR	1	4.7	Ordered test code system version	Required		Use most common LOINC version available (Currently "2.71")
95	OBR	1	7.1	Observation result date	Required		{Same as SPM-17.1}
96	OBR	1	16.1	Ordering provider ID	Required for Prescription		{NPI}
97	OBR	1	16.2	Ordering provider last name	Required for Prescription		{Ordering provider last name}
98	OBR	1	16.3	Ordering provider first name	Required		See 'Test Specific HL7v2 Field Values Tool'
99	OBR	1	16.9.2	Ordering provider ID assigner OID	Conditional		When OBR-16.1 is valued: "2.16.840.1.113883.4.6"
100	OBR	1	16.9.3	Ordering provider ID assigner type	Conditional		When OBR-16.1 is valued: "ISO"
101	OBR	1	16.13	Ordering provider ID type	Conditional		When OBR 16.1 is valued: "NPI"
102	OBR	1	22.1	Test result date released	Required		{"YYYYMMDDHHMMSS+ZZZZ}
103	OBR	1	25	Result status	Required		"F"
104	OBX	1	1	Set ID	Required		"1" NOTE: For multiplex tests, there shall be an OBX and an NTE segment for each result in the panel. Each result OBX segment shall follow the format given here for OBX[1]. The Set ID in OBX-1 must be incremented for each OBX segment. For SARS-CoV-2 reporting, the SARS-CoV-2 result must be the first OBX segment, followed by any other result OBX segments, and then the Age, Symptomatic, and Date of Onset OBX segments. Do not change the Set ID for the added NTE segments.
105	OBX	1	2	Test result format	Required		"CWE"
106	OBX	1	3.1	Test performed code	Required		See 'Test Specific HL7v2 Field Values Tool'
107	OBX	1	3.2	Test performed description	Required		See 'Test Specific HL7v2 Field Values Tool'
108	OBX	1	3.3	Test performed code system	Required		"LN"
109	OBX	1	3.7	Test Performed code system version	Required		Use most common LOINC version available (Currently "2.71")
110	OBX	1	5.1	Test result code	Required		See 'Test Specific HL7v2 Field Values Tool'
111	OBX	1	5.2	Test result description	Required		See 'Test Specific HL7v2 Field Values Tool'
112	OBX	1	5.3	Test result code system	Required		"SCT"
113	OBX	1	5.7	Test result code system version	Required		"20210301"
114	OBX	1	8.1	Test result abnormal flags code	Required		"A" for detected results, "N" for not detected and invalid results
115	OBX	1	8.2	Test result abnormal flags description	Required		"Abnormal" for detected results, "Normal" for not detected and invalid results
116	OBX	1	8.3	Test result abnormal flags code system	Required		"HL70078"
117	OBX	1	8.7	Test result abnormal flags code system version	Required		"2.5.1"
118	OBX	1	11	Test result status	Required		"F" NOTE: This field must match across all OBX segments.
119	OBX	1	15.1	Test Producer's ID	Required		See 'Test Specific HL7v2 Field Values Tool'
120	OBX	1	17.1	Device identifier	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: For multiplex tests, this field must match across all result OBX segments.
121	OBX	1	17.3	Device Coding System	Required		"99ELR"
122	OBX	1	17.7	Device Code System version	Required		"Vunknown"
123	OBX	1	19	Test analysis date	Required		{YYYYMMDDHHMMSS[+/-ZZZZ]}, Date of mobile device interpretation NOTE: For multiplex tests, this field must match across all result OBX segments.
124	OBX	1	23.1	Test Performing organization name	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
125	OBX	1	23.6.2	Test Performing Organization ID Assigner OID	Required		"2.16.840.1.113883.3.8589.4.1.152"
126	OBX	1	23.6.3	Test Performing Organization Assigner ID type	Required		"ISO"
127	OBX	1	23.7	Test Performing Organization ID Type	Required		"XX"
128	OBX	1	23.10	Test Performing Organization identifier	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
129	OBX	1	24.1	Test Performing Organization Street address	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
130	OBX	1	24.3	Test Performing Organization City	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
131	NTE	1	1	Set ID	Required		"1"
132	NTE	1	2	Source of Comment	Required		"L"
133	NTE	1	3	Comment	Required		{Same as OBX-17.1}
134	OBX	2	1	Set ID	Required		"2"
135	OBX	2	2	Patient age value type	Required		"NM"
136	OBX	2	3.1	Patient age code	Required		"35659-2"
137	OBX	2	3.2	Patient age description	Required		"Age at specimen collection"
138	OBX	2	3.3	Patient age code system	Required		"LN"
139	OBX	2	3.7	Patient age code system version	Optional		Use most common LOINC version available (Currently "2.71")
140	OBX	2	5	Patient age	Required to ask user / obtain from DOB	Required	Age in years
141	OBX	2	6.1	Patient age unit of measure code	Required		"a"
142	OBX	2	6.2	Patient age unit of measure description	Required		"year"
143	OBX	2	6.3	Patient age unit of measure code system	Required		"UCUM"
144	OBX	2	6.7	Patient age unit of measure code system version	Required		"2.1"
145	OBX	2	11	Patient age result status	Required		"F" NOTE: This field must match across all OBX segments.
146	OBX	2	15.1	Patient age Producer's ID	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
147	OBX	2	23.1	Patient age Performing organization name	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
148	OBX	2	23.6.2	Patient age Performing Organization ID Assigner OID	Required		"2.16.840.1.113883.3.8589.4.1.152"
149	OBX	2	23.6.3	Patient age Performing Organization Assigner ID type	Required		"ISO"
150	OBX	2	23.7	Patient age Performing Organization ID Type	Required		"XX"
151	OBX	2	23.10	Patient age Performing Organization identifier	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
152	OBX	2	24.1	Patient age Performing organization street address	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
153	OBX	2	24.3	Patient age Performing Organization City	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
154	OBX	2	29	Patient age Observation type	Required		"QST"
155	OBX	3	1	Set ID	Conditional		When OBX-5 (Set3) is valued: "3"
156	OBX	3	2	Symptomatic assessment value type	Conditional		When OBX-5 (Set 3) is valued: "CWE"
157	OBX	3	3.1	Symptomatic assessment code	Conditional		When OBX-5 (Set 3) is valued: "95419-8"
158	OBX	3	3.2	Symptomatic assessment code description	Conditional		When OBX-5 (Set 3) is valued: "Whether the patient has symptoms related to condition of interest"
159	OBX	3	3.3	Symptomatic assessment code system	Conditional		When OBX-5 (Set 3) is valued: "LN"
160	OBX	3	3.7	Symptomatic assessment code system version	Optional		Use most common LOINC version available (Currently "2.71")
161	OBX	3	5	Symptomatic assessment result	Required to ask user	Optional	"Y^Yes^HL70136^^^^2.5.1" if yes, "N^no^HL70136^^^^2.5.1" if no, "UNK^Unknown^NULLFL^^^^2.0.0" if unknown
162	OBX	3	11	Symptomatic assessment result status	Conditional		When OBX-5 (Set 3) is valued: "F" Note: This field must match across all OBX segments.
163	OBX	3	15.1	Symptomatic assessment Producer's ID	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
164	OBX	3	23.1	Symptomatic assessment Performing organization name	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
165	OBX	3	23.6.2	Symptomatic assessment Performing Organization ID Assigner OID	Required		"2.16.840.1.113883.3.8589.4.1.152"
166	OBX	3	23.6.3	Symptomatic assessment Performing Organization Assigner ID type	Required		"ISO"
167	OBX	3	23.7	Symptomatic assessment Performing Organization ID Type	Required		"XX"
168	OBX	3	23.10	Symptomatic assessment Performing Organization identifier	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
169	OBX	3	24.1	Symptomatic assessment Performing organization street address	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
170	OBX	3	24.3	Symptomatic assessment Performing Organization City	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
171	OBX	3	29	Symptomatic assessment Observation type	Required		"QST"
172	OBX	4	1	Set ID	Conditional		When OBX-5 (Set 4) is valued: "4"
173	OBX	4	2	Illness onset date value type	Conditional		When OBX-5 (Set 4) is valued: "DT"
174	OBX	4	3.1	Illness onset date code	Conditional		When OBX-5 (Set 4) is valued: "65222-2"
175	OBX	4	3.2	Illness onset date code description	Conditional		When OBX-5 (Set 4) is valued: "Date and time of symptom onset"
176	OBX	4	3.3	Illness onset date code system	Conditional		When OBX-5 (Set 4) is valued: "LN"
177	OBX	4	3.7	Illness onset date code system version	Optional		Use most common LOINC version available (Currently "2.71")
178	OBX	4	5	Illness onset date result	Conditional		When OBX-5 (Set 3) is valued "Y" and user enters valid date: {YYYYMMDD}
179	OBX	4	11	Illness onset date result status	Conditional		When OBX-5 (Set 4) is valued: "F"
180	OBX	4	15.1	Illness onset Producer's ID	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
181	OBX	4	23.1	Illness onset Performing organization name	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
182	OBX	4	23.6.2	Illness onset Performing Organization ID Assigner OID	Required		"2.16.840.1.113883.3.8589.4.1.152"
183	OBX	4	23.6.3	Illness onset Performing Organization Assigner ID type	Required		"ISO"
184	OBX	4	23.7	Illness onset Performing Organization ID Type	Required		"XX"
185	OBX	4	23.10	Illness onset Performing Organization identifier	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
186	OBX	4	24.1	Illness onset Performing organization street address	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments.
187	OBX	4	24.3	Illness onset Performing Organization City	Required		See 'Test Specific HL7v2 Field Values Tool' NOTE: This field must match across all OBX segments
188	OBX	4	29	Illness onset Observation type	Required		"QST"
189	SPM	1	1	Set ID	Required		"1"
190	SPM	1	2.2.1	Specimen ID	Required		{Unique ID assigned to every test by app manufacturer} Must be 100 characters or less
191	SPM	1	2.2.3	Specimen ID Assigner OID	Required		See 'Sender-specific fields'(same as MSH-3.2) Must be 100 characters or less
192	SPM	1	2.2.4	Specimen ID assigner ID type	Required		"ISO"
193	SPM	1	4.1	Specimen type code	Required		See 'Test Specific HL7v2 Field Values Tool'
194	SPM	1	4.2	Specimen type description	Optional		See 'Test Specific HL7v2 Field Values Tool'
195	SPM	1	4.3	Specimen type code system	Required		"SCT"
196	SPM	1	4.7	Specimen type code system version	Required		"20210301"
197	SPM	1	17.1	Specimen collected date	Required		{YYYYMMDDHHMMSS[+/-ZZZZ]}
198	SPM	1	18.1	Specimen received date/time	Required		{YYYYMMDDHHMMSS[+/-ZZZZ]}

Showing 1 to 198 of 198 entries

Links

Last Updated 05/06/2024

LISTSERV

STAY IN TOUCH