SignalsRawAlert

One individual Signals alert, not an episode: available whether or not the project's episodicAlerts is on. id, createdAt and resolvedAt are Signals' own.

An alert stays open for the practitioner until it is acknowledged: acknowledgedAt is null until then, even when status is already RESOLVED because the reading recovered. Acknowledging resolves it, and the next breaching reading opens a new alert.

Kind: Type alias
Package: @ovok/core

Import

import { SignalsRawAlert } from '@ovok/core';

TypeScript shape

type SignalsRawAlert = {
    id: string;
    patientId: string;
    signalsPatientId: string;
    code: string | null;
    reason: "TRIGGER" | "EMPTY" | "NOTE" | "INACTIVE";
    valueNumber: number | null;
    valueString: string | null;
    message: string | null;
    observationId: string | null;
    triggerCode: string | null;
    triggerVersion: number | null;
    status: SignalsRawAlertStatus;
    createdAt: string;
    resolvedAt: string | null;
    acknowledgedAt: string | null;
    acknowledgedBy: string | null;
    acknowledgedActor: SignalsAcknowledgedActor | null;
    noteCount: number | null;
    [key: string]: unknown;
};

This is a type-level export; it has no call parameters.

Public members

Member	Type	Details
id	string	—
patientId	string	—
signalsPatientId	string	—
code	string | null	The LOINC code that breached; null when no reading's code raised it.
reason	"TRIGGER" | "EMPTY" | "NOTE" | "INACTIVE"	TRIGGER is a threshold breach; EMPTY a reading with no value; NOTE a note; INACTIVE a resident who stopped reporting.
valueNumber	number | null	The latest breaching reading, as a number or as text.
valueString	string | null	—
message	string | null	The rule's own payload; it names the bound that was crossed.
observationId	string | null	—
triggerCode	string | null	—
triggerVersion	number | null	—
status	SignalsRawAlertStatus	—
createdAt	string	—
resolvedAt	string | null	—
acknowledgedAt	string | null	—
acknowledgedBy	string | null	The Signals client that acknowledged it (Ovok's), not a person: use acknowledgedActor.
acknowledgedActor	SignalsAcknowledgedActor | null	—
noteCount	number | null	—

Learn the workflow

Continue with Signals for the workflow context and examples.

Source

View the declaration in the SDK source.