@ovok/core 0.4.1 → 0.4.2

package/README.md

@@ -17,6 +17,7 @@ Core TypeScript SDK for healthcare applications. Provides authentication, AI-FHI
 - 🧭 Runtime discovery of the backend FHIR and public API capabilities
 - 🧩 Typed accounts, projects, localization, and patient-observation APIs
 - 🏥 Typed CareHub patient, device, telemetry, notification, and monitoring APIs
+- 🚨 Typed Signals thresholds, alerts, and project settings APIs
 
 ## Installation
 
@@ -151,6 +152,40 @@ const slots = await client.listPatientSlots({
 });
 ```
 
+## Signals APIs
+
+The Signals client methods and hooks cover resident thresholds, the project's alert feed, and
+Signals tenant settings. Ovok forwards observations for enabled residents to Signals on the
+backend; continue saving readings through the existing Observation APIs and do not submit the
+same readings to Signals separately.
+
+```ts
+const thresholds = await client.getSignalsThresholds(patientId);
+const updated = await client.setSignalsThreshold(patientId, "8867-4", {
+  low: 50,
+  high: 120,
+  reason: "Updated after review",
+});
+const alerts = await client.listSignalsAlerts({
+  status: "OPEN",
+  codes: ["8867-4"],
+  limit: 25,
+});
+await client.acknowledgeSignalsAlert(alerts.items[0].id);
+const settings = await client.getSignalsSettings();
+```
+
+Use `editable` and `source` from threshold rows to present the available controls, but let the
+backend enforce permissions. When lowering alert sensitivity or removing a bound, provide a
+non-empty `reason`; the backend decides whether the caller has the required capability. A
+`shared` settings tenant is read-only. Signal errors are exposed as `SignalsError` values and can
+be checked with `isSignalsError`.
+
+`useSignalsAlerts` accumulates pages through `loadMore`. Check `hasMore` rather than the current
+item count: access filtering can produce a short or empty page with another cursor. Query changes
+and `reload` start again at the first page. The hook exposes `reload` so a screen can refresh its
+alert list after `useAcknowledgeSignalsAlert` succeeds.
+
 ## CareHub APIs
 
 CareHub methods cover the verified `/v1/slim/*` and `/v2/slim/*` application routes for

package/dist/client/ovok-client.d.ts

@@ -14,6 +14,7 @@ import * as patientMethods from "./patient/methods";
 import * as patientSharingMethods from "./patient-sharing/methods";
 import * as platformMethods from "./platform/methods";
 import * as questionnaireResponseMethods from "./questionnaire-response/methods";
+import * as signalsMethods from "./signals/methods";
 export declare const MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
 export { MAX_OBSERVATION_BUNDLE_BYTES } from "./observation/observation-bundle-utils";
 export type SaveObservationsResult = {
@@ -59,7 +60,7 @@ export declare class OvokClient extends MedplumClient {
      */
     getSubscriptionManager(): SubscriptionManager;
 }
-type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof carehubMethods & typeof platformMethods & typeof experienceMethods & typeof patientMethods & typeof patientSharingMethods;
+type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof carehubMethods & typeof platformMethods & typeof experienceMethods & typeof patientMethods & typeof patientSharingMethods & typeof signalsMethods;
 type Omitted<T> = Omit<T, "executeBot">;
 declare module "./ovok-client" {
     interface OvokClient extends Omitted<Methods> {

package/dist/client/ovok-client.js

@@ -51,6 +51,8 @@ const patientMethods = __importStar(require("./patient/methods"));
 const patientSharingMethods = __importStar(require("./patient-sharing/methods"));
 const platformMethods = __importStar(require("./platform/methods"));
 const questionnaireResponseMethods = __importStar(require("./questionnaire-response/methods"));
+const errors_1 = require("./signals/errors");
+const signalsMethods = __importStar(require("./signals/methods"));
 exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
 var observation_bundle_utils_2 = require("./observation/observation-bundle-utils");
 Object.defineProperty(exports, "MAX_OBSERVATION_BUNDLE_BYTES", { enumerable: true, get: function () { return observation_bundle_utils_2.MAX_OBSERVATION_BUNDLE_BYTES; } });
@@ -75,6 +77,7 @@ class OvokClient extends core_1.MedplumClient {
         this.bindMethods(experienceMethods);
         this.bindMethods(patientMethods);
         this.bindMethods(patientSharingMethods);
+        this.bindMethods(signalsMethods, (error) => (0, errors_1.mapSignalsError)((0, rate_limit_error_1.mapRateLimitError)(error), { signalsRequest: true }));
         this.clientStorage = config.storage;
         this.offlineQueueOptions = (_b = config.offlineQueue) !== null && _b !== void 0 ? _b : {};
     }
@@ -141,7 +144,7 @@ class OvokClient extends core_1.MedplumClient {
     async executeObservationBundle(bundle) {
         return (0, observation_bundle_utils_1.executeObservationBundle)(bundle, (request) => this.executeBatch(request));
     }
-    bindMethods(methods) {
+    bindMethods(methods, mapError = rate_limit_error_1.mapRateLimitError) {
         for (const [name, method] of Object.entries(methods)) {
             const boundMethod = method.bind(this);
             this[name] = async (...args) => {
@@ -149,7 +152,7 @@ class OvokClient extends core_1.MedplumClient {
                     return await boundMethod(...args);
                 }
                 catch (error) {
-                    throw (0, rate_limit_error_1.mapRateLimitError)(error);
+                    throw mapError(error);
                 }
             };
         }

package/dist/client/signals/errors.d.ts

@@ -0,0 +1,19 @@
+import { SignalsErrorCode, SignalsFieldError } from "./types";
+type SignalsErrorOptions = {
+    cause?: unknown;
+    fieldErrors?: SignalsFieldError[];
+};
+/** A typed error returned by an Ovok Signals API route. */
+export declare class SignalsError extends Error {
+    readonly code: SignalsErrorCode;
+    readonly status: number;
+    readonly fieldErrors: SignalsFieldError[];
+    readonly cause: unknown;
+    constructor(code: SignalsErrorCode, status: number, message: string, options?: SignalsErrorOptions);
+}
+export declare function isSignalsError(error: unknown): error is SignalsError;
+/** Converts the Signals error envelope while leaving unrelated errors untouched. */
+export declare function mapSignalsError(error: unknown, options?: {
+    signalsRequest?: boolean;
+}): unknown;
+export {};

package/dist/client/signals/errors.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignalsError = void 0;
+exports.isSignalsError = isSignalsError;
+exports.mapSignalsError = mapSignalsError;
+const ovok_error_1 = require("../errors/ovok-error");
+const SIGNALS_ERROR_STATUSES = {
+    signals_threshold_not_editable: 409,
+    signals_patient_not_enrolled: 409,
+    signals_conflict: 409,
+    signals_code_not_medical: 422,
+    signals_reason_required: 422,
+    signals_episodes_disabled: 409,
+    signals_bad_request: 422,
+    signals_shared_tenant: 409,
+    signals_audit_failed: 503,
+    signals_write_mismatch: 503,
+    signals_unavailable: 503,
+    signals_undo_failed: 503,
+    signals_forbidden: 403,
+    signals_not_found: 404,
+    validation_error: 422,
+};
+const SIGNALS_ERROR_CODES = new Set(Object.keys(SIGNALS_ERROR_STATUSES));
+/** A typed error returned by an Ovok Signals API route. */
+class SignalsError extends Error {
+    constructor(code, status, message, options = {}) {
+        var _a;
+        super(message);
+        this.name = "SignalsError";
+        this.code = code;
+        this.status = status;
+        this.fieldErrors = (_a = options.fieldErrors) !== null && _a !== void 0 ? _a : [];
+        if (options.cause !== undefined) {
+            Object.defineProperty(this, "cause", {
+                configurable: true,
+                enumerable: false,
+                value: options.cause,
+                writable: false,
+            });
+        }
+    }
+}
+exports.SignalsError = SignalsError;
+function isSignalsError(error) {
+    return error instanceof SignalsError;
+}
+/** Converts the Signals error envelope while leaving unrelated errors untouched. */
+function mapSignalsError(error, options = {}) {
+    if (isSignalsError(error)) {
+        return error;
+    }
+    const payload = responsePayload(error);
+    const code = responseCode(payload);
+    const parsed = (0, ovok_error_1.parseOvokError)(payload !== null && payload !== void 0 ? payload : error);
+    const message = (parsed.message === "[object Object]" || parsed.message === "undefined") &&
+        error instanceof Error
+        ? error.message
+        : parsed.message;
+    const status = responseStatus(error, payload);
+    if (code && SIGNALS_ERROR_CODES.has(code)) {
+        const knownCode = code;
+        const resolvedStatus = status !== null && status !== void 0 ? status : SIGNALS_ERROR_STATUSES[knownCode];
+        if (resolvedStatus !== undefined) {
+            return new SignalsError(knownCode, resolvedStatus, message, {
+                cause: error,
+                fieldErrors: parsed.fieldErrors,
+            });
+        }
+    }
+    if (status === 409 && options.signalsRequest && !code) {
+        return new SignalsError("signals_conflict", status, message, { cause: error });
+    }
+    if (status === 403 && !code) {
+        return new SignalsError("signals_forbidden", status, message, { cause: error });
+    }
+    if (status === 404 && !code) {
+        return new SignalsError("signals_not_found", status, message, { cause: error });
+    }
+    if (status === 422 && !code) {
+        const validationCode = /reason.*(required|missing|provide|must)|(?:required|missing).{0,20}reason/i.test(message)
+            ? "signals_reason_required"
+            : "validation_error";
+        return new SignalsError(validationCode, status, message, {
+            cause: error,
+            fieldErrors: parsed.fieldErrors,
+        });
+    }
+    return error;
+}
+function responsePayload(error) {
+    var _a, _b;
+    const root = asRecord(error);
+    const candidates = [
+        root === null || root === void 0 ? void 0 : root.body,
+        root === null || root === void 0 ? void 0 : root.data,
+        (_a = asRecord(root === null || root === void 0 ? void 0 : root.response)) === null || _a === void 0 ? void 0 : _a.data,
+        (_b = asRecord(root === null || root === void 0 ? void 0 : root.response)) === null || _b === void 0 ? void 0 : _b.body,
+        root === null || root === void 0 ? void 0 : root.outcome,
+    ];
+    for (const candidate of candidates) {
+        const parsed = parseJson(candidate);
+        if (parsed !== undefined) {
+            return parsed;
+        }
+    }
+    if (error instanceof Error) {
+        const parsed = parseJson(error.message);
+        if (parsed !== undefined) {
+            return parsed;
+        }
+    }
+    return error;
+}
+function responseCode(payload) {
+    var _a, _b, _c, _d, _e, _f;
+    const root = asRecord(payload);
+    const error = asRecord(root === null || root === void 0 ? void 0 : root.error);
+    const directCode = (_b = (_a = (typeof (root === null || root === void 0 ? void 0 : root.error) === "string" ? root.error : undefined)) !== null && _a !== void 0 ? _a : (typeof (root === null || root === void 0 ? void 0 : root.code) === "string" ? root.code : undefined)) !== null && _b !== void 0 ? _b : (typeof (error === null || error === void 0 ? void 0 : error.code) === "string" ? error.code : undefined);
+    if (directCode) {
+        return directCode;
+    }
+    const outcome = (_d = (_c = asRecord(root === null || root === void 0 ? void 0 : root.outcome)) !== null && _c !== void 0 ? _c : root) !== null && _d !== void 0 ? _d : {};
+    const issues = Array.isArray(outcome.issue) ? outcome.issue : [];
+    for (const issue of issues) {
+        const issueRecord = asRecord(issue);
+        const details = asRecord(issueRecord === null || issueRecord === void 0 ? void 0 : issueRecord.details);
+        const coding = Array.isArray(details === null || details === void 0 ? void 0 : details.coding) ? details.coding : [];
+        for (const entry of coding) {
+            const entryCode = (_e = asRecord(entry)) === null || _e === void 0 ? void 0 : _e.code;
+            if (typeof entryCode === "string" && entryCode.startsWith("signals_")) {
+                return entryCode;
+            }
+        }
+        const diagnostic = parseJson(issueRecord === null || issueRecord === void 0 ? void 0 : issueRecord.diagnostics);
+        const diagnosticRecord = asRecord(diagnostic);
+        const diagnosticCode = (_f = diagnosticRecord === null || diagnosticRecord === void 0 ? void 0 : diagnosticRecord.error) !== null && _f !== void 0 ? _f : diagnosticRecord === null || diagnosticRecord === void 0 ? void 0 : diagnosticRecord.code;
+        if (typeof diagnosticCode === "string") {
+            return diagnosticCode;
+        }
+    }
+    return undefined;
+}
+function responseStatus(error, payload) {
+    var _a, _b, _c, _d, _e, _f;
+    const root = asRecord(error);
+    const response = asRecord(root === null || root === void 0 ? void 0 : root.response);
+    const body = asRecord(payload);
+    const status = (_d = (_c = (_b = (_a = root === null || root === void 0 ? void 0 : root.status) !== null && _a !== void 0 ? _a : root === null || root === void 0 ? void 0 : root.statusCode) !== null && _b !== void 0 ? _b : response === null || response === void 0 ? void 0 : response.status) !== null && _c !== void 0 ? _c : body === null || body === void 0 ? void 0 : body.status) !== null && _d !== void 0 ? _d : body === null || body === void 0 ? void 0 : body.statusCode;
+    if (typeof status === "number") {
+        return status;
+    }
+    const outcome = (_e = asRecord(body === null || body === void 0 ? void 0 : body.outcome)) !== null && _e !== void 0 ? _e : body;
+    const issues = Array.isArray(outcome === null || outcome === void 0 ? void 0 : outcome.issue) ? outcome.issue : [];
+    for (const issue of issues) {
+        const issueCode = (_f = asRecord(issue)) === null || _f === void 0 ? void 0 : _f.code;
+        if (issueCode === "conflict") {
+            return 409;
+        }
+        if (issueCode === "forbidden") {
+            return 403;
+        }
+        if (issueCode === "not-found") {
+            return 404;
+        }
+    }
+    return undefined;
+}
+function parseJson(value) {
+    if (typeof value !== "string") {
+        return value;
+    }
+    try {
+        return JSON.parse(value);
+    }
+    catch (_a) {
+        return undefined;
+    }
+}
+function asRecord(value) {
+    return value && typeof value === "object"
+        ? value
+        : undefined;
+}

package/dist/client/signals/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./errors";
+export * from "./methods";
+export * from "./types";

package/dist/client/signals/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors"), exports);
+__exportStar(require("./methods"), exports);
+__exportStar(require("./types"), exports);

package/dist/client/signals/methods.d.ts

@@ -0,0 +1,11 @@
+import { OvokClient } from "../ovok-client";
+import { SetSignalsThresholdBody, SignalsAlert, SignalsAlertsPage, SignalsAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "./types";
+export declare function getSignalsThresholds(this: OvokClient, patientId: string): Promise<SignalsThresholds>;
+export declare function setSignalsThreshold(this: OvokClient, patientId: string, code: string, body: SetSignalsThresholdBody): Promise<SignalsThreshold>;
+export declare function removeSignalsThreshold(this: OvokClient, patientId: string, code: string, reason: string): Promise<void>;
+export declare function serializeSignalsAlertsQuery(query?: SignalsAlertsQuery): string;
+export declare function listSignalsAlerts(this: OvokClient, query?: SignalsAlertsQuery): Promise<SignalsAlertsPage>;
+export declare function getSignalsAlert(this: OvokClient, episodeId: string): Promise<SignalsAlert>;
+export declare function acknowledgeSignalsAlert(this: OvokClient, episodeId: string): Promise<SignalsAlert>;
+export declare function getSignalsSettings(this: OvokClient): Promise<SignalsSettingsResponse>;
+export declare function updateSignalsSettings(this: OvokClient, patch: SignalsSettingsPatch, reason?: string | null): Promise<SignalsSettingsResponse>;

package/dist/client/signals/methods.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignalsThresholds = getSignalsThresholds;
+exports.setSignalsThreshold = setSignalsThreshold;
+exports.removeSignalsThreshold = removeSignalsThreshold;
+exports.serializeSignalsAlertsQuery = serializeSignalsAlertsQuery;
+exports.listSignalsAlerts = listSignalsAlerts;
+exports.getSignalsAlert = getSignalsAlert;
+exports.acknowledgeSignalsAlert = acknowledgeSignalsAlert;
+exports.getSignalsSettings = getSignalsSettings;
+exports.updateSignalsSettings = updateSignalsSettings;
+const segment = (value) => encodeURIComponent(value);
+function getSignalsThresholds(patientId) {
+    return this.get(`/v1/signals/patients/${segment(patientId)}/thresholds`);
+}
+function setSignalsThreshold(patientId, code, body) {
+    return this.put(`/v1/signals/patients/${segment(patientId)}/thresholds/${segment(code)}`, body);
+}
+function removeSignalsThreshold(patientId, code, reason) {
+    return this.delete(`/v1/signals/patients/${segment(patientId)}/thresholds/${segment(code)}?reason=${segment(reason)}`);
+}
+function serializeSignalsAlertsQuery(query = {}) {
+    const params = [];
+    if (query.status !== undefined) {
+        params.push(["status", query.status]);
+    }
+    if (query.since !== undefined) {
+        params.push(["since", query.since]);
+    }
+    if (query.acknowledged !== undefined) {
+        params.push(["acknowledged", String(query.acknowledged)]);
+    }
+    if (query.codes !== undefined) {
+        params.push(["codes", query.codes.join(",")]);
+    }
+    if (query.limit !== undefined) {
+        params.push(["limit", String(query.limit)]);
+    }
+    if (query.cursor !== undefined) {
+        params.push(["cursor", query.cursor]);
+    }
+    return params
+        .map(([key, value]) => `${segment(key)}=${segment(value)}`)
+        .join("&");
+}
+function listSignalsAlerts(query = {}) {
+    const serialized = serializeSignalsAlertsQuery(query);
+    return this.get(`/v1/signals/alerts${serialized ? `?${serialized}` : ""}`);
+}
+function getSignalsAlert(episodeId) {
+    return this.get(`/v1/signals/alerts/${segment(episodeId)}`);
+}
+function acknowledgeSignalsAlert(episodeId) {
+    return this.post(`/v1/signals/alerts/${segment(episodeId)}/ack`);
+}
+function getSignalsSettings() {
+    return this.get("/v1/signals/settings");
+}
+function updateSignalsSettings(patch, reason) {
+    return this.patch("/v1/signals/settings", {
+        ...patch,
+        ...(reason !== undefined ? { reason } : {}),
+    });
+}

package/dist/client/signals/types.d.ts

@@ -0,0 +1,54 @@
+import { ValidationError } from "../../types/ValidationError";
+export type SignalsThresholdSource = "organization" | "individual" | "auto" | "unknown";
+export type SignalsThreshold = {
+    code: string;
+    low: number | null;
+    high: number | null;
+    editable: boolean;
+    version: number;
+    updatedAt: string;
+    source: SignalsThresholdSource;
+};
+export type SignalsThresholds = {
+    patientId: string;
+    thresholds: SignalsThreshold[];
+};
+export type SetSignalsThresholdBody = {
+    low: number | null;
+    high: number | null;
+    reason?: string | null;
+};
+export type SignalsAlertStatus = "OPEN" | "CLOSED";
+export type SignalsAlert = {
+    id: string;
+    patientId: string;
+    signalsPatientId: string;
+    code: string;
+    status: SignalsAlertStatus;
+    [key: string]: unknown;
+};
+export type SignalsAlertsQuery = {
+    status?: SignalsAlertStatus;
+    since?: string;
+    acknowledged?: boolean;
+    codes?: readonly string[];
+    limit?: number;
+    cursor?: string;
+};
+export type SignalsAlertsPage = {
+    items: SignalsAlert[];
+    nextCursor: string | null;
+};
+export type SignalsSettings = {
+    episodicAlerts: boolean;
+    synchronousMode: boolean;
+    throttleLimit: number | null;
+};
+export type SignalsTenantKind = "project" | "shared";
+export type SignalsSettingsResponse = {
+    tenant: SignalsTenantKind;
+    settings: SignalsSettings;
+};
+export type SignalsSettingsPatch = Partial<SignalsSettings>;
+export type SignalsErrorCode = "signals_threshold_not_editable" | "signals_patient_not_enrolled" | "signals_conflict" | "signals_code_not_medical" | "signals_reason_required" | "signals_episodes_disabled" | "signals_bad_request" | "signals_shared_tenant" | "signals_audit_failed" | "signals_write_mismatch" | "signals_unavailable" | "signals_undo_failed" | "signals_forbidden" | "signals_not_found" | "validation_error";
+export type SignalsFieldError = ValidationError;

package/dist/client/signals/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/conformance/capability-requirements.js

@@ -48,7 +48,7 @@ exports.OVOK_CORE_REQUIREMENTS = {
     description: "The FHIR surface a server must provide for the @ovok/core client library's own methods to function.",
     software: {
         name: "@ovok/core",
-        version: "0.4.1",
+        version: "0.4.2",
     },
     fhirVersion: "4.0.1",
     format: ["json"],

package/dist/hooks/index.d.ts

@@ -11,3 +11,4 @@ export { useConsentSignature, useContent, useCreateVideoCallAppointment, useCrea
 export { useI18nextDocument, useLocales, useLocalizations, useUpdateI18nextDocument, useUpdateLocalization, } from "./platform-hooks";
 export { useCurrentPatientProfile, useExtractQuestionnaireObservations, usePatientAppointments, usePatientCarePlans, usePatientDevices, usePatientDeviceTelemetry, usePatientDeviceTelemetryHistory, usePatientMeasurement, usePatientMeasurementHistory, usePatientDashboard, usePatientLatestObservations, usePatientNotifications, usePatientQuestionnaireResponses, usePatientQuestionnaires, usePatientSchedules, usePatientSlots, usePopulateQuestionnaire, useSubmitQuestionnaireResponse, } from "./patient-hooks";
 export { useCreatePatientSharingInvite, usePatientSharing, usePatientSharingSettings, useRedeemPatientSharingInvite, useRevokePatientSharing, useUpdatePatientSharingSettings, } from "./patient-sharing-hooks";
+export { useAcknowledgeSignalsAlert, useRemoveSignalsThreshold, useSetSignalsThreshold, useSignalsAlert, useSignalsAlerts, useSignalsSettings, useSignalsThresholds, useUpdateSignalsSettings, } from "./signals-hooks";

package/dist/hooks/index.js

@@ -35,7 +35,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.usePatientMeasurement = exports.usePatientDeviceTelemetryHistory = exports.usePatientDeviceTelemetry = exports.usePatientDevices = exports.usePatientCarePlans = exports.usePatientAppointments = exports.useExtractQuestionnaireObservations = exports.useCurrentPatientProfile = exports.useUpdateLocalization = exports.useUpdateI18nextDocument = exports.useLocalizations = exports.useLocales = exports.useI18nextDocument = exports.useVideoCallAppointments = exports.useVideoCallAccess = exports.useDocuments = exports.useCreateVideoCallUserAccess = exports.useCreateVideoCallAppointment = exports.useContent = exports.useConsentSignature = exports.useRecentCarehubNotifications = exports.usePublicApiEndpoints = exports.useProjectSettings = exports.useProjectFeatures = exports.useOvokRequest = exports.useOvokMutation = exports.useCapabilityStatement = exports.useCarehubPatients = exports.useCarehubNotifications = exports.useCarehubDevices = exports.useCarehubDeviceTelemetry = exports.useAdministeredProjects = exports.useUrineTests = exports.useSaveMeasurement = exports.useObservations = exports.useEcgRecording = exports.observationsToMeasurements = exports.OvokProvider = exports.useClient = exports.useCachedBinaryUrl = exports.reactContext = exports.useSubscription = exports.useSearchResources = exports.useSearchOne = exports.useSearch = exports.useResource = exports.usePrevious = exports.useMedplumProfile = exports.useMedplumNavigate = exports.useMedplumContext = void 0;
-exports.useUpdatePatientSharingSettings = exports.useRevokePatientSharing = exports.useRedeemPatientSharingInvite = exports.usePatientSharingSettings = exports.usePatientSharing = exports.useCreatePatientSharingInvite = exports.useSubmitQuestionnaireResponse = exports.usePopulateQuestionnaire = exports.usePatientSlots = exports.usePatientSchedules = exports.usePatientQuestionnaires = exports.usePatientQuestionnaireResponses = exports.usePatientNotifications = exports.usePatientLatestObservations = exports.usePatientDashboard = exports.usePatientMeasurementHistory = void 0;
+exports.useUpdateSignalsSettings = exports.useSignalsThresholds = exports.useSignalsSettings = exports.useSignalsAlerts = exports.useSignalsAlert = exports.useSetSignalsThreshold = exports.useRemoveSignalsThreshold = exports.useAcknowledgeSignalsAlert = exports.useUpdatePatientSharingSettings = exports.useRevokePatientSharing = exports.useRedeemPatientSharingInvite = exports.usePatientSharingSettings = exports.usePatientSharing = exports.useCreatePatientSharingInvite = exports.useSubmitQuestionnaireResponse = exports.usePopulateQuestionnaire = exports.usePatientSlots = exports.usePatientSchedules = exports.usePatientQuestionnaires = exports.usePatientQuestionnaireResponses = exports.usePatientNotifications = exports.usePatientLatestObservations = exports.usePatientDashboard = exports.usePatientMeasurementHistory = void 0;
 /*
  * The only React-dependent module in the package.
  *
@@ -130,3 +130,12 @@ Object.defineProperty(exports, "usePatientSharingSettings", { enumerable: true,
 Object.defineProperty(exports, "useRedeemPatientSharingInvite", { enumerable: true, get: function () { return patient_sharing_hooks_1.useRedeemPatientSharingInvite; } });
 Object.defineProperty(exports, "useRevokePatientSharing", { enumerable: true, get: function () { return patient_sharing_hooks_1.useRevokePatientSharing; } });
 Object.defineProperty(exports, "useUpdatePatientSharingSettings", { enumerable: true, get: function () { return patient_sharing_hooks_1.useUpdatePatientSharingSettings; } });
+var signals_hooks_1 = require("./signals-hooks");
+Object.defineProperty(exports, "useAcknowledgeSignalsAlert", { enumerable: true, get: function () { return signals_hooks_1.useAcknowledgeSignalsAlert; } });
+Object.defineProperty(exports, "useRemoveSignalsThreshold", { enumerable: true, get: function () { return signals_hooks_1.useRemoveSignalsThreshold; } });
+Object.defineProperty(exports, "useSetSignalsThreshold", { enumerable: true, get: function () { return signals_hooks_1.useSetSignalsThreshold; } });
+Object.defineProperty(exports, "useSignalsAlert", { enumerable: true, get: function () { return signals_hooks_1.useSignalsAlert; } });
+Object.defineProperty(exports, "useSignalsAlerts", { enumerable: true, get: function () { return signals_hooks_1.useSignalsAlerts; } });
+Object.defineProperty(exports, "useSignalsSettings", { enumerable: true, get: function () { return signals_hooks_1.useSignalsSettings; } });
+Object.defineProperty(exports, "useSignalsThresholds", { enumerable: true, get: function () { return signals_hooks_1.useSignalsThresholds; } });
+Object.defineProperty(exports, "useUpdateSignalsSettings", { enumerable: true, get: function () { return signals_hooks_1.useUpdateSignalsSettings; } });

package/dist/hooks/signals-hooks.d.ts

@@ -0,0 +1,34 @@
+import { SetSignalsThresholdBody, SignalsAlert, SignalsAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "../client/signals";
+import { OvokMutationState, OvokRequestState } from "./api-hooks";
+type SetSignalsThresholdParams = {
+    patientId: string;
+    code: string;
+    body: SetSignalsThresholdBody;
+};
+type RemoveSignalsThresholdParams = {
+    patientId: string;
+    code: string;
+    reason: string;
+};
+type UpdateSignalsSettingsParams = {
+    patch: SignalsSettingsPatch;
+    reason?: string | null;
+};
+type SignalsAlertsHookQuery = Omit<SignalsAlertsQuery, "cursor">;
+export type SignalsAlertsHookState = {
+    items: SignalsAlert[];
+    loading: boolean;
+    error: Error | undefined;
+    reload: () => void;
+    hasMore: boolean;
+    loadMore: () => Promise<void>;
+};
+export declare const useSignalsThresholds: (patientId?: string) => OvokRequestState<SignalsThresholds>;
+export declare const useSetSignalsThreshold: () => OvokMutationState<SetSignalsThresholdParams, SignalsThreshold>;
+export declare const useRemoveSignalsThreshold: () => OvokMutationState<RemoveSignalsThresholdParams, void>;
+export declare const useSignalsAlerts: (query?: SignalsAlertsHookQuery) => SignalsAlertsHookState;
+export declare const useSignalsAlert: (episodeId?: string) => OvokRequestState<SignalsAlert>;
+export declare const useAcknowledgeSignalsAlert: () => OvokMutationState<string, SignalsAlert>;
+export declare const useSignalsSettings: () => OvokRequestState<SignalsSettingsResponse>;
+export declare const useUpdateSignalsSettings: () => OvokMutationState<UpdateSignalsSettingsParams, SignalsSettingsResponse>;
+export {};

package/dist/hooks/signals-hooks.js

@@ -0,0 +1,152 @@
+"use strict";
+"use client";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useUpdateSignalsSettings = exports.useSignalsSettings = exports.useAcknowledgeSignalsAlert = exports.useSignalsAlert = exports.useSignalsAlerts = exports.useRemoveSignalsThreshold = exports.useSetSignalsThreshold = exports.useSignalsThresholds = void 0;
+const React = __importStar(require("react"));
+const api_hooks_1 = require("./api-hooks");
+const index_1 = require("./index");
+const useSignalsThresholds = (patientId) => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getSignalsThresholds(patientId), [client, patientId]);
+    return (0, api_hooks_1.useOvokRequest)(load, patientId !== undefined);
+};
+exports.useSignalsThresholds = useSignalsThresholds;
+const useSetSignalsThreshold = () => (0, api_hooks_1.useOvokMutation)((client, params) => client.setSignalsThreshold(params.patientId, params.code, params.body));
+exports.useSetSignalsThreshold = useSetSignalsThreshold;
+const useRemoveSignalsThreshold = () => (0, api_hooks_1.useOvokMutation)((client, params) => client.removeSignalsThreshold(params.patientId, params.code, params.reason));
+exports.useRemoveSignalsThreshold = useRemoveSignalsThreshold;
+const useSignalsAlerts = (query = {}) => {
+    const client = (0, index_1.useClient)();
+    const queryKey = JSON.stringify(query);
+    const querySnapshot = React.useMemo(() => JSON.parse(queryKey), [queryKey]);
+    const [items, setItems] = React.useState([]);
+    const [nextCursor, setNextCursor] = React.useState(null);
+    const [loading, setLoading] = React.useState(true);
+    const [error, setError] = React.useState();
+    const [revision, setRevision] = React.useState(0);
+    const generation = React.useRef(0);
+    const loadingRef = React.useRef(false);
+    React.useEffect(() => {
+        const requestGeneration = generation.current + 1;
+        generation.current = requestGeneration;
+        loadingRef.current = true;
+        setItems([]);
+        setNextCursor(null);
+        setError(undefined);
+        setLoading(true);
+        client
+            .listSignalsAlerts(querySnapshot)
+            .then((page) => {
+            if (generation.current === requestGeneration) {
+                setItems(page.items);
+                setNextCursor(page.nextCursor);
+            }
+        })
+            .catch((reason) => {
+            if (generation.current === requestGeneration) {
+                setError(toError(reason));
+            }
+        })
+            .finally(() => {
+            if (generation.current === requestGeneration) {
+                loadingRef.current = false;
+                setLoading(false);
+            }
+        });
+        return () => {
+            generation.current += 1;
+        };
+    }, [client, queryKey, querySnapshot, revision]);
+    const loadMore = React.useCallback(async () => {
+        if (nextCursor === null || loadingRef.current) {
+            return;
+        }
+        const requestGeneration = generation.current;
+        loadingRef.current = true;
+        setLoading(true);
+        setError(undefined);
+        try {
+            const page = await client.listSignalsAlerts({
+                ...querySnapshot,
+                cursor: nextCursor,
+            });
+            if (generation.current === requestGeneration) {
+                setItems((current) => [...current, ...page.items]);
+                setNextCursor(page.nextCursor);
+            }
+        }
+        catch (reason) {
+            if (generation.current === requestGeneration) {
+                setError(toError(reason));
+            }
+        }
+        finally {
+            if (generation.current === requestGeneration) {
+                loadingRef.current = false;
+                setLoading(false);
+            }
+        }
+    }, [client, nextCursor, querySnapshot]);
+    const reload = React.useCallback(() => {
+        setRevision((current) => current + 1);
+    }, []);
+    return {
+        items,
+        loading,
+        error,
+        reload,
+        hasMore: nextCursor !== null,
+        loadMore,
+    };
+};
+exports.useSignalsAlerts = useSignalsAlerts;
+const useSignalsAlert = (episodeId) => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getSignalsAlert(episodeId), [client, episodeId]);
+    return (0, api_hooks_1.useOvokRequest)(load, episodeId !== undefined);
+};
+exports.useSignalsAlert = useSignalsAlert;
+const useAcknowledgeSignalsAlert = () => (0, api_hooks_1.useOvokMutation)((client, episodeId) => client.acknowledgeSignalsAlert(episodeId));
+exports.useAcknowledgeSignalsAlert = useAcknowledgeSignalsAlert;
+const useSignalsSettings = () => {
+    const client = (0, index_1.useClient)();
+    const load = React.useCallback(() => client.getSignalsSettings(), [client]);
+    return (0, api_hooks_1.useOvokRequest)(load);
+};
+exports.useSignalsSettings = useSignalsSettings;
+const useUpdateSignalsSettings = () => (0, api_hooks_1.useOvokMutation)((client, params) => client.updateSignalsSettings(params.patch, params.reason));
+exports.useUpdateSignalsSettings = useUpdateSignalsSettings;
+const toError = (error) => error instanceof Error ? error : new Error(String(error));

package/dist/index.d.ts

@@ -941,6 +941,7 @@ export * from "./client/carehub/types";
 export * from "./client/experience/types";
 export * from "./client/patient/types";
 export * from "./client/patient-sharing";
+export { SignalsError, isSignalsError, mapSignalsError } from "./client/signals/errors";
 export * from "./client/storage";
 export * from "./client/questionnaire-response/methods";
 export * from "./client/questionnaire-response/types";

package/dist/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveMeasurement = exports.MAX_OBSERVATION_BUNDLE_BYTES = exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = exports.OvokClient = exports.Medplum = void 0;
+exports.mapSignalsError = exports.isSignalsError = exports.SignalsError = exports.saveMeasurement = exports.MAX_OBSERVATION_BUNDLE_BYTES = exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = exports.OvokClient = exports.Medplum = void 0;
 const MedplumCore = __importStar(require("@medplum/core"));
 __exportStar(require("./types"), exports);
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -64,6 +64,10 @@ __exportStar(require("./client/carehub/types"), exports);
 __exportStar(require("./client/experience/types"), exports);
 __exportStar(require("./client/patient/types"), exports);
 __exportStar(require("./client/patient-sharing"), exports);
+var errors_1 = require("./client/signals/errors");
+Object.defineProperty(exports, "SignalsError", { enumerable: true, get: function () { return errors_1.SignalsError; } });
+Object.defineProperty(exports, "isSignalsError", { enumerable: true, get: function () { return errors_1.isSignalsError; } });
+Object.defineProperty(exports, "mapSignalsError", { enumerable: true, get: function () { return errors_1.mapSignalsError; } });
 __exportStar(require("./client/storage"), exports);
 __exportStar(require("./client/questionnaire-response/methods"), exports);
 __exportStar(require("./client/questionnaire-response/types"), exports);

package/dist/types/index.d.ts

@@ -18,5 +18,6 @@ export * from "../client/chat/ai/types/CreateAiSessionProps";
 export * from "../client/chat/ai/types/SessionMessagesResponse";
 export * from "../client/chat/ai/types/CreateAiSessionResponse";
 export * from "../client/ai-fhir/types";
+export * from "../client/signals/types";
 export * from "./ValidationError";
 export * from "@medplum/core";

package/dist/types/index.js

@@ -38,6 +38,7 @@ __exportStar(require("../client/chat/ai/types/CreateAiSessionProps"), exports);
 __exportStar(require("../client/chat/ai/types/SessionMessagesResponse"), exports);
 __exportStar(require("../client/chat/ai/types/CreateAiSessionResponse"), exports);
 __exportStar(require("../client/ai-fhir/types"), exports);
+__exportStar(require("../client/signals/types"), exports);
 // Common types
 __exportStar(require("./ValidationError"), exports);
 __exportStar(require("@medplum/core"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ovok/core",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "private": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -37,6 +37,7 @@
     "@types/jest": "^29.5.14",
     "@types/node": "^20.11.0",
     "@types/react": "^18.3.12",
+    "@types/react-test-renderer": "^18.3.1",
     "eslint": "^9.15.0",
     "eslint-plugin-check-file": "^2.8.0",
     "eslint-plugin-import": "^2.31.0",
@@ -45,6 +46,7 @@
     "globals": "^15.12.0",
     "jest": "^29.7.0",
     "react": "^18.3.1",
+    "react-test-renderer": "^18.3.1",
     "release-it": "^19.0.6",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",