@ovok/core 0.3.2 → 0.3.4

package/README.md

@@ -103,3 +103,17 @@ if ("nextStep" in result && result.nextStep === "mfa") {
   const authenticated = await result.verify(oneTimeCode);
 }
 ```
+
+## Large measurements
+
+`saveMeasurement` and `saveObservations` use conditional creates for idempotent saves. Medplum
+limits a serializable transaction with conditional operations to eight entries, so the SDK keeps
+the first observation in a transaction and sends additional observations in a FHIR batch request.
+This supports measurements such as urine strips and long ECG recordings without changing retry
+behavior. The first observation should remain first when supplying observations manually.
+
+The offline queue applies the same split when it flushes a measurement. A partial retry is safe:
+the first conditional create finds the existing observation and the batch only creates missing
+members. Applications building their own bundles can use the exported
+`MAX_CONDITIONAL_OBSERVATION_ENTRIES` limit. See [FHIR batch requests](https://www.medplum.com/docs/fhir-datastore/fhir-batch-requests)
+for the transaction and batch semantics.

package/dist/client/auth/methods/index.d.ts

@@ -6,6 +6,7 @@ export * from "./requestDeleteUser";
 export * from "./googleLogin";
 export * from "./appleLogin";
 export * from "./resetPassword";
+export * from "./setPasswordFromReset";
 export * from "./logout";
 export * from "./getSessions";
 export * from "./revokeSessions";

package/dist/client/auth/methods/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./requestDeleteUser"), exports);
 __exportStar(require("./googleLogin"), exports);
 __exportStar(require("./appleLogin"), exports);
 __exportStar(require("./resetPassword"), exports);
+__exportStar(require("./setPasswordFromReset"), exports);
 __exportStar(require("./logout"), exports);
 __exportStar(require("./getSessions"), exports);
 __exportStar(require("./revokeSessions"), exports);

package/dist/client/auth/methods/login.js

@@ -12,18 +12,21 @@ async function login(body) {
         body,
         codeChallenge,
     });
-    const tenantCode = (0, handle_tenant_code_1.handleTenantCode)({
-        profiles: startResponse.profiles,
-        tenantCode: body.tenantCode,
-        type: body.type,
-    });
-    if (!tenantCode) {
-        throw new Error("No tenant code found");
-    }
     if (startResponse.nextStep === "mfa") {
         return {
             nextStep: "mfa",
             verify: async (code) => {
+                const tenantCode = body.type === "Practitioner" && !startResponse.profiles
+                    ? body.tenantCode
+                    : (0, handle_tenant_code_1.handleTenantCode)({
+                        profiles: startResponse.profiles,
+                        tenantCode: body.tenantCode,
+                        type: body.type,
+                    });
+                const practitionerTenantCode = tenantCode;
+                if (body.type === "Practitioner" && !practitionerTenantCode) {
+                    throw new Error("No tenant code found");
+                }
                 const mfaResponse = await this.post(`auth/tenant/${body.type}/login/mfa`, {
                     loginId: startResponse.loginId,
                     mfaToken: code,
@@ -34,7 +37,7 @@ async function login(body) {
                         type: "Practitioner",
                         sessionCode: mfaResponse.sessionCode,
                         codeVerifier,
-                        tenantCode,
+                        tenantCode: practitionerTenantCode,
                     });
                 }
                 return (0, exchange_code_1.exchangeCode)({
@@ -46,6 +49,14 @@ async function login(body) {
             },
         };
     }
+    const tenantCode = (0, handle_tenant_code_1.handleTenantCode)({
+        profiles: startResponse.profiles,
+        tenantCode: body.tenantCode,
+        type: body.type,
+    });
+    if (!tenantCode) {
+        throw new Error("No tenant code found");
+    }
     const exchangeCodeProps = body.type === "Practitioner"
         ? {
             client: this,

package/dist/client/auth/methods/setPasswordFromReset.d.ts

@@ -0,0 +1,4 @@
+import { OperationOutcome } from "@medplum/fhirtypes";
+import { OvokClient } from "../../ovok-client";
+import { CompletePasswordResetBody } from "../types/CompletePasswordResetBody";
+export declare function setPasswordFromReset(this: OvokClient, body: CompletePasswordResetBody): Promise<OperationOutcome>;

package/dist/client/auth/methods/setPasswordFromReset.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setPasswordFromReset = setPasswordFromReset;
+async function setPasswordFromReset(body) {
+    return this.post("v2/auth/reset-password/process", body, "application/json");
+}

package/dist/client/auth/types/CompletePasswordResetBody.d.ts

@@ -0,0 +1,5 @@
+export interface CompletePasswordResetBody {
+    id: string;
+    secret: string;
+    password: string;
+}

package/dist/client/auth/types/CompletePasswordResetBody.js

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

package/dist/client/auth/types/Session.d.ts

@@ -2,11 +2,8 @@
 export interface OvokSession {
     id: string;
     authMethod?: string;
-    ip?: string;
-    browser?: string;
-    os?: string;
-    createdAt?: string;
-    lastActiveAt?: string;
+    remoteAddress?: string;
+    lastUpdated?: string;
 }
 /** Session selector accepted by the session revocation endpoint. */
 export type SessionRevokeOption = "current" | "other" | "all" | (string & {});

package/dist/client/errors/rate-limit-error.js

@@ -4,6 +4,7 @@ exports.RateLimitError = void 0;
 exports.isRateLimitError = isRateLimitError;
 exports.mapRateLimitError = mapRateLimitError;
 const core_1 = require("@medplum/core");
+const RATE_LIMIT_RESET_EXTENSION_URL = "https://medplum.com/fhir/StructureDefinition/rate-limit-reset";
 /** A typed error returned when the server asks the client to slow down. */
 class RateLimitError extends Error {
     constructor(retryAfterMs, options) {
@@ -31,10 +32,33 @@ function mapRateLimitError(error) {
         return error;
     }
     if (error instanceof core_1.OperationOutcomeError && isRateLimitOutcome(error.outcome)) {
-        return new RateLimitError((0, core_1.getRateLimitReset)(error.outcome), { cause: error });
+        return new RateLimitError(rateLimitResetFromOutcome(error.outcome), { cause: error });
     }
     return error;
 }
+function rateLimitResetFromOutcome(outcome) {
+    var _a, _b, _c;
+    if (!outcome || typeof outcome !== "object") {
+        return undefined;
+    }
+    const record = outcome;
+    const extension = (_a = record.extension) === null || _a === void 0 ? void 0 : _a.find((candidate) => candidate.url === RATE_LIMIT_RESET_EXTENSION_URL);
+    if (typeof (extension === null || extension === void 0 ? void 0 : extension.valueUnsignedInt) === "number") {
+        return extension.valueUnsignedInt * 1000;
+    }
+    for (const issue of (_b = record.issue) !== null && _b !== void 0 ? _b : []) {
+        try {
+            const diagnostics = JSON.parse((_c = issue.diagnostics) !== null && _c !== void 0 ? _c : "");
+            if (typeof diagnostics.msBeforeNext === "number") {
+                return diagnostics.msBeforeNext;
+            }
+        }
+        catch (_d) {
+            // Diagnostics are optional and may be ordinary human-readable text.
+        }
+    }
+    return undefined;
+}
 function isRateLimitOutcome(outcome) {
     if (!(0, core_1.isOperationOutcome)(outcome)) {
         return false;

package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js

@@ -19,6 +19,12 @@ async function generateObservationBodiesByMeasurement(params) {
     const observationService = creator_1.ObservationServiceCreator.getInstance().getService(measurementTypeKey);
     const deviceObject = (0, getDeviceObject_1.getDeviceObject)(device);
     const observationFragments = (_a = observationService.generateObservationFragments) === null || _a === void 0 ? void 0 : _a.call(observationService, measurement);
+    const applyEffectiveDateTime = (observation) => params.effectiveDateTime && !observation.effectivePeriod
+        ? {
+            ...observation,
+            effectiveDateTime: params.effectiveDateTime.toISOString(),
+        }
+        : observation;
     if (observationFragments) {
         return observationFragments
             .map((fragment) => ({
@@ -32,7 +38,8 @@ async function generateObservationBodiesByMeasurement(params) {
             code: fragment.code,
             ...(fragment.additionalProperties || {}),
         }))
-            .filter(hasObservationValue);
+            .filter(hasObservationValue)
+            .map(applyEffectiveDateTime);
     }
     const observationCodes = observationService.getObservationCodes();
     const values = observationService.generateValues(measurement);
@@ -48,7 +55,7 @@ async function generateObservationBodiesByMeasurement(params) {
         code,
         ...(additionalProperties[index] || {}),
     }));
-    return observationBodies.filter(hasObservationValue);
+    return observationBodies.filter(hasObservationValue).map(applyEffectiveDateTime);
 }
 const hasObservationValue = (observation) => {
     var _a, _b, _c, _d, _e;

package/dist/client/observation/observation-bundle-utils.d.ts

@@ -0,0 +1,6 @@
+import { Bundle, BundleEntry, Observation } from "@medplum/fhirtypes";
+export declare const MAX_OBSERVATION_BUNDLE_BYTES = 900000;
+export declare const MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
+export declare const linkObservationMembers: (observations: Observation[]) => Observation[];
+export declare const splitObservationBundleEntries: (bundle: Bundle) => BundleEntry[][] | undefined;
+export declare const executeObservationBundle: (bundle: Bundle, executeBatch: (bundle: Bundle) => Promise<Bundle>) => Promise<Bundle>;

package/dist/client/observation/observation-bundle-utils.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeObservationBundle = exports.splitObservationBundleEntries = exports.linkObservationMembers = exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = exports.MAX_OBSERVATION_BUNDLE_BYTES = void 0;
+const offline_1 = require("../offline");
+exports.MAX_OBSERVATION_BUNDLE_BYTES = 900000;
+exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
+const linkObservationMembers = (observations) => {
+    const main = observations[0];
+    if (!main) {
+        return observations;
+    }
+    const mainReference = `urn:uuid:${(0, offline_1.stableMeasurementId)(main)}`;
+    return observations.map((observation, index) => {
+        var _a;
+        return index === 0
+            ? observation
+            : {
+                ...observation,
+                hasMember: [
+                    ...((_a = observation.hasMember) !== null && _a !== void 0 ? _a : []),
+                    { reference: mainReference },
+                ],
+            };
+    });
+};
+exports.linkObservationMembers = linkObservationMembers;
+const splitObservationBundleEntries = (bundle) => {
+    var _a;
+    const entries = (_a = bundle.entry) !== null && _a !== void 0 ? _a : [];
+    if (entries.length <= 1 || JSON.stringify(bundle).length <= exports.MAX_OBSERVATION_BUNDLE_BYTES) {
+        return undefined;
+    }
+    const chunks = [];
+    let chunk = [];
+    for (const entry of entries) {
+        const candidate = [...chunk, entry];
+        if (chunk.length > 0 &&
+            JSON.stringify({ ...bundle, entry: candidate }).length > exports.MAX_OBSERVATION_BUNDLE_BYTES) {
+            chunks.push(chunk);
+            chunk = [entry];
+        }
+        else {
+            chunk = candidate;
+        }
+    }
+    if (chunk.length > 0) {
+        chunks.push(chunk);
+    }
+    return chunks;
+};
+exports.splitObservationBundleEntries = splitObservationBundleEntries;
+const executeObservationBundle = async (bundle, executeBatch) => {
+    var _a, _b, _c, _d;
+    const entries = (_a = bundle.entry) !== null && _a !== void 0 ? _a : [];
+    if (bundle.type === "transaction" &&
+        entries.length > exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES) {
+        const transactionResponse = await (0, exports.executeObservationBundle)({ ...bundle, entry: entries.slice(0, 1) }, executeBatch);
+        const batchResponse = await (0, exports.executeObservationBundle)({ ...bundle, type: "batch", entry: entries.slice(1) }, executeBatch);
+        return {
+            resourceType: "Bundle",
+            type: "batch-response",
+            entry: [
+                ...((_b = transactionResponse.entry) !== null && _b !== void 0 ? _b : []),
+                ...((_c = batchResponse.entry) !== null && _c !== void 0 ? _c : []),
+            ],
+        };
+    }
+    const chunks = (0, exports.splitObservationBundleEntries)(bundle);
+    if (chunks) {
+        const responses = [];
+        for (const entry of chunks) {
+            responses.push(await (0, exports.executeObservationBundle)({ ...bundle, entry }, executeBatch));
+        }
+        return {
+            resourceType: "Bundle",
+            type: "batch-response",
+            entry: responses.flatMap((response) => { var _a; return (_a = response.entry) !== null && _a !== void 0 ? _a : []; }),
+        };
+    }
+    const response = await executeBatch(bundle);
+    if ((_d = response.entry) === null || _d === void 0 ? void 0 : _d.some((entry) => {
+        var _a, _b;
+        const status = (_b = (_a = entry.response) === null || _a === void 0 ? void 0 : _a.status) !== null && _b !== void 0 ? _b : "";
+        return status.startsWith("4") || status.startsWith("5");
+    })) {
+        throw response;
+    }
+    return response;
+};
+exports.executeObservationBundle = executeObservationBundle;

package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts

@@ -2,6 +2,7 @@ import { Measurement } from "../../../../types";
 import { MeasurementDevice } from "../measurement/MeasurementDevice";
 export type GenerateObservationBodyParams = {
     device?: MeasurementDevice;
+    effectiveDateTime?: Date;
     patientId?: string;
     measurement: Measurement;
 };

package/dist/client/observation/types/measurement/MeasurementDevice.d.ts

@@ -2,6 +2,8 @@ export type MeasurementDevice = {
     name: string;
     localName: string;
     manufacturerData: string;
+    manufacturerName?: string;
+    model?: string;
     sn: string;
     id: string;
     /**

package/dist/client/observation/utils/getDeviceObject.js

@@ -4,6 +4,8 @@ exports.getDeviceObject = void 0;
 const EXTENSION_BASE_URL = "http://ovok.com/fhir/StructureDefinition";
 const LOCAL_NAME_URL = `${EXTENSION_BASE_URL}/device-local-name`;
 const MANUFACTURER_DATA_URL = `${EXTENSION_BASE_URL}/device-manufacturer-data`;
+const MANUFACTURER_NAME_URL = `${EXTENSION_BASE_URL}/device-manufacturer-name`;
+const MODEL_URL = `${EXTENSION_BASE_URL}/device-model`;
 const SERIAL_NUMBER_URL = `${EXTENSION_BASE_URL}/device-serial-number`;
 const BATTERY_PERCENTAGE_URL = `${EXTENSION_BASE_URL}/device-battery-percentage`;
 /**
@@ -21,6 +23,12 @@ const getBatteryExtension = (batteryPercentage) => {
         },
     ];
 };
+const getOptionalStringExtension = (url, value) => {
+    if (!value) {
+        return [];
+    }
+    return [{ url, valueString: value }];
+};
 const getDeviceObject = (measurementDevice) => {
     var _a, _b;
     if (!measurementDevice) {
@@ -44,6 +52,8 @@ const getDeviceObject = (measurementDevice) => {
                 url: MANUFACTURER_DATA_URL,
                 valueString: measurementDevice.manufacturerData || "no-manufacturer-data",
             },
+            ...getOptionalStringExtension(MANUFACTURER_NAME_URL, measurementDevice.manufacturerName),
+            ...getOptionalStringExtension(MODEL_URL, measurementDevice.model),
             {
                 url: SERIAL_NUMBER_URL,
                 valueString: measurementDevice.sn || "no-serial-number",

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

@@ -8,6 +8,8 @@ import * as observationMethods from "./observation/methods";
 import { GenerateObservationBodyParams } from "./observation/types/generate-observation-body/GenerateObservationBodyParams";
 import { OfflineMeasurementFlushOptions, OfflineMeasurementFlushResult, OfflineMeasurementQueueOptions } from "./offline";
 import * as questionnaireResponseMethods from "./questionnaire-response/methods";
+export declare const MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
+export { MAX_OBSERVATION_BUNDLE_BYTES } from "./observation/observation-bundle-utils";
 export type SaveObservationsResult = {
     status: "saved";
     response: Bundle;
@@ -36,6 +38,7 @@ export declare class OvokClient extends MedplumClient {
     flushOfflineMeasurementQueue(options?: OfflineMeasurementFlushOptions): Promise<OfflineMeasurementFlushResult>;
     private getOfflineMeasurementQueue;
     private executeConditionalObservationCreates;
+    private executeObservationBundle;
     private bindMethods;
     /**
      * Gets the `SubscriptionManager` for WebSocket subscriptions.
@@ -53,4 +56,3 @@ declare module "./ovok-client" {
         clientStorage: IClientStorage | undefined;
     }
 }
-export {};

package/dist/client/ovok-client.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OvokClient = void 0;
+exports.OvokClient = exports.MAX_OBSERVATION_BUNDLE_BYTES = exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = void 0;
 /* eslint-disable @typescript-eslint/no-unsafe-function-type */ // TODO: fix this whenever find time
 const core_1 = require("@medplum/core");
 const aiFhirMethods = __importStar(require("./ai-fhir/methods"));
@@ -42,8 +42,12 @@ const botMethods = __importStar(require("./bot/methods"));
 const aiMethods = __importStar(require("./chat/ai/methods"));
 const rate_limit_error_1 = require("./errors/rate-limit-error");
 const observationMethods = __importStar(require("./observation/methods"));
+const observation_bundle_utils_1 = require("./observation/observation-bundle-utils");
 const offline_1 = require("./offline");
 const questionnaireResponseMethods = __importStar(require("./questionnaire-response/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; } });
 class OvokClient extends core_1.MedplumClient {
     /**
      * @param config - The configuration for the client.
@@ -70,15 +74,16 @@ class OvokClient extends core_1.MedplumClient {
     }
     /** Saves observations with conditional creates so a retry cannot create a duplicate. */
     async saveObservations(observations) {
+        const linkedObservations = (0, observation_bundle_utils_1.linkObservationMembers)(observations);
         const queue = this.getOfflineMeasurementQueue();
         if (queue) {
-            const { id, flush } = await queue.enqueueAndFlush(observations);
+            const { id, flush } = await queue.enqueueAndFlush(linkedObservations);
             const response = flush.responses[id];
             return response
                 ? { status: "saved", response }
                 : { status: "queued", queueId: id };
         }
-        const response = await this.executeConditionalObservationCreates(observations);
+        const response = await this.executeConditionalObservationCreates(linkedObservations);
         return { status: "saved", response };
     }
     /** Flushes measurements queued while offline. Call this on connectivity/app-resume events. */
@@ -103,25 +108,19 @@ class OvokClient extends core_1.MedplumClient {
         if (!this.clientStorage) {
             throw new Error("Offline measurement queue requires a durable client storage adapter.");
         }
-        (_a = this.offlineMeasurementQueue) !== null && _a !== void 0 ? _a : (this.offlineMeasurementQueue = new offline_1.OfflineMeasurementQueue(this.clientStorage, (bundle) => this.executeBatch(bundle), this.offlineQueueOptions));
+        (_a = this.offlineMeasurementQueue) !== null && _a !== void 0 ? _a : (this.offlineMeasurementQueue = new offline_1.OfflineMeasurementQueue(this.clientStorage, (bundle) => this.executeObservationBundle(bundle), this.offlineQueueOptions));
         return this.offlineMeasurementQueue;
     }
     async executeConditionalObservationCreates(observations) {
-        var _a;
         const entries = observations.map(offline_1.entryForObservation);
-        const bundle = await this.executeBatch({
+        return this.executeObservationBundle({
             resourceType: "Bundle",
             type: "transaction",
             entry: entries,
         });
-        if ((_a = bundle.entry) === null || _a === void 0 ? void 0 : _a.some((entry) => {
-            var _a, _b;
-            const status = (_b = (_a = entry.response) === null || _a === void 0 ? void 0 : _a.status) !== null && _b !== void 0 ? _b : "";
-            return status.startsWith("4") || status.startsWith("5");
-        })) {
-            throw bundle;
-        }
-        return bundle;
+    }
+    async executeObservationBundle(bundle) {
+        return (0, observation_bundle_utils_1.executeObservationBundle)(bundle, (request) => this.executeBatch(request));
     }
     bindMethods(methods) {
         for (const [name, method] of Object.entries(methods)) {

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.3.1",
+        version: "0.3.3",
     },
     fhirVersion: "4.0.1",
     format: ["json"],

package/dist/index.d.ts

@@ -924,6 +924,7 @@ declare const Medplum: {
 export { Medplum };
 export { OvokClient } from "./client/ovok-client";
 export * from "./client/errors/rate-limit-error";
+export { MAX_CONDITIONAL_OBSERVATION_ENTRIES, MAX_OBSERVATION_BUNDLE_BYTES, } from "./client/ovok-client";
 export type { SaveObservationsResult } from "./client/ovok-client";
 export * from "./client/offline";
 export * from "./hooks";

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.OvokClient = exports.Medplum = void 0;
+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
@@ -45,6 +45,9 @@ exports.Medplum = Medplum;
 var ovok_client_1 = require("./client/ovok-client");
 Object.defineProperty(exports, "OvokClient", { enumerable: true, get: function () { return ovok_client_1.OvokClient; } });
 __exportStar(require("./client/errors/rate-limit-error"), exports);
+var ovok_client_2 = require("./client/ovok-client");
+Object.defineProperty(exports, "MAX_CONDITIONAL_OBSERVATION_ENTRIES", { enumerable: true, get: function () { return ovok_client_2.MAX_CONDITIONAL_OBSERVATION_ENTRIES; } });
+Object.defineProperty(exports, "MAX_OBSERVATION_BUNDLE_BYTES", { enumerable: true, get: function () { return ovok_client_2.MAX_OBSERVATION_BUNDLE_BYTES; } });
 __exportStar(require("./client/offline"), exports);
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./utils"), exports);

package/package.json

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