Generate invitation tokens

name

"generate-invitation-tokens"

status

"active"

kind

"operation"

description

This operation allows:

a system to generate invitation tokens for 1 or many patients identified by national identifier.

Generates invitation tokens for the patient identified by patientIdentifier (e.g. NHS). Multiple patient identifiers can be supplied as the input to the operation. This allows the calling system to work in batches.

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

"generate-invitation-tokens"

resource

"Organization"

system

false

type

true

instance

false

parameter

parameter[0]
- name = "patientIdentifier"
- use = "in"
- min = 1
- max = "500"
- type = "token"

Currently only NHS, CHI and Health & Care numbers are supported. Reference: https://pkbdev.atlassian.net/wiki/spaces/api/pages/3365077531/Identifier+Systems. If an unsupported system identifier is supplied on the request then the whole request will be rejected and an error returned.

parameter[1]
- name = "patientTokens"
- use = "out"
- min = 1
- max = "500"
- type = "multi part parameter"

patientTokens will not be returned where patient is deceased, not found, already registered, has no date of birth, or is under 16 years old. status-query should be used prior to this operation to confirm the patient is applicable for invitation.

parameter[2]
- name = "patientIdentifier"
- use = "out"
- min = 1
- max = "1"
- type = "token"
- part = patientTokens
parameter[3]
- name = "token"
- use = "out"
- min = 1
- max = "1"
- type = "string"
- part = patientTokens
parameter[4]
- name = "code"
- use = "out"
- min = 1
- max = "1"
- type = "string"
- part = patientTokens
parameter[5]
- name = "expiry"
- use = "out"
- min = 1
- max = "1"
- type = "DateTime"
- part = patientTokens