Explore
For customers and partners who are
planning to integrate with PKB
looking to understand PKB’s capabilities, existing and upcoming functionality
evaluating PKB’s' technical and feature roadmap to schedule collaboration
Data flow – start here to understand how and what data flows into and from PKB
Data ingress (sending data to PKB) and egress (querying data from PKB) flows always look the same, independent of the actual implementation of the components.
Client → Interface → Authentication → Authorisation → PKB aggregated record
Client:
Customer: an organisation who interacts with PKB on their own behalf
Partner: who interacts with PKB on behalf of a customer
App: interacts with PKB APIs on behalf of a registered PKB user.
Interface:
HL7
Messaging-based, details: HL7 API
FHIR
REST-based, details: FHIR® APIs
Authentication:
HTTP Basic + IP filtering: used by the HL7 API FULLY AVAILABLE
OAuth2: used by the FHIR API
FULLY AVAILABLE for customers sending data
IN PROGRESS for customers pulling data (~ 2023 Q4)
IN PROGRESS for Apps and Partners sending and pulling data (~ 2023 Q4)
NHS Login (OpenID Connect): used by
users logging in through the UI FULLY AVAILABLE
users navigating to PKB from other sites or apps using NHS Login PARTIALLY AVAILABLE
Authorisation
See https://manual.patientsknowbest.com/ to learn more about PKB’s business rules governing access control.
Build
For customers and partners already collaborating with PKB.
Start here: https://wiki.patientsknowbest.com/space/api/3364093979/Developer+documentation
Get help
For customers and partners having questions about their live integration.
Readiness levels
FULLY AVAILABLE - feature is available on production environments
PARTIALLY AVAILABLE - some aspects of the feature are available on production
IN PROGRESS - the feature is actively being developed, but is not yet ready for testing or use
PLANNED - the feature is on the roadmap or backlog, but has not yet been started
EXPLORATORY - the feature is still being researched or discussed