StandaloneAPI referencePatients

Delete a patient

Delete a patient, through Ovok's Signals gateway.

Delete a patient

MethodPath
DELETE/v1/signals/api/patient/{id}
  • Sandbox: available
  • Staging: available
  • Production: unknown

Deletes the patient with its triggers, alerts, episodes and readings. This can't be undone through the API.

Through ovok

  • Who can call it: Manager apps, and users whose access policy grants the capabilities.
  • Capabilities, all required: signals_patients:delete. Project admins have every capability; client applications get no admin bypass.
  • If your access covers only some patients (anyone but project admins, manager or submitter apps, and anyone whose Patient access has no criteria), the patient must be one you can delete. A patient is named by its Signals id, or by its Medplum Patient id where Signals takes a refId; ovok asks Signals which patient a Signals id is.

Request

Path parameters

NameTypeRequiredDescription
idstringYesThe Signals patient id.

Responses

StatusMeaning
200Deleted: the id of the patient that is gone.
400A path value holds a character ovok does not send to Signals, such as a raw : or +. Percent-encode it. The query carries a raw #, or more than 200 parameters.
401Your ovok access token, or your client id and secret, are missing or invalid.
403ovok refused the call: you lack a capability this route needs, or your session has no project, or you can read a patient the call names but not delete it.
404A patient the call names is not one you can read. From Signals: No such patient in this tenant.
409Your project has no Signals tenant of its own (SIGNALS_TENANT_NOT_OWN), or it is moving to another one.
422A patient id is not 1 to 64 letters, digits, ., _, ~ or -.
429Too many requests. Retry after the seconds in Retry-After.
500ovok hit an unexpected fault, such as your project having no Signals submitter.
502Signals answered with something ovok couldn't use, or refused ovok's own credential.
503Signals is unavailable. Retry after the seconds in Retry-After.
504Signals did not answer in time.

Example

curl --request DELETE 'https://api.sandbox.ovok.com/v1/signals/api/patient/:id' \
  --user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"

Last updated on

On this page