Status |
| ||||||
|---|---|---|---|---|---|---|---|
Since | 28. August, 2024 | ||||||
Document version | 1 |
| Table of Contents | ||
|---|---|---|
|
Overview
We are in the process of consolidating our FHIR APIs. During this transitional period different
...
FHIR resources and operations will be available via different/multiple endpoints. The PKB integrations team will support you in identifying which environment(s) you will need to use to meet the objectives of your PKB integration.
Currently, we have four different endpoints, you will find connectivity details for each within each “Environment” page :
Aggregated endpoint
*,Status colour Blue title read-only Customer read/write endpoint
,Status colour Yellow title READ/WRITE Facade read-only FHIR
Status colour Blue title read-only
,Status colour Red title deprecating Demographics write-only FHIR endpoint
Status colour Yellow title WRITE
.Status colour Red title deprecating
| Warning |
|---|
TODO: Add links to the API docs of these endpoints ? |
Connectivity wise
Aggregated and Customer endpoint
...
are a pair
...
Facade and Demographics endpoint
...
are a pair
they are exposed via the same ingress routes, hence they share some key parameters.
...
| Warning |
|---|
TODO: Add links to the API docs of these endpoints ? |
Testing
Sandbox
...
| title | Click to expand for more details on Aggregated FHIR endpoint on Sandbox |
|---|
Aggregated
...
URL
...
https://aggregated-fhir.sandbox.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
aggregated-fhir.sandbox.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Customer FHIR endpoints on Sandbox |
|---|
Customer
...
URL
...
https://<customer>.sandbox.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
aggregated-fhir.sandbox.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Facade / Demographics FHIR endpoints on Sandbox |
|---|
Facade / Demographics
Base URLs
...
Facade
...
https://sandbox.patientsknowbest.com/fhir
...
Demographics
...
https://sandbox.patientsknowbest.com/phr-fhir
Commonalities
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
sandbox.patientsknowbest.com
...
Supported cipher suites
...
Production
EDU
...
| title | Click to expand for more details on Aggregated FHIR endpoint on EDU |
|---|
Aggregated
...
URL
...
https://aggregated-fhir.edu.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
aggregated-fhir.edu.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Customer FHIR endpoint on EDU |
|---|
Customer
...
URL
...
https://<customer>.edu.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
<customer>.edu.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Facade / Demographics FHIR endpoints on EDU |
|---|
Facade / Demographics
Base URLs
...
Aggregated
...
https://edu.patientsknowbest.com/fhir
...
Customer
...
https://edu.patientsknowbest.com/phr-fhir
Commonalities
...
Address
...
Supported TLS versions
...
TLSv1.2, TLSv1.3
...
Certificate Issuer
...
Subject CN
...
Supported cipher suites
...
EU
...
| title | Click to expand for more details on Aggregated FHIR endpoint on EU |
|---|
Aggregated
...
URL
...
https://aggregated-fhir.eu.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
aggregated-fhir.eu.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Customer FHIR endpoint on EU |
|---|
Customer
...
URL
...
https://<customer>.eu.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
<customer>.eu.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Facade / Demographics FHIR endpoints on EU |
|---|
Facade / Demographics
Base URLs
...
Aggregated
...
https://eu.patientsknowbest.com/fhir
...
Customer
...
https://eu.patientsknowbest.com/phr-fhir
Commonalities
...
Address
...
Supported TLS versions
...
TLSv1.2, TLSv1.3
...
Certificate Issuer
...
Subject CN
...
eu.patientsknowbest.com
...
Supported cipher suites
...
UK
...
| title | Click to expand for more details on Aggregated FHIR endpoint on EU |
|---|
Aggregated
...
URL
...
https://aggregated-fhir.uk.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
aggregated-fhir.uk.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Customer FHIR endpoint on EU |
|---|
Customer
...
URL
...
https://<customer>.uk.patientsknowbest.com
...
Address
...
Supported TLS versions
...
Certificate Issuer
...
Subject CN
...
<customer>.uk.patientsknowbest.com
...
Supported cipher suites
...
| title | Click to expand for more details on Facade / Demographics FHIR endpoints on EU |
|---|
Facade / Demographics
Base URLs
...
Aggregated
...
https://uk.patientsknowbest.com/fhir
...
Customer
...
https://uk.patientsknowbest.com/phr-fhir
Commonalities
...
Address
...
Supported TLS versions
...
TLSv1.2, TLSv1.3
...
Certificate Issuer
...
Subject CN
...
uk.patientsknowbest.com
...
Supported cipher suites
...
Advanced Questionnaire Service (AQS)
| Note |
|---|
AQS is an operation that violates the read-only contract on Aggregated FHIR endpoint by design. |
If you are trying to use AQS, then connectivity wise, please look for details of Aggregated FHIR endpoint.
Available Environments
Sandbox (Testing)
PKB provides a Sandbox on a Public connection to support the testing / development activity of customers and partners using the PKB APIs.
Connectivity details for the PKB Sandbox environment can be found on the PKB Sandbox page
Production
PKB has 3 different FHIR supported Production environments and customers / partners will be required to connect to the correct one depending on the nature of their PKB activity.
UK
PKB support both a Public and HSCN connection on this endpoint, customers will be asked to choose which one they intend to use.
Intended for integrations where the patients are being cared for within the UK.
EU
Intended for integrations where the patients are being cared for outside of the UK.
EDU
Intended for integrations where PKB is being used as an educational tool.