FHIR API - Network Connectivity

Status	ACTIVE
Since	28. August, 2024
Document version	1

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.

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

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.

Advanced Questionnaire Service (AQS)

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.

Testing

Sandbox

Click to expand for more details on Aggregated FHIR endpoint on Sandbox

Aggregated

URL	https://aggregated-fhir.sandbox.patientsknowbest.com
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`aggregated-fhir.sandbox.patientsknowbest.com`
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 Customer FHIR endpoints on Sandbox

Customer

URL	`https://<customer>.sandbox.patientsknowbest.com`
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`aggregated-fhir.sandbox.patientsknowbest.com`
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 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	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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`sandbox.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 Aggregated FHIR endpoint on EDU

Aggregated

URL	https://aggregated-fhir.edu.patientsknowbest.com
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`aggregated-fhir.edu.patientsknowbest.com`
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 Customer FHIR endpoint on EDU

Customer

URL	`https://<customer>.edu.patientsknowbest.com`
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`<customer>.edu.patientsknowbest.com`
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 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	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'.

EU

Click to expand for more details on Aggregated FHIR endpoint on UK

Aggregated

URL	https://aggregated-fhir.eu.patientsknowbest.com
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`aggregated-fhir.eu.patientsknowbest.com`
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 Customer FHIR endpoint on UK

Customer

URL	`https://<customer>.eu.patientsknowbest.com`
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`<customer>.eu.patientsknowbest.com`
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 Facade / Demographics FHIR endpoints on UK

Facade / Demographics

Base URLs

Aggregated	https://eu.patientsknowbest.com/fhir
Customer	https://eu.patientsknowbest.com/phr-fhir

Commonalities

Address	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	`TLSv1.2`, `TLSv1.3`
Certificate Issuer	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`eu.patientsknowbest.com`
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 Aggregated FHIR endpoint on EU

Aggregated

URL	https://aggregated-fhir.uk.patientsknowbest.com
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`aggregated-fhir.uk.patientsknowbest.com`
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 Customer FHIR endpoint on EU

Customer

URL	`https://<customer>.uk.patientsknowbest.com`
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	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`<customer>.uk.patientsknowbest.com`
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 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	Error rendering macro 'excerpt-include' : No link could be created for 'IP addresses'.
Supported TLS versions	`TLSv1.2`, `TLSv1.3`
Certificate Issuer	Error rendering macro 'excerpt-include' : No link could be created for 'TLS parameters'.
Subject CN	`uk.patientsknowbest.com`
Supported cipher suites	Error rendering macro 'excerpt-include' : No link could be created for 'Supported cipher suites by ingress types'.