@ovok/core 0.3.23 → 0.4.0

package/README.md

@@ -282,6 +282,35 @@ if ("nextStep" in result && result.nextStep === "mfa") {
 }
 ```
 
+## Patient registration invitations
+
+When a project invites people with a business email address to join as clinicians,
+`register()` can return a clinician-invite step instead of an authenticated session. Check
+`nextStep` before reading tokens or setting the active login:
+
+```typescript
+const result = await client.register(registerBody);
+
+if ("nextStep" in result && result.nextStep === "clinician-invite") {
+  showCheckYourEmailMessage();
+  return;
+}
+
+await client.setActiveLogin(result);
+```
+
+The invitation email's “continue as patient” link includes a
+`continueAsPatientToken` query parameter. The host app owns its deep-link and universal-link
+configuration: read that parameter from the incoming URL and pass it to `register()` to finish
+registration as a patient:
+
+```typescript
+await client.register({ ...registerBody, continueAsPatientToken });
+```
+
+The token is optional and is sent only when provided. An invalid or expired token is rejected
+with HTTP 400 and the message “The continue-as-patient link is invalid or has expired.”
+
 ## Large measurements
 
 `saveMeasurement` and `saveObservations` use conditional creates for idempotent saves. Medplum

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

@@ -1,4 +1,4 @@
 import { OvokClient } from "../../ovok-client";
-import { AuthResponse } from "../types/AuthResponse";
 import { RegisterBody } from "../types/RegisterBody";
-export declare function register(this: OvokClient, body: RegisterBody): Promise<AuthResponse>;
+import { RegisterResponse } from "../types/RegisterResponse";
+export declare function register(this: OvokClient, body: RegisterBody): Promise<RegisterResponse>;

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

@@ -11,5 +11,8 @@ async function register(body) {
         name: body.name,
         surname: body.surname,
         tenantCode: body.tenantCode,
+        ...(body.continueAsPatientToken !== undefined
+            ? { continueAsPatientToken: body.continueAsPatientToken }
+            : {}),
     }, "application/json");
 }

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

@@ -5,4 +5,5 @@ export interface RegisterBody {
     name: string;
     surname: string;
     tenantCode: string;
+    continueAsPatientToken?: string;
 }

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

@@ -0,0 +1,5 @@
+import { AuthResponse } from "./AuthResponse";
+export type ClinicianInviteStep = {
+    nextStep: "clinician-invite";
+};
+export type RegisterResponse = AuthResponse | ClinicianInviteStep;

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

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

package/dist/client/observation/methods/observationsToMeasurements.d.ts

@@ -1,6 +1,6 @@
 import { Observation } from "@medplum/fhirtypes";
-import { BloodGlucoseMeasurement, BloodPressureMeasurement, BodyTemperatureMeasurement, BodyWeightMeasurement, EcgMeasurement, HeartRateMeasurement, HeartRateVariabilityMeasurement, LipidPanelMeasurement, Measurement, MeasurementTypeKey, PulseOximeterMeasurement, RespiratoryRateMeasurement, RespiratoryTherapyMeasurement, RestingHeartRateMeasurement, StepCountMeasurement, UrineAnalyzeMeasurement, Vo2MaxMeasurement, WalkingHeartRateAverageMeasurement } from "../../../types";
-export type SupportedMeasurement = BloodGlucoseMeasurement | BloodPressureMeasurement | BodyTemperatureMeasurement | BodyWeightMeasurement | EcgMeasurement | HeartRateMeasurement | HeartRateVariabilityMeasurement | LipidPanelMeasurement | PulseOximeterMeasurement | RespiratoryRateMeasurement | RespiratoryTherapyMeasurement | RestingHeartRateMeasurement | StepCountMeasurement | UrineAnalyzeMeasurement | Vo2MaxMeasurement | WalkingHeartRateAverageMeasurement | Measurement;
+import { BabySleepMeasurement, BloodGlucoseMeasurement, BloodPressureMeasurement, BodyTemperatureMeasurement, BodyWeightMeasurement, EcgMeasurement, HeartRateMeasurement, HeartRateVariabilityMeasurement, LipidPanelMeasurement, Measurement, MeasurementTypeKey, PulseOximeterMeasurement, RespiratoryRateMeasurement, RespiratoryTherapyMeasurement, RestingHeartRateMeasurement, StepCountMeasurement, UrineAnalyzeMeasurement, Vo2MaxMeasurement, WalkingHeartRateAverageMeasurement } from "../../../types";
+export type SupportedMeasurement = BloodGlucoseMeasurement | BabySleepMeasurement | BloodPressureMeasurement | BodyTemperatureMeasurement | BodyWeightMeasurement | EcgMeasurement | HeartRateMeasurement | HeartRateVariabilityMeasurement | LipidPanelMeasurement | PulseOximeterMeasurement | RespiratoryRateMeasurement | RespiratoryTherapyMeasurement | RestingHeartRateMeasurement | StepCountMeasurement | UrineAnalyzeMeasurement | Vo2MaxMeasurement | WalkingHeartRateAverageMeasurement | Measurement;
 type SupportedType = Exclude<MeasurementTypeKey, MeasurementTypeKey.symptomQuestionnaire>;
 export type ObservationGrouping = "hasMember" | "time" | ((observation: Observation, index: number, observations: readonly Observation[]) => string);
 export interface ObservationsToMeasurementsOptions {

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

@@ -384,6 +384,12 @@ const inverseGroup = (type, observations) => {
                 measurementTypeKey: type,
                 components: respiratoryComponents(observations),
             };
+        case types_1.MeasurementTypeKey.babySleep:
+            return {
+                ...measurement,
+                measurementTypeKey: type,
+                components: respiratoryComponents(observations),
+            };
         default:
             return measurement;
     }
@@ -415,6 +421,7 @@ const codesForType = {
         ...LIPID_FIELDS.flatMap(({ codes }) => codes),
     ],
     [types_1.MeasurementTypeKey.respiratoryTherapy]: [types_1.ObservationCode.RESPIRATORY_THERAPY],
+    [types_1.MeasurementTypeKey.babySleep]: [types_1.ObservationCode.BABY_SLEEP],
 };
 const observationCodesForTypes = (types) => [...new Set(types.flatMap((type) => { var _a; return (_a = codesForType[type]) !== null && _a !== void 0 ? _a : []; }))].join(",");
 exports.observationCodesForTypes = observationCodesForTypes;
@@ -437,6 +444,10 @@ const observationsToMeasurements = (observations, types, options = {}) => {
                 respiratoryComponents(group.observations).length === 0) {
                 return;
             }
+            if (type === types_1.MeasurementTypeKey.babySleep &&
+                respiratoryComponents(group.observations).length === 0) {
+                return;
+            }
             output.push(inverseGroup(type, group.observations));
         });
     });

package/dist/client/observation/services/baby-sleep.d.ts

@@ -0,0 +1,28 @@
+import { Observation } from "@medplum/fhirtypes";
+import { BabySleepMeasurement, Measurement, MeasurementTypeKey, ObservationCode } from "../../../types";
+import { RecordResult, RecordType } from "../types/generate-measurement/HealthConnectTypes";
+import { Sample } from "../types/generate-measurement/Sample";
+import { ObservationFragment } from "../types/generate-observation-body/ObservationFragment";
+import { ObservationValue } from "../types/generate-observation-body/ObservationValue";
+import { ObservationMetadata } from "../types/service/ObservationMetadata";
+import { BaseObservationService } from "./base-observation-service";
+export declare class BabySleepService extends BaseObservationService<BabySleepMeasurement> {
+    protected measurementTypeKey: MeasurementTypeKey;
+    protected measurementTypeName: string;
+    protected observationMetadata: ObservationMetadata<BabySleepMeasurement>[];
+    generateObservationFragments(measurement: Measurement): ObservationFragment[];
+    getObservationCodes(): {
+        coding: {
+            code: ObservationCode;
+            display: string;
+            system: string;
+        }[];
+    }[];
+    getAdditionalProperties(measurement: Measurement): Partial<Observation>[];
+    generateValues(_measurement: Measurement): ObservationValue[];
+    getUnits(): string[];
+    getMeasurementDisplay(measurement: Measurement): string;
+    getObservationDisplay(observations: Observation[]): string | undefined;
+    convertSamplesToMeasurement(_samples: Sample[]): BabySleepMeasurement;
+    convertRecordToMeasurement(_record: RecordResult<RecordType>): BabySleepMeasurement;
+}

package/dist/client/observation/services/baby-sleep.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BabySleepService = void 0;
+const types_1 = require("../../../types");
+const base_observation_service_1 = require("./base-observation-service");
+const BABY_SLEEP_SYSTEM = "https://sdk.ovok.com/fhir/CodeSystem/measurement-type";
+const recordedAt = (measurement) => measurement.recordedAt instanceof Date &&
+    !Number.isNaN(measurement.recordedAt.getTime())
+    ? measurement.recordedAt.toISOString()
+    : new Date().toISOString();
+class BabySleepService extends base_observation_service_1.BaseObservationService {
+    constructor() {
+        super(...arguments);
+        this.measurementTypeKey = types_1.MeasurementTypeKey.babySleep;
+        this.measurementTypeName = "baby sleep";
+        this.observationMetadata = [];
+    }
+    generateObservationFragments(measurement) {
+        const babySleep = this.getCastedMeasurement(measurement);
+        if (babySleep.components.length === 0) {
+            return [];
+        }
+        return [{
+                code: {
+                    coding: [{
+                            code: types_1.ObservationCode.BABY_SLEEP,
+                            display: "Baby sleep observation",
+                            system: BABY_SLEEP_SYSTEM,
+                        }],
+                },
+                additionalProperties: {
+                    effectiveDateTime: recordedAt(babySleep),
+                    component: babySleep.components,
+                },
+            }];
+    }
+    getObservationCodes() {
+        return [{
+                coding: [{
+                        code: types_1.ObservationCode.BABY_SLEEP,
+                        display: "Baby sleep observation",
+                        system: BABY_SLEEP_SYSTEM,
+                    }],
+            }];
+    }
+    getAdditionalProperties(measurement) {
+        return [{ effectiveDateTime: recordedAt(this.getCastedMeasurement(measurement)) }];
+    }
+    generateValues(_measurement) {
+        return [];
+    }
+    getUnits() {
+        return [];
+    }
+    getMeasurementDisplay(measurement) {
+        return `${this.getCastedMeasurement(measurement).components.length} baby sleep metrics`;
+    }
+    getObservationDisplay(observations) {
+        const count = observations.reduce((total, observation) => { var _a, _b; return total + ((_b = (_a = observation.component) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0); }, 0);
+        return count ? `${count} baby sleep metrics` : undefined;
+    }
+    convertSamplesToMeasurement(_samples) {
+        throw new Error("Baby sleep samples are not supported.");
+    }
+    convertRecordToMeasurement(_record) {
+        throw new Error("Baby sleep Health Connect records are not supported.");
+    }
+}
+exports.BabySleepService = BabySleepService;

package/dist/client/observation/services/creator.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObservationServiceCreator = void 0;
 const types_1 = require("../../../types");
+const baby_sleep_1 = require("./baby-sleep");
 const blood_glucose_1 = require("./blood-glucose");
 const blood_oxygen_1 = require("./blood-oxygen");
 const blood_pressure_1 = require("./blood-pressure");
@@ -47,6 +48,7 @@ class ObservationServiceCreator {
         this.services.set(types_1.MeasurementTypeKey.uricAcid, new uric_acid_service_1.UricAcidService());
         this.services.set(types_1.MeasurementTypeKey.lipidPanel, new lipid_panel_1.LipidPanelService());
         this.services.set(types_1.MeasurementTypeKey.respiratoryTherapy, new respiratory_therapy_1.RespiratoryTherapyService());
+        this.services.set(types_1.MeasurementTypeKey.babySleep, new baby_sleep_1.BabySleepService());
     }
     getService(type) {
         const service = this.services.get(type);

package/dist/client/observation/types/MeasurementTypeKey.d.ts

@@ -20,5 +20,6 @@ export declare enum MeasurementTypeKey {
     restingHeartRate = "resting-heart-rate",
     walkingHeartRateAverage = "walking-heart-rate-average",
     lipidPanel = "lipid-panel",
-    respiratoryTherapy = "respiratory-therapy"
+    respiratoryTherapy = "respiratory-therapy",
+    babySleep = "baby-sleep"
 }

package/dist/client/observation/types/MeasurementTypeKey.js

@@ -25,4 +25,5 @@ var MeasurementTypeKey;
     MeasurementTypeKey["walkingHeartRateAverage"] = "walking-heart-rate-average";
     MeasurementTypeKey["lipidPanel"] = "lipid-panel";
     MeasurementTypeKey["respiratoryTherapy"] = "respiratory-therapy";
+    MeasurementTypeKey["babySleep"] = "baby-sleep";
 })(MeasurementTypeKey || (exports.MeasurementTypeKey = MeasurementTypeKey = {}));

package/dist/client/observation/types/ObservationCode.d.ts

@@ -45,5 +45,6 @@ export declare enum ObservationCode {
     TRIGLYCERIDES_MASS = "2571-8",
     TRIGLYCERIDES_MOLAR = "14927-8",
     TOTAL_CHOLESTEROL_HDL_RATIO = "9830-1",
-    RESPIRATORY_THERAPY = "respiratory-therapy"
+    RESPIRATORY_THERAPY = "respiratory-therapy",
+    BABY_SLEEP = "baby-sleep"
 }

package/dist/client/observation/types/ObservationCode.js

@@ -50,4 +50,5 @@ var ObservationCode;
     ObservationCode["TRIGLYCERIDES_MOLAR"] = "14927-8";
     ObservationCode["TOTAL_CHOLESTEROL_HDL_RATIO"] = "9830-1";
     ObservationCode["RESPIRATORY_THERAPY"] = "respiratory-therapy";
+    ObservationCode["BABY_SLEEP"] = "baby-sleep";
 })(ObservationCode || (exports.ObservationCode = ObservationCode = {}));

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

@@ -0,0 +1,12 @@
+import { ObservationComponent } from "@medplum/fhirtypes";
+import { MeasurementTypeKey } from "../MeasurementTypeKey";
+import { Measurement } from "./Measurement";
+/**
+ * One BabySleep observation, such as a clip sample or a session summary.
+ * Core preserves the coded components supplied by the device adapter rather than
+ * assigning vendor-specific meaning to sleep states, posture, or device status.
+ */
+export type BabySleepMeasurement = Measurement & {
+    measurementTypeKey: MeasurementTypeKey.babySleep;
+    components: ObservationComponent[];
+};

package/dist/client/observation/types/measurement/BabySleepMeasurement.js

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

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

@@ -17,3 +17,4 @@ export * from "./Vo2MaxMeasurement";
 export * from "./WalkingHeartRateAverageMeasurement";
 export * from "./LipidPanelMeasurement";
 export * from "./RespiratoryTherapyMeasurement";
+export * from "./BabySleepMeasurement";

package/dist/client/observation/types/measurement/index.js

@@ -33,3 +33,4 @@ __exportStar(require("./Vo2MaxMeasurement"), exports);
 __exportStar(require("./WalkingHeartRateAverageMeasurement"), exports);
 __exportStar(require("./LipidPanelMeasurement"), exports);
 __exportStar(require("./RespiratoryTherapyMeasurement"), exports);
+__exportStar(require("./BabySleepMeasurement"), exports);

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

@@ -68,7 +68,7 @@ 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"];
+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 type OvokProjectSettingKey = (typeof OVOK_PROJECT_SETTING_KEYS)[number];
 export type OvokProjectSettings = {
     projectId: string;

package/dist/client/platform/types.js

@@ -24,4 +24,5 @@ exports.OVOK_PROJECT_SETTING_KEYS = [
     "PRACTITIONER_REGISTRATION_ENABLED",
     "PRACTITIONER_LOGIN_ENABLED",
     "IOT_ENABLED",
+    "CLINICIAN_INVITE_ON_BUSINESS_EMAIL",
 ];

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

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "../client/auth/types/AuthResponse";
 export * from "../client/auth/types/LoginResponse";
 export * from "../client/auth/types/LoginBody";
 export * from "../client/auth/types/RegisterBody";
+export * from "../client/auth/types/RegisterResponse";
 export * from "../client/auth/types/ChangePasswordBody";
 export * from "../client/auth/types/ChangePasswordResponse";
 export * from "../client/auth/types/RequestDeleteUserBody";

package/dist/types/index.js

@@ -19,6 +19,7 @@ __exportStar(require("../client/auth/types/AuthResponse"), exports);
 __exportStar(require("../client/auth/types/LoginResponse"), exports);
 __exportStar(require("../client/auth/types/LoginBody"), exports);
 __exportStar(require("../client/auth/types/RegisterBody"), exports);
+__exportStar(require("../client/auth/types/RegisterResponse"), exports);
 __exportStar(require("../client/auth/types/ChangePasswordBody"), exports);
 __exportStar(require("../client/auth/types/ChangePasswordResponse"), exports);
 __exportStar(require("../client/auth/types/RequestDeleteUserBody"), exports);

package/package.json

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