ezmedicationinput 0.1.42 → 0.1.44

package/dist/types.d.ts

@@ -3,14 +3,28 @@ export interface FhirCoding {
     system?: string;
     code?: string;
     display?: string;
+    _display?: FhirPrimitiveElement;
+    i18n?: Record<string, string>;
 }
 export interface FhirCodeableConcept {
     coding?: FhirCoding[];
     text?: string;
+    _text?: FhirPrimitiveElement;
+}
+export interface FhirExtension {
+    url: string;
+    extension?: FhirExtension[];
+    valueCode?: string;
+    valueString?: string;
+}
+export interface FhirPrimitiveElement {
+    extension?: FhirExtension[];
 }
 export interface FhirQuantity {
     value?: number;
     unit?: string;
+    system?: string;
+    code?: string;
 }
 export interface FhirRange {
     low?: FhirQuantity;
@@ -242,6 +256,8 @@ export declare enum FhirDayOfWeek {
 }
 export interface FhirTimingRepeat {
     count?: number;
+    boundsDuration?: FhirQuantity;
+    boundsRange?: FhirRange;
     frequency?: number;
     frequencyMax?: number;
     period?: number;
@@ -267,9 +283,11 @@ export interface FhirDoseAndRate {
 }
 export interface FhirDosage {
     text?: string;
+    patientInstruction?: string;
     timing?: FhirTiming;
     route?: FhirCodeableConcept;
     site?: FhirCodeableConcept;
+    method?: FhirCodeableConcept;
     additionalInstruction?: FhirCodeableConcept[];
     asNeededBoolean?: boolean;
     asNeededFor?: FhirCodeableConcept[];
@@ -296,6 +314,17 @@ export interface MedicationContext {
 export interface FormatOptions {
     locale?: "en" | "th" | string;
     i18n?: SigTranslationConfig;
+    /**
+     * Collapses repeated meal relation phrases into a grouped phrase when all
+     * meal anchors share the same relation (for example, "after breakfast,
+     * lunch and dinner" instead of repeating "after" for each meal).
+     */
+    groupMealTimingsByRelation?: boolean;
+    /**
+     * Adds a per-day frequency summary when it can be derived safely from the
+     * schedule (for example, "three times daily" or "วันละ 3 ครั้ง").
+     */
+    includeTimesPerDaySummary?: boolean;
 }
 export interface FormatBatchOptions extends FormatOptions {
     /**
@@ -308,21 +337,23 @@ export interface BodySiteCode {
     code: string;
     display?: string;
     system?: string;
+    i18n?: Record<string, string>;
 }
 export interface BodySiteDefinition {
     coding?: BodySiteCode;
     text?: string;
+    routeHint?: RouteCode;
     /**
      * Optional phrases that should resolve to the same coding as this entry.
      * Aliases are normalized with the same logic as map keys so callers can
      * provide punctuation-heavy variants such as "first bicuspid, left".
      */
-    aliases?: string[];
+    aliases?: readonly string[];
 }
 export interface CodeableConceptDefinition {
     coding?: FhirCoding;
     text?: string;
-    aliases?: string[];
+    aliases?: readonly string[];
     /** Optional translations for different locales (e.g., { "th": "ปวด" }) */
     i18n?: Record<string, string>;
 }
@@ -330,6 +361,71 @@ export interface PrnReasonDefinition extends CodeableConceptDefinition {
 }
 export interface AdditionalInstructionDefinition extends CodeableConceptDefinition {
 }
+export declare enum AdvicePolarity {
+    Affirm = "affirm",
+    Negate = "negate"
+}
+export declare enum AdviceForce {
+    Instruction = "instruction",
+    Warning = "warning",
+    Caution = "caution",
+    Sequence = "sequence"
+}
+export declare enum AdviceModality {
+    May = "may",
+    Can = "can",
+    Might = "might",
+    Could = "could",
+    Should = "should",
+    Must = "must"
+}
+export declare enum AdviceRelation {
+    With = "with",
+    Without = "without",
+    Before = "before",
+    After = "after",
+    During = "during",
+    Then = "then",
+    Until = "until",
+    For = "for",
+    In = "in",
+    On = "on"
+}
+export declare enum AdviceArgumentRole {
+    Theme = "theme",
+    Object = "object",
+    Substance = "substance",
+    MealState = "meal_state",
+    Activity = "activity",
+    Material = "material",
+    Site = "site",
+    Amount = "amount",
+    Duration = "duration",
+    Time = "time",
+    Free = "free"
+}
+export interface AdviceArgument {
+    role: AdviceArgumentRole;
+    text: string;
+    normalized?: string;
+    conceptId?: string;
+    span?: TextRange;
+}
+export interface AdviceFrame {
+    force: AdviceForce;
+    polarity?: AdvicePolarity;
+    modality?: AdviceModality;
+    predicate: {
+        lemma: string;
+        semanticClass?: string;
+    };
+    relation?: AdviceRelation;
+    args: AdviceArgument[];
+    span: TextRange;
+    sourceText: string;
+    sequenceIndex?: number;
+    coding?: FhirCoding;
+}
 export interface TextRange {
     /** Inclusive start index of the matched substring within the original input. */
     start: number;
@@ -422,6 +518,30 @@ export type SiteCodeResolver = (request: SiteCodeLookupRequest) => SiteCodeResol
  * caller's full input and the character range of the detected site phrase.
  */
 export type SiteCodeSuggestionResolver = (request: SiteCodeLookupRequest) => SiteCodeSuggestionsResult | SiteCodeSuggestion[] | SiteCodeSuggestion | null | undefined | Promise<SiteCodeSuggestionsResult | SiteCodeSuggestion[] | SiteCodeSuggestion | null | undefined>;
+export interface SmartMealExpansionScope {
+    /**
+     * Optional allowlist of routes that may use smart meal expansion. When
+     * provided, non-matching routes are excluded unless a dosage form matches
+     * `includeDosageForms`.
+     */
+    includeRoutes?: RouteCode[];
+    /**
+     * Optional denylist of routes that must not use smart meal expansion.
+     * Exclusions take precedence over includes.
+     */
+    excludeRoutes?: RouteCode[];
+    /**
+     * Optional allowlist of dosage forms that may use smart meal expansion.
+     * Values are matched case-insensitively after dosage-form normalization.
+     */
+    includeDosageForms?: string[];
+    /**
+     * Optional denylist of dosage forms that must not use smart meal expansion.
+     * Values are matched case-insensitively after dosage-form normalization.
+     * Exclusions take precedence over includes.
+     */
+    excludeDosageForms?: string[];
+}
 export interface ParseOptions extends FormatOptions {
     /**
      * Optional medication context that assists with default unit inference.
@@ -457,6 +577,12 @@ export interface ParseOptions extends FormatOptions {
      * `context.mealRelation` when provided.
      */
     smartMealExpansion?: boolean;
+    /**
+     * Optional route/dosage-form policy overrides for smart meal expansion.
+     * When omitted, the parser uses its built-in default heuristic.
+     * Exclusions take precedence over includes.
+     */
+    smartMealExpansionScope?: SmartMealExpansionScope;
     /**
      * Enables parsing meal dash shorthand like `1-0-1` / `1-0-0-1` into
      * multiple dosage clauses aligned to breakfast/lunch/dinner/(bedtime).
@@ -515,6 +641,95 @@ export interface ParseOptions extends FormatOptions {
      */
     prnReasonSuggestionResolvers?: PrnReasonSuggestionResolver | PrnReasonSuggestionResolver[];
 }
+export interface CanonicalDoseRange {
+    low?: number;
+    high?: number;
+}
+export interface CanonicalDoseExpr {
+    value?: number;
+    range?: CanonicalDoseRange;
+    unit?: string;
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalRouteExpr {
+    code?: RouteCode;
+    text?: string;
+    inferred?: boolean;
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalSiteExpr {
+    text?: string;
+    coding?: BodySiteCode;
+    source?: "abbreviation" | "text" | "selection" | "resolver";
+    inferred?: boolean;
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalMethodExpr {
+    text?: string;
+    _text?: FhirPrimitiveElement;
+    coding?: FhirCoding;
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalScheduleExpr {
+    timingCode?: string;
+    count?: number;
+    duration?: number;
+    durationMax?: number;
+    durationUnit?: FhirPeriodUnit;
+    frequency?: number;
+    frequencyMax?: number;
+    period?: number;
+    periodMax?: number;
+    periodUnit?: FhirPeriodUnit;
+    dayOfWeek?: FhirDayOfWeek[];
+    when?: EventTiming[];
+    timeOfDay?: string[];
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalPrnReasonExpr {
+    text?: string;
+    coding?: FhirCoding;
+}
+export interface CanonicalPrnExpr {
+    enabled: boolean;
+    reason?: CanonicalPrnReasonExpr;
+    reasons?: CanonicalPrnReasonExpr[];
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalAdditionalInstructionExpr {
+    text?: string;
+    coding?: FhirCoding;
+    frames?: AdviceFrame[];
+    evidence?: CanonicalEvidence[];
+}
+export interface CanonicalSourceSpan extends TextRange {
+    text: string;
+    tokenIndices?: number[];
+}
+export interface CanonicalEvidence {
+    rule: string;
+    spans: CanonicalSourceSpan[];
+    score?: number;
+    note?: string;
+}
+export interface CanonicalSigClause {
+    kind: "administration";
+    rawText: string;
+    span?: TextRange;
+    raw: CanonicalSourceSpan;
+    dose?: CanonicalDoseExpr;
+    route?: CanonicalRouteExpr;
+    site?: CanonicalSiteExpr;
+    method?: CanonicalMethodExpr;
+    schedule?: CanonicalScheduleExpr;
+    prn?: CanonicalPrnExpr;
+    patientInstruction?: string;
+    additionalInstructions?: CanonicalAdditionalInstructionExpr[];
+    leftovers: CanonicalSourceSpan[];
+    evidence: CanonicalEvidence[];
+    confidence: number;
+    warnings?: string[];
+}
 export interface ParseResult {
     fhir: FhirDosage;
     shortText: string;
@@ -523,21 +738,9 @@ export interface ParseResult {
     meta: {
         consumedTokens: string[];
         leftoverText?: string;
-        normalized: {
-            route?: RouteCode;
-            unit?: string;
-            site?: {
-                text?: string;
-                coding?: BodySiteCode;
-            };
-            prnReason?: {
-                text?: string;
-                coding?: FhirCoding;
-            };
-            additionalInstructions?: Array<{
-                text?: string;
-                coding?: FhirCoding;
-            }>;
+        normalized: ParseNormalizedMeta;
+        canonical: {
+            clauses: CanonicalSigClause[];
         };
         siteLookups?: Array<{
             request: SiteCodeLookupRequest;
@@ -549,6 +752,31 @@ export interface ParseResult {
         }>;
     };
 }
+export interface ParseNormalizedMeta {
+    route?: RouteCode;
+    unit?: string;
+    site?: {
+        text?: string;
+        coding?: BodySiteCode;
+    };
+    method?: {
+        text?: string;
+        coding?: FhirCoding;
+    };
+    patientInstruction?: string;
+    prnReason?: {
+        text?: string;
+        coding?: FhirCoding;
+    };
+    prnReasons?: Array<{
+        text?: string;
+        coding?: FhirCoding;
+    }>;
+    additionalInstructions?: Array<{
+        text?: string;
+        coding?: FhirCoding;
+    }>;
+}
 export interface ParseBatchSegmentMeta {
     index: number;
     text: string;
@@ -577,21 +805,9 @@ export interface ParseBatchResult {
     meta: {
         consumedTokens: string[];
         leftoverText?: string;
-        normalized: {
-            route?: RouteCode;
-            unit?: string;
-            site?: {
-                text?: string;
-                coding?: BodySiteCode;
-            };
-            prnReason?: {
-                text?: string;
-                coding?: FhirCoding;
-            };
-            additionalInstructions?: Array<{
-                text?: string;
-                coding?: FhirCoding;
-            }>;
+        normalized: ParseNormalizedMeta;
+        canonical: {
+            clauses: CanonicalSigClause[];
         };
         siteLookups?: Array<{
             request: SiteCodeLookupRequest;

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteCode = exports.FhirDayOfWeek = exports.FhirPeriodUnit = exports.SNOMEDCTRouteCodes = exports.EventTiming = void 0;
+exports.AdviceArgumentRole = exports.AdviceRelation = exports.AdviceModality = exports.AdviceForce = exports.AdvicePolarity = exports.RouteCode = exports.FhirDayOfWeek = exports.FhirPeriodUnit = exports.SNOMEDCTRouteCodes = exports.EventTiming = void 0;
 /**
  * Follows https://build.fhir.org/valueset-event-timing.html
  * Real-world event relating to the schedule.
@@ -226,3 +226,51 @@ var FhirDayOfWeek;
     FhirDayOfWeek["Sunday"] = "sun";
 })(FhirDayOfWeek || (exports.FhirDayOfWeek = FhirDayOfWeek = {}));
 exports.RouteCode = SNOMEDCTRouteCodes;
+var AdvicePolarity;
+(function (AdvicePolarity) {
+    AdvicePolarity["Affirm"] = "affirm";
+    AdvicePolarity["Negate"] = "negate";
+})(AdvicePolarity || (exports.AdvicePolarity = AdvicePolarity = {}));
+var AdviceForce;
+(function (AdviceForce) {
+    AdviceForce["Instruction"] = "instruction";
+    AdviceForce["Warning"] = "warning";
+    AdviceForce["Caution"] = "caution";
+    AdviceForce["Sequence"] = "sequence";
+})(AdviceForce || (exports.AdviceForce = AdviceForce = {}));
+var AdviceModality;
+(function (AdviceModality) {
+    AdviceModality["May"] = "may";
+    AdviceModality["Can"] = "can";
+    AdviceModality["Might"] = "might";
+    AdviceModality["Could"] = "could";
+    AdviceModality["Should"] = "should";
+    AdviceModality["Must"] = "must";
+})(AdviceModality || (exports.AdviceModality = AdviceModality = {}));
+var AdviceRelation;
+(function (AdviceRelation) {
+    AdviceRelation["With"] = "with";
+    AdviceRelation["Without"] = "without";
+    AdviceRelation["Before"] = "before";
+    AdviceRelation["After"] = "after";
+    AdviceRelation["During"] = "during";
+    AdviceRelation["Then"] = "then";
+    AdviceRelation["Until"] = "until";
+    AdviceRelation["For"] = "for";
+    AdviceRelation["In"] = "in";
+    AdviceRelation["On"] = "on";
+})(AdviceRelation || (exports.AdviceRelation = AdviceRelation = {}));
+var AdviceArgumentRole;
+(function (AdviceArgumentRole) {
+    AdviceArgumentRole["Theme"] = "theme";
+    AdviceArgumentRole["Object"] = "object";
+    AdviceArgumentRole["Substance"] = "substance";
+    AdviceArgumentRole["MealState"] = "meal_state";
+    AdviceArgumentRole["Activity"] = "activity";
+    AdviceArgumentRole["Material"] = "material";
+    AdviceArgumentRole["Site"] = "site";
+    AdviceArgumentRole["Amount"] = "amount";
+    AdviceArgumentRole["Duration"] = "duration";
+    AdviceArgumentRole["Time"] = "time";
+    AdviceArgumentRole["Free"] = "free";
+})(AdviceArgumentRole || (exports.AdviceArgumentRole = AdviceArgumentRole = {}));

package/dist/utils/text.d.ts

@@ -0,0 +1,3 @@
+export declare function isWhitespaceChar(char: string): boolean;
+export declare function isLoosePhraseSeparatorChar(char: string): boolean;
+export declare function normalizeLoosePhraseKey(value: string): string;

package/dist/utils/text.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWhitespaceChar = isWhitespaceChar;
+exports.isLoosePhraseSeparatorChar = isLoosePhraseSeparatorChar;
+exports.normalizeLoosePhraseKey = normalizeLoosePhraseKey;
+function isWhitespaceChar(char) {
+    const code = char.charCodeAt(0);
+    return (code <= 0x20 ||
+        code === 0x00a0 ||
+        code === 0x1680 ||
+        (code >= 0x2000 && code <= 0x200a) ||
+        code === 0x2028 ||
+        code === 0x2029 ||
+        code === 0x202f ||
+        code === 0x205f ||
+        code === 0x3000);
+}
+function isAsciiPunctuationCode(code) {
+    return ((code >= 0x21 && code <= 0x2f) ||
+        (code >= 0x3a && code <= 0x40) ||
+        (code >= 0x5b && code <= 0x60) ||
+        (code >= 0x7b && code <= 0x7e));
+}
+function isLoosePhraseSeparatorChar(char) {
+    const code = char.charCodeAt(0);
+    return (isWhitespaceChar(char) ||
+        isAsciiPunctuationCode(code) ||
+        (code >= 0x2000 && code <= 0x206f) ||
+        (code >= 0x2e00 && code <= 0x2e7f) ||
+        (code >= 0x3000 && code <= 0x303f));
+}
+function normalizeLoosePhraseKey(value) {
+    const lowered = value.trim().toLowerCase();
+    let normalized = "";
+    let pendingSpace = false;
+    for (const char of lowered) {
+        if (isLoosePhraseSeparatorChar(char)) {
+            pendingSpace = normalized.length > 0;
+            continue;
+        }
+        if (pendingSpace) {
+            normalized += " ";
+            pendingSpace = false;
+        }
+        normalized += char;
+    }
+    return normalized.trim();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ezmedicationinput",
-  "version": "0.1.42",
+  "version": "0.1.44",
   "description": "Parse concise medication sigs into FHIR R5 Dosage JSON",
   "type": "module",
   "main": "dist/index.js",