...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| minLevel | 1 |
|---|---|
| maxLevel | 7 |
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
...
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
| Miro macro resizing | ||
|---|---|---|
|
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
Status colour Green title Fully available OAuth2: used by the FHIR API
for customers sending dataStatus colour Green title Fully available
for customers pulling data (~ 2023 Q4)Status colour Red title In progress
for Apps and Partners sending and pulling data (~ 2023 Q4)Status colour Red title In progress
NHS Login (OpenID Connect): used by
users logging in through the UI
Status colour Green title Fully available users navigating to PKB from other sites or apps using NHS Login
Status colour Yellow title 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: Developer documentation
Get help
For customers and partners having questions about their live integration.If you have questions about using the API, or would like to set up a call to discuss integration, do email us on integrations@patientsknowbest.com.
Also, if you find a bug or think our service isn't working as expected, you can raise a helpdesk ticket by emailing help@patientsknowbest.com.
We are always updating our developer APIs with more features; subscribe to our developer blog so we can keep you posted!
...
Readiness levels
- feature is available on production environmentsStatus colour Green title Fully available
- some aspects of the feature are available on productionStatus colour Yellow title Partially available
- the feature is actively being developed, but is not yet ready for testing or useStatus colour Red title In progress
- the feature is on the roadmap or backlog, but has not yet been startedStatus colour Purple title Planned
- the feature is still being researched or discussedStatus title Exploratory