Page Comparison

Readiness levels

• Status
  colour Green title Fully available

  - feature is considered ready and fully usable

• Status
  colour Yellow title Partially available

  - some aspects of the feature is available and usable

• Status
  colour Red title In progress

  - the feature is actively being developed, but is not yet ready for testing or use.

• Status
  colour Purple title Planned

  - the feature is on the roadmap or backlog, but has not yet been started.

• Status
  title Exploratory

  - the feature is still being researched or discussed

EXPLORE

For customers and partners who are

...

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

  • Details here: https://pkbdev.atlassian.net/wiki/spaces/api/pages/3364093979/Developer+documentation#Customer

• Partner: who interacts with PKB on behalf of a customer

  • Details here: https://pkbdev.atlassian.net/wiki/spaces/api/pages/3364093979/Developer+documentation#Partner

• App: interacts with PKB APIs on behalf of a registered PKB user.

  • Details here: https://pkbdev.atlassian.net/wiki/spaces/api/pages/3364093979/Developer+documentation#App

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

  • Status
    colour Green title Fully available

    for customers sending data

  • Status
    colour Red title In progress

    for customers pulling data (~ 2023 Q4)

  • Status
    colour Red title In progress

    for Apps and Partners sending and pulling data (~ 2023 Q4)

• 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.

...

For customers and partners having questions about their live integration.

Readiness levels

• Status
  colour Green title Fully available

  - feature is considered ready and fully usable

• Status
  colour Yellow title Partially available

  - some aspects of the feature is available and usable

• Status
  colour Red title In progress

  - the feature is actively being developed, but is not yet ready for testing or use.

• Status
  colour Purple title Planned

  - the feature is on the roadmap or backlog, but has not yet been started.

• Status
  title Exploratory

  - the feature is still being researched or discussed