Page Comparison

Status

Status

colour	Green
title	Active

Since

28. August, 2024

Document version

1

Table of Contents

style	none

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

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.

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

Testing

Sandbox

Expand

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

Aggregated

URL

https://aggregated-fhir.sandbox.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	sandbox-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

aggregated-fhir.sandbox.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

title	Click to expand for more details on Customer FHIR endpoints on Sandbox

Customer

URL

https://<customer>.sandbox.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	sandbox-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

aggregated-fhir.sandbox.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

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

Insert excerpt

	IP addresses
	IP addresses
name	sandbox-public-custom-nginx-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

sandbox.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-custom-nginx-cipher-suites
nopanel	true

Production

EDU

Expand

title	Click to expand for more details on Aggregated FHIR endpoint on EDU

Aggregated

URL

https://aggregated-fhir.edu.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	edu-prod-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

aggregated-fhir.edu.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

title	Click to expand for more details on Customer FHIR endpoint on EDU

Customer

URL

https://<customer>.edu.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	edu-prod-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

<customer>.edu.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

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

Insert excerpt

	IP addresses
	IP addresses
name	edu-prod-public-custom-nginx-ip
nopanel	true

Supported TLS versions

TLSv1.2, TLSv1.3

Certificate Issuer

Subject CN

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-custom-nginx-cipher-suites
nopanel	true

EU

Expand

title	Click to expand for more details on Aggregated FHIR endpoint on EUUK

Aggregated

URL

https://aggregated-fhir.eu.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	eu-prod-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

aggregated-fhir.eu.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

title	Click to expand for more details on Customer FHIR endpoint on EUUK

Customer

URL

https://<customer>.eu.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	eu-prod-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

<customer>.eu.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

title	Click to expand for more details on Facade / Demographics FHIR endpoints on EUUK

Facade / Demographics

Base URLs

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

Commonalities

Address

Insert excerpt

	IP addresses
	IP addresses
name	eu-prod-public-custom-nginx-ip
nopanel	true

Supported TLS versions

TLSv1.2, TLSv1.3

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

eu.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-custom-nginx-cipher-suites
nopanel	true

UK

Expand

title	Click to expand for more details on Aggregated FHIR endpoint on EU

Aggregated

URL

https://aggregated-fhir.uk.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	uk-prod-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

aggregated-fhir.uk.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

title	Click to expand for more details on Customer FHIR endpoint on EU

Customer

URL

https://<customer>.uk.patientsknowbest.com

Address

Insert excerpt

	IP addresses
	IP addresses
name	uk-prod-public-ingress-ip
nopanel	true

Supported TLS versions

Insert excerpt

	TLS parameters
	TLS parameters
name	supported-tls-versions
nopanel	true

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

<customer>.uk.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-public-nginx-cipher-suites
nopanel	true

Expand

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

Insert excerpt

	IP addresses
	IP addresses
name	uk-prod-public-custom-nginx-ip
nopanel	true

Supported TLS versions

TLSv1.2, TLSv1.3

Certificate Issuer

Insert excerpt

	TLS parameters
	TLS parameters
name	le-cas
nopanel	true

Subject CN

uk.patientsknowbest.com

Supported cipher suites

Insert excerpt

	Supported cipher suites by ingress types
	Supported cipher suites by ingress types
name	default-custom-nginx-cipher-suites
nopanel	true

Versions Compared

Old Version 26

New Version 27

Key

Overview

Testing

Sandbox

Aggregated

Customer

Facade / Demographics

Production

EDU

Aggregated

Customer

Facade / Demographics

EU

Aggregated

Customer

Facade / Demographics

UK

Aggregated

Customer

Facade / Demographics