@ovok/core 0.4.3 → 0.4.5

package/dist/client/invites/methods.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invitePractitioner = invitePractitioner;
+exports.invitePatient = invitePatient;
+exports.acceptPractitionerInvite = acceptPractitionerInvite;
+exports.acceptPatientInvite = acceptPatientInvite;
+exports.acceptInvite = acceptInvite;
+function invitePractitioner(body) {
+    return this.post("/v1/invites/practitioner", body);
+}
+function invitePatient(body) {
+    return this.post("/v1/invites/patient", body);
+}
+function acceptPractitionerInvite(body) {
+    return this.post("/v1/invites/practitioner/accept", body);
+}
+function acceptPatientInvite(body) {
+    return this.post("/v1/invites/patient/accept", body);
+}
+function acceptInvite(body) {
+    var _a;
+    const resourceType = (_a = this.getProfile()) === null || _a === void 0 ? void 0 : _a.resourceType;
+    if (resourceType === "Practitioner") {
+        return this.acceptPractitionerInvite(body);
+    }
+    if (resourceType === "Patient") {
+        return this.acceptPatientInvite(body);
+    }
+    throw new Error("Accepting an invite requires a signed-in Patient or Practitioner profile.");
+}

package/dist/client/invites/parse-accept-invite-link.d.ts

@@ -0,0 +1,3 @@
+import { AcceptInviteBody } from "./types";
+/** Reads an invite link without making a request; callers should remove its code from browser history. */
+export declare function parseAcceptInviteLink(url: string | URL): AcceptInviteBody | null;

package/dist/client/invites/parse-accept-invite-link.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseAcceptInviteLink = parseAcceptInviteLink;
+/** Reads an invite link without making a request; callers should remove its code from browser history. */
+function parseAcceptInviteLink(url) {
+    let parsed;
+    try {
+        parsed = url instanceof URL ? url : new URL(url, "https://ovok.invalid");
+    }
+    catch (_a) {
+        return null;
+    }
+    const inviteId = parsed.searchParams.get("invite");
+    const code = parsed.searchParams.get("code");
+    if (!inviteId ||
+        !/^[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i.test(inviteId) ||
+        !code ||
+        code.length < 16 ||
+        code.length > 128) {
+        return null;
+    }
+    return { inviteId, code };
+}

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

@@ -0,0 +1,19 @@
+import { PatientSharingPractitionerShare } from "../patient-sharing/types";
+export type InviteBody = {
+    email: string;
+    firstName: string;
+    lastName: string;
+};
+export type InviteSent = {
+    status: "sent";
+};
+export type AcceptInviteBody = {
+    inviteId: string;
+    code: string;
+};
+export type AcceptInviteResult = PatientSharingPractitionerShare;
+export declare const OVOK_INVITE_ERROR_CODES: {
+    readonly invitationNotConfigured: "invitation_not_configured";
+    readonly appUrlNotConfigured: "app_url_not_configured";
+    readonly practitionerWithoutAccessPolicy: "practitioner_without_access_policy";
+};

package/dist/client/invites/types.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVOK_INVITE_ERROR_CODES = void 0;
+exports.OVOK_INVITE_ERROR_CODES = {
+    invitationNotConfigured: "invitation_not_configured",
+    appUrlNotConfigured: "app_url_not_configured",
+    practitionerWithoutAccessPolicy: "practitioner_without_access_policy",
+};

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

@@ -6,7 +6,9 @@ import * as authMethods from "./auth/methods";
 import * as botMethods from "./bot/methods";
 import * as carehubMethods from "./carehub/methods";
 import * as aiMethods from "./chat/ai/methods";
+import * as emailMethods from "./email";
 import * as experienceMethods from "./experience/methods";
+import * as inviteMethods from "./invites/methods";
 import * as observationMethods from "./observation/methods";
 import { GenerateObservationBodyParams } from "./observation/types/generate-observation-body/GenerateObservationBodyParams";
 import { OfflineMeasurementFlushOptions, OfflineMeasurementFlushResult, OfflineMeasurementQueueOptions } from "./offline";
@@ -60,7 +62,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 & typeof signalsMethods;
+type Methods = typeof authMethods & typeof observationMethods & typeof questionnaireResponseMethods & typeof aiMethods & typeof aiFhirMethods & typeof botMethods & typeof carehubMethods & typeof emailMethods & typeof platformMethods & typeof experienceMethods & typeof inviteMethods & 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

@@ -42,8 +42,10 @@ const authMethods = __importStar(require("./auth/methods"));
 const botMethods = __importStar(require("./bot/methods"));
 const carehubMethods = __importStar(require("./carehub/methods"));
 const aiMethods = __importStar(require("./chat/ai/methods"));
+const emailMethods = __importStar(require("./email"));
 const rate_limit_error_1 = require("./errors/rate-limit-error");
 const experienceMethods = __importStar(require("./experience/methods"));
+const inviteMethods = __importStar(require("./invites/methods"));
 const observationMethods = __importStar(require("./observation/methods"));
 const observation_bundle_utils_1 = require("./observation/observation-bundle-utils");
 const offline_1 = require("./offline");
@@ -73,8 +75,10 @@ class OvokClient extends core_1.MedplumClient {
         this.bindMethods(aiFhirMethods);
         this.bindMethods(botMethods);
         this.bindMethods(carehubMethods);
+        this.bindMethods(emailMethods);
         this.bindMethods(platformMethods);
         this.bindMethods(experienceMethods);
+        this.bindMethods(inviteMethods);
         this.bindMethods(patientMethods);
         this.bindMethods(patientSharingMethods);
         this.bindMethods(signalsMethods, (error) => (0, errors_1.mapSignalsError)((0, rate_limit_error_1.mapRateLimitError)(error), { signalsRequest: true }));

package/dist/client/patient-sharing/methods.d.ts

@@ -1,8 +1,8 @@
 import { OvokClient } from "../ovok-client";
-import { CreatePatientSharingInvite, PatientSharingInvite, PatientSharingSettings, PatientSharingShare, PatientSharingShares, RedeemPatientSharingInvite } from "./types";
+import { CreatePatientSharingInvite, PatientSharingInvite, PatientSharingSettings, PatientSharingShare, PatientSharingShares, RedeemPatientSharingInvite, PatientSharingSettingsUpdate } from "./types";
 export declare function createPatientSharingInvite(this: OvokClient, body: CreatePatientSharingInvite): Promise<PatientSharingInvite>;
 export declare function redeemPatientSharingInvite(this: OvokClient, body: RedeemPatientSharingInvite): Promise<PatientSharingShare>;
 export declare function listPatientSharing(this: OvokClient): Promise<PatientSharingShares>;
 export declare function revokePatientSharing(this: OvokClient, consentId: string): Promise<void>;
 export declare function getPatientSharingSettings(this: OvokClient): Promise<PatientSharingSettings>;
-export declare function updatePatientSharingSettings(this: OvokClient, settings: PatientSharingSettings): Promise<PatientSharingSettings>;
+export declare function updatePatientSharingSettings(this: OvokClient, settings: PatientSharingSettingsUpdate): Promise<PatientSharingSettings>;

package/dist/client/patient-sharing/methods.js

@@ -14,7 +14,13 @@ function redeemPatientSharingInvite(body) {
     return this.post("/v1/patient-sharing/invites/redeem", body);
 }
 function listPatientSharing() {
-    return this.get("/v1/patient-sharing/shares");
+    return this.get("/v1/patient-sharing/shares").then((shares) => {
+        var _a;
+        return ({
+            ...shares,
+            practitioners: (_a = shares.practitioners) !== null && _a !== void 0 ? _a : [],
+        });
+    });
 }
 async function revokePatientSharing(consentId) {
     await this.delete(`/v1/patient-sharing/shares/${segment(consentId)}`);

package/dist/client/patient-sharing/types.d.ts

@@ -5,18 +5,45 @@ export type PatientSharingInvite = {
 };
 export type PatientSharingShare = {
     consentId: string;
-    [key: string]: unknown;
+    sharer: PatientSharingParty;
+    recipient: PatientSharingParty;
+    codes: string[];
+    startedAt: string | null;
+    endsAt: string | null;
+};
+export type PatientSharingParty = {
+    patientId: string;
+    name: string | null;
+};
+export type PatientSharingPractitionerShare = {
+    consentId: string;
+    sharer: PatientSharingParty;
+    practitioner: {
+        practitionerId: string;
+        name: string | null;
+    };
+    startedAt: string | null;
+    endsAt: string | null;
 };
 export type PatientSharingShares = {
     outgoing: PatientSharingShare[];
     incoming: PatientSharingShare[];
+    practitioners: PatientSharingPractitionerShare[];
 };
 export type CreatePatientSharingInvite = {
     codes: string[];
-    endsAt: string;
+    endsAt: string | null;
 };
 export type RedeemPatientSharingInvite = {
     inviteId: string;
     code: string;
 };
-export type PatientSharingSettings = Record<string, unknown>;
+export type PatientSharingSettings = {
+    enabled: boolean;
+    accessPolicyId: string | null;
+    practitionerSharingEnabled: boolean;
+};
+export type PatientSharingSettingsUpdate = {
+    enabled: boolean;
+    practitionerSharingEnabled?: boolean | null;
+};

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

@@ -1,5 +1,5 @@
 import { OvokClient } from "../ovok-client";
-import { OvokAccount, OvokAdministeredProject, OvokCreateProject, OvokCreatedProject, OvokI18nDocument, OvokI18nValue, OvokInviteProjectMember, OvokLocalization, OvokLocalizationQuery, OvokLocalizationUpdate, OvokLocales, OvokPage, OvokPatientObservations, OvokProjectFeature, OvokProjectFeatures, OvokProjectMember, OvokProjectMemberResponse, OvokProjectSettings, OvokProjectSettingKey, OvokRemoveProjectMemberResponse, OvokUpdateProjectMember } from "./types";
+import { OvokAccount, OvokAdministeredProject, OvokCreateProject, OvokCreatedProject, OvokI18nDocument, OvokI18nValue, OvokInviteProjectMember, OvokLocalization, OvokLocalizationQuery, OvokLocalizationUpdate, OvokLocales, OvokPage, OvokPatientObservations, OvokProjectFeature, OvokProjectFeatures, OvokProjectMember, OvokProjectMemberResponse, OvokProjectSettings, OvokProjectSettingKey, OvokProjectTextSettingKey, OvokRemoveProjectMemberResponse, OvokUpdateProjectMember } from "./types";
 export declare function getAccounts(this: OvokClient): Promise<OvokAccount[]>;
 export declare function listAdministeredProjects(this: OvokClient, params?: {
     page?: number;
@@ -24,6 +24,7 @@ export declare function getProjectFeatures(this: OvokClient): Promise<OvokProjec
 export declare function updateProjectFeatures(this: OvokClient, features: OvokProjectFeature[]): Promise<OvokProjectFeatures>;
 export declare function getProjectSettings(this: OvokClient): Promise<OvokProjectSettings>;
 export declare function updateProjectSetting(this: OvokClient, key: OvokProjectSettingKey, enabled: boolean): Promise<OvokProjectSettings>;
+export declare function updateProjectTextSetting(this: OvokClient, key: OvokProjectTextSettingKey, value: string | null): Promise<OvokProjectSettings>;
 export declare function getLocales(this: OvokClient): Promise<OvokLocales>;
 export declare function updateLocales(this: OvokClient, locales: OvokLocales): Promise<OvokLocales>;
 export declare function listLocalizations(this: OvokClient, language: string, params?: OvokLocalizationQuery): Promise<{

package/dist/client/platform/methods.js

@@ -13,6 +13,7 @@ exports.getProjectFeatures = getProjectFeatures;
 exports.updateProjectFeatures = updateProjectFeatures;
 exports.getProjectSettings = getProjectSettings;
 exports.updateProjectSetting = updateProjectSetting;
+exports.updateProjectTextSetting = updateProjectTextSetting;
 exports.getLocales = getLocales;
 exports.updateLocales = updateLocales;
 exports.listLocalizations = listLocalizations;
@@ -73,6 +74,9 @@ async function getProjectSettings() {
 async function updateProjectSetting(key, enabled) {
     return (await this.put(`/v1/project/settings/${segment(key)}`, { enabled }));
 }
+async function updateProjectTextSetting(key, value) {
+    return (await this.put(`/v1/project/settings/values/${segment(key)}`, { value }));
+}
 async function getLocales() {
     return this.get("/locales");
 }

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

@@ -68,11 +68,20 @@ export type OvokProjectFeatures = {
 export type OvokProjectFeaturesUpdate = {
     features: OvokProjectFeature[];
 };
-export declare const OVOK_PROJECT_SETTING_KEYS: readonly ["CONTENT_ENABLED", "MAILING_ENABLED", "PATIENT_INVITATION_ENABLED", "PATIENT_REGISTRATION_ENABLED", "PATIENT_LOGIN_ENABLED", "PRACTITIONER_INVITATION_ENABLED", "PRACTITIONER_REGISTRATION_ENABLED", "PRACTITIONER_LOGIN_ENABLED", "IOT_ENABLED", "CLINICIAN_INVITE_ON_BUSINESS_EMAIL"];
+export declare const OVOK_PROJECT_SETTING_KEYS: readonly ["CONTENT_ENABLED", "MAILING_ENABLED", "PATIENT_INVITATION_ENABLED", "PATIENT_REGISTRATION_ENABLED", "PATIENT_LOGIN_ENABLED", "PRACTITIONER_INVITATION_ENABLED", "PRACTITIONER_REGISTRATION_ENABLED", "PRACTITIONER_LOGIN_ENABLED", "CLINICIAN_INVITE_ON_BUSINESS_EMAIL"];
 export type OvokProjectSettingKey = (typeof OVOK_PROJECT_SETTING_KEYS)[number];
+export declare const OVOK_PROJECT_TEXT_SETTING_KEYS: readonly ["PATIENT_APP_URL", "PRACTITIONER_APP_URL", "PATIENT_SIGNUP_URL", "CLINICIAN_DASHBOARD_URL", "DEFAULT_PRACTITIONER_ACCESS_POLICY", "CLINICIAN_INVITE_ACCESS_POLICY"];
+export type OvokProjectTextSettingKey = (typeof OVOK_PROJECT_TEXT_SETTING_KEYS)[number];
+export declare const OVOK_PROJECT_TEXT_SETTING_ERROR_CODES: {
+    readonly invalidValue: "INVALID_SETTING_VALUE";
+    readonly appUrlNotAllowed: "APP_URL_NOT_ALLOWED";
+    readonly unknownSetting: "UNKNOWN_SETTING";
+    readonly appUrlNotConfigured: "app_url_not_configured";
+};
 export type OvokProjectSettings = {
     projectId: string;
     settings: Record<OvokProjectSettingKey, boolean>;
+    values: Record<OvokProjectTextSettingKey, string | null>;
 };
 export type OvokLocales = {
     languages: string[];

package/dist/client/platform/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OVOK_PROJECT_SETTING_KEYS = exports.OVOK_PROJECT_FEATURE_VALUES = void 0;
+exports.OVOK_PROJECT_TEXT_SETTING_ERROR_CODES = exports.OVOK_PROJECT_TEXT_SETTING_KEYS = exports.OVOK_PROJECT_SETTING_KEYS = exports.OVOK_PROJECT_FEATURE_VALUES = void 0;
 exports.OVOK_PROJECT_FEATURE_VALUES = [
     "ai",
     "aws-comprehend",
@@ -23,6 +23,19 @@ exports.OVOK_PROJECT_SETTING_KEYS = [
     "PRACTITIONER_INVITATION_ENABLED",
     "PRACTITIONER_REGISTRATION_ENABLED",
     "PRACTITIONER_LOGIN_ENABLED",
-    "IOT_ENABLED",
     "CLINICIAN_INVITE_ON_BUSINESS_EMAIL",
 ];
+exports.OVOK_PROJECT_TEXT_SETTING_KEYS = [
+    "PATIENT_APP_URL",
+    "PRACTITIONER_APP_URL",
+    "PATIENT_SIGNUP_URL",
+    "CLINICIAN_DASHBOARD_URL",
+    "DEFAULT_PRACTITIONER_ACCESS_POLICY",
+    "CLINICIAN_INVITE_ACCESS_POLICY",
+];
+exports.OVOK_PROJECT_TEXT_SETTING_ERROR_CODES = {
+    invalidValue: "INVALID_SETTING_VALUE",
+    appUrlNotAllowed: "APP_URL_NOT_ALLOWED",
+    unknownSetting: "UNKNOWN_SETTING",
+    appUrlNotConfigured: "app_url_not_configured",
+};

package/dist/client/signals/errors.js

@@ -51,21 +51,14 @@ 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);
+    const { code, fieldErrors, message, status } = (0, ovok_error_1.readOvokError)(error);
     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,
+                fieldErrors,
             });
         }
     }
@@ -84,102 +77,8 @@ function mapSignalsError(error, options = {}) {
             : "validation_error";
         return new SignalsError(validationCode, status, message, {
             cause: error,
-            fieldErrors: parsed.fieldErrors,
+            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/methods.d.ts

@@ -1,16 +1,29 @@
 import { OvokClient } from "../ovok-client";
-import { EnableSignalsResponse, SetSignalsThresholdBody, SignalsAlert, SignalsAlertsPage, SignalsAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "./types";
+import { EnableSignalsResponse, SetSignalsThresholdBody, SignalsAlert, SignalsAlertsPage, SignalsAlertsQuery, SignalsRawAlert, SignalsRawAlertsPage, SignalsRawAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "./types";
 /**
- * Enables Signals for an existing patient. The operation is idempotent; observations saved through Ovok are
- * forwarded by the backend, so callers should not submit the same readings to Signals separately.
+ * Enables Signals for an existing patient. The operation is idempotent; retry after 409 or 503.
+ * Observations saved through Ovok are forwarded by the backend, so callers should not submit
+ * the same readings to Signals separately.
  */
 export declare function enableSignalsForPatient(this: OvokClient, patientId: string): Promise<EnableSignalsResponse>;
 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 serializeSignalsAlertsQuery(query?: SignalsAlertsQuery | SignalsRawAlertsQuery, keys?: readonly string[]): 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>;
+/**
+ * The project's individual Signals alerts, not episodes: works whether or not the project's
+ * `episodicAlerts` is on. `acknowledged: false` lists what is still open for the practitioner.
+ */
+export declare function listSignalsRawAlerts(this: OvokClient, query?: SignalsRawAlertsQuery): Promise<SignalsRawAlertsPage>;
+export declare function getSignalsRawAlert(this: OvokClient, alertId: string): Promise<SignalsRawAlert>;
+/**
+ * Acknowledges one alert: it resolves, and `acknowledgedAt` and `acknowledgedActor` record when
+ * and by whom. Idempotent: an acknowledged alert keeps its first acknowledgement. Needs
+ * `signals_alerts:update` and update access to the resident.
+ */
+export declare function acknowledgeSignalsRawAlert(this: OvokClient, alertId: string): Promise<SignalsRawAlert>;
 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

@@ -8,12 +8,16 @@ exports.serializeSignalsAlertsQuery = serializeSignalsAlertsQuery;
 exports.listSignalsAlerts = listSignalsAlerts;
 exports.getSignalsAlert = getSignalsAlert;
 exports.acknowledgeSignalsAlert = acknowledgeSignalsAlert;
+exports.listSignalsRawAlerts = listSignalsRawAlerts;
+exports.getSignalsRawAlert = getSignalsRawAlert;
+exports.acknowledgeSignalsRawAlert = acknowledgeSignalsRawAlert;
 exports.getSignalsSettings = getSignalsSettings;
 exports.updateSignalsSettings = updateSignalsSettings;
 const segment = (value) => encodeURIComponent(value);
 /**
- * Enables Signals for an existing patient. The operation is idempotent; observations saved through Ovok are
- * forwarded by the backend, so callers should not submit the same readings to Signals separately.
+ * Enables Signals for an existing patient. The operation is idempotent; retry after 409 or 503.
+ * Observations saved through Ovok are forwarded by the backend, so callers should not submit
+ * the same readings to Signals separately.
  */
 function enableSignalsForPatient(patientId) {
     return this.post(`/fhir/Patient/${segment(patientId)}/$enable-signals`);
@@ -27,28 +31,28 @@ function setSignalsThreshold(patientId, 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)}`)
+// Each route's own filters, in the order they are sent: a key outside the list is never sent, so
+// a wider object passed as an episode query can't turn into a refused request.
+const EPISODE_QUERY_KEYS = ["status", "since", "acknowledged", "codes", "limit", "cursor"];
+const RAW_ALERT_QUERY_KEYS = [
+    "status",
+    "patientId",
+    "since",
+    "until",
+    "acknowledged",
+    "codes",
+    "limit",
+    "cursor",
+];
+function serializeSignalsAlertsQuery(query = {}, keys = EPISODE_QUERY_KEYS) {
+    const values = query;
+    return keys
+        .filter((key) => values[key] !== undefined)
+        .map((key) => {
+        const value = values[key];
+        const text = Array.isArray(value) ? value.join(",") : String(value);
+        return `${segment(key)}=${segment(text)}`;
+    })
         .join("&");
 }
 function listSignalsAlerts(query = {}) {
@@ -61,6 +65,25 @@ function getSignalsAlert(episodeId) {
 function acknowledgeSignalsAlert(episodeId) {
     return this.post(`/v1/signals/alerts/${segment(episodeId)}/ack`);
 }
+/**
+ * The project's individual Signals alerts, not episodes: works whether or not the project's
+ * `episodicAlerts` is on. `acknowledged: false` lists what is still open for the practitioner.
+ */
+function listSignalsRawAlerts(query = {}) {
+    const serialized = serializeSignalsAlertsQuery(query, RAW_ALERT_QUERY_KEYS);
+    return this.get(`/v1/signals/raw-alerts${serialized ? `?${serialized}` : ""}`);
+}
+function getSignalsRawAlert(alertId) {
+    return this.get(`/v1/signals/raw-alerts/${segment(alertId)}`);
+}
+/**
+ * Acknowledges one alert: it resolves, and `acknowledgedAt` and `acknowledgedActor` record when
+ * and by whom. Idempotent: an acknowledged alert keeps its first acknowledgement. Needs
+ * `signals_alerts:update` and update access to the resident.
+ */
+function acknowledgeSignalsRawAlert(alertId) {
+    return this.post(`/v1/signals/raw-alerts/${segment(alertId)}/ack`);
+}
 function getSignalsSettings() {
     return this.get("/v1/signals/settings");
 }

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

@@ -39,6 +39,79 @@ export type SignalsAlertsPage = {
     items: SignalsAlert[];
     nextCursor: string | null;
 };
+/** Signals' own state of a raw alert: ACTIVE while breaching, RESOLVED once recovered or acknowledged. */
+export type SignalsRawAlertStatus = "ACTIVE" | "RESOLVED";
+/** The person who acknowledged an alert. */
+export type SignalsAcknowledgedActor = {
+    /** A FHIR reference, e.g. `Practitioner/<id>`. */
+    reference: string;
+    display: string | null;
+};
+/**
+ * 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.
+ */
+export type SignalsRawAlert = {
+    id: string;
+    /** The resident's Medplum Patient id. */
+    patientId: string;
+    signalsPatientId: string;
+    /** The LOINC code that breached; null when no reading's code raised it. */
+    code: string | null;
+    /**
+     * TRIGGER is a threshold breach; EMPTY a reading with no value; NOTE a note; INACTIVE a resident
+     * who stopped reporting.
+     */
+    reason: "TRIGGER" | "EMPTY" | "NOTE" | "INACTIVE";
+    /** The latest breaching reading, as a number or as text. */
+    valueNumber: number | null;
+    valueString: string | null;
+    /** The rule's own payload; it names the bound that was crossed. */
+    message: string | null;
+    observationId: string | null;
+    triggerCode: string | null;
+    triggerVersion: number | null;
+    status: SignalsRawAlertStatus;
+    createdAt: string;
+    resolvedAt: string | null;
+    acknowledgedAt: string | null;
+    /** The Signals client that acknowledged it (Ovok's), not a person: use `acknowledgedActor`. */
+    acknowledgedBy: string | null;
+    acknowledgedActor: SignalsAcknowledgedActor | null;
+    [key: string]: unknown;
+};
+export type SignalsRawAlertsQuery = {
+    status?: SignalsRawAlertStatus;
+    /** `false` for the alerts still open for the practitioner, whatever their `status`. */
+    acknowledged?: boolean;
+    /**
+     * One resident's alerts, by Medplum Patient id. 404 when the caller can't read the resident,
+     * 409 `signals_patient_not_enrolled` when they aren't in Signals yet.
+     */
+    patientId?: string;
+    /** LOINC codes, e.g. `["8867-4", "9279-1"]`. Omitted or empty, every alert. */
+    codes?: readonly string[];
+    /** Alerts created at or after this date-time, with `Z` or an offset. */
+    since?: string;
+    /** Alerts created before this date-time, with `Z` or an offset. */
+    until?: string;
+    /** 1 to 50; 50 when omitted. */
+    limit?: number;
+    /** The previous page's `nextCursor`, passed back unchanged. */
+    cursor?: string;
+};
+/**
+ * Newest first. A page can be shorter than `limit`, even empty, and still have a next one: alerts
+ * of residents the caller can't read are left out. Page until `nextCursor` is null.
+ */
+export type SignalsRawAlertsPage = {
+    items: SignalsRawAlert[];
+    nextCursor: string | null;
+};
 export type SignalsSettings = {
     episodicAlerts: boolean;
     synchronousMode: boolean;
@@ -53,7 +126,7 @@ export type SignalsSettingsPatch = Partial<SignalsSettings>;
 export type EnableSignalsResponse = {
     patientId: string;
     signalsPatientId: string;
-    enabled: boolean;
+    enabled: true;
 };
 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_mint_failed" | "signals_forbidden" | "signals_not_found" | "validation_error";
 export type SignalsFieldError = ValidationError;