Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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-7

O

Quantity Limited Request

QRD-7.1

The result size to return before a DSC segment is introduced. If a value greater than the system maximum is specified, the system maximum will be used instead. This is currently set to 10,000.

10000

QRD-7.2

Must be 'RD'

RD

QRD-9

O

"STA" to request results for all patients including registration status custom segment.

QRD-9.1

What subject filter

STA

QRD-11

O

Registration status filter.

QRD-11.1

An optional registration status to filter results by when QRD-9.1 = STA.

Options:

REGISTERED
NOT_REGISTERED

If start timestamp (QRF-2.1) is specified then the query behaviour is to find patients where current registration status = specified value and where that status was set on or after the timestamp specified in QRF-2.1.

If there is no date restriction specified within the QRF segment then this is an open status query and results will be returned where current registration status = the value specified.

REGISTERED

[ QRF ]

Query filter

QRF-2

O

Start timestamp. This will restrict the returned results to those patients whose record has been updated on or after this point in time.

QRF-2.1

Start timestamp (inclusive)

201507012352

QRF-5

O

Last seen patient identifier. This should be used in conjunction with QRF-2.1 when a previous search response has been truncated and a DSC segment provided.

Providing the last seen patient identifier from the previous response allows the registration status query to be reinvoked from that last known point (QRF-2.1 + QRF-5.1).

The last known patient identifier will not be returned in the response i.e. the search criteria is non inclusive.

QRF-5.1

Public ID (UUID) for the corresponding patient

1fd2a0f6-890b-4f68-9fa1-65342f649771

...