Schemas
Every response and request body shape.
Every response and request body shape referenced by the API.
AcknowledgedActorSchema
| Field | Type | Required | Description |
|---|---|---|---|
reference | string | yes | The caller's own identifier for the person, opaque to Signals. Carehub sends a FHIR reference such as Practitioner/1a2b3c. |
display | string | null | yes | A human-readable label captured at ack time, or null. Denormalised on purpose — the name shown against a historical acknowledgement should be the one that was true when it happened. |
AlertComponentSchema
| Field | Type | Required | Description |
|---|---|---|---|
code | object | yes | Example: {"coding":[{"code":"8867-4"}]}. |
valueQuantity | object | no | Example: {"value":128}. |
valueString | string | no |
AlertPageSchema
| 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 | V1AlertSchema[] | yes |
AlertPatientSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tags | object | no | The patient's v1 tags. Absent when unset. Example: {"ward":"3B"}. |
metadata | object | yes | The patient's metadata. |
createdAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
AssociatePatientsDto
| Field | Type | Required | Description |
|---|---|---|---|
patients | string[] | yes |
AttachedPatientsSchema
| Field | Type | Required | Description |
|---|---|---|---|
patients | string[] | yes | Signals patient ids. |
AttemptDocumentSchema
| Field | Type | Required | Description |
|---|---|---|---|
attemptedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
durationMs | number | yes | |
delivered | boolean | yes | |
statusCode | number | null | yes | Null when no answer came back. |
error | string | null | yes | Example: "HTTP 503". |
responseSnippet | string | null | yes | The first 2 KB of the answer. |
AttemptPageSchema
| Field | Type | Required | Description |
|---|---|---|---|
items | AttemptDocumentSchema[] | yes | Oldest first, at most 100. |
ComponentEntrySchema
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | Example: "8867-4". |
system | string | no | Example: "http://loinc.org". |
display | string | no | Example: "Heart rate". |
valueNumber | number | no | Example: 72. |
valueUnit | string | no | Example: "/min". |
valueString | string | no | |
valueDateTime | date-time | no | A date-time value as sent; valueNumber is the same instant in epoch ms. |
valueSampledData | object | no | The component's whole FHIR SampledData series, as sent. Example: {"origin":{"value":0,"unit":"/min"},"period":30000,"dimensions":1,"data":"61 62 E 60"}. |
dataAbsentReason | string | no | FHIR's reason the device sent no value: its first coding's code, else its text. Example: "not-performed". |
sequence | number | yes | Position in the reading as sent. |
CreateUserDto
| Field | Type | Required | Description |
|---|---|---|---|
role | string | yes | Validated against the assignable roles rather than the full enum, so this MANAGER-gated route cannot mint a cross-tenant SUPER_ADMIN credential. One of: ADMIN, MANAGER, SUBMITTER, SUBSCRIBER, SUPER_ADMIN, TENANT_PROVISIONER. |
clientId | string | yes | |
secret | string | yes | |
name | string | no | |
webhookUrl | uri | no | |
webhookSecret | string | no | |
events | string[] | no | |
custom | string | no | v1's custom: an opaque string every webhook carries back as x-actimi-custom. |
eventSchema | number | no | 1 keeps v1's event names and bodies; 2, the default, sends one name per state change. One of: 1, 2. |
reach | string | no | attached: the patients attached to it, as v1's; all: every patient of the tenant, later ones included. One of: attached, all. |
DbHealthSchema
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | yes | Whether the database answered within the probe timeout. |
latencyMs | number | no | Round-trip time of the probe query. Present when ok. |
error | string | no | Why the probe failed. Present when ok is false. |
EffectivePeriodSchema
| Field | Type | Required | Description |
|---|---|---|---|
start | date-time | yes | When the absence began. Example: "2026-08-27T09:15:00.000Z". |
end | date-time | yes | The reading or tick that last fired it. Example: "2026-08-27T09:15:00.000Z". |
EventDocumentSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The delivery: one event to one subscriber. Name it in /api/events/{id}/…. |
eventId | string | yes | The event, as webhook-id and x-actimi-event-id; shared by its copies to other subscribers. |
eventType | string | yes | Example: "alert.trigger". |
subscriberId | string | yes | The subscriber's Signals id. |
status | string | yes | pending: queued or retrying. delivered: a 2xx came back. failed: abandoned after a 410 or its retries. expired: an alert past its delivery window, not sent. held: kept while the endpoint was disabled. One of: pending, delivered, failed, expired, held. |
attempts | number | yes | Attempts since it was queued or last redelivered. |
nextAttemptAt | date-time | null | yes | When it is next tried; null unless pending. Example: "2026-08-27T09:15:00.000Z". |
lastStatusCode | number | null | yes | |
lastError | string | null | yes | |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
redeliveredAt | date-time | null | yes | When a redeliver last queued it. Example: "2026-08-27T09:15:00.000Z". |
payload | object | yes | The body the webhook carries. |
EventPageSchema
| Field | Type | Required | Description |
|---|---|---|---|
items | EventDocumentSchema[] | 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. |
FieldErrorSchema
| Field | Type | Required | Description |
|---|---|---|---|
field | string | null | yes | The field, by its path. Example: "ids". |
code | string | yes | What is wrong with it. Example: "FIELD_INVALID_TYPE". |
params | object | null | yes | Example: null. |
NotificationPageSchema
| Field | Type | Required | Description |
|---|---|---|---|
items | NotificationSchema[] | yes | |
nextCursor | string | null | yes | Opaque. Pass it back as cursor for the next page; null means this page was the last. Do not construct or parse it. |
NotificationSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
patientId | string | yes | |
code | string | yes | Example: "8867-4". |
system | string | null | yes | Example: "http://loinc.org". |
display | string | null | yes | |
status | string | yes | One of: OPEN, CLOSED. |
openedAt | date-time | yes | When the episode started: the recorded time of the reading that opened it. A reading recorded before the previous episode of this code closed, but judged after that close, opens its episode 1 ms after the close instead, so episodes of one code never overlap; that reading is still the first of the detail values. Example: "2026-08-27T09:15:00.000Z". |
closedAt | date-time | null | yes | When the episode ended. For RECOVERED that is the recovery reading itself, or the episode's newest reading when the recovery was recorded before it; for TIMEOUT it is the instant the device became a disconnect, which is the last evidence of reporting plus the tenant's disconnect horizon — NOT that last evidence, which would report an alert as having ended while it was still on the bell; for AWAY it is when Signals was told the patient had left, or the episode's newest evidence if that is later. Example: "2026-08-27T09:15:00.000Z". |
closeReason | string | null | yes | RECOVERED means a reading came back into range; TIMEOUT means readings stopped for longer than the idle window, and an out-of-bed episode closed so before anyone acknowledged it opens again under the same id when readings resume during the same absence; ACKNOWLEDGED means a person acknowledged it, which ends the alerting window so the next breach opens a new episode; CROSSED means the vital moved to the opposite bound with no normal reading between, which is a different event and gets its own episode; THRESHOLD_CHANGED means the rule itself was edited mid-window, so the window under the old rule ended and the next breach opens a clean one under the new rule; AWAY means the caller reported that the patient left the bed the vital is measured from, which ends the window when Signals is told, so the next breach after their return opens a new episode; STALE means an out-of-bed episode stayed open past 48 hours and was discarded, and no new one opens until the resident is back in bed; MANUAL is reserved for a close by hand. One of: RECOVERED, TIMEOUT, MANUAL, ACKNOWLEDGED, CROSSED, THRESHOLD_CHANGED, AWAY, STALE. |
lastSampleAt | date-time | yes | The newest evidence that the device is still reporting: the last reading folded into this episode, or the patient's last accepted reading of any code if that is later. Present on an OPEN episode too, where it is the freshness signal — closedAt is null and durationMs is measured to here, so without it a caller cannot tell a live episode from one whose device went quiet an hour ago. Example: "2026-08-27T09:15:00.000Z". |
durationMs | number | yes | Open episodes measure to their newest reading, not to now. |
observationCount | number | yes | Every reading in the episode, including the one that closed it. |
firingCount | number | yes | How many of those breached. Excludes the recovery reading. |
minValue | number | null | yes | Spans all readings in the window. |
maxValue | number | null | yes | |
avgValue | number | null | yes | |
lastValue | number | null | yes | |
peakValue | number | null | yes | The furthest-from-normal value while breaching. This is the number to show a clinician — min/max include the recovery reading. |
peakAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
lastFiringValue | number | null | yes | The newest breaching value. On a RECOVERED episode this is the last out-of-range reading; lastValue is the recovery reading. Null for episodes stored before this field existed. |
lastFiringAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
firstObservationId | string | yes | |
lastObservationId | string | yes | |
lastAlertId | string | null | yes | |
triggerId | string | null | yes | |
triggerVersion | number | null | yes | |
dedupKey | string | yes | |
firedAlertMessage | string | null | yes | The firing alert's own message — the rule's provenance payload, recorded when the alert fired and never recomputed. It is the only record of the band the reading was judged against that is written at fire time, which is why it is carried here rather than reconstructed from the configuration audit log: that log cannot answer for an episode older than its horizon, and it is keyed on a triggerVersion that is re-used when a vital is toggled off and on. Opaque to Signals — the rule owns the payload and Signals does not interpret it. Null when the episode has no firing alert. |
observationEffectivePeriod | object | null | yes | Out of bed (103214-3) only: the absence behind the episode, from when its first alert's absence began to the reading or tick that last fired it. Null for every other code, and for episodes opened before it was recorded. |
limitSeconds | number | null | yes | Out of bed (103214-3) only: the limit in force when it last fired, in seconds — the absolute limit floored to the minute, or the tighter baseline limit. Null for every other code, and for out-of-bed alerts raised before it was recorded. |
kind | string | yes | One of: medical. |
acknowledgedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
acknowledgedBy | string | null | yes | |
acknowledgedActor | object | null | yes | The person the caller says acknowledged it, or null. Distinct from acknowledgedBy, which is the API client: one deployment holds one credential, so that field answers "which system" and this one answers "which person". Null on any episode acknowledged before the caller began sending an actor — the absence is real, so do not fall back to acknowledgedBy to fill it. |
OrgSettingsSchema
| Field | Type | Required | Description |
|---|---|---|---|
project | string | null | yes | The project these settings are for; null for the tenant-wide row. |
settings | object | yes | Opaque to Signals beyond triggers; the triggers give the other keys their meaning. Example: {"bands":{"8867-4":{"low":50,"high":110}}}. |
created | boolean | no | PUT ?ifAbsent=true only: whether this call created the row. |
PatientConfigDocumentSchema
| Field | Type | Required | Description |
|---|---|---|---|
alertIfEmpty | boolean | yes | |
alertIfNote | boolean | yes | |
alertInactiveDays | number | null | yes | |
updatedAt | date-time | null | yes | When this config last changed. Example: "2026-08-27T09:15:00.000Z". |
triggers | object | yes | The patient's stored triggers, and its own bands for codes without one, keyed by code, in the shape v1 keyed its triggers. |
PatientSettingsItemSchema
| Field | Type | Required | Description |
|---|---|---|---|
patientId | string | yes | |
refId | string | null | yes | |
settings | object | yes | Opaque to Signals beyond triggers; the triggers give the other keys their meaning. Example: {"bands":{"8867-4":{"low":50,"high":110}}}. |
PatientSettingsPageSchema
| Field | Type | Required | Description |
|---|---|---|---|
items | PatientSettingsItemSchema[] | yes | |
nextCursor | string | null | yes |
PatientSettingsSchema
| Field | Type | Required | Description |
|---|---|---|---|
patientId | string | yes | |
settings | object | yes | Opaque to Signals beyond triggers; the triggers give the other keys their meaning. Example: {"bands":{"8867-4":{"low":50,"high":110}}}. |
QueuedSchema
| Field | Type | Required | Description |
|---|---|---|---|
queued | number | yes | Deliveries queued to be sent again. |
RaisedAlertSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
code | string | null | yes | Example: "8867-4". |
RotatedSigningSecretSchema
| Field | Type | Required | Description |
|---|---|---|---|
secret | string | yes | The new Standard Webhooks signing secret, whsec_ and 32 random bytes in base64. Example: "whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=". |
previousSecretExpiresAt | date-time | null | yes | When the replaced secret stops signing; null when there was none. |
RuleCoverageSchema
| Field | Type | Required | Description |
|---|---|---|---|
uncoveredCodes | string[] | yes | Codes this call's readings carried a value for that no trigger fired or resolved, leaving out the codes the tenant declares informational (presence, baselines). Empty while the patient's alerts are paused, when nothing is judged. Example: ["8867-4"]. |
fingerprints | object | yes | Every trigger and band the patient's own settings hold, not only this call's codes: its code to the fingerprint of the trigger, else the band (out of bed, 103214-3, to that of its limit), the same string bulk status reports in triggerFingerprints. A code absent here follows the org settings. Example: {"8867-4":"3f2a9c1de0b74a55"}. |
ruleSet | string | yes | Deprecated: always triggers, what judges every reading. Kept for callers that read it. Example: "triggers". |
SubmitterAttachSchema
| Field | Type | Required | Description |
|---|---|---|---|
matched | number | yes | How many of the requested patients were newly attached. |
associated | string[] | yes | Every requested patient now attached. |
SubmitterDetachSchema
| Field | Type | Required | Description |
|---|---|---|---|
submitterId | string | yes | |
patientId | string | yes |
SubscriberAttachSchema
| Field | Type | Required | Description |
|---|---|---|---|
associated | string[] | yes | The requested patients newly attached. |
patients | string[] | yes | Every requested patient now attached. |
SubscriberDetachSchema
| Field | Type | Required | Description |
|---|---|---|---|
subscriberId | string | yes | |
patientId | string | yes |
SubscriberEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
events | string[] | yes |
SubscriberEventsSchema
| Field | Type | Required | Description |
|---|---|---|---|
modifiedCount | number | yes | Always 1 on success. |
events | string[] | yes |
TenantSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
name | string | yes | |
settings | object | yes | Feature switches. episodicAlerts gates episode recording and the notification feed; synchronousMode returns before evaluating; informationalCodes, historyCategories and feedCodes are the codes and categories the tenant declares (PATCH /api/tenant); ruleSet, when present, is deprecated and ignored. |
orgSettings | object | null | yes | The tenant's rule settings, {} when none were written: what the triggers judge by, the triggers themselves included. Written through PATCH /api/tenant. Null for a SUBMITTER or SUBSCRIBER credential. Example: {"bands":{"8867-4":{"low":50,"high":110}}}. |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
TenantSettingsDto
| Field | Type | Required | Description |
|---|---|---|---|
synchronousMode | boolean | no | Return from ingest before evaluation runs; evaluation continues in the background. |
episodicAlerts | boolean | no | Group firing observations into AlertEpisode rows and expose the episode routes. |
mtlsEnabled | boolean | no | Deliver the tenant's webhooks over mutual TLS, presenting Signals' client certificate, to https endpoints only. |
episodeIdleMinutes | number | no | The grouping boundary. When a reading arrives after a gap wider than this, it opens a new episode instead of joining the open one. |
episodeDisconnectMinutes | number | no | The lost-observation boundary. An open episode fed nothing for this long is closed as TIMEOUT by the sweep, because the device is to be treated as disconnected and an alert that looks live is worse than one that is closed. Shorter than episodeIdleMinutes on purpose: that one governs a reading that DID arrive, this one governs a reading that never did. |
throttleLimit | number | no | This tenant's requests per THROTTLE_TTL_MS window, overriding THROTTLE_LIMIT. 0 exempts the tenant, which is what THROTTLE_EXEMPT_TENANT does from env — but a setting reaches a tenant created at runtime, which env cannot. |
ruleSet | string | null | no | Deprecated and ignored: Signals has no rule sets. Every reading is judged by the triggers stored in the home's and the resident's settings. Still accepted, and stored as sent, so an older caller is not refused. |
informationalCodes | string[] | no | Codes this tenant's triggers consume and never judge: a value of one left without a verdict is not counted as a no-verdict, and the * trigger does not run on it. |
historyCategories | string[] | no | Reading categories that are history: stored, never judged, never a trigger input. |
feedCodes | string[] | no | The codes the notification feed lists when the caller names none; empty lists every code. |
TestDeliverySchema
| Field | Type | Required | Description |
|---|---|---|---|
delivered | boolean | yes | |
statusCode | number | null | yes | |
durationMs | number | yes | |
error | string | null | yes | |
responseSnippet | string | null | yes | The first 2 KB of the answer. |
TriggerDocumentSchema
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | Example: "8867-4". |
system | string | null | yes | |
display | string | null | yes | |
valueKey | string | yes | Example: "value". |
constants | object | yes | A stored trigger's constants as pushed; for a code with no stored trigger, the patient's own band from its settings ({ low, high }, or { mode: 'baseline', pct }), { band: 'NO_THRESHOLD' } for a code switched off; for out of bed (103214-3), { limitSeconds }. |
logic | object | null | yes | A stored trigger's JSON-logic as pushed, which judges the code in place of the home's trigger; null for a band, which the home's trigger judges. |
metadata | object | yes | |
version | number | yes | |
updatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
UpdateClientDto
| Field | Type | Required | Description |
|---|---|---|---|
secret | string | no | |
name | string | no | |
webhookUrl | uri | no | |
webhookSecret | string | no | |
events | string[] | no | |
custom | string | no | v1's custom: an opaque string every webhook carries back as x-actimi-custom. |
eventSchema | number | no | Moves the subscriber to another event schema: 2 sends one name per state change. One of: 1, 2. |
reach | string | no | One of: attached, all. |
UpdatePatientDto
| 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 |
UpdateTenantDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | |
settings | TenantSettingsDto | no | |
orgSettings | object | no | The tenant's rule settings, merged key by key: a key sent replaces the stored one, null removes it. |
resolvedAt | string | no | When the caller resolved orgSettings: it lands only over a write resolved earlier. |
V1AlertSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
patientId | string | yes | |
observationId | string | null | yes | |
status | string | yes | One of: ACTIVE, RESOLVED. |
code | string | null | yes | Example: "8867-4". |
dedupKey | string | null | yes | What this alert deduplicates against while it stays open. Repeated breaches of the same trigger refresh one alert rather than opening more. Example: "TRIGGER:8867-4". |
message | string | null | yes | Supplied by the rule when it returns one. ECH rules return a JSON document here describing which bound was crossed. |
valueNumber | number | null | yes | |
valueString | string | null | yes | The rule's own payload; carries the level and colour the UI paints. |
triggerCode | string | null | yes | |
triggerVersion | number | null | yes | |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
resolvedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
acknowledgedAt | date-time | null | yes | When this alert was acknowledged, or null. Acknowledging resolves it; an alert that resolved on its own stays unacknowledged until someone acknowledges it. Example: "2026-08-27T09:15:00.000Z". |
acknowledgedBy | string | null | yes | The client that acknowledged it, or null. |
acknowledgedActor | object | null | yes | The person the caller says acknowledged it, or null. Distinct from acknowledgedBy, which is the API client: one deployment holds one credential, so that field answers "which system" and this one answers "which person". |
observationEffectivePeriod | object | null | yes | Out of bed (103214-3) only: the absence the alert is about, from when Signals first saw the resident absent to the reading or tick that last fired it. The start holds through a presence flicker shorter than the return time, as the out-of-bed clock does. Null for every other code, and for out-of-bed alerts raised before it was recorded. |
limitSeconds | number | null | yes | Out of bed (103214-3) only: the limit in force when it last fired, in seconds — the absolute limit floored to the minute, or the tighter baseline limit. Null for every other code, and for out-of-bed alerts raised before it was recorded. |
_id | string | yes | The same value as id, under v1's name. |
reason | string | yes | v1's lowercase reason. trigger is a threshold breach; empty a reading with no value; note a clinician note; inactive a patient who stopped reporting. One of: trigger, empty, note, inactive. |
observation | string | null | yes | The observation id. |
component | object | null | yes | The reading that fired, rebuilt from its stored code and value. |
trigger | object | null | yes | Example: {"code":"8867-4"}. |
updatedAt | date-time | yes | The last change: raised, resolved or acknowledged. Example: "2026-08-27T09:15:00.000Z". |
patient | AlertPatientSchema | yes |
V1BatchConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
patients | V1BatchConfigEntrySchema[] | yes |
V1BatchConfigEntrySchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Signals patient id, or the caller's refId. |
triggers | V1ConfigTriggerSchema[] | no | |
metadata | object | no | Labels for this patient, merged not replaced. Whatever key the notification feed is queried by must appear here, or the patient is invisible to it. |
resolvedAt | string | no | ISO-8601 instant at which this entry's configuration was COMPUTED — not when it was sent. Per entry, because one batch can mix a fresh individual save with an older org fan-out slice. A push carrying one is ignored when the patient already holds a configuration resolved strictly later; omitting it applies the entry unconditionally. |
alertIfEmpty | boolean | no | |
alertIfNote | boolean | no | |
alertInactiveDays | number | no |
V1BatchConfigResultSchema
| Field | Type | Required | Description |
|---|---|---|---|
matched | number | yes | |
modified | number | yes | |
staleIgnored | number | yes | Entries refused for carrying a configuration resolved before the one already applied, summed across the batch. |
results | object[] | yes | Per-patient match and modify counts. |
misses | string[] | yes | |
rejected | V1RejectedTriggerSchema[] | yes | Triggers without logic, per patient, so nothing was stored for them. |
V1BulkStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
ids | string[] | yes |
V1CodeableConceptDto
| Field | Type | Required | Description |
|---|---|---|---|
coding | V1CodingDto[] | no | |
text | string | no |
V1CodingDto
| Field | Type | Required | Description |
|---|---|---|---|
system | string | no | |
code | string | no | |
display | string | no |
V1ComponentDto
| Field | Type | Required | Description |
|---|---|---|---|
code | V1CodeableConceptDto | yes | |
dataAbsentReason | V1CodeableConceptDto | no | |
valueQuantity | V1QuantityDto | no | |
valueSampledData | V1SampledDataDto | no | |
valueString | string | no | |
valueInteger | number | no | |
valueBoolean | boolean | no | |
valueDateTime | string | no | |
valueTime | string | no | |
valuePeriod | object | no | |
valueRange | V1RangeDto | no | |
valueRatio | V1RatioDto | no | |
valueCodeableConcept | V1CodeableConceptDto | no |
V1ConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
resolvedAt | string | no | ISO-8601 instant at which this configuration was COMPUTED (not sent). A push carrying one is ignored if the patient already has a configuration resolved strictly later. Optional: a push without it is applied unconditionally, exactly as before. |
triggers | V1ConfigTriggerSchema[] | no | |
ids | string[] | yes | |
metadata | object | no | Stamped onto the Patient rows named by ids, merged not replaced. |
alertIfEmpty | boolean | no | |
alertIfNote | boolean | no | |
alertInactiveDays | number | no |
V1ConfigEnvelopeSchema
| Field | Type | Required | Description |
|---|---|---|---|
ids | string[] | yes | The ids the request named, echoed back. |
status | V1ConfigResultSchema | yes |
V1ConfigResultSchema
| Field | Type | Required | Description |
|---|---|---|---|
acknowledged | boolean | yes | |
matchedCount | number | yes | |
modifiedCount | number | yes | Patients where the push actually changed something, counted from the settings it changed rather than from the shape of the request. A push whose only effect was deleting an already-absent band does not count. |
triggerWrites | unknown | yes | The row counts behind modifiedCount, summed across every patient named. |
staleIgnoredCount | number | yes | Patients whose push was refused because it carried a resolvedAt older than the configuration already applied. Nothing was written for them. This is not a failure: it is the expected outcome for a resident who was individually saved while an org-wide fan-out was in flight. |
misses | string[] | yes | Ids that matched no patient. Reported rather than failing the batch. |
rejected | V1RejectedTriggerSchema[] | yes | Triggers without logic, so nothing was stored for them. Empty when every trigger was stored. |
V1ConfigTriggerSchema
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | LOINC code. Unique per patient. Example: "8867-4". |
system | string | no | Example: "http://loinc.org". |
display | string | no | |
valueKey | string | no | Key the rule reads the reading under. Example: "value". |
constants | object | no | Named values the rule compares against, e.g. { "low": 50, "high": 110 }. |
logic | object | no | json-logic. May return a boolean, a string used as the message, or an object {alert, value, message} — the shape the ECH rules use. |
delete | boolean | no | Remove this trigger instead of writing it. The patient stops being alerted on the code. |
metadata | object | no | Free-form routing labels, MERGED into whatever is already there and left untouched when absent — so a push that omits them cannot un-route a trigger. Signals does not interpret the keys. A caller managing thresholds at two levels records which level owns each trigger here, so a group-wide write matches one label and cannot clobber a per-patient exception. |
V1CreatePatientEntry
| Field | Type | Required | Description |
|---|---|---|---|
config | object | no | Initial config, applied in the same call: alertIfEmpty, alertIfNote, alertInactiveDays, and triggers in the same shape as V1ConfigTriggerSchema, including its metadata stamp. |
id | string | no | |
name | string | no | |
refId | string | yes | |
submitters | string[] | no | |
subscribers | string[] | no | |
metadata | object | no | |
email | email | null | no | |
bsn | string | null | no | |
umoId | string | null | no | |
dateOfBirth | string | null | no | |
tags | object | null | no |
V1CreatePatientsDto
| Field | Type | Required | Description |
|---|---|---|---|
patients | V1CreatePatientEntry[] | yes |
V1ErrorSchema
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | v1's error class name. Example: "ValidationError". |
message | string | yes | |
code | number | yes | The HTTP status. Example: 422. |
type | uri | yes | The problem type: https://docs.ovok.com/errors/ plus the machine code in kebab case, e.g. …/patient-not-found, …/feature-disabled. Example: "https://docs.ovok.com/errors/validation-error". |
data | object | no | Detail: the failed checks for a validation error, extra fields otherwise. |
status | number | yes | The HTTP status, as RFC 9457 names it. Example: 422. |
detail | string | yes | What went wrong, for a person. A 5xx never names its cause. Example: "The request has invalid fields.". |
instance | string | yes | The route that failed. Example: "/api/patient/config/bulk-status". |
traceId | string | null | yes | The OpenTelemetry trace of the request, to quote when reporting it. Example: "4bf92f3577b34da6a3ce929d0e0e4736". |
errors | FieldErrorSchema[] | yes | One entry per invalid field of a validation error; empty otherwise. |
V1HealthSchema
| Field | Type | Required | Description |
|---|---|---|---|
healthy | boolean | yes | False while the database does not answer, as db.ok; the status stays 200. Example: true. |
db | unknown | yes | Database reachability; ok is false on a stall. |
version | string | null | yes | The running release: the one the deploy workflow stamped, else <next>-dev+<commit>; null when neither is known. Example: "1.2.0-rc.3". |
commit | string | null | yes | The commit the running build was made from; null when unknown. Example: "a1b2c3d". |
V1IdentifierDto
| Field | Type | Required | Description |
|---|---|---|---|
system | string | no | |
value | string | no |
V1ObservationBatchDto
| Field | Type | Required | Description |
|---|---|---|---|
observations | V1ObservationDto[] | yes |
V1ObservationByRefDto
| Field | Type | Required | Description |
|---|---|---|---|
patientRefId | string | no | |
resourceType | string | no | |
identifier | V1IdentifierDto[] | no | |
refId | string | no | |
status | string | no | |
category | object[] | no | Its codings' codes are stored; a code the tenant names in historyCategories makes the reading history: stored, never judged. |
note | object | no | Accepted as a plain string or as FHIR's [{text, time}] Annotations, which the mapper flattens to newline-joined text. Deliberately untyped: typing it as a string would reject real readings ovok sends today. |
code | V1ReadingCodeDto | yes | |
subject | V1ReferenceDto | no | |
component | V1ComponentDto[] | no | |
device | object | no | id (v1) or reference (FHIR) names the device. |
dataAbsentReason | object | no | v1's string or FHIR's CodeableConcept; untyped so that neither is refused. |
observedAt | string | no | |
effectiveDateTime | string | no | |
effectiveInstant | string | no | |
effectivePeriod | object | no | Only .start and .end are read, as in v1. |
issued | string | no | |
valueQuantity | V1QuantityDto | no | |
valueSampledData | V1SampledDataDto | no | |
valueString | string | no | |
valueInteger | number | no | |
valueBoolean | boolean | no | |
valueDateTime | string | no | |
valueTime | string | no | |
valuePeriod | object | no | |
valueRange | V1RangeDto | no | |
valueRatio | V1RatioDto | no | |
valueCodeableConcept | V1CodeableConceptDto | no |
V1ObservationDto
| Field | Type | Required | Description |
|---|---|---|---|
resourceType | string | no | |
identifier | V1IdentifierDto[] | no | |
refId | string | no | |
status | string | no | |
category | object[] | no | Its codings' codes are stored; a code the tenant names in historyCategories makes the reading history: stored, never judged. |
note | object | no | Accepted as a plain string or as FHIR's [{text, time}] Annotations, which the mapper flattens to newline-joined text. Deliberately untyped: typing it as a string would reject real readings ovok sends today. |
code | V1ReadingCodeDto | yes | |
subject | V1ReferenceDto | no | |
component | V1ComponentDto[] | no | |
device | object | no | id (v1) or reference (FHIR) names the device. |
dataAbsentReason | object | no | v1's string or FHIR's CodeableConcept; untyped so that neither is refused. |
observedAt | string | no | |
effectiveDateTime | string | no | |
effectiveInstant | string | no | |
effectivePeriod | object | no | Only .start and .end are read, as in v1. |
issued | string | no | |
valueQuantity | V1QuantityDto | no | |
valueSampledData | V1SampledDataDto | no | |
valueString | string | no | |
valueInteger | number | no | |
valueBoolean | boolean | no | |
valueDateTime | string | no | |
valueTime | string | no | |
valuePeriod | object | no | |
valueRange | V1RangeDto | no | |
valueRatio | V1RatioDto | no | |
valueCodeableConcept | V1CodeableConceptDto | no |
V1ObservationEntrySchema
| Field | Type | Required | Description |
|---|---|---|---|
observationId | string | yes | |
valueNumber | number | null | yes | |
valueString | string | null | yes | |
valueUnit | string | null | yes | Example: "beats/min". |
note | string | null | yes | |
observedAt | date-time | null | yes | Clinical time the reading was taken. May be absent or backdated. Example: "2026-08-27T09:15:00.000Z". |
recordedAt | date-time | yes | When Signals recorded it. Episode bounds use this clock. Example: "2026-08-27T09:15:00.000Z". |
code | string | null | yes | |
system | string | null | yes | |
display | string | null | yes | |
status | string | null | yes | |
components | ComponentEntrySchema[] | yes | A combined reading's vitals, in the order sent; empty for a single-vital reading. |
category | string[] | yes | The codes of the reading's FHIR category; [] when it was sent none. A reading in one of its tenant's history categories was stored and never judged. Example: ["batch-data"]. |
valueSampledData | object | null | yes | The root's whole FHIR SampledData series, as sent; null when it sent none. Example: {"origin":{"value":0,"unit":"/min"},"period":30000,"dimensions":1,"data":"61 62 E 60"}. |
valueDateTime | date-time | null | yes | The root's valueDateTime; valueNumber is the same instant in epoch ms. Null when it was sent none. |
effectiveStart | date-time | null | yes | The start of the reading's effectivePeriod; null when it was sent none. |
effectiveEnd | date-time | null | yes | The end of the reading's effectivePeriod (a night's statistics end on that night); null when it was sent none. |
deviceId | string | null | yes | The device that sent the reading (FHIR device.reference, v1's device.id). Example: "Device/sleepiz-1". |
_id | string | yes | The same value as id. |
id | string | yes | The observation id, as observationId. |
patient | string | yes | The Signals patient id. |
valueQuantity | object | no | Example: {"value":72,"unit":"/min"}. |
createdAt | date-time | yes | When it was stored, as recordedAt. Example: "2026-08-27T09:15:00.000Z". |
V1ObservationIngestSchema
| Field | Type | Required | Description |
|---|---|---|---|
_id | string | yes | The same value as id. |
id | string | yes | |
patient | string | yes | The Signals patient id. |
code | object | yes | As sent: a FHIR CodeableConcept. Example: {"coding":[{"system":"http://loinc.org","code":"8867-4"}]}. |
valueQuantity | object | no | Example: {"value":72,"unit":"/min"}. |
observedAt | date-time | no | 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". |
observationIds | string[] | yes | |
mode | string | yes | Evaluation finishes before this response in both modes. sync (only under Prefer: respond-sync) means its alerts are reported here rather than by webhook; async means no alerts are reported here and they are delivered by webhook. One of: sync, async. |
alertIds | string[] | no | |
alerts | RaisedAlertSchema[] | no | Sync mode only: alertIds with each alert's code, in the same order. |
resolvedAlertIds | string[] | no | Sync mode only: the alerts this call closed, which no webhook reports either. |
evaluated | number | no | |
ruleCoverage | RuleCoverageSchema | no |
V1ObservationPageSchema
| Field | Type | Required | Description |
|---|---|---|---|
items | V1ObservationEntrySchema[] | yes | Exactly the fields keys instead, when fields is sent. |
total | number | yes | |
page | number | yes | 1-based. |
pageSize | number | yes | |
totalPages | number | yes | |
nextCursor | string | null | yes | Opaque keyset cursor. |
V1ObservationSchema
| Field | Type | Required | Description |
|---|---|---|---|
_id | string | yes | The same value as id. |
id | string | yes | |
patient | string | yes | The Signals patient id. |
code | object | yes | As sent: a FHIR CodeableConcept. Example: {"coding":[{"system":"http://loinc.org","code":"8867-4"}]}. |
valueQuantity | object | no | Example: {"value":72,"unit":"/min"}. |
observedAt | date-time | no | 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". |
V1PatientConfigStatusSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
refId | string | null | yes | Null for an id that resolved to no patient. |
configUpdatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
triggerCodes | string[] | yes | The codes the patient's own settings hold a trigger or a band for, and out of bed (103214-3) when they hold its limit. |
triggerFingerprints | V1TriggerFingerprintSchema[] | yes | The CONTENT behind each code, so a caller can compare configuration instead of only checking that a code is present. Added beside triggerCodes, which keeps its exact old meaning. |
V1PatientPageSchema
| 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 |
V1PatientSchema
| 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 |
V1QuantityDto
| Field | Type | Required | Description |
|---|---|---|---|
value | number | no | |
unit | string | no | |
system | string | no | |
code | string | no |
V1RangeDto
| Field | Type | Required | Description |
|---|---|---|---|
low | V1QuantityDto | no | |
high | V1QuantityDto | no |
V1RatioDto
| Field | Type | Required | Description |
|---|---|---|---|
numerator | V1QuantityDto | no | |
denominator | V1QuantityDto | no |
V1ReadingCodeDto
| Field | Type | Required | Description |
|---|---|---|---|
coding | V1CodingDto[] | yes | |
text | string | no |
V1ReferenceDto
| Field | Type | Required | Description |
|---|---|---|---|
reference | string | no | |
display | string | no |
V1RejectedTriggerSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The patient id as the request named it. |
code | string | yes | Example: "8867-4". |
reason | string | yes | Why the trigger was not stored. |
V1SampledDataDto
| Field | Type | Required | Description |
|---|---|---|---|
origin | V1QuantityDto | no | |
period | number | no | |
factor | number | no | |
lowerLimit | number | no | |
upperLimit | number | no | |
dimensions | number | no | |
data | string | no | Space-separated samples, oldest first; E, L and U are no sample. |
V1TriggerFingerprintSchema
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | Example: "8867-4". |
fingerprint | string | yes | Stable hash of the patient's own trigger for this code, else its band (for out of bed, of its limit), whatever the key order: two patients configured the same way answer with the same string and one that is not stands out. Example: "3f2a9c1de0b74a55". |
updatedAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
V1TriggerWriteCountsSchema
| Field | Type | Required | Description |
|---|---|---|---|
inserted | number | yes | Triggers added to the patient's settings. |
updated | number | yes | Existing triggers changed. |
deleted | number | yes | Triggers (or bands an earlier push stored) removed. |
deletedMissing | number | yes | Deletes for a code the patient held no trigger or band for. These changed nothing and are NOT counted as a modification. |
V1UserPageSchema
| 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 | V1UserSchema[] | yes |
V1UserSchema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
clientId | string | yes | |
name | string | null | yes | |
webhookUrl | string | null | yes | Where alert webhooks are POSTed. |
custom | string | no | v1's custom: an opaque string sent back on every webhook in the x-actimi-custom header. Absent when unset. |
hasWebhookSecret | boolean | yes | Whether v1's webhookSecret is set (event schema 1); a schema-2 subscriber signs with its Standard Webhooks secret instead. Never returned: it is write-only. |
events | string[] | yes | Event patterns this client receives, e.g. alert.*. |
eventSchema | number | yes | Which names and bodies its webhooks use. 1: v1's, alert.trigger with refire and resolved flags. 2: one type per state change (alert.triggered, alert.refired, alert.resolved, …) in the Standard Webhooks envelope {type, timestamp, sequence, data}, the alert carrying its version. One of: 1, 2. |
reach | string | yes | A subscriber's patients: attached, those attached to it, as v1's; all, every patient of the tenant, those enrolled later included. One of: attached, all. |
signingSecret | string | no | On a new event-schema-2 subscriber's create answer only: its first Standard Webhooks signing secret, returned this once. Rotate it with POST /api/subscriber/{id}/webhook/rotate-secret. Example: "whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=". |
createdAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
updatedAt | date-time | yes | Example: "2026-08-27T09:15:00.000Z". |
_id | string | yes | The same value as id. |
role | string | yes | The role in v1's lowercase. Example: "subscriber". |
tenant | string | yes | The tenant id, under v1's name. |
WebhookEndpointSchema
| Field | Type | Required | Description |
|---|---|---|---|
subscriberId | string | yes | |
url | string | null | yes | |
status | string | yes | failing: the newest attempts failed; five days of that disables it. disabled: nothing is sent, and new events are held. One of: enabled, failing, disabled. |
disabledAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
disabledReason | string | null | yes | gone: it answered 410. failing: five days of failures. manual: disabled by a caller. One of: gone, failing, manual. |
failingSince | date-time | null | yes | When the current run of failures began. Example: "2026-08-27T09:15:00.000Z". |
lastSuccessAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
lastFailureAt | date-time | null | yes | Example: "2026-08-27T09:15:00.000Z". |
WriteStampedSettingsDto
| Field | Type | Required | Description |
|---|---|---|---|
resolvedAt | string | no | |
settings | object | yes |
Updated 9 days ago
Did this page help you?