Overall direction of travel
Each customer who wishes to interact with PKB using FHIR endpoints will eventually use just two different endpoints:
Customer Endpoint
Aggregated Endpoint
Customer Endpoint
This will be a dedicated FHIR REST endpoint with an underlying data store. The customer will have full read/write access to the data store, using their choice of either STU3 or R4.
What you can do with this endpoint:
Read/write all standard FHIR resources
What you cannot do with this endpoint:
Read data from other sources
Aggregated Endpoint
This is a read-only, R4 endpoint which all customers can use to fetch data which has been added to the aggregated data store.
What you can do with this endpoint:
Read data from other sources, even if it was provided in non-FHIR format
What you cannot do with this endpoint:
Write data
Read resource types that have not been included in PKB's aggregation logic. Please see the Aggregated Endpoint documentation for a list of which resource types have been included so far.
Read resources that you do not have authorisation to see. For example, a resource from a different organisation tagged with a privacy label that has not been granted to the caller.
Current status
Please see our FHIR overview page for details on the current FHIR endpoints.
We currently support two additional endpoints which expose data/actions that have not yet been moved over to the Aggregated Endpoint.