OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Signals API - Patients

Attach patients to a submitter

  • Sandbox: available
  • Staging: available
  • Production: unknown
POST
/v1/signals/api/submitter/{id}/patients

Grants the client permission to post readings for those patients. Unknown patient ids are skipped, so a caller can re-post a superset of ids without a 404.

Through ovok

  • Who can call it: Manager apps, and users whose access policy grants the capabilities.
  • Capabilities, all required: signals_associations:update. 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), every patient the body names must be one you can update. 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.

Authorization

headerAuthorizationBearer <JWT>

Path Parameters

id*string

The client's clientId: the value a patient's submitters/subscribers hold.

Request Body

application/json
  1. body
patients*array<string>

Response Body

matched: patients newly attached; associated: every requested patient now attached.

application/json
  1. response
matched*number

How many of the requested patients were newly attached.

associated*array<string>

Every requested patient now attached.

Example Request
curl -X POST 'https://api.sandbox.ovok.com/v1/signals/api/submitter/string/patients' \  -H 'Content-Type: application/json' \  -d '{  "patients": [    "string"  ]}'
Example Response
{  "matched": 0,  "associated": [    "string"  ]}

List a submitter's patients GET

The ids of the patients in this tenant the submitter may post readings for. ### Through ovok - **Who can call it:** Manager apps, and users whose access policy grants the capabilities. - **Capabilities, all required:** `signals_associations:read`. Project admins have every capability; client applications get no admin bypass. - It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.

Detach a patient from a submitter DELETE

The submitter may no longer post readings for the patient. ### Through ovok - **Who can call it:** Manager apps, and users whose access policy grants the capabilities. - **Capabilities, all required:** `signals_associations:update`. Project admins have every capability; client applications get no admin bypass. - Your project's own submitter stays attached to its patients. - 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 update. 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.