Frequently requested APIs

Additional detail for the most frequently requested APIs

The tables below provide some general information about the APIs most commonly utilised by organisations extracting data from the PKB data warehouse. We recommend that customers pursuing an integration, begin by looking at utilising a combination of these as a starting point.

NB - where the scope is co-ordinator or clinician the API will only return data for which the user has team / privacy access to view.

Measurement data

Whether measurements have been added manually by a patient or clinician, directly from a device integration or via an integrated data feed, the API will return all the current and historical data for any patient that grants the organisation API access to their record.

See our help manual for details on measurement support within PKB:

https://manual.patientsknowbest.com/patient/measurements

Technical information on how data can be sent via an HL7 message feed can be found here:

http://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory

Care plans

Whether a care plan has been created manually (e.g. by a patient or clinician) or via an integrated data feed, the API will return data for all the plans (including any older versions) associated with the chosen patient.

See our help manual for information on how Care plans are supported within PKB:

https://manual.patientsknowbest.com/patient/plans

Technical information on how data can be sent via an HL7 message feed can be found here:

http://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan

Allergies

Whether allergy information has been added manually (e.g. by the patient) or via an integrated data feed, the API will return all related data for a chosen patient that the API authorising clinician has medical record access for.

See our help manual for information on how Allergy information is supported within PKB:

https://manual.patientsknowbest.com/patient/allergies

Technical information on how data can be sent via an HL7 message feed can be found here:

http://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28

Diagnosis

Whether diagnosis information has been added manually (e.g. by the patient) or via an integrated data feed, the API will return all related data for a chosen patient that the API authorising clinician has medical record access for. There is also the option to only return diagnosis data for entries entered after a chosen date.

See our help manual for information on how Diagnosis information is supported within PKB:

https://manual.patientsknowbest.com/patient/diagnoses

Technical information on how data can be sent via an HL7 message feed can be found here:

http://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28

Test Results

Whether test results have been added manually (e.g. by the patient) or have been sent in via an integrated data feed, the API will return all the available results for a chosen patient. The test result data contains identifying information for the test, along with all the related result(s) values (there may be multiple returns where a test is undertaken multiple times) and any identifying codes.

See our help manual for information on how Test result information is supported within PKB:

https://manual.patientsknowbest.com/patient/tests

Technical information on how Test result data can be sent via an HL7 message feed can be found here:

http://dev.patientsknowbest.com/home/hl7-api/messages/oru-r01/laboratory

Messages

Returns the messages sent between a patient and clinician(s) via the PKB interface. Messages are returned within the context of a conversation, which ensures that the whole conversation thread is provided.

An additional API (GET /attachments/{id}) is also available to enable the extraction of any document attachments linked to a message.

See our help manual for information on how Test result information is supported within PKB:

Patient perspective - https://manual.patientsknowbest.com/patient/events-messages

Clinician perspective - https://manual.patientsknowbest.com/professional/messages

Finding Patient PKB ID with Demographics

The API calls below make it possible to extract the demographics, basic metrics and the internal PKB ID information for an individual patient or all patients a clinician or coordinator have access to.

The internal PKB ID is a parameter required for a number of the PKB APIs, so the use of the below APIs often form part of data extraction workflows.

Technical information on how patient demographic data can be sent via an HL7 message feed can be found here:

http://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28