From September 2022, customers will have access to a full read/write, R4 FHIR endpoint.
You can read the R4 FHIR specification here: https://www.hl7.org/fhir/R4
Access to these endpoints will be controlled by OAuth 2.0, and compatible with NHS Login SSO.
This page outlines the current capabilities deployed to production; please see our FHIR API Roadmap to learn more about upcoming changes.
PKB maintains four different types of FHIR API endpoint. Each endpoint is associated with a corresponding pot of data.
This page provides a brief overview of each endpoint type; please see the linked subpages for more information.
This is a read-only, R4 FHIR API which aggregates data from all input routes, both FHIR and non-FHIR. The aggregation will perform STU3->R4 mappings as required. PKB will iteratively build support for resources, beginning with Appointments. Complex access control applies since this contains data from multiple sources.
See here for more information.
Each customer is allocated 1 dedicated instance for each of their inbound feeds to PKB. Full read/write support for all REST interactions, for all resource types, available in customer's choice of STU3 or R4. Read/write access to each endpoint is restricted to the customer who owns it.
See here for more information.
PKB maintains a Facade FHIR endpoint which provides read-only access to FHIR representations of non-FHIR data in PKB medical records. This endpoint provides access to all data provided to PKB, whether via UI or integration, but excludes data provided directly to a Customer FHIR endpoint. Only a subset of resource types and elements are supported. Over time, external API access to this endpoint will be removed. Complex access control applies since this contains data from multiple sources.
See here for more information.
PKB exposes a dedicated endpoint to handle uploads to a custom $process-message operation.