Page Comparison

Facade

Messaging

Customer

Aggregated

Customer

Authentication →

HL7 Org Credentials

N/A

N/A

N/A

Customer System Client

Send data

A Customer can send data to PKB using the HL7 v2 API.

A Customer cannot interact with the Custom REST API.

A Customer cannot interact with the Facade FHIR endpoint.

A Customer cannot interact with the Messaging FHIR endpoint.

A Customer can send any FHIR resource to a Customer FHIR endpoint.

Data cannot be sent to the Aggregated FHIR endpoint.

Read demographic data

A Customer can query patient demographics using the HL7 v2 API.

See: QRY A19

Any demographic data a Customer has sent to their FHIR endpoint can be read back from the same endpoint.

A Customer can read data from the Aggregated FHIR endpoint.

This is the only endpoint that exposes data sent to a Customer FHIR endpoint (apart from a Customer’s ability to query their own data from their own Customer FHIR endpoint).

Read clinical data

A Customer cannot read clinical data from the HL7 v2 API.

Any data a Customer has sent to their FHIR endpoint can be read back from the same endpoint.

Read clinical data from others

A Customer FHIR endpoint only contains data from the owning Customer.

Partner

Authentication →

HL7 Partner Credentials

Tethered-Token System Client

System Client

Pending

Pending

Send data

A Partner can send data to PKB using the HL7 v2 API.

A Partner can send and read data using the endpoints available in our Custom REST API.

Data cannot be written to the Facade endpoint.

A Partner can create or update a Patient resource.

See: Process message

Pending

Data cannot be sent to the Aggregated FHIR endpoint.

Read demographic data

A Partner can query patient demographics using the HL7 v2 API.

See: QRY A19

A Partner can read data from the Facade FHIR endpoint.

Data cannot be read from the Messaging FHIR endpoint.

Pending

Read clinical data

A Partner cannot read clinical data from the HL7 v2 API.

Read clinical data from others

App

Authentication →

N/A

User Client

N/A

Pending

Pending

Send data

An App cannot interact with the HL7 API.

An App can send and read data using the endpoints available in our Custom REST API.

Data cannot be written to the Facade endpoint.

An App cannot interact with the Messaging FHIR endpoint.

Pending

Data cannot be sent to the Aggregated FHIR endpoint.

Read demographic data

An App can read data from the Facade FHIR endpoint.

An App can read data from the Aggregated FHIR endpoint.

Read clinical data

Read clinical data from others