Patients
Patients and their alerting flags. refId is the caller's own identifier.
| Operation | Endpoint |
|---|---|
| Get one patient | GET /api/patient/{id} |
| Update a patient | POST /api/patient/{id} |
| List a submitter's patients | GET /api/submitter/{id}/patients |
| Attach patients to a submitter | POST /api/submitter/{id}/patients |
| Detach a patient from a submitter | DELETE /api/submitter/{id}/patients/{patientId} |
| List a subscriber's patients | GET /api/subscriber/{id}/patients |
| Attach patients to a subscriber | POST /api/subscriber/{id}/patients |
| Detach a patient from a subscriber | DELETE /api/subscriber/{id}/patients/{patientId} |
| List patients | GET /api/patient |
| Create patients | POST /api/patient |
| Resolve refIds to Signals ids | GET /api/patient/ids |
GET /api/patient/{id}
/api/patient/{id}Get one patient
The patient with its config, triggers keyed by code. A SUBMITTER or SUBSCRIBER reads only patients it is attached to.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The Signals patient id. |
Responses
| Status | Meaning |
|---|---|
200 | The patient. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | No such patient in this tenant. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
refId | string | yes | The caller's own identifier for this patient. |
name | string | null | yes | |
submitters | string[] | yes | Client ids permitted to post readings. |
subscribers | string[] | yes | Client ids permitted to read the record. |
alertIfEmpty | boolean | yes | Raise an alert when a reading carries no value. |
alertIfNote | boolean | yes | Raise an alert when a reading carries a note. |
alertInactiveDays | number | null | yes | |
alertsPaused | boolean | yes | Whole-patient mute. True silences every decision the evaluator would raise for this resident until the flag is cleared; existing open alerts stay open. |
metadata | object | yes | Free-form. project scopes the patient to a facility. |
configUpdatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
lastSeenAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
email | string | no | Absent when unset, as in v1. |
bsn | string | no | Dutch citizen service number. Absent when unset. |
umoId | string | no | Absent when unset. |
dateOfBirth | string | no | The day at UTC midnight, v1's serialisation. Accepted as yyyy-MM-dd, dd-MM-yyyy or dd/MM/yyyy. Absent when unset. Example: "1950-03-14T00:00:00.000Z". |
tags | object | no | Labels with alphanumeric keys, filterable on the patient and alert lists with tags[key]=a,b. Absent when unset. Example: {"ward":"3B"}. |
manager | string | no | The id of the client that created the patient. |
_id | string | yes | The same value as id, under v1's name. |
tenant | string | yes | The tenant id, under v1's name. |
config | PatientConfigDocumentSchema | yes |
POST /api/patient/{id}
/api/patient/{id}Update a patient
Only the fields present are changed; metadata is merged, not replaced. Answered with the v1 document.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The Signals patient id. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
refId | string | no | v1 let an update move the patient to a new refId; one another patient holds is a 409. |
name | string | no | |
submitters | string[] | no | |
subscribers | string[] | no | |
alertIfEmpty | boolean | no | |
alertIfNote | boolean | no | |
alertInactiveDays | number | null | no | |
alertsPaused | boolean | no | |
metadata | object | no | Merged into the existing metadata, not replaced — a write that omits project does not clear the stamp. |
email | email | null | no | |
bsn | string | null | no | |
umoId | string | null | no | |
dateOfBirth | string | null | no | |
tags | object | null | no |
Responses
| Status | Meaning |
|---|---|
200 | The patient as it now stands. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | No such patient in this tenant. |
409 | Another patient in this tenant already has that refId. |
422 | The payload failed validation. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
refId | string | yes | The caller's own identifier for this patient. |
name | string | null | yes | |
submitters | string[] | yes | Client ids permitted to post readings. |
subscribers | string[] | yes | Client ids permitted to read the record. |
alertIfEmpty | boolean | yes | Raise an alert when a reading carries no value. |
alertIfNote | boolean | yes | Raise an alert when a reading carries a note. |
alertInactiveDays | number | null | yes | |
alertsPaused | boolean | yes | Whole-patient mute. True silences every decision the evaluator would raise for this resident until the flag is cleared; existing open alerts stay open. |
metadata | object | yes | Free-form. project scopes the patient to a facility. |
configUpdatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
lastSeenAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
email | string | no | Absent when unset, as in v1. |
bsn | string | no | Dutch citizen service number. Absent when unset. |
umoId | string | no | Absent when unset. |
dateOfBirth | string | no | The day at UTC midnight, v1's serialisation. Accepted as yyyy-MM-dd, dd-MM-yyyy or dd/MM/yyyy. Absent when unset. Example: "1950-03-14T00:00:00.000Z". |
tags | object | no | Labels with alphanumeric keys, filterable on the patient and alert lists with tags[key]=a,b. Absent when unset. Example: {"ward":"3B"}. |
manager | string | no | The id of the client that created the patient. |
_id | string | yes | The same value as id, under v1's name. |
tenant | string | yes | The tenant id, under v1's name. |
config | PatientConfigDocumentSchema | yes |
GET /api/submitter/{id}/patients
/api/submitter/{id}/patientsList a submitter's patients
The ids of the patients in this tenant the submitter may post readings for.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The client's clientId: the value a patient's submitters/subscribers hold. |
Responses
| Status | Meaning |
|---|---|
200 | { patients: [id] }. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
patients | string[] | yes | Signals patient ids. |
POST /api/submitter/{id}/patients
/api/submitter/{id}/patientsAttach patients to a submitter
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.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The client's clientId: the value a patient's submitters/subscribers hold. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
patients | string[] | yes |
Responses
| Status | Meaning |
|---|---|
200 | matched: patients newly attached; associated: every requested patient now attached. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | CLIENT_NOT_FOUND: no SUBMITTER or ADMIN with that clientId in this tenant. |
422 | The payload failed validation. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
matched | number | yes | How many of the requested patients were newly attached. |
associated | string[] | yes | Every requested patient now attached. |
DELETE /api/submitter/{id}/patients/{patientId}
/api/submitter/{id}/patients/{patientId}Detach a patient from a submitter
The submitter may no longer post readings for the patient.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The client's clientId: the value a patient's submitters/subscribers hold. |
patientId | path | yes | The Signals patient id. |
Responses
| Status | Meaning |
|---|---|
200 | The pair that was detached. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | The submitter was not attached to that patient. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
submitterId | string | yes | |
patientId | string | yes |
GET /api/subscriber/{id}/patients
/api/subscriber/{id}/patientsList a subscriber's patients
The ids of the patients in this tenant the subscriber reads and receives alerts for.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The client's clientId: the value a patient's submitters/subscribers hold. |
Responses
| Status | Meaning |
|---|---|
200 | { patients: [id] }. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
patients | string[] | yes | Signals patient ids. |
POST /api/subscriber/{id}/patients
/api/subscriber/{id}/patientsAttach patients to a subscriber
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.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The client's clientId: the value a patient's submitters/subscribers hold. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
patients | string[] | yes |
Responses
| Status | Meaning |
|---|---|
200 | associated: patients newly attached; patients: every requested patient now attached. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | CLIENT_NOT_FOUND: no SUBSCRIBER with that clientId in this tenant. |
422 | The payload failed validation. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
associated | string[] | yes | The requested patients newly attached. |
patients | string[] | yes | Every requested patient now attached. |
DELETE /api/subscriber/{id}/patients/{patientId}
/api/subscriber/{id}/patients/{patientId}Detach a patient from a subscriber
The subscriber no longer reads the patient's records or receives its alerts.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The client's clientId: the value a patient's submitters/subscribers hold. |
patientId | path | yes | The Signals patient id. |
Responses
| Status | Meaning |
|---|---|
200 | The pair that was detached. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
404 | The subscriber was not attached to that patient. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
subscriberId | string | yes | |
patientId | string | yes |
GET /api/patient
/api/patientList patients
Scoped to what the caller may see: a MANAGER gets the tenant, a SUBMITTER or SUBSCRIBER only the patients it is attached to. Newest first.
v1's paginate envelope, driven by page and limit (default 10). A page may start at most 10000 rows in; past that, walk with the keyset cursor: pass nextCursor back verbatim, and null means the last page.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
limit | query | no | Page size. Defaults to 10, as in v1; at most 1000. |
ids | query | no | Only these patients, by Signals id. Repeat the parameter or separate with commas. |
sort | query | no | Accepted for v1 callers and ignored, as v1 ignored it. Newest first, always. |
page | query | no | 1-based, as v1 paged. A page may start at most 10000 rows in; walk further with cursor. |
cursor | query | no | Opaque keyset cursor: a previous answer's nextCursor, passed back verbatim. |
tags[key] | query | no | v1's tag filter: only patients whose tags.key equals one of the comma-separated values, or holds one in an array. Repeat with other keys to require them all. Keys are alphanumeric; tags.key= is accepted too. |
Responses
| Status | Meaning |
|---|---|
200 | One page of patients, each with its config. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
422 | A query parameter failed validation, or the page starts too deep. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
totalItems | number | yes | |
limit | number | yes | |
page | number | yes | 1-based. |
totalPages | number | yes | At least 1, even for an empty list. |
pagingCounter | number | yes | The 1-based position of the first item on this page. |
hasPrevPage | boolean | yes | |
hasNextPage | boolean | yes | |
prevPage | number | null | yes | |
nextPage | number | null | yes | |
nextCursor | string | null | yes | Opaque keyset cursor. Pass it back as cursor for the next page; null means this page was the last. Do not construct or parse it. |
items | V1PatientSchema[] | yes |
POST /api/patient
/api/patientCreate patients
Upserts on refId: posting a patient that already exists updates it rather than duplicating it, so a replayed provisioning run is safe. Each entry's config — flags and triggers — is applied in the same call, and metadata is merged.
Requires Basic authentication.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
patients | V1CreatePatientEntry[] | yes |
Responses
| Status | Meaning |
|---|---|
200 | The patients as stored, in request order. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
422 | The payload failed validation. |
Response body
An array of:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
refId | string | yes | The caller's own identifier for this patient. |
name | string | null | yes | |
submitters | string[] | yes | Client ids permitted to post readings. |
subscribers | string[] | yes | Client ids permitted to read the record. |
alertIfEmpty | boolean | yes | Raise an alert when a reading carries no value. |
alertIfNote | boolean | yes | Raise an alert when a reading carries a note. |
alertInactiveDays | number | null | yes | |
alertsPaused | boolean | yes | Whole-patient mute. True silences every decision the evaluator would raise for this resident until the flag is cleared; existing open alerts stay open. |
metadata | object | yes | Free-form. project scopes the patient to a facility. |
configUpdatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
lastSeenAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
email | string | no | Absent when unset, as in v1. |
bsn | string | no | Dutch citizen service number. Absent when unset. |
umoId | string | no | Absent when unset. |
dateOfBirth | string | no | The day at UTC midnight, v1's serialisation. Accepted as yyyy-MM-dd, dd-MM-yyyy or dd/MM/yyyy. Absent when unset. Example: "1950-03-14T00:00:00.000Z". |
tags | object | no | Labels with alphanumeric keys, filterable on the patient and alert lists with tags[key]=a,b. Absent when unset. Example: {"ward":"3B"}. |
manager | string | no | The id of the client that created the patient. |
_id | string | yes | The same value as id, under v1's name. |
tenant | string | yes | The tenant id, under v1's name. |
config | PatientConfigDocumentSchema | yes |
GET /api/patient/ids
/api/patient/idsResolve refIds to Signals ids
An object from each patientRefId this tenant holds to its Signals id. A refId the tenant does not hold is left out rather than failing the request.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
patientRefId | query | yes | The caller's refIds to resolve. Repeat the parameter or separate with commas. |
Responses
| Status | Meaning |
|---|---|
200 | An object mapping each found refId to its Signals id: { [refId]: id }. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. |
422 | patientRefId was absent or too long a list. |
Updated 28 days ago