PHC Hub User Guide (v. July 2018)

QBP Message Segment Specifications

The following information was retrieved from the HL7 Version 2.5.1 Implementation Guide for Immunization Messaging (U.S. Department of Health and Human Services, 2014) and describes various QBP message segment specifications.

MSH Specification for Acknowledgment Response

SEQ	LEN	Data Type	Cardinality	Value Set	ELEMENT NAME	Usage	Constraint
1	1	ST	[1..1]		Field Seperator	R	The MSH.1 field shall be \|
2	4	ST	[1..1]		Encoding Characters	R	The MSH.2 field shall be ^-\&
3		HD	[0..1]	0361	Sending Application	RE	No constraint
4		HD	[0..1]	0362	Sending Facility	RE	No constraint
5		HD	[0..1]	0361	Receiving Application	RE	No constraint
6		HD	[0..1]	0362	Receiving Facility	RE	No constraint
7	26	TS_Z	[1..1]		Date/Time of Message	R	The degree of precision must be at least to the second, (format YYYYMMDDHHMMSS+/-ZZZZ).
8	40	ST	[0..1]		Security	O
9	15	MSG	[1..1]		Message Type	R	RSP^K11^RSP_K11
10	199	ST	[1..1]		Message Control ID	R
11	3	PT	[1..1]		Processing ID	R
12		VID	[1..1]		Version ID	R	2.5.1
13	15	NM	[0..1]		Sequence Number	O
14	180	ST	[0..1]		Continuation Pointer	O
15	2	ID	[0..1]	0155	Accept Acknowledgment Type	R	NE
16	2	ID	[0.11]	0155	Accept Acknowledgment Type	RE
17	3	ID	[0..1]	0399	Country Code	X	blank
18	16	ID	[0..1]	0211	Character Set	X	blank
19		CE	[0..1]		Principal Language of Message	X	blank
20	20	ID	[0..1]		Alternate Character Set Handling Scheme	X	blank
21		EI	[1..1]		Message Profile Identifier	R	Z33^CDCPHINVS
22		XON	[0..1]	0362	Sending Responsible Organization	RE
23		XON	[0..1]	0362	Receiving Responsible Organization	RE

Source: HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 222.

Modifications: MSH-7 description, MSH-11 usage, MSH-15 usage, MSH-16 usage.

MSH-7 - The registry local time stamp is used to populate this field. +/-zzzz time zone indications are not supported.
MSH-9 - RSP^K11^RSP_K11
MSH-10 - Reflects the submitted message control ID. If a message control ID was not submitted, PHC Hub generates a random number and places it here, to assist in query/response matching.
MSH-21 - Message Profile Identifier SHALL contain the constant value ZXX^CDCPHINVS, where XX is the profile of the response

MSA - Message Acknowledgment Segment

MSA has been altered as described in the following table:

SEQ	Element Name	Data Type	Usage	Cardinality	LEN	Conditional Predicate	Value Set	Description/Comment
1	Acknowledgment Code	ID	R	[1..1]	2..2		HL70008	Will be AA, AE, or AR
2	Message Control ID	ST	RE	[1..1]	1..199			Reflects the value submitted in MSH-10
3	Text Message	ST	O	[1..1]	1..2^31-1			A human-readable description of errors, warnings, and rejections
4	Expected Sequence Number		X					Not used by PHC Hub
5	Delayed Acknowledgment Type		X					Not used by PHC Hub
6	Error Condition	CE	O			If MSA-1 is AE or AR		Will be HL70357

Source: HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 234.

Modifications: MSH-2 usage, MSA-3 usage and length, MSA-4 usage, MSA-5 usage, and MSA-6 usage.

MSH-2 - This field contains the message control ID of the message sent by the sending system. It allows the sending system to associate this response with the message for which it is intended. This field echoes the message control ID sent in MSH-10 by the initiating system.

ERR - Error Segment

SEQ	Element Name	Data Type	Usage	Cardinality	LEN	Conditional Predicate	Value Set	Description/Comment
1	Error Code and Location	ELD	X					Not supported for Version 2.5 and later
2	Error Location	ERL	RE	[0..1]	18
3	HL7 Error Code	CWE	R	[0..1]			HL70357
4	Severity	ID	R	[1..1]	1..1		HL70516	Always "E"
5	Application Error Code	CWE	RE	[0..1]			HL70533
6	Application Error Parameter	ST	X
7	Diagnostic Information	TX	X
8	User Message	TX	X	[0..1]				This is a locally specified informative text message about the error.
9	Inform Person Indicator	IS	X
10	Override Type	CWE	X
11	Override Reason Code	CWE	X
12	Help Desk Contact Point	XTN	X

Source: HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 129.

Modifications: ERR-4 description and ERR-6 to ERR-12 usage.

ERR-2 - Identifies the location in a message related to the identified error, warning, or message. Each error has an ERR, so no repeats are allowed on this field. This field may be left empty if location is not meaningful. For example, if it is unable to be parsed, an ERR to that effect may be returned.
ERR-4 - Always "E." PHC Hub allows for custom handling of ignore, warning, and error. Ignore/Warning does not cause a rejection of the HL7 message and thus is not returned in the ACK.
ERR-6 through ERR-12 - PHC Hub does not support these sequences.

QAK - Query Acknowledgment Segment

SEQ	Element Name	Data Type	Usage	Cardinality	LEN	Conditional Predicate	Value Set	Description/Comment
1	Query Tag	ST	R	[1..1]	32			Reflection of submitted value in QPD-2. If this value is blank, PHC Hub creates a unique random value for it.
2	Query Response Status	ID	R	[0..1]				Will be OK or NF
3	Message Query Name	CE	R	[1..1]				Reflection of QPD-1. If QPD-1.1 is blank, it defaults to Z34.
4	Hit Count	NM	X	[0..1]				This is not supported.
5	This Payload	NM	X	[0..1]				This is not supported.
6	Hits Remaining	NM	X	[0..1]				This is not supported.

Source: HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 189.

Modifications: QAK-2 usage, QAK-4 usage, QAK-5 usage, and QAK-6 usage.

QAK-1 - This field contains the value sent in QPD-2 (query tag) by the initiating system, and is used to match response messages to the originating query. The responding system is required to echo it back as the first field in the query acknowledgment segment (QAK). If QPD-2 is not populated, PHC Hub creates a unique random value for the query and presents that here.
QAK-2 - This field allows the responding system to return a precise response status. It is especially useful in the case where no data is found that matches the query parameters, but where there is also no error.
QAK-3 - This field contains the name of the query. This mirrors the QPD-1 (Message Query Name) found in the query message that is being responded to. If QPD-1 is not populated, this defaults to Z34.

QPD - Input Parameter Specification

Field Seq (Query ID=Z34)	Name	LEN	Type	Usage	Rep	Segment Field Name	Element Name or Value
1	MessageQueryName		CE	R			Z44^Request Immunization History^HL70471
2	QueryTag	32	ST	R
3	PatientList		CX	RE	Y	PID.3	PID-3: Patient Identifier List
4	PatientName		XPN	RE		PID.5	PID-5: Patient Name
5	PatientMotherMaidenName		XPN_M	RE		PID.6	PID-6: Mother's maiden name
6	Patient Date of Birth	26	TS_NZ	RE		PID.7	PID-7: Patient date of birth
7	Patient Sex	1	IS	RE		PID.8	PID-8: Patient sex
8	Patient Address		XAD	RE		PID.11	PID-11: Patient Address - does not reflect repetitions
9	Patient Home Phone		ST	RE		PID.13	PID-13: Patient home phone - value is reflected in QPD-9.1
10	Patient Multiple Birth Indicator	1	ID	X		PID.24	PID-24: Patient multiple birth indicator
11	Patient Birth Order	2	NM	X		PID.25	PID-25: Patient birth order
12	Client Last Updated Date		TS	X		PID.33	PID-33: Patient last update date
13	Client Last Update Facility		HD	X		PID.34	PID-34: Patient last update facility

Source: HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 256.

Modifications: QPD-8 description, QPD-9 type, QPD-10 usage, QPD-11 usage, QPD-12 usage, and QPD-13 usage.