---
title: "System Overview"
canonical: "https://wiki.patientsknowbest.com/space/api/3675881497/System%20Overview"
format: markdown
---
> Macro (toc)

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.

<span style="color: #4c9aff">Client</span><span style="color: #006644"> → </span><span style="color: #36b37e">Interface</span><span style="color: #006644"> </span>→ <span style="color: #6554c0">Authentication</span> → <span style="color: #ffc400">Authorisation</span><span style="color: #403294"> → </span><span style="color: #00b8d9">PKB aggregated record</span>


> Macro (viewpdf)

# <span style="color: #4c9aff">Client</span> 

- Customer: an organisation who interacts with PKB on their own behalf
  - Details here: [https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364093979/Planning+Your+PKB+Integration#Customer](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364093979/Planning+Your+PKB+Integration#Customer)
- Partner: who interacts with PKB on behalf of a customer
  - Details here: [https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364093979/Planning+Your+PKB+Integration#Partner](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364093979/Planning+Your+PKB+Integration#Partner)
- App: interacts with PKB APIs on behalf of a registered PKB user.
  - Details here: [https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364093979/Planning+Your+PKB+Integration#App](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364093979/Planning+Your+PKB+Integration#App)

# <span style="color: #36b37e">Interface</span>

- HL7
  - Messaging-based, details: [https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012127](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012127)
- FHIR
  - REST-based, details: [https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363602489](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3363602489)

# <span style="color: #6554c0">Authentication</span>

- 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]

# <span style="color: #ffc400">Authorisation</span>

See [https://manual.patientsknowbest.com/](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](https://wiki.patientsknowbest.com/space/api/3364093979/Developer+documentation)

# Get Help

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](mailto: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](mailto:help@patientsknowbest.com).

We are always updating our developer APIs with more features; [subscribe to our developer blog](http://www.google.com/url?q=http%3A%2F%2Fdevblog.patientsknowbest.com%2F&sa=D&sntz=1&usg=AOvVaw2uALa-klAhTubWNMzOve6z) so we can keep you posted!

# 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