Frequently requested APIs

API

Brief Description

API Type

Scope

Parameters

Output Overview

GET /v2-beta/measurements

Returns all current and historical measurement data for a patient.

Utilises authorisation code granted by a patient

Option of selecting results for specific measurement(s) or returning all.

Dates of when taken and entered into PKB, along with measurement value(s) and the PKB measurement reference value..

REST

Patient

GET /v2-beta/measurements/{patientId}

The current and historical measurement field data  can be extracted for a patient.

Patient PKB ID

Measurement API Ref (e.g. medication compliance)

Dates of when taken and entered into PKB, along with measurement percentage.

REST

Clinician

GET /v2-beta/measurements/apiRefs

Returns a list of all the measurement types PKB supports within the User Interface.

n/a

Information about every measurement, such as the name, PKB reference, category and measurement unit(s) 

REST

Public

API Name

Brief Description

API Type

Scope

Parameters

Output Overview

GET /v2-beta/careplans/{patientId}

For a selected patient it returns data for all available care plans and care plan versions.

Patient PKB ID

For each care plan it will return general information such as: date created, care plan name, version No., date last edited, next review data and the associated patient id.

Data will also be provided on which user created the plan and who last edited it.

REST

Clinician

Coordinator

API Name

Brief Description

API Type

Scope

Parameters

Output Overview

GET /v2-beta/allergies/forPatient/{patientId}

Returns all recorded allergies for a chosen patient

Patient PKB ID

Information for every recorded allergy.  Including the code, name, date of onset, date entered, reactions and severity. 

REST

Clinician

API Name

Brief Description

API Type

Scope

Parameters

Output Overview

GET /v2-beta/diagnoses/forPatient/{patientId}

Returns all recorded diagnosis for a chosen patient (past and current)

Patient PKB ID

Optionally, a date can be given to only return diagnosis with an entered date from that point forward.

Information for every recorded diagnosis.  Including the code, name, date of onset, date entered, reactions and severity. 

REST

Clinician

API Name

Brief Description

API Type

Scope

Parameters

Output

GET /v1/tests/results/all

Returns all tests results for a patient

Patient selected is defined from the access code used to generate the API token.

Returns all data for every test result recorded in PKB for the patient.

Each individual test is returned and for each one the fields providing name, description, notes, result and code data are displayed.

REST

Patient

GET /v1/tests/results/forPatient/byTestIds

Returns all tests results for a patient.  NB - Filtering of results by LOINC id is supported

Patient PKB ID

Optionally - LOINC id (singular or multiple)

REST

Clinician

API Name

Brief Description

API Type

Scope

Parameters

Output

GET /messages/after/{timestamp}

Returns conversations between a patient and clinician.  Includes all messages in the thread, along with attachment details.

Message Date -  returns any conversations where a message has been sent after the specified date.

Set a limit for the number of conversation threads returned.

Conversations between the patient and all clinicians

Returns all messages in the conversation, displaying content, attachment details, sender and recipient info (including name) and message status 

REST

Patient

Conversations between the clinician and any patients. Returns the same message data as above.

Clinician

API Name

Brief Description

API Type

Scope

Parameters

Output

GET /v2-beta/users/byNationalId/{nationalId}/{nationalIdType}

Returns the PKB id, patient metrics and demographics for a chosen patient. Note - can support searching across the whole org or network with coordinator scoped access.

Patient national identifier (e.g. NHS number)

Internal PKB ID

Patient metrics such as height and weight.

Patient demographics including name, dob, address, contact details (i.e. email, phone number), gender, date deceased (where applicable)

REST

Patient

Clinician

Coordinator

GET /v1/users/self/patients

Returns the PKB id, patient metrics and demographics for all patient records in their list of accessible patient records.

n/a - as derived by the access to data defined by the Scope (e.g all patient records a coordinator has access to).

Internal PKB ID

Patient metrics such as height and weight.

Patient demographics including name, dob, address, contact details (i.e. email, phone number), gender, date deceased (where applicable)

REST

Clinician

Coordinator