Why

The patient must be in your PKB organisation, with access to the appropriate privacy labels, in order to pull data out of the PKB Aggregated endpoint for the patient.

Prerequisites

• A verified patient identifier (either national identifier or PKB public id) and basic demographic details to create a PKB record (first name, last name, date of birth, gender). If you don’t already have an identifier, see the Patient demographic retrieval page.

• API credentials – issued by PKB once development dates have been agreed

How to

Via HL7

• Send an ADT^A28/31 message to PKB using either Organisation or Partner HL7 credentials. The PKB integrations team will help determine which credential type will be used.

  • That demographic message will automatically create / add the patient to the PKB organisation.

• If auto create is turned on, any HL7 message sent to PKB with a verified identifier will create / add the patient to the PKB organisation.

• See PKB’s HL7 connectivity information for details on endpoints.

Via FHIR (version STU3)

• See PKB’s FHIR API connectivity information overview.

• Obtain a valid access token through OAuth 2.0 using the Client credentials grant workflow (example requests and responses).

• Once you have a valid access token, use PKB’s Messaging FHIR API to add the patient to your PKB organisation. Refer to the example request and response for further details.