Canonical: http://fhir.patientsknowbest.com
Quick Start
This is the home of our Implementation Guide, which explains everything you need to know in order to interact with the API.
PKB is committed to external interoperability by making all our data available via FHIR compliant REST APIs.
To this end we are currently building out our FHIR API and migrating away from our current custom implementation. Our new single page application based UI is already using the new FHIR API to communicate with our backend. We are implementing resources iteratively in response to prioritised requirements. New resources (and new elements within already supported resources) will be added as needed. Resources in production can be seen here. Resources under development are listed here.
If you would like us to support something not yet documented, or if you have any other questions, please get in touch via help@patientsknowbest.com.
FHIR® overviewFast Healthcare Interoperability Resources (FHIR, pronounced "fire") is an open standard which governments are increasingly adopting. FHIR describes data formats and elements (known as "resources") and an application programming interface (API) for exchanging electronic health records. NHS England is rapidly including this in its contracting. Developers find the standard easy to learn, and learning a standard is easier than learning different companies' proprietary APIs.In October 2017, we began providing open FHIR API versions of all our existing proprietary REST API work. All our FHIR APIs will be for reading and writing, and PKB's front-end user interface will use these FHIR APIs to communicate with PKB's back-end database. See https://www.hl7.org/fhir/STU3/ for the FHIR specification (Release 3). How to read this Implementation GuideThis Implementation Guide is divided into several sections. You can navigate through these sections using the subpage navigation.A popular section is PKB's FHIR Resource mappings, which explain which Resource types we support, and how our own Data Model maps into the FHIR data model. Each FHIR Resource supported by PKB has its own dedicated section underneath the Resources page. For each FHIR Resource, the documentation will provide the following:
OAuth 2.0The majority of FHIR resources supported by PKB require the user to authenticate by providing an OAuth 2.0 bearer token.Please see our OAuth 2.0 documentation for more information on how to use our authentication workflow to obtain a token. Breaking changesClients of the FHIR API should be aware that PKB will continually and incrementally improve the API over time. There are many changes which we might make that we do not consider to be breaking changes.Changes we reserve the right to make include (but are not limited to):
Integration patternsThe PKB FHIR API supports two different integration paradigms: REST and Messaging.We already support the REST paradigm and are using this as a communication mechanism for our new SPA UI. Our plan is to add an asynchronous messaging paradigm to support external customers sending and receiving data. The table below outlines a few key differences along with some pointers for implementation considerations.
|