Patients

Patients and their alerting flags. refId is the caller's own identifier.

OperationEndpoint
Get one patientGET /api/patient/{id}
Update a patientPOST /api/patient/{id}
List a submitter's patientsGET /api/submitter/{id}/patients
Attach patients to a submitterPOST /api/submitter/{id}/patients
Detach a patient from a submitterDELETE /api/submitter/{id}/patients/{patientId}
List a subscriber's patientsGET /api/subscriber/{id}/patients
Attach patients to a subscriberPOST /api/subscriber/{id}/patients
Detach a patient from a subscriberDELETE /api/subscriber/{id}/patients/{patientId}
List patientsGET /api/patient
Create patientsPOST /api/patient
Resolve refIds to Signals idsGET /api/patient/ids

GET /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

NameInRequiredDescription
idpathyesThe Signals patient id.

Responses

StatusMeaning
200The patient.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
404No such patient in this tenant.

Response body

FieldTypeRequiredDescription
idstringyes
tenantIdstringyes
refIdstringyesThe caller's own identifier for this patient.
namestring | nullyes
submittersstring[]yesClient ids permitted to post readings.
subscribersstring[]yesClient ids permitted to read the record.
alertIfEmptybooleanyesRaise an alert when a reading carries no value.
alertIfNotebooleanyesRaise an alert when a reading carries a note.
alertInactiveDaysnumber | nullyes
alertsPausedbooleanyesWhole-patient mute. True silences every decision the evaluator would raise for this resident until the flag is cleared; existing open alerts stay open.
metadataobjectyesFree-form. project scopes the patient to a facility.
configUpdatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
lastSeenAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
emailstringnoAbsent when unset, as in v1.
bsnstringnoDutch citizen service number. Absent when unset.
umoIdstringnoAbsent when unset.
dateOfBirthstringnoThe 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".
tagsobjectnoLabels with alphanumeric keys, filterable on the patient and alert lists with tags[key]=a,b. Absent when unset. Example: {"ward":"3B"}.
managerstringnoThe id of the client that created the patient.
_idstringyesThe same value as id, under v1's name.
tenantstringyesThe tenant id, under v1's name.
configPatientConfigDocumentSchemayes

POST /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

NameInRequiredDescription
idpathyesThe Signals patient id.

Request body

FieldTypeRequiredDescription
refIdstringnov1 let an update move the patient to a new refId; one another patient holds is a 409.
namestringno
submittersstring[]no
subscribersstring[]no
alertIfEmptybooleanno
alertIfNotebooleanno
alertInactiveDaysnumber | nullno
alertsPausedbooleanno
metadataobjectnoMerged into the existing metadata, not replaced — a write that omits project does not clear the stamp.
emailemail | nullno
bsnstring | nullno
umoIdstring | nullno
dateOfBirthstring | nullno
tagsobject | nullno

Responses

StatusMeaning
200The patient as it now stands.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
404No such patient in this tenant.
409Another patient in this tenant already has that refId.
422The payload failed validation.

Response body

FieldTypeRequiredDescription
idstringyes
tenantIdstringyes
refIdstringyesThe caller's own identifier for this patient.
namestring | nullyes
submittersstring[]yesClient ids permitted to post readings.
subscribersstring[]yesClient ids permitted to read the record.
alertIfEmptybooleanyesRaise an alert when a reading carries no value.
alertIfNotebooleanyesRaise an alert when a reading carries a note.
alertInactiveDaysnumber | nullyes
alertsPausedbooleanyesWhole-patient mute. True silences every decision the evaluator would raise for this resident until the flag is cleared; existing open alerts stay open.
metadataobjectyesFree-form. project scopes the patient to a facility.
configUpdatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
lastSeenAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
emailstringnoAbsent when unset, as in v1.
bsnstringnoDutch citizen service number. Absent when unset.
umoIdstringnoAbsent when unset.
dateOfBirthstringnoThe 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".
tagsobjectnoLabels with alphanumeric keys, filterable on the patient and alert lists with tags[key]=a,b. Absent when unset. Example: {"ward":"3B"}.
managerstringnoThe id of the client that created the patient.
_idstringyesThe same value as id, under v1's name.
tenantstringyesThe tenant id, under v1's name.
configPatientConfigDocumentSchemayes

GET /api/submitter/{id}/patients

List a submitter's patients

The ids of the patients in this tenant the submitter may post readings for.

Requires Basic authentication.

Parameters

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

Responses

StatusMeaning
200{ patients: [id] }.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.

Response body

FieldTypeRequiredDescription
patientsstring[]yesSignals patient ids.

POST /api/submitter/{id}/patients

Attach 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

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

Request body

FieldTypeRequiredDescription
patientsstring[]yes

Responses

StatusMeaning
200matched: patients newly attached; associated: every requested patient now attached.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
404CLIENT_NOT_FOUND: no SUBMITTER or ADMIN with that clientId in this tenant.
422The payload failed validation.

Response body

FieldTypeRequiredDescription
matchednumberyesHow many of the requested patients were newly attached.
associatedstring[]yesEvery requested patient now attached.

DELETE /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

NameInRequiredDescription
idpathyesThe client's clientId: the value a patient's submitters/subscribers hold.
patientIdpathyesThe Signals patient id.

Responses

StatusMeaning
200The pair that was detached.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
404The submitter was not attached to that patient.

Response body

FieldTypeRequiredDescription
submitterIdstringyes
patientIdstringyes

GET /api/subscriber/{id}/patients

List a subscriber's patients

The ids of the patients in this tenant the subscriber reads and receives alerts for.

Requires Basic authentication.

Parameters

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

Responses

StatusMeaning
200{ patients: [id] }.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.

Response body

FieldTypeRequiredDescription
patientsstring[]yesSignals patient ids.

POST /api/subscriber/{id}/patients

Attach 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

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

Request body

FieldTypeRequiredDescription
patientsstring[]yes

Responses

StatusMeaning
200associated: patients newly attached; patients: every requested patient now attached.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
404CLIENT_NOT_FOUND: no SUBSCRIBER with that clientId in this tenant.
422The payload failed validation.

Response body

FieldTypeRequiredDescription
associatedstring[]yesThe requested patients newly attached.
patientsstring[]yesEvery requested patient now attached.

DELETE /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

NameInRequiredDescription
idpathyesThe client's clientId: the value a patient's submitters/subscribers hold.
patientIdpathyesThe Signals patient id.

Responses

StatusMeaning
200The pair that was detached.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
404The subscriber was not attached to that patient.

Response body

FieldTypeRequiredDescription
subscriberIdstringyes
patientIdstringyes

GET /api/patient

List 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

NameInRequiredDescription
limitquerynoPage size. Defaults to 10, as in v1; at most 1000.
idsquerynoOnly these patients, by Signals id. Repeat the parameter or separate with commas.
sortquerynoAccepted for v1 callers and ignored, as v1 ignored it. Newest first, always.
pagequeryno1-based, as v1 paged. A page may start at most 10000 rows in; walk further with cursor.
cursorquerynoOpaque keyset cursor: a previous answer's nextCursor, passed back verbatim.
tags[key]querynov1'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

StatusMeaning
200One page of patients, each with its config.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
422A query parameter failed validation, or the page starts too deep.

Response body

FieldTypeRequiredDescription
totalItemsnumberyes
limitnumberyes
pagenumberyes1-based.
totalPagesnumberyesAt least 1, even for an empty list.
pagingCounternumberyesThe 1-based position of the first item on this page.
hasPrevPagebooleanyes
hasNextPagebooleanyes
prevPagenumber | nullyes
nextPagenumber | nullyes
nextCursorstring | nullyesOpaque keyset cursor. Pass it back as cursor for the next page; null means this page was the last. Do not construct or parse it.
itemsV1PatientSchema[]yes

POST /api/patient

Create 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

FieldTypeRequiredDescription
patientsV1CreatePatientEntry[]yes

Responses

StatusMeaning
200The patients as stored, in request order.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
422The payload failed validation.

Response body

An array of:

FieldTypeRequiredDescription
idstringyes
tenantIdstringyes
refIdstringyesThe caller's own identifier for this patient.
namestring | nullyes
submittersstring[]yesClient ids permitted to post readings.
subscribersstring[]yesClient ids permitted to read the record.
alertIfEmptybooleanyesRaise an alert when a reading carries no value.
alertIfNotebooleanyesRaise an alert when a reading carries a note.
alertInactiveDaysnumber | nullyes
alertsPausedbooleanyesWhole-patient mute. True silences every decision the evaluator would raise for this resident until the flag is cleared; existing open alerts stay open.
metadataobjectyesFree-form. project scopes the patient to a facility.
configUpdatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
lastSeenAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
emailstringnoAbsent when unset, as in v1.
bsnstringnoDutch citizen service number. Absent when unset.
umoIdstringnoAbsent when unset.
dateOfBirthstringnoThe 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".
tagsobjectnoLabels with alphanumeric keys, filterable on the patient and alert lists with tags[key]=a,b. Absent when unset. Example: {"ward":"3B"}.
managerstringnoThe id of the client that created the patient.
_idstringyesThe same value as id, under v1's name.
tenantstringyesThe tenant id, under v1's name.
configPatientConfigDocumentSchemayes

GET /api/patient/ids

Resolve 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

NameInRequiredDescription
patientRefIdqueryyesThe caller's refIds to resolve. Repeat the parameter or separate with commas.

Responses

StatusMeaning
200An object mapping each found refId to its Signals id: { [refId]: id }.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient.
422patientRefId was absent or too long a list.

Did this page help you?