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 resources will be available via different/multiple endpoints/URLs.

Currently, we have four different URLsendpoints:

  • Aggregated read-only endpoint,

  • Customer read/write endpoint,

  • Facade read-only FHIR

    Status
    colourRed
    titledeprecating
    ,

  • Demographics write-only FHIR endpoint

    Status
    colourRed
    titledeprecating
    .

Connectivity wise, these endpoints are exposed using only two policies.

  • Aggregated and / Customer endpoints ,and

  • Facade FHIR and / Demographics FHIR endpoints

in pair use the same same policiesparameters.

Aggregated

Each customer is allocated 1 dedicated FHIR instance for each of their inbound FHIR feeds to PKB.
Full read/write support for all REST interactions, for all resource types, available in customer's choice of STU3 or R4. Read/write access to each endpoint is restricted to the customer who owns it.

Customer

This is a read-only, R4 FHIR API which aggregates data from all input routes, both FHIR and non-FHIR. The aggregation will perform STU3->R4 mappings as required. Complex access control applies since this contains data from multiple sources.

Legacy

PKB maintains a Facade FHIR endpoint which provides read-only access to:

  • FHIR representations of non-FHIR data in PKB medical records (for data types not yet supported by the Aggregated FHIR endpoint). For example, data received via our HL7 API can be queried using this endpoint.

  • The aggregation of both FHIR and non-FHIR data (for data types supported by the Aggregated FHIR endpoint).

Only a subset of resource types and elements are supported. Complex access control applies since this contains

$process-message

PKB maintains a dedicated endpoint at /phr-fhir which exposes a single, custom operation, designed to allow a Messaging-like way of creating new patients
Warning

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

Testing

Sandbox

Expand
titleClick to expand for more details on Sandbox

URL

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

Address

Insert excerpt
IP addresses
IP addresses
namesandbox-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

Production

EDU

Expand
titleClick to expand for more details on edu

URL

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

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