Attach patients to a subscriber
- Sandbox: available
- Staging: available
- Production: unknown
Grants the client permission to read those patients' records and receive their alert webhooks. 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.
AuthorizationBearer <JWT>id*stringThe client's clientId: the value a patient's submitters/subscribers hold.
application/json- body
patients*array<string>associated: patients newly attached; patients: every requested patient now attached.
application/json- response
associated*array<string>The requested patients newly attached.
patients*array<string>Every requested patient now attached.
curl -X POST 'https://api.sandbox.ovok.com/v1/signals/api/subscriber/string/patients' \ -H 'Content-Type: application/json' \ -d '{ "patients": [ "string" ]}'{ "associated": [ "string" ], "patients": [ "string" ]}List a subscriber's patients GET
The ids of the patients in this tenant the subscriber reads and receives alerts 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 subscriber DELETE
The subscriber no longer reads the patient's records or receives its alerts. ### 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), 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.