Step 2 · Configure the Ovok project

Give nurses practitioner accounts that can create pseudonymous Patients and save readings, and note the values the kiosk needs.

A sandbox project where nurses sign in as practitioners and may create Patients and Observations. No patient accounts, and no patient sign-in.

Before you begin

  • The patient register from step 1.
  • Access to the Ovok Console as a project admin.

Set up practitioner accessConsole

  1. Create a sandbox project, or select one.
  2. Keep practitioner login on. Patient login and patient registration can stay off: no patient signs in to this kiosk.
  3. Create a practitioner access policy for kiosk staff that allows, and only allows:
    • Patient: read and create;
    • Observation: read and create.
  4. Add each nurse as a team member with that policy, or set it as the default practitioner access policy before you invite them.
  5. Confirm that the transaction bundles feature is on. The kiosk saves each reading as one transaction.

Collect the valuesConsole

The function and the kiosk need four values:

ValueWhere it comes fromUsed by
API URLhttps://api.sandbox.ovok.comBoth
Tenant codeThe project's settings in the ConsoleThe kiosk, to sign nurses in
Project idproject.id in the answer to GET /v1/auth/meThe function, to refuse other projects
Identifier systemA URL you control, such as https://kiosk.example.org/patient-idThe function, as the Patient identifier's system

The identifier system names your register. Keep it the same for the life of the project: a Patient is found by system and pseudonym together.

Verify your integration

Sign in as a nurse, then read who the token belongs to:

curl "https://api.sandbox.ovok.com/v1/auth/me" \
  -H "Authorization: Bearer {{ACCESS_TOKEN}}"

In the answer, profile.resourceType is Practitioner and project.id is the project id you noted.

Troubleshooting

  • profile.resourceType is Patient: you signed in with a patient account. Use a practitioner account.
  • The nurse cannot sign in: check that practitioner login is on and that the account belongs to this tenant.
  • Saving a reading answers 403 later: the nurse's access policy is missing Observation create.

Next step

Continue to step 3: add the patients function.

Last updated on

On this page