Schemas

Every response and request body shape.

Every response and request body shape referenced by the API.

AcknowledgedActorSchema

FieldTypeRequiredDescription
referencestringyesThe caller's own identifier for the person, opaque to Signals. Carehub sends a FHIR reference such as Practitioner/1a2b3c.
displaystring | nullyesA 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

FieldTypeRequiredDescription
codeobjectyesExample: {"coding":[{"code":"8867-4"}]}.
valueQuantityobjectnoExample: {"value":128}.
valueStringstringno

AlertPageSchema

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.
itemsV1AlertSchema[]yes

AlertPatientSchema

FieldTypeRequiredDescription
idstringyes
tagsobjectnoThe patient's v1 tags. Absent when unset. Example: {"ward":"3B"}.
metadataobjectyesThe patient's metadata.
createdAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".

AssociatePatientsDto

FieldTypeRequiredDescription
patientsstring[]yes

AttachedPatientsSchema

FieldTypeRequiredDescription
patientsstring[]yesSignals patient ids.

AttemptDocumentSchema

FieldTypeRequiredDescription
attemptedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
durationMsnumberyes
deliveredbooleanyes
statusCodenumber | nullyesNull when no answer came back.
errorstring | nullyesExample: "HTTP 503".
responseSnippetstring | nullyesThe first 2 KB of the answer.

AttemptPageSchema

FieldTypeRequiredDescription
itemsAttemptDocumentSchema[]yesOldest first, at most 100.

ComponentEntrySchema

FieldTypeRequiredDescription
codestringyesExample: "8867-4".
systemstringnoExample: "http://loinc.org".
displaystringnoExample: "Heart rate".
valueNumbernumbernoExample: 72.
valueUnitstringnoExample: "/min".
valueStringstringno
valueDateTimedate-timenoA date-time value as sent; valueNumber is the same instant in epoch ms.
valueSampledDataobjectnoThe component's whole FHIR SampledData series, as sent. Example: {"origin":{"value":0,"unit":"/min"},"period":30000,"dimensions":1,"data":"61 62 E 60"}.
dataAbsentReasonstringnoFHIR's reason the device sent no value: its first coding's code, else its text. Example: "not-performed".
sequencenumberyesPosition in the reading as sent.

CreateUserDto

FieldTypeRequiredDescription
rolestringyesValidated 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.
clientIdstringyes
secretstringyes
namestringno
webhookUrlurino
webhookSecretstringno
eventsstring[]no
customstringnov1's custom: an opaque string every webhook carries back as x-actimi-custom.
eventSchemanumberno1 keeps v1's event names and bodies; 2, the default, sends one name per state change. One of: 1, 2.
reachstringnoattached: the patients attached to it, as v1's; all: every patient of the tenant, later ones included. One of: attached, all.

DbHealthSchema

FieldTypeRequiredDescription
okbooleanyesWhether the database answered within the probe timeout.
latencyMsnumbernoRound-trip time of the probe query. Present when ok.
errorstringnoWhy the probe failed. Present when ok is false.

EffectivePeriodSchema

FieldTypeRequiredDescription
startdate-timeyesWhen the absence began. Example: "2026-08-27T09:15:00.000Z".
enddate-timeyesThe reading or tick that last fired it. Example: "2026-08-27T09:15:00.000Z".

EventDocumentSchema

FieldTypeRequiredDescription
idstringyesThe delivery: one event to one subscriber. Name it in /api/events/{id}/….
eventIdstringyesThe event, as webhook-id and x-actimi-event-id; shared by its copies to other subscribers.
eventTypestringyesExample: "alert.trigger".
subscriberIdstringyesThe subscriber's Signals id.
statusstringyespending: 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.
attemptsnumberyesAttempts since it was queued or last redelivered.
nextAttemptAtdate-time | nullyesWhen it is next tried; null unless pending. Example: "2026-08-27T09:15:00.000Z".
lastStatusCodenumber | nullyes
lastErrorstring | nullyes
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
redeliveredAtdate-time | nullyesWhen a redeliver last queued it. Example: "2026-08-27T09:15:00.000Z".
payloadobjectyesThe body the webhook carries.

EventPageSchema

FieldTypeRequiredDescription
itemsEventDocumentSchema[]yes
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.

FieldErrorSchema

FieldTypeRequiredDescription
fieldstring | nullyesThe field, by its path. Example: "ids".
codestringyesWhat is wrong with it. Example: "FIELD_INVALID_TYPE".
paramsobject | nullyesExample: null.

NotificationPageSchema

FieldTypeRequiredDescription
itemsNotificationSchema[]yes
nextCursorstring | nullyesOpaque. Pass it back as cursor for the next page; null means this page was the last. Do not construct or parse it.

NotificationSchema

FieldTypeRequiredDescription
idstringyes
tenantIdstringyes
patientIdstringyes
codestringyesExample: "8867-4".
systemstring | nullyesExample: "http://loinc.org".
displaystring | nullyes
statusstringyesOne of: OPEN, CLOSED.
openedAtdate-timeyesWhen 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".
closedAtdate-time | nullyesWhen 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".
closeReasonstring | nullyesRECOVERED 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.
lastSampleAtdate-timeyesThe 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".
durationMsnumberyesOpen episodes measure to their newest reading, not to now.
observationCountnumberyesEvery reading in the episode, including the one that closed it.
firingCountnumberyesHow many of those breached. Excludes the recovery reading.
minValuenumber | nullyesSpans all readings in the window.
maxValuenumber | nullyes
avgValuenumber | nullyes
lastValuenumber | nullyes
peakValuenumber | nullyesThe furthest-from-normal value while breaching. This is the number to show a clinician — min/max include the recovery reading.
peakAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
lastFiringValuenumber | nullyesThe 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.
lastFiringAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
firstObservationIdstringyes
lastObservationIdstringyes
lastAlertIdstring | nullyes
triggerIdstring | nullyes
triggerVersionnumber | nullyes
dedupKeystringyes
firedAlertMessagestring | nullyesThe 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.
observationEffectivePeriodobject | nullyesOut 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.
limitSecondsnumber | nullyesOut 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.
kindstringyesOne of: medical.
acknowledgedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
acknowledgedBystring | nullyes
acknowledgedActorobject | nullyesThe 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

FieldTypeRequiredDescription
projectstring | nullyesThe project these settings are for; null for the tenant-wide row.
settingsobjectyesOpaque to Signals beyond triggers; the triggers give the other keys their meaning. Example: {"bands":{"8867-4":{"low":50,"high":110}}}.
createdbooleannoPUT ?ifAbsent=true only: whether this call created the row.

PatientConfigDocumentSchema

FieldTypeRequiredDescription
alertIfEmptybooleanyes
alertIfNotebooleanyes
alertInactiveDaysnumber | nullyes
updatedAtdate-time | nullyesWhen this config last changed. Example: "2026-08-27T09:15:00.000Z".
triggersobjectyesThe patient's stored triggers, and its own bands for codes without one, keyed by code, in the shape v1 keyed its triggers.

PatientSettingsItemSchema

FieldTypeRequiredDescription
patientIdstringyes
refIdstring | nullyes
settingsobjectyesOpaque to Signals beyond triggers; the triggers give the other keys their meaning. Example: {"bands":{"8867-4":{"low":50,"high":110}}}.

PatientSettingsPageSchema

FieldTypeRequiredDescription
itemsPatientSettingsItemSchema[]yes
nextCursorstring | nullyes

PatientSettingsSchema

FieldTypeRequiredDescription
patientIdstringyes
settingsobjectyesOpaque to Signals beyond triggers; the triggers give the other keys their meaning. Example: {"bands":{"8867-4":{"low":50,"high":110}}}.

QueuedSchema

FieldTypeRequiredDescription
queuednumberyesDeliveries queued to be sent again.

RaisedAlertSchema

FieldTypeRequiredDescription
idstringyes
codestring | nullyesExample: "8867-4".

RotatedSigningSecretSchema

FieldTypeRequiredDescription
secretstringyesThe new Standard Webhooks signing secret, whsec_ and 32 random bytes in base64. Example: "whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=".
previousSecretExpiresAtdate-time | nullyesWhen the replaced secret stops signing; null when there was none.

RuleCoverageSchema

FieldTypeRequiredDescription
uncoveredCodesstring[]yesCodes 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"].
fingerprintsobjectyesEvery 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"}.
ruleSetstringyesDeprecated: always triggers, what judges every reading. Kept for callers that read it. Example: "triggers".

SubmitterAttachSchema

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

SubmitterDetachSchema

FieldTypeRequiredDescription
submitterIdstringyes
patientIdstringyes

SubscriberAttachSchema

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

SubscriberDetachSchema

FieldTypeRequiredDescription
subscriberIdstringyes
patientIdstringyes

SubscriberEventsDto

FieldTypeRequiredDescription
eventsstring[]yes

SubscriberEventsSchema

FieldTypeRequiredDescription
modifiedCountnumberyesAlways 1 on success.
eventsstring[]yes

TenantSchema

FieldTypeRequiredDescription
idstringyes
namestringyes
settingsobjectyesFeature 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.
orgSettingsobject | nullyesThe 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}}}.
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".

TenantSettingsDto

FieldTypeRequiredDescription
synchronousModebooleannoReturn from ingest before evaluation runs; evaluation continues in the background.
episodicAlertsbooleannoGroup firing observations into AlertEpisode rows and expose the episode routes.
mtlsEnabledbooleannoDeliver the tenant's webhooks over mutual TLS, presenting Signals' client certificate, to https endpoints only.
episodeIdleMinutesnumbernoThe grouping boundary. When a reading arrives after a gap wider than this, it opens a new episode instead of joining the open one.
episodeDisconnectMinutesnumbernoThe 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.
throttleLimitnumbernoThis 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.
ruleSetstring | nullnoDeprecated 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.
informationalCodesstring[]noCodes 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.
historyCategoriesstring[]noReading categories that are history: stored, never judged, never a trigger input.
feedCodesstring[]noThe codes the notification feed lists when the caller names none; empty lists every code.

TestDeliverySchema

FieldTypeRequiredDescription
deliveredbooleanyes
statusCodenumber | nullyes
durationMsnumberyes
errorstring | nullyes
responseSnippetstring | nullyesThe first 2 KB of the answer.

TriggerDocumentSchema

FieldTypeRequiredDescription
codestringyesExample: "8867-4".
systemstring | nullyes
displaystring | nullyes
valueKeystringyesExample: "value".
constantsobjectyesA 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 }.
logicobject | nullyesA 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.
metadataobjectyes
versionnumberyes
updatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".

UpdateClientDto

FieldTypeRequiredDescription
secretstringno
namestringno
webhookUrlurino
webhookSecretstringno
eventsstring[]no
customstringnov1's custom: an opaque string every webhook carries back as x-actimi-custom.
eventSchemanumbernoMoves the subscriber to another event schema: 2 sends one name per state change. One of: 1, 2.
reachstringnoOne of: attached, all.

UpdatePatientDto

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

UpdateTenantDto

FieldTypeRequiredDescription
namestringno
settingsTenantSettingsDtono
orgSettingsobjectnoThe tenant's rule settings, merged key by key: a key sent replaces the stored one, null removes it.
resolvedAtstringnoWhen the caller resolved orgSettings: it lands only over a write resolved earlier.

V1AlertSchema

FieldTypeRequiredDescription
idstringyes
tenantIdstringyes
patientIdstringyes
observationIdstring | nullyes
statusstringyesOne of: ACTIVE, RESOLVED.
codestring | nullyesExample: "8867-4".
dedupKeystring | nullyesWhat 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".
messagestring | nullyesSupplied by the rule when it returns one. ECH rules return a JSON document here describing which bound was crossed.
valueNumbernumber | nullyes
valueStringstring | nullyesThe rule's own payload; carries the level and colour the UI paints.
triggerCodestring | nullyes
triggerVersionnumber | nullyes
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
resolvedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
acknowledgedAtdate-time | nullyesWhen 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".
acknowledgedBystring | nullyesThe client that acknowledged it, or null.
acknowledgedActorobject | nullyesThe 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".
observationEffectivePeriodobject | nullyesOut 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.
limitSecondsnumber | nullyesOut 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.
_idstringyesThe same value as id, under v1's name.
reasonstringyesv1'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.
observationstring | nullyesThe observation id.
componentobject | nullyesThe reading that fired, rebuilt from its stored code and value.
triggerobject | nullyesExample: {"code":"8867-4"}.
updatedAtdate-timeyesThe last change: raised, resolved or acknowledged. Example: "2026-08-27T09:15:00.000Z".
patientAlertPatientSchemayes

V1BatchConfigDto

FieldTypeRequiredDescription
patientsV1BatchConfigEntrySchema[]yes

V1BatchConfigEntrySchema

FieldTypeRequiredDescription
idstringyesSignals patient id, or the caller's refId.
triggersV1ConfigTriggerSchema[]no
metadataobjectnoLabels for this patient, merged not replaced. Whatever key the notification feed is queried by must appear here, or the patient is invisible to it.
resolvedAtstringnoISO-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.
alertIfEmptybooleanno
alertIfNotebooleanno
alertInactiveDaysnumberno

V1BatchConfigResultSchema

FieldTypeRequiredDescription
matchednumberyes
modifiednumberyes
staleIgnorednumberyesEntries refused for carrying a configuration resolved before the one already applied, summed across the batch.
resultsobject[]yesPer-patient match and modify counts.
missesstring[]yes
rejectedV1RejectedTriggerSchema[]yesTriggers without logic, per patient, so nothing was stored for them.

V1BulkStatusDto

FieldTypeRequiredDescription
idsstring[]yes

V1CodeableConceptDto

FieldTypeRequiredDescription
codingV1CodingDto[]no
textstringno

V1CodingDto

FieldTypeRequiredDescription
systemstringno
codestringno
displaystringno

V1ComponentDto

FieldTypeRequiredDescription
codeV1CodeableConceptDtoyes
dataAbsentReasonV1CodeableConceptDtono
valueQuantityV1QuantityDtono
valueSampledDataV1SampledDataDtono
valueStringstringno
valueIntegernumberno
valueBooleanbooleanno
valueDateTimestringno
valueTimestringno
valuePeriodobjectno
valueRangeV1RangeDtono
valueRatioV1RatioDtono
valueCodeableConceptV1CodeableConceptDtono

V1ConfigDto

FieldTypeRequiredDescription
resolvedAtstringnoISO-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.
triggersV1ConfigTriggerSchema[]no
idsstring[]yes
metadataobjectnoStamped onto the Patient rows named by ids, merged not replaced.
alertIfEmptybooleanno
alertIfNotebooleanno
alertInactiveDaysnumberno

V1ConfigEnvelopeSchema

FieldTypeRequiredDescription
idsstring[]yesThe ids the request named, echoed back.
statusV1ConfigResultSchemayes

V1ConfigResultSchema

FieldTypeRequiredDescription
acknowledgedbooleanyes
matchedCountnumberyes
modifiedCountnumberyesPatients 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.
triggerWritesunknownyesThe row counts behind modifiedCount, summed across every patient named.
staleIgnoredCountnumberyesPatients 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.
missesstring[]yesIds that matched no patient. Reported rather than failing the batch.
rejectedV1RejectedTriggerSchema[]yesTriggers without logic, so nothing was stored for them. Empty when every trigger was stored.

V1ConfigTriggerSchema

FieldTypeRequiredDescription
codestringyesLOINC code. Unique per patient. Example: "8867-4".
systemstringnoExample: "http://loinc.org".
displaystringno
valueKeystringnoKey the rule reads the reading under. Example: "value".
constantsobjectnoNamed values the rule compares against, e.g. { "low": 50, "high": 110 }.
logicobjectnojson-logic. May return a boolean, a string used as the message, or an object {alert, value, message} — the shape the ECH rules use.
deletebooleannoRemove this trigger instead of writing it. The patient stops being alerted on the code.
metadataobjectnoFree-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

FieldTypeRequiredDescription
configobjectnoInitial config, applied in the same call: alertIfEmpty, alertIfNote, alertInactiveDays, and triggers in the same shape as V1ConfigTriggerSchema, including its metadata stamp.
idstringno
namestringno
refIdstringyes
submittersstring[]no
subscribersstring[]no
metadataobjectno
emailemail | nullno
bsnstring | nullno
umoIdstring | nullno
dateOfBirthstring | nullno
tagsobject | nullno

V1CreatePatientsDto

FieldTypeRequiredDescription
patientsV1CreatePatientEntry[]yes

V1ErrorSchema

FieldTypeRequiredDescription
namestringyesv1's error class name. Example: "ValidationError".
messagestringyes
codenumberyesThe HTTP status. Example: 422.
typeuriyesThe 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".
dataobjectnoDetail: the failed checks for a validation error, extra fields otherwise.
statusnumberyesThe HTTP status, as RFC 9457 names it. Example: 422.
detailstringyesWhat went wrong, for a person. A 5xx never names its cause. Example: "The request has invalid fields.".
instancestringyesThe route that failed. Example: "/api/patient/config/bulk-status".
traceIdstring | nullyesThe OpenTelemetry trace of the request, to quote when reporting it. Example: "4bf92f3577b34da6a3ce929d0e0e4736".
errorsFieldErrorSchema[]yesOne entry per invalid field of a validation error; empty otherwise.

V1HealthSchema

FieldTypeRequiredDescription
healthybooleanyesFalse while the database does not answer, as db.ok; the status stays 200. Example: true.
dbunknownyesDatabase reachability; ok is false on a stall.
versionstring | nullyesThe running release: the one the deploy workflow stamped, else <next>-dev+<commit>; null when neither is known. Example: "1.2.0-rc.3".
commitstring | nullyesThe commit the running build was made from; null when unknown. Example: "a1b2c3d".

V1IdentifierDto

FieldTypeRequiredDescription
systemstringno
valuestringno

V1ObservationBatchDto

FieldTypeRequiredDescription
observationsV1ObservationDto[]yes

V1ObservationByRefDto

FieldTypeRequiredDescription
patientRefIdstringno
resourceTypestringno
identifierV1IdentifierDto[]no
refIdstringno
statusstringno
categoryobject[]noIts codings' codes are stored; a code the tenant names in historyCategories makes the reading history: stored, never judged.
noteobjectnoAccepted 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.
codeV1ReadingCodeDtoyes
subjectV1ReferenceDtono
componentV1ComponentDto[]no
deviceobjectnoid (v1) or reference (FHIR) names the device.
dataAbsentReasonobjectnov1's string or FHIR's CodeableConcept; untyped so that neither is refused.
observedAtstringno
effectiveDateTimestringno
effectiveInstantstringno
effectivePeriodobjectnoOnly .start and .end are read, as in v1.
issuedstringno
valueQuantityV1QuantityDtono
valueSampledDataV1SampledDataDtono
valueStringstringno
valueIntegernumberno
valueBooleanbooleanno
valueDateTimestringno
valueTimestringno
valuePeriodobjectno
valueRangeV1RangeDtono
valueRatioV1RatioDtono
valueCodeableConceptV1CodeableConceptDtono

V1ObservationDto

FieldTypeRequiredDescription
resourceTypestringno
identifierV1IdentifierDto[]no
refIdstringno
statusstringno
categoryobject[]noIts codings' codes are stored; a code the tenant names in historyCategories makes the reading history: stored, never judged.
noteobjectnoAccepted 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.
codeV1ReadingCodeDtoyes
subjectV1ReferenceDtono
componentV1ComponentDto[]no
deviceobjectnoid (v1) or reference (FHIR) names the device.
dataAbsentReasonobjectnov1's string or FHIR's CodeableConcept; untyped so that neither is refused.
observedAtstringno
effectiveDateTimestringno
effectiveInstantstringno
effectivePeriodobjectnoOnly .start and .end are read, as in v1.
issuedstringno
valueQuantityV1QuantityDtono
valueSampledDataV1SampledDataDtono
valueStringstringno
valueIntegernumberno
valueBooleanbooleanno
valueDateTimestringno
valueTimestringno
valuePeriodobjectno
valueRangeV1RangeDtono
valueRatioV1RatioDtono
valueCodeableConceptV1CodeableConceptDtono

V1ObservationEntrySchema

FieldTypeRequiredDescription
observationIdstringyes
valueNumbernumber | nullyes
valueStringstring | nullyes
valueUnitstring | nullyesExample: "beats/min".
notestring | nullyes
observedAtdate-time | nullyesClinical time the reading was taken. May be absent or backdated. Example: "2026-08-27T09:15:00.000Z".
recordedAtdate-timeyesWhen Signals recorded it. Episode bounds use this clock. Example: "2026-08-27T09:15:00.000Z".
codestring | nullyes
systemstring | nullyes
displaystring | nullyes
statusstring | nullyes
componentsComponentEntrySchema[]yesA combined reading's vitals, in the order sent; empty for a single-vital reading.
categorystring[]yesThe 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"].
valueSampledDataobject | nullyesThe 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"}.
valueDateTimedate-time | nullyesThe root's valueDateTime; valueNumber is the same instant in epoch ms. Null when it was sent none.
effectiveStartdate-time | nullyesThe start of the reading's effectivePeriod; null when it was sent none.
effectiveEnddate-time | nullyesThe end of the reading's effectivePeriod (a night's statistics end on that night); null when it was sent none.
deviceIdstring | nullyesThe device that sent the reading (FHIR device.reference, v1's device.id). Example: "Device/sleepiz-1".
_idstringyesThe same value as id.
idstringyesThe observation id, as observationId.
patientstringyesThe Signals patient id.
valueQuantityobjectnoExample: {"value":72,"unit":"/min"}.
createdAtdate-timeyesWhen it was stored, as recordedAt. Example: "2026-08-27T09:15:00.000Z".

V1ObservationIngestSchema

FieldTypeRequiredDescription
_idstringyesThe same value as id.
idstringyes
patientstringyesThe Signals patient id.
codeobjectyesAs sent: a FHIR CodeableConcept. Example: {"coding":[{"system":"http://loinc.org","code":"8867-4"}]}.
valueQuantityobjectnoExample: {"value":72,"unit":"/min"}.
observedAtdate-timenoExample: "2026-08-27T09:15:00.000Z".
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
observationIdsstring[]yes
modestringyesEvaluation 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.
alertIdsstring[]no
alertsRaisedAlertSchema[]noSync mode only: alertIds with each alert's code, in the same order.
resolvedAlertIdsstring[]noSync mode only: the alerts this call closed, which no webhook reports either.
evaluatednumberno
ruleCoverageRuleCoverageSchemano

V1ObservationPageSchema

FieldTypeRequiredDescription
itemsV1ObservationEntrySchema[]yesExactly the fields keys instead, when fields is sent.
totalnumberyes
pagenumberyes1-based.
pageSizenumberyes
totalPagesnumberyes
nextCursorstring | nullyesOpaque keyset cursor.

V1ObservationSchema

FieldTypeRequiredDescription
_idstringyesThe same value as id.
idstringyes
patientstringyesThe Signals patient id.
codeobjectyesAs sent: a FHIR CodeableConcept. Example: {"coding":[{"system":"http://loinc.org","code":"8867-4"}]}.
valueQuantityobjectnoExample: {"value":72,"unit":"/min"}.
observedAtdate-timenoExample: "2026-08-27T09:15:00.000Z".
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".

V1PatientConfigStatusSchema

FieldTypeRequiredDescription
idstringyes
refIdstring | nullyesNull for an id that resolved to no patient.
configUpdatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
triggerCodesstring[]yesThe codes the patient's own settings hold a trigger or a band for, and out of bed (103214-3) when they hold its limit.
triggerFingerprintsV1TriggerFingerprintSchema[]yesThe 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

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

V1PatientSchema

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

V1QuantityDto

FieldTypeRequiredDescription
valuenumberno
unitstringno
systemstringno
codestringno

V1RangeDto

FieldTypeRequiredDescription
lowV1QuantityDtono
highV1QuantityDtono

V1RatioDto

FieldTypeRequiredDescription
numeratorV1QuantityDtono
denominatorV1QuantityDtono

V1ReadingCodeDto

FieldTypeRequiredDescription
codingV1CodingDto[]yes
textstringno

V1ReferenceDto

FieldTypeRequiredDescription
referencestringno
displaystringno

V1RejectedTriggerSchema

FieldTypeRequiredDescription
idstringyesThe patient id as the request named it.
codestringyesExample: "8867-4".
reasonstringyesWhy the trigger was not stored.

V1SampledDataDto

FieldTypeRequiredDescription
originV1QuantityDtono
periodnumberno
factornumberno
lowerLimitnumberno
upperLimitnumberno
dimensionsnumberno
datastringnoSpace-separated samples, oldest first; E, L and U are no sample.

V1TriggerFingerprintSchema

FieldTypeRequiredDescription
codestringyesExample: "8867-4".
fingerprintstringyesStable 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".
updatedAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".

V1TriggerWriteCountsSchema

FieldTypeRequiredDescription
insertednumberyesTriggers added to the patient's settings.
updatednumberyesExisting triggers changed.
deletednumberyesTriggers (or bands an earlier push stored) removed.
deletedMissingnumberyesDeletes for a code the patient held no trigger or band for. These changed nothing and are NOT counted as a modification.

V1UserPageSchema

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.
itemsV1UserSchema[]yes

V1UserSchema

FieldTypeRequiredDescription
idstringyes
tenantIdstringyes
clientIdstringyes
namestring | nullyes
webhookUrlstring | nullyesWhere alert webhooks are POSTed.
customstringnov1's custom: an opaque string sent back on every webhook in the x-actimi-custom header. Absent when unset.
hasWebhookSecretbooleanyesWhether 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.
eventsstring[]yesEvent patterns this client receives, e.g. alert.*.
eventSchemanumberyesWhich 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.
reachstringyesA 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.
signingSecretstringnoOn 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=".
createdAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
updatedAtdate-timeyesExample: "2026-08-27T09:15:00.000Z".
_idstringyesThe same value as id.
rolestringyesThe role in v1's lowercase. Example: "subscriber".
tenantstringyesThe tenant id, under v1's name.

WebhookEndpointSchema

FieldTypeRequiredDescription
subscriberIdstringyes
urlstring | nullyes
statusstringyesfailing: the newest attempts failed; five days of that disables it. disabled: nothing is sent, and new events are held. One of: enabled, failing, disabled.
disabledAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
disabledReasonstring | nullyesgone: it answered 410. failing: five days of failures. manual: disabled by a caller. One of: gone, failing, manual.
failingSincedate-time | nullyesWhen the current run of failures began. Example: "2026-08-27T09:15:00.000Z".
lastSuccessAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".
lastFailureAtdate-time | nullyesExample: "2026-08-27T09:15:00.000Z".

WriteStampedSettingsDto

FieldTypeRequiredDescription
resolvedAtstringno
settingsobjectyes

Did this page help you?