Users

Update user consents

Update user consents using Ovok’s Slim API.

MethodPath
POST/v1/slim/user/consents

Authentication · Access policies

Updates one or more consents of the signed-in practitioner. Use it to save the answers of a combined consent prompt.

Auth: Bearer token for a practitioner session (the profile must be a Practitioner). The caller's access policy must grant Consent:read, Consent:search, Consent:create and Consent:update (project admins skip this check). Scope: The caller's practitioner profile in the caller's project (from the token).

Request

Body

NameTypeRequiredDescription
medicalSettingsNotificationsConsentbooleanNotrue accepts the currently published medical settings and notifications consent. false withdraws it. Omit to leave it unchanged.
termsAndConditionsConsentbooleanNotrue accepts the currently published terms and conditions. false withdraws the acceptance. Omit to leave it unchanged.

At least one of the two fields is required. null and other types are refused.

Behaviour

  • Send at least one of medicalSettingsNotificationsConsent and termsAndConditionsConsent. Only the fields you send change.
  • true records acceptance of the currently published version of that consent. false withdraws it.
  • A termsAndConditionsConsent change also creates, re-activates or revokes the legal Consent read by GET /v1/me/consent/legal.
  • All changes commit together or not at all. Repeating the same values writes nothing.
  • The consent answers of /v1/me/consent/* are refreshed right away.
  • The response always carries the resulting state of every consent.

Example

curl -X POST 'https://api.sandbox.ovok.com/v1/slim/user/consents' \
  -H "Authorization: Bearer ${OVOK_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d '{ "medicalSettingsNotificationsConsent": true, "termsAndConditionsConsent": true }'

Successful response

201 — Consent statuses updated successfully.

{
  "medicalSettingsNotificationsConsent": true,
  "termsAndConditionsConsent": true
}
FieldTypeDescription
medicalSettingsNotificationsConsentbooleanThe resulting state: the value you sent, or the unchanged state when you omitted it.
termsAndConditionsConsentbooleanThe resulting state: the value you sent, or the unchanged state when you omitted it.

Errors

StatusMeaning
400The FHIR server refused the consent write.
401The bearer token is missing or invalid.
403The session is not a practitioner session, has no project, or its access policy lacks one of the Consent interactions.
409The consent write lost a conflict with a concurrent write. Retry.
422The body fails validation, for example a value is not a boolean, or it contains neither consent field.
500The write failed unexpectedly, or failed and could not be fully rolled back.
503Your access policy could not be read, or the service is temporarily over capacity. Retry shortly, and honour Retry-After when it is present.

Last updated on

On this page