High level overview of available APIs

The table below provides an “at a glance” list of the patient record data points held within the PKB data warehouse, that can in some capacity be extracted using an API.

The table does not provide detail on exactly what fields are returned, the parameters that can be used to filter results or the Scope that defines the context within which an API can be used. It is only intended to be a general overview for any customer or partner interested in acquiring a general understanding at a very high level.

Data Points

API Type(s) Available

Demographics and Identifiers

HL7, FHIR and Proprietary REST

Measurements

Proprietary REST

Allergies

Proprietary REST

Diagnosis

Proprietary REST

Medication

Proprietary REST

Symptoms

Proprietary REST

Test (lab) Results

Proprietary REST and FHIR

Radiology Reports

FHIR

Care (Treatment) Plans

Proprietary REST

Consent

Proprietary REST and FHIR

Messages

Proprietary REST and FHIR

Encounters

Proprietary REST and FHIR

Appointments

Proprietary REST and FHIR

Documents

Proprietary REST and FHIR

Registration Status

FHIR and HL7

Read Receipt Queries

FHIR

Invitation Tokens

FHIR

Access Tokens

Proprietary REST

One Time Passwords (SSO support)

Proprietary REST

Date of Last Data Point

FHIR

Questionnaire Responses

FHIR

 

© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.

This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.