...
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.
...
Note: although a Customer can read all the data they send to a Customer FHIR endpoint directly from that same endpoint, the Aggregated FHIR endpoint is the only mechanism by which others (including the patient) can read that data.
See here for more information.
Customer FHIR endpoints
Each customer is allocated 1 dedicated instance for each of their inbound FHIR 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.
Note: although a Customer can read all the data they send to a Customer FHIR endpoint directly from that same endpoint, the Aggregated FHIR endpoint is the only mechanism by which others (including the patient) can read that data.
See here for more information.
Facade FHIR endpoint
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.
Messaging FHIR endpoint
PKB exposes a dedicated endpoint to handle uploads to a custom $process-message operation.