@ovok/core 0.4.39 → 0.4.40

package/dist/client/observation/measurement-fields.d.ts

@@ -0,0 +1,10 @@
+import { MeasurementTypeKey } from "../../types";
+import { MeasurementField } from "./types/service/MeasurementField";
+/**
+ * For each measurement type the SDK stores, its properties as their Observations store them: the
+ * code (LOINC), unit and decimals of each, the main one first. Apps read codes and units here rather
+ * than keeping their own table. Lipid panels, respiratory therapy and baby sleep list none: their
+ * values are components rather than fixed properties (see `URINE_ANALYTE_DEFINITIONS` for urine).
+ */
+export declare const MEASUREMENT_FIELDS: Readonly<Partial<Record<MeasurementTypeKey, readonly MeasurementField[]>>>;
+export type { MeasurementField };

package/dist/client/observation/measurement-fields.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MEASUREMENT_FIELDS = void 0;
+const creator_1 = require("./services/creator");
+const services = creator_1.ObservationServiceCreator.getInstance();
+/**
+ * For each measurement type the SDK stores, its properties as their Observations store them: the
+ * code (LOINC), unit and decimals of each, the main one first. Apps read codes and units here rather
+ * than keeping their own table. Lipid panels, respiratory therapy and baby sleep list none: their
+ * values are components rather than fixed properties (see `URINE_ANALYTE_DEFINITIONS` for urine).
+ */
+exports.MEASUREMENT_FIELDS = Object.fromEntries(services.getTypes().map((type) => [type, services.getService(type).getFields()]));

package/dist/client/observation/services/base-observation-service.d.ts

@@ -5,6 +5,7 @@ import { Sample } from "../types/generate-measurement/Sample";
 import { ObservationValue } from "../types/generate-observation-body/ObservationValue";
 import { IObservationService } from "../types/IObservationService";
 import { Measurement } from "../types/measurement/Measurement";
+import { MeasurementField } from "../types/service/MeasurementField";
 import { ObservationMetadata } from "../types/service/ObservationMetadata";
 export declare abstract class BaseObservationService<T extends Measurement> implements IObservationService {
     protected abstract observationMetadata: ObservationMetadata<T>[];
@@ -12,6 +13,7 @@ export declare abstract class BaseObservationService<T extends Measurement> impl
     protected abstract measurementTypeName: string;
     abstract convertSamplesToMeasurement(samples: Sample[]): T;
     abstract convertRecordToMeasurement(record: RecordResult<RecordType>): T;
+    getFields(): MeasurementField[];
     protected getCastedMeasurement(measurement: Measurement): T;
     generateValues(measurement: Measurement): ObservationValue[];
     getObservationCodes(): CodeableConcept[];

package/dist/client/observation/services/base-observation-service.js

@@ -3,6 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseObservationService = void 0;
 const fhir_systems_1 = require("../fhir-systems");
 class BaseObservationService {
+    getFields() {
+        return this.observationMetadata.map(({ valueKey, primaryCode, unit, toFixed, display }) => ({
+            key: String(valueKey),
+            code: primaryCode,
+            unit,
+            decimals: toFixed,
+            display,
+        }));
+    }
     getCastedMeasurement(measurement) {
         if (measurement.measurementTypeKey !== this.measurementTypeKey) {
             throw new Error(`Measurement is not a ${this.measurementTypeName} measurement`);

package/dist/client/observation/services/creator.d.ts

@@ -5,5 +5,7 @@ export declare class ObservationServiceCreator {
     private readonly services;
     private constructor();
     static getInstance(): ObservationServiceCreator;
+    /** The measurement types the SDK turns into Observations. */
+    getTypes(): MeasurementTypeKey[];
     getService(type: MeasurementTypeKey): IObservationService;
 }

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

@@ -32,6 +32,10 @@ class ObservationServiceCreator {
         }
         return ObservationServiceCreator.instance;
     }
+    /** The measurement types the SDK turns into Observations. */
+    getTypes() {
+        return [...this.services.keys()];
+    }
     getService(type) {
         const service = this.services.get(type);
         if (!service) {

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

@@ -4,12 +4,15 @@ import { Sample } from "./generate-measurement/Sample";
 import { ObservationFragment } from "./generate-observation-body/ObservationFragment";
 import { ObservationValue } from "./generate-observation-body/ObservationValue";
 import { Measurement } from "./measurement/Measurement";
+import { MeasurementField } from "./service/MeasurementField";
 export interface IObservationService {
     generateValues: (measurement: Measurement) => ObservationValue[];
     generateObservationFragments?: (measurement: Measurement) => ObservationFragment[];
     getObservationCodes: () => CodeableConcept[];
     getAdditionalProperties: (measurement: Measurement) => Partial<Observation>[];
     getUnits: () => string[];
+    /** The measurement's properties as their Observations store them; the first is the main one. */
+    getFields: () => MeasurementField[];
     getMeasurementDisplay: (measurement: Measurement) => string;
     getObservationDisplay: (observations: Observation[]) => string | undefined;
     convertSamplesToMeasurement: (samples: Sample[]) => Measurement;

package/dist/client/observation/types/service/MeasurementField.d.ts

@@ -0,0 +1,11 @@
+/** One property of a measurement, as its Observation stores it. */
+export type MeasurementField = {
+    /** The property on the measurement: `systolic`, `bloodGlucose`, … */
+    key: string;
+    /** The code (LOINC) of the Observation that carries it. */
+    code: string;
+    unit: string;
+    /** The decimal places the SDK keeps when it writes the value. */
+    decimals: number;
+    display: string;
+};

package/dist/client/observation/types/service/MeasurementField.js

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

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

package/dist/index.d.ts

@@ -940,6 +940,7 @@ export * from "./hooks";
 export * from "./utils";
 export * from "./client/observation/services";
 export * from "./client/observation/methods";
+export * from "./client/observation/measurement-fields";
 export { saveMeasurement } from "./client/observation/methods/saveMeasurement";
 export * from "./conformance/capability-requirements";
 export * from "./conformance/api-requirements";

package/dist/index.js

@@ -58,6 +58,7 @@ __exportStar(require("./hooks"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./client/observation/services"), exports);
 __exportStar(require("./client/observation/methods"), exports);
+__exportStar(require("./client/observation/measurement-fields"), exports);
 var saveMeasurement_1 = require("./client/observation/methods/saveMeasurement");
 Object.defineProperty(exports, "saveMeasurement", { enumerable: true, get: function () { return saveMeasurement_1.saveMeasurement; } });
 __exportStar(require("./conformance/capability-requirements"), exports);

package/package.json

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