Page Comparison

Note: It is recommended that the FHIR APIs are used for any new integrations.

Why the API

This implementation guide is centered on the Record Access Token API call, available from our custom REST API.

...

Please also review the letter-based mass registration guidance on our deployment site, which includes additional information, including a sample letter.

Here are the steps:

The organisation creates a record for their patient as they normally do (e.g. via HL7 ADT A28 or CSV manual upload). The organisation can immediately send data to populate the record, for example with laboratory test results and clinic appointments.
Any user with decryption rights to this patient’s record can use the new PKB REST API call to generate a patient-specific unique invitation code and decryption token for that record. For example, a hospital can use these values to create an invitation letter, SMS or email to send to the patient.
The patient uses the invitation code and decryption token to start registration on the PKB web site - refer to Join PKB URLs.
For security, PKB tests the registering user’s knowledge of the patient’s date of birth.
The patient enters their email address and password.
The patient can now log into the PKB web site to see their data and send messages to their clinical team.

Here is an example of the steps using an integration with letter printing software (such as Synertec):

...

GET /v1/users/{PKB ID}/recordAccessToken

...

...