Custom REST API

Owned by Andrew Turner (Unlicensed)
Last updated: Dec 04, 2024 by Sara Muse
1 min read

The Custom REST API allows developers to quickly and easily interact with PKB functionality in a programmatic way, including accessing patient medical records. We are currently in the process of moving to a FHIR compliant REST API.

Quick start

Specification

Please see here for our auto-generated Swagger documentation.

Test with Postman

There are many tools available to test REST APIs; we've had good experiences working with Postman: http://www.postman.com

Example

This example demonstrates how to search for a patient's diagnoses based on their known PKB ID.

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: aaaaa-bbbbb

  2. Confirm the PKB ID of the patient whose appointments you want to search for

    1. The example below assumes a PKB ID of: 123

  3. Make the call as detailed below, replacing the access token and PKB ID with your own values

  4. The patient's diagnoses will be returned in the response

Example request

This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.

curl -X GET --header "Accept: application/json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/json/v2-beta/diagnoses/forPatient/123"