Developer documentation‎ > ‎FHIR® REST API‎ > ‎Roadmap‎ > ‎Operations‎ > ‎

Hybrid Mail / Mass Registration Workstream

Workstream summary

This section provides early visibility of operations which are under development to support the PKB hybrid mail and mass registration workstream. This workstream comprises three custom operations which will be made available to partners and customers wishing to deploy our hybrid mail workstream or adopt a mass registration workflow - including via letter, kiosk and sms.  The operations in this workstream will be made available by request and are secured via an OAuth2 protected PKB service - referred to as 'system user'.

For further details and to express interest please contact integrations@patientsknowbest.com.


Please see the subpages for full details of each operation.


Mail partner example

The below workflow diagram shows an example workflow where a mail (postal company) partner will process documents received from a customer and send these digitally to PKB using an MDM T02.  The partner can check the registration status of the patient on PKB using status-query and if eligible may invite the patient to sign up to PKB using tokens generated from generate-invitation-tokens.  If documents sent digitally to PKB are not read then the mail partner has the option to send them in the post by querying the read status of the document in PKB using read-receipt-query

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 status-query 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 generate-invitation-tokens 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 generate-invitation-tokens.  The partner embeds the invitation tokens in an SMS message and sends to the patient.  Reference https://deploy.patientsknowbest.com/reg/verified-sms-number-mass-registration-of-patients for SMS details.