Signals route policies

The signals_* AccessPolicy rows that authorize Signals routes through Ovok, what each one opens, and which app types hold it.

Ovok guards every Signals route with custom AccessPolicy rows named signals_<area>. They are not FHIR resource types: each one says what a caller may do with Signals, and it is checked on top of the caller's project. Add the exact resource type and interaction to the policy. A catch-all FHIR rule (*) does not grant them.

{ "resourceType": "signals_alerts", "interaction": ["read", "update"] }

Capabilities

A route needs every capability listed for it. The table is built from the API reference, so it always matches what Ovok serves.

CapabilityRoutes under /v1/signals/apiApp types
signals_alerts:readGET /alert
GET /alert/{id}
Manager
signals_alerts:updatePOST /alert/{id}/ackManager
signals_associations:readGET /submitter/{id}/patients
GET /subscriber/{id}/patients
Manager
signals_associations:updatePOST /submitter/{id}/patients
DELETE /submitter/{id}/patients/{patientId}

POST /subscriber/{id}/patients

DELETE /subscriber/{id}/patients/{patientId}
Manager
signals_clients:readGET /user
GET /user/{id}
Manager
signals_config:readPOST /patient/config/bulk-status
GET /tenant

GET /patient/{id}/settings
Manager
signals_config:updatePOST /patient/config
POST /patient/config/batch

PATCH /tenant

PUT /patient/{id}/settings
Manager
signals_events:readPOST /user
POST /user/{id}

GET /events

GET /events/{id}/attempts
Manager
signals_observations:createPOST /observation
POST /observation/{patientId}

POST /observation/{patientId}/batch
Submitter
signals_observations:readGET /observation/{patientId}Manager
signals_patients:deleteDELETE /patient/{id}Manager
signals_patients:readGET /patient
GET /patient/ids

GET /patient/{id}
Manager, Submitter
signals_patients:updatePOST /patient
POST /patient/{id}
Manager
signals_silence:updatePOST /patient/config
POST /patient/config/batch

PATCH /tenant

PUT /patient/{id}/settings
Manager
signals_webhooks:deleteDELETE /user/{id}Manager
signals_webhooks:readGET /subscriber/{id}/webhookManager
signals_webhooks:updatePOST /user
POST /user/{id}

POST /events/redeliver

POST /events/{id}/redeliver

POST /subscriber/{id}/webhook/enable

POST /subscriber/{id}/webhook/disable

POST /subscriber/{id}/webhook/test

POST /subscriber/{id}/webhook/rotate-secret
Manager

signals_config:update also opens Enable Signals for a Patient, together with Patient update access in the same policy. Writing a patient's alerting fields through the standalone API needs signals_config:update and signals_silence:update on top of the route's own capability.

App types

A Manager or Submitter application's policy is made from the routes its Signals role may call, so it holds the capabilities in the App types column. Its policy is kept at those rows when Ovok starts: add capabilities through your own policies, not by editing it.

Example policy

A ward role that reads alerts and acknowledges them, for its own patients:

{
  "resourceType": "AccessPolicy",
  "name": "Ward alert handling",
  "resource": [
    {
      "resourceType": "Patient",
      "criteria": "Patient?organization=Organization/ward-a",
      "interaction": ["read", "search"]
    },
    { "resourceType": "DetectedIssue", "readonly": true },
    { "resourceType": "Flag", "readonly": true },
    { "resourceType": "signals_alerts", "interaction": ["read", "update"] }
  ]
}

The example is illustrative. A signals_* row is project-wide: it does not narrow to the Patient criteria, and Patient access alone grants no Signals route.

Admin and integration behavior

Super Admins and project admins pass the capability check for project users. Project scope still applies. ClientApplication callers do not get the admin bypass, even if marked as admins: give an integration the exact rows it needs.

Last updated on

On this page