FHIR API Connectivity

Status	ACTIVE
Since	28. August, 2024
Document version	1

This page outlines connectivity to PKB’s FHIR API which allows clients to send and access data in FHIR format.

TODO: add link to legacy FHIR API

This covers AQS.

Overview

We are in the process of consolidating our FHIR APIs. During this transitional period different resources6operations will be available via different/multiple endpoints.

Currently, we have four different endpoints:

Aggregated endpoint READ-ONLY ,
Customer read/write endpoint READ/WRITE ,
Facade read-only FHIR READ-ONLYDEPRECATING,
Demographics write-only FHIR endpoint WRITE DEPRECATING .

Connectivity wise

Aggregated and Customer endpoint in pair and
Facade and Demographics endpoint in another pair

are exposed via the same ingress routes, hence they share some key parameters.

TODO: Add links to the API docs of these endpoints ?

Testing

Sandbox

Click to expand for more details on FHIR endpoints grouped by ingress type on Sandbox

Aggregated/Customer

Base URLs

Aggregated	https://aggregated-fhir.sandbox.patientsknowbest.com
Customer	`https://<customer>.sandbox.patientsknowbest.com`

Commonalities

Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Certificate Issuer
Subject CN	`*.patientsknowbest.com`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.

Facade / Demographics

Base URLs

Aggregated	https://aggregated-fhir.sandbox.patientsknowbest.com
Customer	`https://<customer>.sandbox.patientsknowbest.com`

Commonalities

Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Certificate Issuer
Subject CN	`*.patientsknowbest.com`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.

Production

EDU

Click to expand for more details on FHIR endpoints grouped by ingress type on Sandbox

Aggregated/Customer

Base URLs

Aggregated	https://aggregated-fhir.sandbox.patientsknowbest.com
Customer	`https://<customer>.sandbox.patientsknowbest.com`

Commonalities

Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Certificate Issuer
Subject CN	`*.patientsknowbest.com`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.

Facade / Demographics

Base URLs

Aggregated	https://aggregated-fhir.edu.patientsknowbest.com
Customer	`https://<customer>.edu.patientsknowbest.com`

Commonalities

Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	`TLSv1.2`, `TLSv1.3`
Certificate Issuer
Subject CN
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.

Click to expand for more details on edu

URL
Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	`TLSv1.2`, `TLSv1.3`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.

EU

Click to expand for more details on eu

URL	https://aggregated-fhir.eu.patientsknowbest.com
Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	`TLSv1.2`, `TLSv1.3`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.

UK

Click to expand for more details on eu

URL	https://aggregated-fhir.uk.patientsknowbest.com
Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	`TLSv1.2`, `TLSv1.3`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.