PHC Hub User Guide
(v. July 2018)|
|
| PHC Hub User Guide
(v. July 2018) |
The following information details the QBP query requirements and options.
The following message structure specifications are detailed here:
To return an exact match, PHC Hub requires these segments to always be submitted in a QBP message:
| QBP^Q11^QBP_Q11 | Query Grammar: QBP Message | Usage |
| MSH | Message Header Segment | R |
| QPD | Query Parameter Definition | R |
| RCP | Response Control Parameter | R |
Source: Table 7-3: Z34 Request Complete Immunization History, from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 141.
Example:
MSH| |
To return an exact match, the MSH segment must have the following fields valued.
| SEQ | LEN | Data Type | Cardinality | Value set | Element Name | Usage | Constraint |
| 1 | 1 | ST | [1..1] | Field Separator | R | The MSH.1 field shall be | | |
| 2 | 4 | ST | [1..1] | Encoding Characters | R | The MSH.2 field shall be ^~\& | |
| 4 | HD | [0..1] | 0362 | Sending Facility | C(R/O) | If MSH.22 is not valued | |
| 9 | 15 | MSG | [1..1] | Message Type | R | QBP^Q11^QBP_Q11 | |
| 21 | EI | [1..*] | Message Profile Identifier | R | Z44^CDCPHINVS | ||
| 22 | XON | [0..1] | 0362 | Sending Responsible Organization | RE |
Source: Table 7-4: MSH Specification for Request Complete Immunization History Query, from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 142.
Modification: MSH-4 has been altered and no longer matches the original source.
Note: If you are expecting a Z42 response, the MSH-21 field must contain a Z44 value. If MSH-21 is left blank, it performs like Z34. If Z44 is sent in, it returns forecasting information regardless of the Import Profile Query Settings > Return Vaccination Forecast setting (see Import Profile Query Settings).
Example:
MSH|^~\&||MHM^1346250057|||||QBP^Q11^QBP_Q11|||||||||||||MHM^1346250057 |
To return an exact match, the QPD segment must have the following fields valued, using one of the two following examples.
| Field Seq(Query ID=Z34) | Name | Key/Search | Sort | LEN | TYPE | Usage | Rep | Match Op | TBL | Segment Field Name | Service Identifier Code | Element Name or Value |
| 3 | PatientList | CX | RE | Y | PID.3 | PID-3: Patient Identifier List |
Source: Table 7-5: QPD Input Parameter Specification, from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 145.
| SEQ | Component Name | Data Type | Usage | LEN | Conditional Predicate | Value Set | Comments |
| 1 | ID Number | ST | R | 15 | |||
| 5 | Identifier Type | ID | R | 2.5 | HL70203 |
Source: Table 4-6: Extended Composite ID with Check Digit (CX), from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 36.
Example:
QPD|||123456789^^^^MR |
| Field Seq (Query ID=Z34) | Name | Key/ Search | Sort | LEN | TYPE | Usage | Rep | Match Op | TBL | Segment Field Name | Service Identifier Code | Element Name or Value |
| 4 | PatientName | XPN | RE | PID.5 | PID-5: Patient Name | |||||||
| 6 | Patient Date of Birth | 26 | TS_NZ | RE | PID.7 | PID-7: Patient date of birth |
Source: Table 7-5: QPD Input Parameter Specification, from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 145.
| SEQ | Component Name | Data Type | Usage | LEN | Conditional Predicate | Value Sets | Comments |
| 1 | Family Name | FN | R | ||||
| 2 | Given Name | ST | R | 30 |
Source: Table 4-31: Extended Person Name (XPN), from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 61.
| SEQ | Component Name | Data Type | Usage | LEN | Conditional Predicate | Value Set | Comments |
| 1 | Time | DTM | R |
Source: Table 4-25: Time Stamp No Time Zone (TS_NZ), from the HL7 Version 2.5.1 Implementation Guide: Immunization Messaging (Release 1.5) 10/1/2014, p. 52.
Example:
QPD||||SMITH^JOHN||20150122 |
Although an RCP segment is a required segment group, there are no fields in this segment that must be provided.
Example:
RCP| |
The following are completed examples:
MSH|^~\&|||||||QBP^Q11^QBP_Q11 |
Or
MSH|^~\&|||||||QBP^Q11^QBP_Q11 |
 |