Welcome


Welcome to the Patients Know Best wiki for developers.

This wiki is intended to support and guide current or potential PKB Customers and Partners in successfully integrating their systems, software or applications with the PKB platform. We do this based on the key principles that the patient owns the data, and we enable data to be shared based on patient instruction.

To help you find what you are looking for please review the section explanations below:

Gain insight into the architecture of the PKB platform, our Data model and some of the key overarching data concepts.

Whether you are a Partner or Customer, this section will help you understand how we will help and support you develop your integration.

All the technical detail and guidance you need to be able to successfully connect to PKB endpoints. Also includes our connectivity roadmap and a troubleshooting guide.


Step by step guides for Partners and Customers to follow in order to replicate operationally valuable integration workflows.
(e.g. App integration, improve clinical pathways, develop dashboards and much more. )

All the information required for developing an HL7 feed of data into PKB can be found here. This includes a helpful “Getting Started” section, along with all the API scopes and additional information you’ll need.

If you are or intend to use FHIR to develop your integration with PKB, then this section is a must read as it acts as the PKB conformance registry with which you’ll need to be familiar


The section will explain the different FHIR endpoints PKB supports, how they operationally work together and the APIs they support. Providing explanations and examples of how to use those APIs; as well as insights into what will be supported in the future.

Use of our Customer REST APIs is being phased out and replaced with FHIR API capabilities. However, until that process is complete there are still a number of scenarios where our REST APIs provide the technical solution. This section explains how the APIs work, which APIs are available and some example usage scenarios.