Versions Compared

Old Version 27

changes.mady.by.user Tamás Utasi

Saved on

compared with

New Version 28

changes.mady.by.user Tamás Utasi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status

Status
colourGreen
titleActive

Since

28. August, 2024

Document version

1

Table of Contents
stylenone

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
    colourBlue
    titleread-only
    *,

  • Customer read/write endpoint

    Status
    colourYellow
    titleREAD/WRITE
    ,

  • Facade read-only FHIR

    Status
    colourBlue
    titleread-only
    Status
    colourRed
    titledeprecating
    ,

  • Demographics write-only FHIR endpoint

    Status
    colourYellow
    titleWRITE
    Status
    colourRed
    titledeprecating
    .

Warning

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.

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

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.

Testing

Sandbox

Expand
titleClick 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
namesandbox-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

aggregated-fhir.sandbox.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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
namesandbox-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

aggregated-fhir.sandbox.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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
namesandbox-public-custom-nginx-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

sandbox.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-custom-nginx-cipher-suites
nopaneltrue

Production

EDU

Expand
titleClick 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
nameedu-prod-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

aggregated-fhir.edu.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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
nameedu-prod-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

<customer>.edu.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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
nameedu-prod-public-custom-nginx-ip
nopaneltrue

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
namedefault-custom-nginx-cipher-suites
nopaneltrue

EU

Expand
titleClick to expand for more details on Aggregated FHIR endpoint on UK

Aggregated

URL

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

Address

Insert excerpt
IP addresses
IP addresses
nameeu-prod-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

aggregated-fhir.eu.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick to expand for more details on Customer FHIR endpoint on UK

Customer

URL

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

Address

Insert excerpt
IP addresses
IP addresses
nameeu-prod-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

<customer>.eu.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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

Insert excerpt
IP addresses
IP addresses
nameeu-prod-public-custom-nginx-ip
nopaneltrue

Supported TLS versions

TLSv1.2, TLSv1.3

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

eu.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-custom-nginx-cipher-suites
nopaneltrue

UK

Expand
titleClick 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
nameuk-prod-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

aggregated-fhir.uk.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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
nameuk-prod-public-ingress-ip
nopaneltrue

Supported TLS versions

Insert excerpt
TLS parameters
TLS parameters
namesupported-tls-versions
nopaneltrue

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

<customer>.uk.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick 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
nameuk-prod-public-custom-nginx-ip
nopaneltrue

Supported TLS versions

TLSv1.2, TLSv1.3

Certificate Issuer

Insert excerpt
TLS parameters
TLS parameters
namele-cas
nopaneltrue

Subject CN

uk.patientsknowbest.com

Supported cipher suites

Insert excerpt
Supported cipher suites by ingress types
Supported cipher suites by ingress types
namedefault-custom-nginx-cipher-suites
nopaneltrue