Note: It is recommended that the FHIR APIs are used for any new integrations.
...
This implementation guide is centered on the Record Access Token API call, available from our custom REST API.
The API call allows mass registration of patients by letter-printing companies, patient kiosk vendors and hospital IT departments.
The faster an organisation registers patients the faster the return on investment. This API allows registering patients without needing face-to-face appointments. Instead the registration details for patients can go to each patient’s home using automatically generated letters from the institution’s existing database about the patient.
Please also review the letter-based mass registration guidance on our deployment site, which includes additional information, including a sample letter.
...
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 toJoin 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.
...
This API operation can be called either by Team Coordinators directly, or else by System Clients.
Parameters
PKB ID. This is the PKB-assigned ID of the patient, which can be retrieved using /v2-beta/users/byNationalId/{nationalId}/{nationalIdType}
...
Patients are created with HL7 ADT A28 messages
PKB ID's are retrieved via the REST API: GET /v2-beta/users/byNationalId/{nationalId}/{nationalIdType} passing in the nationalId and nationalIdType (typically NHS_NUMBER)
Registration tokens are created via the REST API: GET /v1/users/{PKB ID}/recordAccessToken patient by patient
...