---
title: "Mass Registration: FHIR APIs"
canonical: "https://wiki.patientsknowbest.com/space/api/3364552775/Mass%20Registration%3A%20FHIR%20APIs"
format: markdown
---
> Macro (toc)

# Tutorial Summary

This section provides examples in how the PKB FHIR APIs can support mass registration. Three custom operations have been made available to partners and customers wishing to deploy a mass registration workflow - including via letter, kiosk and SMS. The operations are made available by request and are secured via an OAuth 2.0 protected PKB service - referred to as 'system user'.

For further details and to express interest please contact [integrations@patientsknowbest.com](mailto:integrations@patientsknowbest.com).

Please see main FHIR API operations section for full details of each operation.

- <u>[generate-invitation-tokens](http://fhir.patientsknowbest.com/operation/generate-invitation-tokens)</u>
- <u>[read-receipt-query](http://fhir.patientsknowbest.com/operation/read-receipt-query)</u>
- <u>[status-query](http://fhir.patientsknowbest.com/operation/status-query)</u>

To construct an invite URL to send invitation tokens via SMS or email refer to <u>[Join PKB URLs](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364356159)</u> for format and parameters.

# Mail Partner Example

Please refer to our mail management tutorial here:[ ](https://dev.patientsknowbest.com/home/developer-tutorial/mail-management-apis/fhir-apis)<u>[FHIR APIs](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363307583)</u>

# Kiosk Partner Example

The below workflow diagram shows an example workflow where a kiosk partner will supplement their patient check in flow with an invite to PKB option. The kiosk partner will check the registration status of the patient on PKB using <u>[status-query](http://fhir.patientsknowbest.com/operation/status-query)</u> in advance of the appointment and if eligible will offer the patient the opportunity to sign up to PKB . The patient will confirm their email address on the kiosk and after the patient has completed 'check in' to their appointment the partner will use <u>[generate-invitation-tokens](http://fhir.patientsknowbest.com/operation/generate-invitation-tokens)</u> to construct an email invitation to the patient.

# SMS Partner Example

The below workflow diagram shows an example workflow where a partner will provide a one-off SMS invite service for a PKB customer. The customer supplies a set of patients to invite to PKB with details including national identifier, mobile number and name. The partner processes the list of patients and creates a set of invitation tokens using <u>[generate-invitation-tokens](http://fhir.patientsknowbest.com/operation/generate-invitation-tokens)</u>. The partner embeds the invitation tokens in an SMS message and sends to the patient.

Reference <u>[https://deploy.patientsknowbest.com/reg/sms](https://wiki.hub.patientsknowbest.com/wiki/spaces/DEPLOY/pages/3540385812)</u> and <u>[Join PKB URLs](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364356159)</u> for SMS details.