Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Link the patient using the App to their PKB record.

Why this is required

This one off process is done in order to ensure the user of the application is linked to their record in PKB and avoid the need for them to grant the application access to their PKB record every time they want to use it, the App needs its own login.

How to:

  1. Patient creates an App account

  2. The app ensures the patient login is associated with a unique app_user_id.

  3. From an appropriate screen in the application, the patient is given a link to the PKB “grant access” OAuth2.0 screens.

  4. Patient grants access using OAuth 2.0.

    1. Using the patient scoped User Client id, the patient grants access using the Authorization Code Grant workflow.

    2. The url to provide is generated as described in this page of the PKB development wiki, using the user client id and the scope of PATIENT. 

  5. Following a successful login, PKB will return an authorization code to Betawerk.

  6. Betawerk exchanges the authorization code for an access and refresh token which enable interaction with PKB REST APIs specifically for that patient.  

    1. Using the authorization code as a parameter, you’ll swap it for an access / refresh token pair.

    2. Endpoint: POST https://sandbox.patientsknowbest.com/apiToken.action

    3. Further details with parameters and examples are here.

    4. The token expiry is set to 1800 seconds (30 minutes).  

    5. The patient will only do this authorization one time.

    6. The partner will need to maintain, manage, and associate tokens with the corresponding patient record in the app.

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

    1. PKB public id using the FHIR Purview operation on PKB’s Facade FHIR API and stores it as a pair with the app_user_id. 

      1. Token endpoint: https://oauth2.sandbox.patientsknowbest.com/api/oauth/token

      2. Example is here.

    2. Demographic details, including their NHS number using a valid access token and PKB’s REST API: https://sandbox.patientsknowbest.com/json/users/self

  • No labels