Versions Compared

Key

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

Status

Status
colourGreen
titleActive

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.

Warning

TODO: add link to legacy FHIR API

Info

This covers AQS.

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
    .

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 ?

Table of Contents
stylenone

Status

Status
colourGreen
titleActive

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.

Warning

TODO: add link to legacy FHIR API

Info

This covers AQS.

Testing

Sandbox

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

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

Subject CN

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

Facade / Demographics

Base URLs

Aggregated

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

Customer

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

Commonalities

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

Subject CN

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

Production

EDU

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

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

Subject CN

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

Facade / Demographics

Base URLs

Aggregated

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

Customer

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

Commonalities

Address

Insert excerpt
IP addresses
IP addresses
nameedu-prod-public-ingress-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-public-nginx-cipher-suites
nopaneltrue

Expand
titleClick to expand for more details on edu

URL

Address

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

Supported TLS versions

TLSv1.2, TLSv1.3

Supported cipher suites

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

EU

Expand
titleClick to expand for more details on eu

URL

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

Address

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

Supported TLS versions

TLSv1.2, TLSv1.3

Supported cipher suites

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

UK

Expand
titleClick to expand for more details on eu

URL

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

Address

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

Supported TLS versions

TLSv1.2, TLSv1.3

Supported cipher suites

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