@ovok/core 0.4.34 → 0.4.36

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

@@ -4,6 +4,7 @@ exports.generateObservationBodiesByMeasurement = generateObservationBodiesByMeas
 const core_1 = require("@medplum/core");
 const creator_1 = require("../services/creator");
 const getDeviceObject_1 = require("../utils/getDeviceObject");
+const DEVICE_READING_IDENTIFIER_SYSTEM = "https://api.ovok.com/fhir/StructureDefinition/device-reading-id";
 const getPatientReference = async (client, patientId) => {
     if (patientId) {
         return `Patient/${patientId}`;
@@ -11,6 +12,21 @@ const getPatientReference = async (client, patientId) => {
     const profile = (await client.getProfileAsync());
     return (0, core_1.getReferenceString)(profile);
 };
+const addSourceIdentifier = (observations, patientReference, sourceId) => patientReference && sourceId
+    ? observations.map((observation, index) => {
+        var _a;
+        return ({
+            ...observation,
+            identifier: [
+                ...((_a = observation.identifier) !== null && _a !== void 0 ? _a : []),
+                {
+                    system: DEVICE_READING_IDENTIFIER_SYSTEM,
+                    value: `${patientReference}/${sourceId}/${index}`,
+                },
+            ],
+        });
+    })
+    : observations;
 async function generateObservationBodiesByMeasurement(params) {
     var _a;
     const { device, measurement } = params;
@@ -26,7 +42,7 @@ async function generateObservationBodiesByMeasurement(params) {
         }
         : observation;
     if (observationFragments) {
-        return observationFragments
+        const observations = observationFragments
             .map((fragment) => ({
             resourceType: "Observation",
             status: "registered",
@@ -40,6 +56,7 @@ async function generateObservationBodiesByMeasurement(params) {
         }))
             .filter(hasObservationValue)
             .map(applyEffectiveDateTime);
+        return addSourceIdentifier(observations, patientReference, params.sourceId);
     }
     const observationCodes = observationService.getObservationCodes();
     const values = observationService.generateValues(measurement);
@@ -55,7 +72,7 @@ async function generateObservationBodiesByMeasurement(params) {
         code,
         ...(additionalProperties[index] || {}),
     }));
-    return observationBodies.filter(hasObservationValue).map(applyEffectiveDateTime);
+    return addSourceIdentifier(observationBodies.filter(hasObservationValue).map(applyEffectiveDateTime), patientReference, params.sourceId);
 }
 const hasObservationValue = (observation) => {
     var _a, _b, _c, _d, _e, _f;

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

@@ -4,5 +4,7 @@ export type GenerateObservationBodyParams = {
     device?: MeasurementDevice;
     effectiveDateTime?: Date;
     patientId?: string;
+    /** Stable ID from the originating device reading. */
+    sourceId?: string;
     measurement: Measurement;
 };

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

@@ -16,6 +16,15 @@ export type MeasurementDevice = {
     sn: string;
     /** Runtime association key; not written to the FHIR device identifier. */
     id: string;
+    /**
+     * The brand and model the advertised name identified, when one decoder serves several
+     * products (the mobile SDK's `deviceData.variant`). Preferred over `manufacturerName` and
+     * `model`, which often describe the Bluetooth module rather than the product.
+     */
+    variant?: {
+        manufacturer: string;
+        model: string;
+    };
     /**
      * Remaining charge, 0 to 100.
      *

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

@@ -8,6 +8,15 @@ 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`;
+const PARSER_URL = `${EXTENSION_BASE_URL}/device-parser`;
+/** The product's own name: its model, prefixed with the brand unless the model already says it. */
+const variantDisplay = ({ manufacturer, model, }) => {
+    var _a, _b;
+    const brand = (_b = (_a = manufacturer.split(" ")[0]) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : "";
+    return brand && model.toLowerCase().startsWith(brand)
+        ? model
+        : `${manufacturer} ${model}`;
+};
 /**
  * The battery extension is omitted rather than defaulted when the device did not report
  * one, because a placeholder charge level would read as a real reading.
@@ -30,7 +39,7 @@ const getOptionalStringExtension = (url, value) => {
     return [{ url, valueString: value }];
 };
 const getDeviceObject = (measurementDevice) => {
-    var _a;
+    var _a, _b, _c, _d, _e;
     if (!measurementDevice) {
         return {
             identifier: {
@@ -46,7 +55,9 @@ const getDeviceObject = (measurementDevice) => {
                 },
             }
             : {}),
-        display: (_a = measurementDevice.name) !== null && _a !== void 0 ? _a : "no-name",
+        display: measurementDevice.variant
+            ? variantDisplay(measurementDevice.variant)
+            : (_a = measurementDevice.name) !== null && _a !== void 0 ? _a : "no-name",
         extension: [
             {
                 url: LOCAL_NAME_URL,
@@ -56,8 +67,11 @@ const getDeviceObject = (measurementDevice) => {
                 url: MANUFACTURER_DATA_URL,
                 valueString: measurementDevice.manufacturerData || "no-manufacturer-data",
             },
-            ...getOptionalStringExtension(MANUFACTURER_NAME_URL, measurementDevice.manufacturerName),
-            ...getOptionalStringExtension(MODEL_URL, measurementDevice.model),
+            ...getOptionalStringExtension(MANUFACTURER_NAME_URL, (_c = (_b = measurementDevice.variant) === null || _b === void 0 ? void 0 : _b.manufacturer) !== null && _c !== void 0 ? _c : measurementDevice.manufacturerName),
+            ...getOptionalStringExtension(MODEL_URL, (_e = (_d = measurementDevice.variant) === null || _d === void 0 ? void 0 : _d.model) !== null && _e !== void 0 ? _e : measurementDevice.model),
+            ...(measurementDevice.variant
+                ? getOptionalStringExtension(PARSER_URL, measurementDevice.name)
+                : []),
             {
                 url: SERIAL_NUMBER_URL,
                 valueString: measurementDevice.sn || "no-serial-number",

package/dist/client/offline/offline-measurement-queue.js

@@ -8,6 +8,7 @@ const DEFAULT_RETRY_BACKOFF_MS = 5000;
 const DEFAULT_MAX_RETRY_BACKOFF_MS = 60 * 60 * 1000;
 const IDENTIFIER_SYSTEM = "https://api.ovok.com/fhir/StructureDefinition/offline-measurement-id";
 exports.OFFLINE_MEASUREMENT_IDENTIFIER_SYSTEM = IDENTIFIER_SYSTEM;
+const DEVICE_READING_IDENTIFIER_SYSTEM = "https://api.ovok.com/fhir/StructureDefinition/device-reading-id";
 const canonicalize = (value) => {
     if (value instanceof Date) {
         return value.toISOString();
@@ -44,25 +45,43 @@ const stableValueId = (input) => {
     hex[16] = ((Number.parseInt(hex[16], 16) & 0x3) | 0x8).toString(16);
     return `${hex.slice(0, 8).join("")}-${hex.slice(8, 12).join("")}-${hex.slice(12, 16).join("")}-${hex.slice(16, 20).join("")}-${hex.slice(20).join("")}`;
 };
-const stableMeasurementId = (observation) => stableValueId(observation);
+const stableMeasurementId = (observation) => {
+    const identifiers = observation.identifier;
+    if (!(identifiers === null || identifiers === void 0 ? void 0 : identifiers.some((identifier) => identifier.system === DEVICE_READING_IDENTIFIER_SYSTEM))) {
+        return stableValueId(observation);
+    }
+    const remainingIdentifiers = identifiers.filter((identifier) => identifier.system !== DEVICE_READING_IDENTIFIER_SYSTEM);
+    const legacyObservation = { ...observation };
+    if (remainingIdentifiers.length > 0) {
+        legacyObservation.identifier = remainingIdentifiers;
+    }
+    else {
+        delete legacyObservation.identifier;
+    }
+    return stableValueId(legacyObservation);
+};
 exports.stableMeasurementId = stableMeasurementId;
 const entryForObservation = (observation) => {
-    var _a;
+    var _a, _b;
     const id = stableMeasurementId(observation);
     const identifier = {
         system: IDENTIFIER_SYSTEM,
         value: id,
     };
+    const sourceIdentifier = (_a = observation.identifier) === null || _a === void 0 ? void 0 : _a.find((item) => item.system === DEVICE_READING_IDENTIFIER_SYSTEM);
+    const ifNoneExist = sourceIdentifier
+        ? `identifier=${encodeURIComponent(`${IDENTIFIER_SYSTEM}|${id}`)},${encodeURIComponent(`${DEVICE_READING_IDENTIFIER_SYSTEM}|${sourceIdentifier.value}`)}`
+        : `identifier=${IDENTIFIER_SYSTEM}|${id}`;
     return {
         fullUrl: `urn:uuid:${id}`,
         request: {
             method: "POST",
             url: "Observation",
-            ifNoneExist: `identifier=${IDENTIFIER_SYSTEM}|${id}`,
+            ifNoneExist,
         },
         resource: {
             ...observation,
-            identifier: [...((_a = observation.identifier) !== null && _a !== void 0 ? _a : []), identifier],
+            identifier: [...((_b = observation.identifier) !== null && _b !== void 0 ? _b : []), identifier],
         },
     };
 };

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

package/package.json

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