FHIR APIs

Tutorial summary

This section provides examples on how the PKB FHIR APIs can support a hybrid mail workstream. Three custom operations have been made available to partners and customers wishing to deploy our hybrid mail workstream. The operations are made available by request and are secured via an OAuth 2.0 protected PKB service - referred to as a 'system client'.

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

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

• generate-invitation-tokens

• read-receipt-query

• status-query

Hybrid 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

Invitation tokens in this workflow may also optionally be sent by SMS. Refer to Join PKB URLs for format and parameters.