...
Segment | Field | Opt | RP/# | Component | Description | Example | Data Model |
|---|---|---|---|---|---|---|---|
MSH | Message header. This conforms to PKB's standard definition. | ||||||
QRD | Query definition | ||||||
QRD-1 | Timestamp. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-4 | Query ID. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-8 | O | Who subject filter. This will be ignored if APN is provided in QRD-9. | |||||
QRD-8.1 | ID number (e.g. NHS number, or an MRN) | 5637453543 | If National ID: If Organisation Level ID: If Team Level ID: | ||||
QRD-8.2 | Patient family name. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-8.3 | Patient given name. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-8.13 | ID number type code. Use "MR" for a local number search. Otherwise, a National ID search is performed, regardless of what this value is. The National ID Type used for the search will be the one associated with the country of the connecting organisation or team. | NH | |||||
QRD-9 | O | Type of query to perform. Use "DEM" for demographics, or "APN" to request all active patients (including those without an ID). The default is "DEM". | |||||
QRD-9.1 | What subject filter | DEM | |||||
[ QRF ] | Query filter. This will be ignored if APN is provided in QRD-9. | ||||||
QRF-2 | O | Start timestamp. This will restrict the returned results to those patients activated or modified since the timestamp. | |||||
QRF-2.1 | Start timestamp (inclusive) | 201507012352 | |||||
QRF-3 | O | End timestamp. This will restrict the returned results to those patients activated or modified before the timestamp. | |||||
QRF-3.1 | End timestamp (exclusive) | 201507022351 |
...
Segment | Field | Opt | RP/# | Component | Description | Example | Data Model |
|---|---|---|---|---|---|---|---|
MSH | Message header. This conforms to PKB's standard definition. | ||||||
QRD | Query definition | ||||||
QRD-1 | Timestamp. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-4 | Query ID. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-8 | O | Who subject filter. This will be ignored if APN is provided in QRD-9. | |||||
QRD-8.1 | ID number (e.g. NHS number, or an MRN) | 5637453543 | If National ID: If Organisation Level ID: If Team Level ID: | ||||
QRD-8.2 | Patient family name. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-8.3 | Patient given name. We do not process this field. However, we will echo the value back to you in our response. | ||||||
QRD-8.13 | ID number type code. Use "MR" for a local number search. Otherwise, a National ID search is performed, regardless of what this value is. The National ID Type used for the search will be the one associated with the country of the connecting organisation or team. | NH | |||||
QRD-9 | O | Type of query to perform. Use "DEM" for demographics, or "APN" to request all active patients (including those without an ID). The default is "DEM". | |||||
QRD-9.1 | What subject filter | DEM | |||||
[ QRF ] | Query filter. This will be ignored if APN is provided in QRD-9. | ||||||
QRF-2 | O | Start timestamp. This will restrict the returned results to those patients activated or modified since the timestamp. | |||||
QRF-2.1 | Start timestamp (inclusive) | 201507012352 | |||||
QRF-3 | O | End timestamp. This will restrict the returned results to those patients activated or modified before the timestamp. | |||||
QRF-3.1 | End timestamp (exclusive) | 201507022351 | |||||
PID-4.1 | Patient ID | XYZ00001 | If Organisation Level ID: If Team Level ID: | ||||
PID-4.4 | Patient ID assigning authority | ABCHospital | If Organisation Level ID: If Team Level ID: | ||||
PID-4.5 | Patient ID type code | MR | If Organisation Level ID: If Team Level ID: | ||||
PID-5 | R | Name | |||||
PID-5.1 | Family name | Smith | [[Patient.Family Name]] | ||||
PID-5.2 | Given name | John | [[Patient.Given Name]] | ||||
PID-7 | O | Date of birth | |||||
PID-7.1 | Date of birth | 19800101 | [[Patient.Date of Birth]] | ||||
PID-11 | O | Address | |||||
PID-11.5 | Postal code | SW1A 1AA | [[Patient.Postal Code]] |
...