What

Enables you to pull back a patient’s PKB public ID and / or a patient’s demographic details, including national identifiers held in PKB.

Prerequisites

• A patient scoped access token.

How to

Using a valid Patient scoped access token, the partner application pulls the patient’s details. There are a few options, two of which are outlined below, and the best option depends on what the partner use case is.

• PKB public id using the FHIR Purview operation on PKB’s Facade FHIR API. Example request is here, and an example response is below.

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "purview",
            "valueReference": {
                "reference": "Patient/1d4a8b2d-f885-499f-ba51-50600312f316"
            }
        }
    ]
}

• Demographic details, including any identifiers (national/local) in the PKB record, using PKB’s REST API. Example response is here (/users/self). Example request below.

curl --location 'https://sandbox.patientsknowbest.com/json/users/self' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer LtftuUgRkYTl3QC9-DpQ3rDvZN09i3s0'