Read receipt query

name

"read-receipt-query"

status

"active"

kind

"operation"

description

This operation allows:

a system to query the read status for 1 or many document identifiers.

For each document identifier provided PKB will return the read status of that document. The calling organisation will be determined from a header parameter. The read-receipt will only be returned for documents that were created by that same organisation. I.e. you can't get the read status of documents that were created by an organisation different to the one you are calling on behalf of.

Multiple document identifiers can be supplied as the input to the operation. This allows the calling system to work in batches. The document identifier provided should correspond to the identifier sent on the original document. The document would typically be supplied to PKB via an HL7 MDM T02. Document identifier as provided in TXA-12.1. The sending system should consider using unique identifiers (e.g. UUID) for the document identifiers to ensure they are unique across organisations.

In addition to the OAuth 2.0 access token, the X-Org-Public-Id HTTP header must be provided in the request to specify the organisation that wants to generate the tokens. The parameter will be the UUID of the PKB organisation.

code

"read-receipt-query"

resource

"DocumentReference"

system

false

type

true

instance

false

parameter

parameter[0]
- name = "documentIdentifier"
- use = "in"
- min = 1
- max = "5000"
- type = "token"
parameter[1]
- name = "readReceipt"
- use = "out"
- min = 0
- max = "5000"
- type = "multi part parameter"

readReceipt will not be returned when the documentIdentifier can not be found.

parameter[2]
- name = "documentIdentifier"
- use = "out"
- min = 1
- max = "1"
- type = "string"
- part = readReceipt
parameter[3]
- name = "read"
- use = "out"
- min = 1
- max = "1"
- type = "boolean"
- part = readReceipt