PHC-Hub 4.17.3 User Guide|
|
| PHC-Hub 4.17.3 User Guide |
The following section contains the VXQ query requirements and options.
The following message structure specifications are detailed here:
To return an exact match, PHC-Hub requires these segments to be submitted in a VXQ message:
VXQ^V01 |
Vaccination Query |
Usage |
MSH |
Message Header Segment |
R |
QRD |
Query Definition Segment |
R |
QRF |
Query Filter Segment |
O |
Source: Table 4.12.1: VXQ - Query for Vaccination Record (V01), from the HL7 Version 2.3.1 Final Standard 05/1999, pp. 4-108.
Example:
MSH| |
To return an exact match, the MSH segment must have the following fields valued.
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
1 |
1 |
ST |
R |
|
|
00001 |
Field Separator |
2 |
4 |
ST |
R |
|
|
00002 |
Encoding Characters |
4 |
180 |
HD |
R |
|
0362 |
00004 |
Sending Facility |
9 |
7 |
CM |
R |
|
0076 0003 |
00009 |
Message Type |
Source: Table 2.24.1: MSH - Message Header Segment, from the HL7 Version 2.3.1 Final Standard 05/1999, pp. 2-93.
Modification: MSH-4 optionality has been altered and no longer matches original source.
Example:
MSH|^~\&||SENDINGFACILITY|||||VXQ^V01 |
To return an exact match, the QRD segment must have the following fields valued, using one of the two following examples.
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
8 |
60 |
XCN |
R |
Y |
|
00032 |
Who Subject Filter |
Source: Table 2.24.4: Original - Style Query Definition Segment, from the HL7 Version 2.3.1 Final Standard 05/1999, pp. 2-112.
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
1 |
|
ST |
R |
|
|
|
ID Number |
13 |
|
IS |
R |
|
|
|
Identifier Type Code |
Example:
QRD||||||||123456789^^^^^^^^^^^^MR |
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
8 |
60 |
XCN |
R |
Y |
|
00032 |
Who Subject Filter |
Source: Table 2.24.4: Original - Style Query Definition Segment, from the HL7 Version 2.3.1 Final Standard 05/1999, pp. 2-112.
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
2 |
|
ST |
R |
|
|
|
Family Name |
3 |
|
ST |
R |
|
|
|
Given Name |
Source: Table 2.8.49: XCN - Extended Composite ID Number and Name for Persons, from the HL7 Version 2.3.1 Final Standard 05/1999, pp. 2-56.
Example:
QRD||||||||^SMITH^JOHN |
To return an exact match, the QRF segment must have the patient date of birth repetition valued.
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
5 |
60 |
See below |
R |
Y |
|
00041 |
Other QRY Subject Filter |
Source: Table 2.24.5: QRF - Original Style Query Filter Segment, from the HL7 Version 2.3.1 Final Standard 05/1999, pp. 2-115.
SEQ |
LEN |
DT |
OPT |
RP/# |
TBL# |
ITEM# |
Element Name |
2 |
8 |
ST |
R |
|
|
|
Patient Date of Birth |
Example:
QRF|||||~20150217 |
The following are completed examples:
MSH|^~\&||SENDINGFACILITY|||||VXQ^V01 |
OR
MSH|^~\&||SENDINGFACILITY|||||VXQ^V01 |