@ovok/core 0.4.2 → 0.4.3

package/README.md

@@ -154,13 +154,14 @@ 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.
+The Signals client methods and hooks cover enrolling an existing patient, 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 enrollment = await client.enableSignalsForPatient(patientId);
 const updated = await client.setSignalsThreshold(patientId, "8867-4", {
   low: 50,
   high: 120,
@@ -181,6 +182,11 @@ non-empty `reason`; the backend decides whether the caller has the required capa
 `shared` settings tenant is read-only. Signal errors are exposed as `SignalsError` values and can
 be checked with `isSignalsError`.
 
+Use `enableSignalsForPatient` to enroll an existing patient. It is idempotent and requires the caller to have
+`signals_config:update` and update access to that patient. A `signals_mint_failed` `SignalsError` is a retryable
+503. React applications can call `useEnableSignalsForPatient().mutate(patientId)`; the hook exposes the standard
+mutation `loading`, `error`, and `data` state.
+
 `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

package/dist/client/signals/errors.js

@@ -17,6 +17,7 @@ const SIGNALS_ERROR_STATUSES = {
     signals_write_mismatch: 503,
     signals_unavailable: 503,
     signals_undo_failed: 503,
+    signals_mint_failed: 503,
     signals_forbidden: 403,
     signals_not_found: 404,
     validation_error: 422,

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

@@ -1,5 +1,10 @@
 import { OvokClient } from "../ovok-client";
-import { SetSignalsThresholdBody, SignalsAlert, SignalsAlertsPage, SignalsAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "./types";
+import { EnableSignalsResponse, SetSignalsThresholdBody, SignalsAlert, SignalsAlertsPage, SignalsAlertsQuery, 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.
+ */
+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>;

package/dist/client/signals/methods.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.enableSignalsForPatient = enableSignalsForPatient;
 exports.getSignalsThresholds = getSignalsThresholds;
 exports.setSignalsThreshold = setSignalsThreshold;
 exports.removeSignalsThreshold = removeSignalsThreshold;
@@ -10,6 +11,13 @@ exports.acknowledgeSignalsAlert = acknowledgeSignalsAlert;
 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.
+ */
+function enableSignalsForPatient(patientId) {
+    return this.post(`/fhir/Patient/${segment(patientId)}/$enable-signals`);
+}
 function getSignalsThresholds(patientId) {
     return this.get(`/v1/signals/patients/${segment(patientId)}/thresholds`);
 }

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

@@ -50,5 +50,10 @@ export type SignalsSettingsResponse = {
     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 EnableSignalsResponse = {
+    patientId: string;
+    signalsPatientId: string;
+    enabled: boolean;
+};
+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;

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.2",
+        version: "0.4.3",
     },
     fhirVersion: "4.0.1",
     format: ["json"],
@@ -92,6 +92,16 @@ exports.OVOK_CORE_REQUIREMENTS = {
                         },
                     ],
                 },
+                {
+                    type: "Patient",
+                    operation: [
+                        {
+                            name: "enable-signals",
+                            definition: "https://fhir.ovok.com/fhir/OperationDefinition/patient-enable-signals",
+                            documentation: "enableSignalsForPatient enrolls an existing patient in Signals. The operation is idempotent.",
+                        },
+                    ],
+                },
                 {
                     type: "QuestionnaireResponse",
                     interaction: [

package/dist/hooks/index.d.ts

@@ -11,4 +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";
+export { useAcknowledgeSignalsAlert, useEnableSignalsForPatient, 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.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;
+exports.useUpdateSignalsSettings = exports.useSignalsThresholds = exports.useSignalsSettings = exports.useSignalsAlerts = exports.useSignalsAlert = exports.useSetSignalsThreshold = exports.useRemoveSignalsThreshold = exports.useEnableSignalsForPatient = 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.
  *
@@ -132,6 +132,7 @@ Object.defineProperty(exports, "useRevokePatientSharing", { enumerable: true, ge
 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, "useEnableSignalsForPatient", { enumerable: true, get: function () { return signals_hooks_1.useEnableSignalsForPatient; } });
 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; } });

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

@@ -1,4 +1,4 @@
-import { SetSignalsThresholdBody, SignalsAlert, SignalsAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "../client/signals";
+import { EnableSignalsResponse, SetSignalsThresholdBody, SignalsAlert, SignalsAlertsQuery, SignalsSettingsPatch, SignalsSettingsResponse, SignalsThreshold, SignalsThresholds } from "../client/signals";
 import { OvokMutationState, OvokRequestState } from "./api-hooks";
 type SetSignalsThresholdParams = {
     patientId: string;
@@ -23,6 +23,7 @@ export type SignalsAlertsHookState = {
     hasMore: boolean;
     loadMore: () => Promise<void>;
 };
+export declare const useEnableSignalsForPatient: () => OvokMutationState<string, EnableSignalsResponse>;
 export declare const useSignalsThresholds: (patientId?: string) => OvokRequestState<SignalsThresholds>;
 export declare const useSetSignalsThreshold: () => OvokMutationState<SetSignalsThresholdParams, SignalsThreshold>;
 export declare const useRemoveSignalsThreshold: () => OvokMutationState<RemoveSignalsThresholdParams, void>;

package/dist/hooks/signals-hooks.js

@@ -34,10 +34,12 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useUpdateSignalsSettings = exports.useSignalsSettings = exports.useAcknowledgeSignalsAlert = exports.useSignalsAlert = exports.useSignalsAlerts = exports.useRemoveSignalsThreshold = exports.useSetSignalsThreshold = exports.useSignalsThresholds = void 0;
+exports.useUpdateSignalsSettings = exports.useSignalsSettings = exports.useAcknowledgeSignalsAlert = exports.useSignalsAlert = exports.useSignalsAlerts = exports.useRemoveSignalsThreshold = exports.useSetSignalsThreshold = exports.useSignalsThresholds = exports.useEnableSignalsForPatient = void 0;
 const React = __importStar(require("react"));
 const api_hooks_1 = require("./api-hooks");
 const index_1 = require("./index");
+const useEnableSignalsForPatient = () => (0, api_hooks_1.useOvokMutation)((client, patientId) => client.enableSignalsForPatient(patientId));
+exports.useEnableSignalsForPatient = useEnableSignalsForPatient;
 const useSignalsThresholds = (patientId) => {
     const client = (0, index_1.useClient)();
     const load = React.useCallback(() => client.getSignalsThresholds(patientId), [client, patientId]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ovok/core",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "private": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",