ts-time-utils 3.0.4 → 4.1.0

package/dist/esm/healthcare.d.ts

@@ -0,0 +1,260 @@
+/**
+ * @fileoverview Healthcare utilities for medical scheduling and compliance timing
+ * Provides medication schedules, shift patterns, on-call rotations, and compliance windows
+ */
+import type { DateInput, DateRange } from './types.js';
+import { Duration } from './duration.js';
+/**
+ * Standard medical abbreviations for medication frequency
+ */
+export type MedicationFrequency = 'QD' | 'BID' | 'TID' | 'QID' | 'q4h' | 'q6h' | 'q8h' | 'q12h' | 'PRN';
+/**
+ * Shift duration patterns
+ */
+export type ShiftPattern = '8hr' | '12hr' | '24hr';
+/**
+ * Configuration for shift scheduling
+ */
+export interface ShiftConfig {
+    pattern: ShiftPattern;
+    startTime: {
+        hour: number;
+        minute: number;
+    };
+    rotation?: 'fixed' | 'rotating';
+}
+/**
+ * Configuration for medication timing
+ */
+export interface MedicationConfig {
+    wakeTime?: string;
+    sleepTime?: string;
+    withMeals?: boolean;
+}
+/**
+ * On-call slot assignment
+ */
+export interface OnCallSlot {
+    staff: string;
+    start: Date;
+    end: Date;
+}
+/**
+ * Number of doses per day for each frequency
+ */
+export declare const MEDICATION_FREQUENCIES: Record<MedicationFrequency, number | null>;
+/**
+ * Hours per shift pattern
+ */
+export declare const SHIFT_DURATIONS: Record<ShiftPattern, number>;
+/**
+ * Default medication timing config
+ */
+export declare const DEFAULT_MEDICATION_CONFIG: Required<MedicationConfig>;
+/**
+ * Get medication administration times for a given date and frequency
+ *
+ * @param date - The date to get medication times for
+ * @param frequency - Medical frequency abbreviation (QD, BID, TID, etc.)
+ * @param config - Optional configuration for wake/sleep times
+ * @returns Array of Date objects for each dose, empty array for PRN
+ *
+ * @example
+ * ```ts
+ * const times = getMedicationTimes(new Date('2024-01-15'), 'BID');
+ * // Returns [7:00 AM, 7:00 PM] (twice daily)
+ *
+ * const customTimes = getMedicationTimes(new Date('2024-01-15'), 'TID', {
+ *   wakeTime: '06:00',
+ *   sleepTime: '21:00'
+ * });
+ * // Returns [6:00 AM, 1:30 PM, 9:00 PM] (three times daily)
+ * ```
+ */
+export declare function getMedicationTimes(date: DateInput, frequency: MedicationFrequency, config?: MedicationConfig): Date[];
+/**
+ * Get the next medication time after a given date/time
+ *
+ * @param after - The date/time to find the next medication time after
+ * @param frequency - Medical frequency abbreviation
+ * @param config - Optional configuration
+ * @returns Next medication Date, or null for PRN
+ *
+ * @example
+ * ```ts
+ * const next = getNextMedicationTime(new Date('2024-01-15T10:00:00'), 'BID');
+ * // Returns 7:00 PM on same day (next BID dose after 10 AM)
+ * ```
+ */
+export declare function getNextMedicationTime(after: DateInput, frequency: MedicationFrequency, config?: MedicationConfig): Date | null;
+/**
+ * Parse a medication frequency string to MedicationFrequency type
+ *
+ * @param freq - String to parse (case-insensitive)
+ * @returns MedicationFrequency or null if invalid
+ *
+ * @example
+ * ```ts
+ * parseMedicationFrequency('bid'); // 'BID'
+ * parseMedicationFrequency('q8h'); // 'q8h'
+ * parseMedicationFrequency('invalid'); // null
+ * ```
+ */
+export declare function parseMedicationFrequency(freq: string): MedicationFrequency | null;
+/**
+ * Generate shift schedule for a date range
+ *
+ * @param start - Start of range
+ * @param end - End of range
+ * @param config - Shift configuration
+ * @returns Array of DateRange objects representing shifts
+ *
+ * @example
+ * ```ts
+ * const shifts = generateShiftSchedule(
+ *   new Date('2024-01-15'),
+ *   new Date('2024-01-17'),
+ *   { pattern: '12hr', startTime: { hour: 7, minute: 0 } }
+ * );
+ * // Returns 4 shifts: day/night on 15th, day/night on 16th
+ * ```
+ */
+export declare function generateShiftSchedule(start: DateInput, end: DateInput, config: ShiftConfig): DateRange[];
+/**
+ * Get the shift containing a specific time
+ *
+ * @param date - The date/time to check
+ * @param config - Shift configuration
+ * @returns DateRange of the shift containing the time
+ *
+ * @example
+ * ```ts
+ * const shift = getShiftForTime(
+ *   new Date('2024-01-15T14:00:00'),
+ *   { pattern: '8hr', startTime: { hour: 7, minute: 0 } }
+ * );
+ * // Returns { start: 7:00 AM, end: 3:00 PM } (day shift)
+ * ```
+ */
+export declare function getShiftForTime(date: DateInput, config: ShiftConfig): DateRange;
+/**
+ * Check if a date/time is during a specific shift
+ *
+ * @param date - The date/time to check
+ * @param shiftStart - When the shift started
+ * @param config - Shift configuration
+ * @returns true if the time is during the shift
+ *
+ * @example
+ * ```ts
+ * isOnShift(
+ *   new Date('2024-01-15T10:00:00'),
+ *   new Date('2024-01-15T07:00:00'),
+ *   { pattern: '8hr', startTime: { hour: 7, minute: 0 } }
+ * ); // true (10 AM is during 7 AM - 3 PM shift)
+ * ```
+ */
+export declare function isOnShift(date: DateInput, shiftStart: DateInput, config: ShiftConfig): boolean;
+/**
+ * Create an on-call rotation schedule
+ *
+ * @param start - Start of rotation period
+ * @param end - End of rotation period
+ * @param staff - Array of staff names to rotate through
+ * @param hoursPerShift - Hours per on-call shift (default 24)
+ * @returns Array of OnCallSlot assignments
+ *
+ * @example
+ * ```ts
+ * const rotation = createOnCallRotation(
+ *   new Date('2024-01-15'),
+ *   new Date('2024-01-18'),
+ *   ['Dr. Smith', 'Dr. Jones', 'Dr. Brown'],
+ *   24
+ * );
+ * // Returns 3 slots, one per doctor per day
+ * ```
+ */
+export declare function createOnCallRotation(start: DateInput, end: DateInput, staff: string[], hoursPerShift?: number): OnCallSlot[];
+/**
+ * Get the staff member on call at a specific time
+ *
+ * @param date - The date/time to check
+ * @param rotation - The on-call rotation schedule
+ * @returns Staff name or null if no one is on call
+ *
+ * @example
+ * ```ts
+ * const onCall = getOnCallStaff(new Date('2024-01-16T03:00:00'), rotation);
+ * // Returns 'Dr. Jones' (whoever is on call at 3 AM on the 16th)
+ * ```
+ */
+export declare function getOnCallStaff(date: DateInput, rotation: OnCallSlot[]): string | null;
+/**
+ * Check if an event occurred within its compliance window
+ *
+ * @param event - When the event occurred
+ * @param deadline - The compliance deadline
+ * @returns true if event is before or at deadline
+ *
+ * @example
+ * ```ts
+ * isWithinComplianceWindow(
+ *   new Date('2024-01-15T10:00:00'),
+ *   new Date('2024-01-15T12:00:00')
+ * ); // true (event occurred before deadline)
+ * ```
+ */
+export declare function isWithinComplianceWindow(event: DateInput, deadline: DateInput): boolean;
+/**
+ * Calculate the compliance deadline from an event
+ *
+ * @param event - The triggering event
+ * @param windowHours - Hours until deadline
+ * @returns Deadline Date
+ *
+ * @example
+ * ```ts
+ * const deadline = getComplianceDeadline(
+ *   new Date('2024-01-15T08:00:00'),
+ *   72
+ * );
+ * // Returns 2024-01-18T08:00:00 (72 hours later)
+ * ```
+ */
+export declare function getComplianceDeadline(event: DateInput, windowHours: number): Date;
+/**
+ * Calculate time remaining until a compliance deadline
+ *
+ * @param event - Current time or event time
+ * @param deadline - The compliance deadline
+ * @returns Duration until deadline, or null if already past
+ *
+ * @example
+ * ```ts
+ * const remaining = timeUntilDeadline(
+ *   new Date('2024-01-15T10:00:00'),
+ *   new Date('2024-01-16T10:00:00')
+ * );
+ * // Returns Duration of 24 hours
+ * ```
+ */
+export declare function timeUntilDeadline(event: DateInput, deadline: DateInput): Duration | null;
+/**
+ * Calculate rest hours between two shifts
+ *
+ * @param shift1End - End of first shift
+ * @param shift2Start - Start of second shift
+ * @returns Hours of rest between shifts
+ *
+ * @example
+ * ```ts
+ * const rest = calculateRestBetweenShifts(
+ *   new Date('2024-01-15T19:00:00'),
+ *   new Date('2024-01-16T07:00:00')
+ * );
+ * // Returns 12 (hours of rest)
+ * ```
+ */
+export declare function calculateRestBetweenShifts(shift1End: DateInput, shift2Start: DateInput): number;
+//# sourceMappingURL=healthcare.d.ts.map

package/dist/esm/healthcare.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthcare.d.ts","sourceRoot":"","sources":["../../src/healthcare.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAMzC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,QAAQ,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,CAAC;IACZ,GAAG,EAAE,IAAI,CAAC;CACX;AAMD;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAU7E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAIxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,QAAQ,CAAC,gBAAgB,CAIhE,CAAC;AA0BF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,mBAAmB,EAC9B,MAAM,CAAC,EAAE,gBAAgB,GACxB,IAAI,EAAE,CAyCR;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,EAChB,SAAS,EAAE,mBAAmB,EAC9B,MAAM,CAAC,EAAE,gBAAgB,GACxB,IAAI,GAAG,IAAI,CAqBb;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,IAAI,CA0BjF;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,EAChB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,WAAW,GAClB,SAAS,EAAE,CA4Bb;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,CAsB/E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAO9F;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,SAAS,EAChB,GAAG,EAAE,SAAS,EACd,KAAK,EAAE,MAAM,EAAE,EACf,aAAa,GAAE,MAAW,GACzB,UAAU,EAAE,CA6Bd;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,MAAM,GAAG,IAAI,CAUrF;AAMD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,GAAG,OAAO,CAKvF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAGjF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,GAAG,QAAQ,GAAG,IAAI,CAWxF;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,GAAG,MAAM,CAM/F"}