Extracting Data via Custom REST APIs

This guide provides a high level source of information for organisations looking to use PKB Custom REST APIs in order to retrieve information from the PKB data repository.

Existing PKB APIs will support a range of use cases and are utilised by many different customers in a variety of ways.

However, these APIs have generally been built to meet a specific set of customer requirements and may have limitations in certain scenarios. It is therefore important their capabilities are understood within the context and scope of what any individual customer wishes to achieve.

At PKB we acknowledge that the desire to extract data from our data repository is becoming increasingly important to many of our current and future customers. In response to this, we have an active FHIR API development roadmap and set of existing capabilities which we strongly encourage our customers to engage.

In respect of our current REST API capabilities we have a range of APIs available, each of which is scoped to work based on the access being granted by either a patient, professional (clinician) or coordinator.

Further details about this can be found here:

https://pkbdev.atlassian.net/wiki/spaces/api/pages/3365013193/Code+grant

Technical information about our APIs and how to utilise them is available here:

• Custom REST API

• FHIR REST API

• HL7 API

Open