@openhi/types 0.0.44 → 0.0.45

package/lib/extensions/on-site-medical/index.d.ts

@@ -6,3 +6,4 @@
  * platform (`hl7.openhi.org`) namespacing via a future data migration.
  */
 export * from "./appointment-series";
+export * from "./supply-request-encounter";

package/lib/extensions/on-site-medical/index.js

@@ -22,4 +22,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * platform (`hl7.openhi.org`) namespacing via a future data migration.
  */
 __exportStar(require("./appointment-series"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZXh0ZW5zaW9ucy9vbi1zaXRlLW1lZGljYWwvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBOzs7Ozs7R0FNRztBQUNILHVEQUFxQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQ3VzdG9tZXItbmFtZXNwYWNlZCAoYG9uLXNpdGUtbWVkaWNhbC5hcHBgKSBleHRlbnNpb24gYW5kIGlkZW50aWZpZXJcbiAqIGNvbnRyYWN0cy4gSGFuZC1hdXRob3JlZCwgbGlrZSBgLi4vb3BlbmhpYC4gU2VlIHRoZSBwcm92ZW5hbmNlIG5vdGUgaW5cbiAqIGVhY2ggbW9kdWxlIOKAlCB0aGVzZSBhcmUgZnJvemVuIHdpcmUgY29udHJhY3RzIHNoYXJlZCBieSB0aGUgT3BlbkhJXG4gKiBiYWNrZW5kIGFuZCB0aGUgb24tc2l0ZS1tZWRpY2FsIGZyb250ZW5kLCBjYW5kaWRhdGVzIGZvciBwcm9tb3Rpb24gdG9cbiAqIHBsYXRmb3JtIChgaGw3Lm9wZW5oaS5vcmdgKSBuYW1lc3BhY2luZyB2aWEgYSBmdXR1cmUgZGF0YSBtaWdyYXRpb24uXG4gKi9cbmV4cG9ydCAqIGZyb20gXCIuL2FwcG9pbnRtZW50LXNlcmllc1wiO1xuIl19
+__exportStar(require("./supply-request-encounter"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZXh0ZW5zaW9ucy9vbi1zaXRlLW1lZGljYWwvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBOzs7Ozs7R0FNRztBQUNILHVEQUFxQztBQUNyQyw2REFBMkMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEN1c3RvbWVyLW5hbWVzcGFjZWQgKGBvbi1zaXRlLW1lZGljYWwuYXBwYCkgZXh0ZW5zaW9uIGFuZCBpZGVudGlmaWVyXG4gKiBjb250cmFjdHMuIEhhbmQtYXV0aG9yZWQsIGxpa2UgYC4uL29wZW5oaWAuIFNlZSB0aGUgcHJvdmVuYW5jZSBub3RlIGluXG4gKiBlYWNoIG1vZHVsZSDigJQgdGhlc2UgYXJlIGZyb3plbiB3aXJlIGNvbnRyYWN0cyBzaGFyZWQgYnkgdGhlIE9wZW5ISVxuICogYmFja2VuZCBhbmQgdGhlIG9uLXNpdGUtbWVkaWNhbCBmcm9udGVuZCwgY2FuZGlkYXRlcyBmb3IgcHJvbW90aW9uIHRvXG4gKiBwbGF0Zm9ybSAoYGhsNy5vcGVuaGkub3JnYCkgbmFtZXNwYWNpbmcgdmlhIGEgZnV0dXJlIGRhdGEgbWlncmF0aW9uLlxuICovXG5leHBvcnQgKiBmcm9tIFwiLi9hcHBvaW50bWVudC1zZXJpZXNcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3N1cHBseS1yZXF1ZXN0LWVuY291bnRlclwiO1xuIl19

package/lib/extensions/on-site-medical/supply-request-encounter.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Hand-authored contract for the `supply-request-encounter` extension —
+ * the `Encounter` a `SupplyRequest` belongs to.
+ *
+ * **Why it exists:** neither FHIR R4 nor R5 gives `SupplyRequest` an
+ * `encounter` field (R5 adds only `deliverFor` → Patient). The
+ * on-site-medical frontend carries the encounter reference in this narrow
+ * custom extension so supply orders can be filtered by visit — and, for
+ * facility orders (`deliverTo` = Location, not Patient), it is the only path
+ * from the order to its patient (order → Encounter → `Encounter.subject`).
+ *
+ * **Namespace provenance:** `on-site-medical.app` — the contract originated
+ * in the frontend and live data already carries it (frozen). This module is
+ * the single shared definition: the frontend writes the extension, and the
+ * OpenHI backend's `SupplyRequest ?encounter=` search filter matches against
+ * this same URL, so the two cannot drift.
+ *
+ * @see sites/app-ehr/docs/fhir/extensions/supply-request-encounter.md
+ */
+import { z } from "zod";
+import type { Extension } from "../../data/extension";
+import type { Reference } from "../../data/reference";
+import type { SupplyRequest } from "../../data/supplyrequest";
+/** `SupplyRequest.extension.url` carrying the `Reference(Encounter)`. */
+export declare const SUPPLY_REQUEST_ENCOUNTER_EXTENSION_URL: "https://on-site-medical.app/fhir/StructureDefinition/supply-request-encounter";
+export declare const supplyRequestEncounterExtensionSchema: z.ZodObject<{
+    url: z.ZodLiteral<"https://on-site-medical.app/fhir/StructureDefinition/supply-request-encounter">;
+    valueReference: z.ZodType<Reference, z.ZodTypeDef, Reference>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    url: z.ZodLiteral<"https://on-site-medical.app/fhir/StructureDefinition/supply-request-encounter">;
+    valueReference: z.ZodType<Reference, z.ZodTypeDef, Reference>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    url: z.ZodLiteral<"https://on-site-medical.app/fhir/StructureDefinition/supply-request-encounter">;
+    valueReference: z.ZodType<Reference, z.ZodTypeDef, Reference>;
+}, z.ZodTypeAny, "passthrough">>;
+export type SupplyRequestEncounterExtension = z.infer<typeof supplyRequestEncounterExtensionSchema>;
+/** Build the extension carrying the encounter a supply order belongs to. */
+export declare function buildSupplyRequestEncounterExtension(encounter: Reference): Extension;
+/**
+ * Returns the encounter reference (`Encounter/<id>`) a SupplyRequest belongs
+ * to, or null when the extension is absent.
+ */
+export declare function getSupplyRequestEncounter(supplyRequest: SupplyRequest): string | null;

package/lib/extensions/on-site-medical/supply-request-encounter.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supplyRequestEncounterExtensionSchema = exports.SUPPLY_REQUEST_ENCOUNTER_EXTENSION_URL = void 0;
+exports.buildSupplyRequestEncounterExtension = buildSupplyRequestEncounterExtension;
+exports.getSupplyRequestEncounter = getSupplyRequestEncounter;
+/**
+ * Hand-authored contract for the `supply-request-encounter` extension —
+ * the `Encounter` a `SupplyRequest` belongs to.
+ *
+ * **Why it exists:** neither FHIR R4 nor R5 gives `SupplyRequest` an
+ * `encounter` field (R5 adds only `deliverFor` → Patient). The
+ * on-site-medical frontend carries the encounter reference in this narrow
+ * custom extension so supply orders can be filtered by visit — and, for
+ * facility orders (`deliverTo` = Location, not Patient), it is the only path
+ * from the order to its patient (order → Encounter → `Encounter.subject`).
+ *
+ * **Namespace provenance:** `on-site-medical.app` — the contract originated
+ * in the frontend and live data already carries it (frozen). This module is
+ * the single shared definition: the frontend writes the extension, and the
+ * OpenHI backend's `SupplyRequest ?encounter=` search filter matches against
+ * this same URL, so the two cannot drift.
+ *
+ * @see sites/app-ehr/docs/fhir/extensions/supply-request-encounter.md
+ */
+const zod_1 = require("zod");
+const reference_1 = require("../../data/reference");
+/** `SupplyRequest.extension.url` carrying the `Reference(Encounter)`. */
+exports.SUPPLY_REQUEST_ENCOUNTER_EXTENSION_URL = "https://on-site-medical.app/fhir/StructureDefinition/supply-request-encounter";
+exports.supplyRequestEncounterExtensionSchema = zod_1.z
+    .object({
+    url: zod_1.z.literal(exports.SUPPLY_REQUEST_ENCOUNTER_EXTENSION_URL),
+    valueReference: reference_1.referenceSchema,
+})
+    .passthrough();
+/** Build the extension carrying the encounter a supply order belongs to. */
+function buildSupplyRequestEncounterExtension(encounter) {
+    return {
+        url: exports.SUPPLY_REQUEST_ENCOUNTER_EXTENSION_URL,
+        valueReference: encounter,
+    };
+}
+/**
+ * Returns the encounter reference (`Encounter/<id>`) a SupplyRequest belongs
+ * to, or null when the extension is absent.
+ */
+function getSupplyRequestEncounter(supplyRequest) {
+    const extension = supplyRequest.extension?.find((ext) => ext.url === exports.SUPPLY_REQUEST_ENCOUNTER_EXTENSION_URL);
+    return extension?.valueReference?.reference ?? null;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3VwcGx5LXJlcXVlc3QtZW5jb3VudGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2V4dGVuc2lvbnMvb24tc2l0ZS1tZWRpY2FsL3N1cHBseS1yZXF1ZXN0LWVuY291bnRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUF3Q0Esb0ZBT0M7QUFNRCw4REFPQztBQTVERDs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBa0JHO0FBQ0gsNkJBQXdCO0FBR3hCLG9EQUF1RDtBQUd2RCx5RUFBeUU7QUFDNUQsUUFBQSxzQ0FBc0MsR0FDakQsK0VBQXdGLENBQUM7QUFFOUUsUUFBQSxxQ0FBcUMsR0FBRyxPQUFDO0tBQ25ELE1BQU0sQ0FBQztJQUNOLEdBQUcsRUFBRSxPQUFDLENBQUMsT0FBTyxDQUFDLDhDQUFzQyxDQUFDO0lBQ3RELGNBQWMsRUFBRSwyQkFBZTtDQUNoQyxDQUFDO0tBQ0QsV0FBVyxFQUFFLENBQUM7QUFLakIsNEVBQTRFO0FBQzVFLFNBQWdCLG9DQUFvQyxDQUNsRCxTQUFvQjtJQUVwQixPQUFPO1FBQ0wsR0FBRyxFQUFFLDhDQUFzQztRQUMzQyxjQUFjLEVBQUUsU0FBUztLQUMxQixDQUFDO0FBQ0osQ0FBQztBQUVEOzs7R0FHRztBQUNILFNBQWdCLHlCQUF5QixDQUN2QyxhQUE0QjtJQUU1QixNQUFNLFNBQVMsR0FBRyxhQUFhLENBQUMsU0FBUyxFQUFFLElBQUksQ0FDN0MsQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEtBQUssOENBQXNDLENBQzVELENBQUM7SUFDRixPQUFPLFNBQVMsRUFBRSxjQUFjLEVBQUUsU0FBUyxJQUFJLElBQUksQ0FBQztBQUN0RCxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBIYW5kLWF1dGhvcmVkIGNvbnRyYWN0IGZvciB0aGUgYHN1cHBseS1yZXF1ZXN0LWVuY291bnRlcmAgZXh0ZW5zaW9uIOKAlFxuICogdGhlIGBFbmNvdW50ZXJgIGEgYFN1cHBseVJlcXVlc3RgIGJlbG9uZ3MgdG8uXG4gKlxuICogKipXaHkgaXQgZXhpc3RzOioqIG5laXRoZXIgRkhJUiBSNCBub3IgUjUgZ2l2ZXMgYFN1cHBseVJlcXVlc3RgIGFuXG4gKiBgZW5jb3VudGVyYCBmaWVsZCAoUjUgYWRkcyBvbmx5IGBkZWxpdmVyRm9yYCDihpIgUGF0aWVudCkuIFRoZVxuICogb24tc2l0ZS1tZWRpY2FsIGZyb250ZW5kIGNhcnJpZXMgdGhlIGVuY291bnRlciByZWZlcmVuY2UgaW4gdGhpcyBuYXJyb3dcbiAqIGN1c3RvbSBleHRlbnNpb24gc28gc3VwcGx5IG9yZGVycyBjYW4gYmUgZmlsdGVyZWQgYnkgdmlzaXQg4oCUIGFuZCwgZm9yXG4gKiBmYWNpbGl0eSBvcmRlcnMgKGBkZWxpdmVyVG9gID0gTG9jYXRpb24sIG5vdCBQYXRpZW50KSwgaXQgaXMgdGhlIG9ubHkgcGF0aFxuICogZnJvbSB0aGUgb3JkZXIgdG8gaXRzIHBhdGllbnQgKG9yZGVyIOKGkiBFbmNvdW50ZXIg4oaSIGBFbmNvdW50ZXIuc3ViamVjdGApLlxuICpcbiAqICoqTmFtZXNwYWNlIHByb3ZlbmFuY2U6KiogYG9uLXNpdGUtbWVkaWNhbC5hcHBgIOKAlCB0aGUgY29udHJhY3Qgb3JpZ2luYXRlZFxuICogaW4gdGhlIGZyb250ZW5kIGFuZCBsaXZlIGRhdGEgYWxyZWFkeSBjYXJyaWVzIGl0IChmcm96ZW4pLiBUaGlzIG1vZHVsZSBpc1xuICogdGhlIHNpbmdsZSBzaGFyZWQgZGVmaW5pdGlvbjogdGhlIGZyb250ZW5kIHdyaXRlcyB0aGUgZXh0ZW5zaW9uLCBhbmQgdGhlXG4gKiBPcGVuSEkgYmFja2VuZCdzIGBTdXBwbHlSZXF1ZXN0ID9lbmNvdW50ZXI9YCBzZWFyY2ggZmlsdGVyIG1hdGNoZXMgYWdhaW5zdFxuICogdGhpcyBzYW1lIFVSTCwgc28gdGhlIHR3byBjYW5ub3QgZHJpZnQuXG4gKlxuICogQHNlZSBzaXRlcy9hcHAtZWhyL2RvY3MvZmhpci9leHRlbnNpb25zL3N1cHBseS1yZXF1ZXN0LWVuY291bnRlci5tZFxuICovXG5pbXBvcnQgeyB6IH0gZnJvbSBcInpvZFwiO1xuaW1wb3J0IHR5cGUgeyBFeHRlbnNpb24gfSBmcm9tIFwiLi4vLi4vZGF0YS9leHRlbnNpb25cIjtcbmltcG9ydCB0eXBlIHsgUmVmZXJlbmNlIH0gZnJvbSBcIi4uLy4uL2RhdGEvcmVmZXJlbmNlXCI7XG5pbXBvcnQgeyByZWZlcmVuY2VTY2hlbWEgfSBmcm9tIFwiLi4vLi4vZGF0YS9yZWZlcmVuY2VcIjtcbmltcG9ydCB0eXBlIHsgU3VwcGx5UmVxdWVzdCB9IGZyb20gXCIuLi8uLi9kYXRhL3N1cHBseXJlcXVlc3RcIjtcblxuLyoqIGBTdXBwbHlSZXF1ZXN0LmV4dGVuc2lvbi51cmxgIGNhcnJ5aW5nIHRoZSBgUmVmZXJlbmNlKEVuY291bnRlcilgLiAqL1xuZXhwb3J0IGNvbnN0IFNVUFBMWV9SRVFVRVNUX0VOQ09VTlRFUl9FWFRFTlNJT05fVVJMID1cbiAgXCJodHRwczovL29uLXNpdGUtbWVkaWNhbC5hcHAvZmhpci9TdHJ1Y3R1cmVEZWZpbml0aW9uL3N1cHBseS1yZXF1ZXN0LWVuY291bnRlclwiIGFzIGNvbnN0O1xuXG5leHBvcnQgY29uc3Qgc3VwcGx5UmVxdWVzdEVuY291bnRlckV4dGVuc2lvblNjaGVtYSA9IHpcbiAgLm9iamVjdCh7XG4gICAgdXJsOiB6LmxpdGVyYWwoU1VQUExZX1JFUVVFU1RfRU5DT1VOVEVSX0VYVEVOU0lPTl9VUkwpLFxuICAgIHZhbHVlUmVmZXJlbmNlOiByZWZlcmVuY2VTY2hlbWEsXG4gIH0pXG4gIC5wYXNzdGhyb3VnaCgpO1xuZXhwb3J0IHR5cGUgU3VwcGx5UmVxdWVzdEVuY291bnRlckV4dGVuc2lvbiA9IHouaW5mZXI8XG4gIHR5cGVvZiBzdXBwbHlSZXF1ZXN0RW5jb3VudGVyRXh0ZW5zaW9uU2NoZW1hXG4+O1xuXG4vKiogQnVpbGQgdGhlIGV4dGVuc2lvbiBjYXJyeWluZyB0aGUgZW5jb3VudGVyIGEgc3VwcGx5IG9yZGVyIGJlbG9uZ3MgdG8uICovXG5leHBvcnQgZnVuY3Rpb24gYnVpbGRTdXBwbHlSZXF1ZXN0RW5jb3VudGVyRXh0ZW5zaW9uKFxuICBlbmNvdW50ZXI6IFJlZmVyZW5jZSxcbik6IEV4dGVuc2lvbiB7XG4gIHJldHVybiB7XG4gICAgdXJsOiBTVVBQTFlfUkVRVUVTVF9FTkNPVU5URVJfRVhURU5TSU9OX1VSTCxcbiAgICB2YWx1ZVJlZmVyZW5jZTogZW5jb3VudGVyLFxuICB9O1xufVxuXG4vKipcbiAqIFJldHVybnMgdGhlIGVuY291bnRlciByZWZlcmVuY2UgKGBFbmNvdW50ZXIvPGlkPmApIGEgU3VwcGx5UmVxdWVzdCBiZWxvbmdzXG4gKiB0bywgb3IgbnVsbCB3aGVuIHRoZSBleHRlbnNpb24gaXMgYWJzZW50LlxuICovXG5leHBvcnQgZnVuY3Rpb24gZ2V0U3VwcGx5UmVxdWVzdEVuY291bnRlcihcbiAgc3VwcGx5UmVxdWVzdDogU3VwcGx5UmVxdWVzdCxcbik6IHN0cmluZyB8IG51bGwge1xuICBjb25zdCBleHRlbnNpb24gPSBzdXBwbHlSZXF1ZXN0LmV4dGVuc2lvbj8uZmluZChcbiAgICAoZXh0KSA9PiBleHQudXJsID09PSBTVVBQTFlfUkVRVUVTVF9FTkNPVU5URVJfRVhURU5TSU9OX1VSTCxcbiAgKTtcbiAgcmV0dXJuIGV4dGVuc2lvbj8udmFsdWVSZWZlcmVuY2U/LnJlZmVyZW5jZSA/PyBudWxsO1xufVxuIl19

package/package.json

@@ -39,7 +39,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.44",
+  "version": "0.0.45",
   "types": "lib/index.d.ts",
   "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"pnpm exec projen\".",
   "scripts": {