saferx-pharma-sdk 0.0.6

package/dist/esm/api/types/ClinicalAlert.d.mts

@@ -0,0 +1,48 @@
+/**
+ * Clinical safety alert from cross-drug analysis
+ */
+export interface ClinicalAlert {
+    /** SFX_ID of the drug involved */
+    drug_id?: string | undefined;
+    /** Drug name (English) */
+    drug?: string | undefined;
+    /** Drug name (Arabic) */
+    drug_ar?: string | undefined;
+    /** Condition name (for condition alerts) */
+    condition?: string | undefined;
+    /** Condition name in Arabic */
+    condition_ar?: string | undefined;
+    /** Population name (for population alerts) */
+    population?: string | undefined;
+    /** Population name in Arabic */
+    population_ar?: string | undefined;
+    /** Alert severity */
+    severity?: number | undefined;
+    /** Severity label (English) */
+    severity_label?: string | undefined;
+    /** Severity label (Arabic) */
+    severity_label_ar?: string | undefined;
+    /** Whether the drug is contraindicated for this population/condition */
+    contraindicated?: boolean | undefined;
+    /** Whether dose adjustment is needed */
+    requires_dose_adjustment?: boolean | undefined;
+    /** Whether additional monitoring is needed */
+    monitoring_required?: boolean | undefined;
+    /** Clinical rationale (English) */
+    reason?: string | undefined;
+    /** Clinical rationale (Arabic) */
+    reason_ar?: string | undefined;
+    /** Data source */
+    source?: string | undefined;
+    /** Additional clinical notes */
+    special_notes?: ClinicalAlert.SpecialNotes | undefined;
+}
+export declare namespace ClinicalAlert {
+    /**
+     * Additional clinical notes
+     */
+    interface SpecialNotes {
+        /** Whether this drug is on the Beers Criteria list */
+        beers_criteria?: boolean | undefined;
+    }
+}

package/dist/esm/api/types/ClinicalAlert.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ClinicalConcern.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Clinical concern for a specific population or condition
+ */
+export interface ClinicalConcern {
+    /** Drug name */
+    name?: string | undefined;
+    /** Concern severity (1=minor, 5=contraindicated) */
+    severity?: number | undefined;
+    /** Human-readable severity label */
+    severity_name?: string | undefined;
+    /** Clinical rationale */
+    reason?: string | undefined;
+    /** Data source */
+    source?: string | undefined;
+}

package/dist/esm/api/types/ClinicalConcern.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ClinicalData.d.mts

@@ -0,0 +1,14 @@
+import type * as SafeRx from "../index.mjs";
+/**
+ * Clinical safety considerations combining per-drug population/condition
+ * data with cross-drug clinical alerts. Enhanced when `patient_profile`
+ * is provided in the request.
+ */
+export interface ClinicalData {
+    /** Per-drug clinical data keyed by SFX_ID */
+    drug_specific?: Record<string, SafeRx.DrugClinicalData> | undefined;
+    /** Cross-drug condition-related alerts (requires `patient_profile.conditions`) */
+    condition_alerts?: SafeRx.ClinicalAlert[] | undefined;
+    /** Cross-drug population-related alerts (requires `patient_profile.populations`) */
+    population_alerts?: SafeRx.ClinicalAlert[] | undefined;
+}

package/dist/esm/api/types/ClinicalData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Condition.d.mts

@@ -0,0 +1,22 @@
+/**
+ * Patient comorbidity. Used by the `clinical` domain to identify
+ * drugs that are contraindicated or require caution for patients
+ * with these conditions.
+ */
+export declare const Condition: {
+    readonly Diabetes: "diabetes";
+    readonly Hypertension: "hypertension";
+    readonly Epilepsy: "epilepsy";
+    readonly HeartFailure: "heart_failure";
+    readonly Asthma: "asthma";
+    readonly LiverDisease: "liver_disease";
+    readonly KidneyDisease: "kidney_disease";
+    readonly Thyroid: "thyroid";
+    readonly Depression: "depression";
+    readonly BloodDisorders: "blood_disorders";
+    readonly IschemicHeart: "ischemic_heart";
+    readonly Arrhythmia: "arrhythmia";
+    readonly Gout: "gout";
+    readonly Osteoporosis: "osteoporosis";
+};
+export type Condition = (typeof Condition)[keyof typeof Condition];

package/dist/esm/api/types/Condition.mjs

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Patient comorbidity. Used by the `clinical` domain to identify
+ * drugs that are contraindicated or require caution for patients
+ * with these conditions.
+ */
+export const Condition = {
+    Diabetes: "diabetes",
+    Hypertension: "hypertension",
+    Epilepsy: "epilepsy",
+    HeartFailure: "heart_failure",
+    Asthma: "asthma",
+    LiverDisease: "liver_disease",
+    KidneyDisease: "kidney_disease",
+    Thyroid: "thyroid",
+    Depression: "depression",
+    BloodDisorders: "blood_disorders",
+    IschemicHeart: "ischemic_heart",
+    Arrhythmia: "arrhythmia",
+    Gout: "gout",
+    Osteoporosis: "osteoporosis",
+};

package/dist/esm/api/types/DailyLimit.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Maximum daily dose details
+ */
+export interface DailyLimit {
+    /** Maximum daily dose in milligrams */
+    limit_mg?: number | undefined;
+    /** Drug potency category */
+    potency?: string | undefined;
+    /** Therapeutic drug class */
+    drug_class?: string | undefined;
+}

package/dist/esm/api/types/DailyLimit.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DomainCode.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Safety domain identifier.
+ * - `ae` — Adverse effects, Black Box Warnings, monitoring parameters
+ * - `ddi` — Drug-drug interactions (requires 2+ drugs)
+ * - `pllr` — Pregnancy & lactation risk ratings
+ * - `food` — Meal timing & food-drug conflicts
+ * - `clinical` — Population & condition safety (enhanced with `patient_profile`)
+ * - `dose` — Maximum daily dose information (preliminary)
+ */
+export declare const DomainCode: {
+    readonly Ae: "ae";
+    readonly Ddi: "ddi";
+    readonly Pllr: "pllr";
+    readonly Food: "food";
+    readonly Clinical: "clinical";
+    readonly Dose: "dose";
+};
+export type DomainCode = (typeof DomainCode)[keyof typeof DomainCode];

package/dist/esm/api/types/DomainCode.mjs

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Safety domain identifier.
+ * - `ae` — Adverse effects, Black Box Warnings, monitoring parameters
+ * - `ddi` — Drug-drug interactions (requires 2+ drugs)
+ * - `pllr` — Pregnancy & lactation risk ratings
+ * - `food` — Meal timing & food-drug conflicts
+ * - `clinical` — Population & condition safety (enhanced with `patient_profile`)
+ * - `dose` — Maximum daily dose information (preliminary)
+ */
+export const DomainCode = {
+    Ae: "ae",
+    Ddi: "ddi",
+    Pllr: "pllr",
+    Food: "food",
+    Clinical: "clinical",
+    Dose: "dose",
+};

package/dist/esm/api/types/DoseClassification.d.mts

@@ -0,0 +1,40 @@
+/**
+ * WHO DDD-based dose-response classification.
+ * Type A reactions are dose-dependent and predictable.
+ * Type B reactions are idiosyncratic and unpredictable.
+ */
+export interface DoseClassification {
+    /**
+     * Primary reaction type.
+     * - `A` — Dose-dependent (augmented). Predictable from pharmacology.
+     * - `B` — Idiosyncratic (bizarre). Unpredictable, not dose-related.
+     */
+    reaction_type?: DoseClassification.ReactionType | undefined;
+    /** Classification rationale */
+    basis?: string | undefined;
+    /** Whether any idiosyncratic (Type B) reactions exist */
+    has_idiosyncratic?: boolean | undefined;
+    /** List of known idiosyncratic effects */
+    idiosyncratic_effects?: string[] | undefined;
+    /** Confidence in the classification */
+    confidence?: DoseClassification.Confidence | undefined;
+}
+export declare namespace DoseClassification {
+    /**
+     * Primary reaction type.
+     * - `A` — Dose-dependent (augmented). Predictable from pharmacology.
+     * - `B` — Idiosyncratic (bizarre). Unpredictable, not dose-related.
+     */
+    const ReactionType: {
+        readonly A: "A";
+        readonly B: "B";
+    };
+    type ReactionType = (typeof ReactionType)[keyof typeof ReactionType];
+    /** Confidence in the classification */
+    const Confidence: {
+        readonly High: "high";
+        readonly Medium: "medium";
+        readonly Low: "low";
+    };
+    type Confidence = (typeof Confidence)[keyof typeof Confidence];
+}

package/dist/esm/api/types/DoseClassification.mjs

@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DoseClassification;
+(function (DoseClassification) {
+    /**
+     * Primary reaction type.
+     * - `A` — Dose-dependent (augmented). Predictable from pharmacology.
+     * - `B` — Idiosyncratic (bizarre). Unpredictable, not dose-related.
+     */
+    DoseClassification.ReactionType = {
+        A: "A",
+        B: "B",
+    };
+    /** Confidence in the classification */
+    DoseClassification.Confidence = {
+        High: "high",
+        Medium: "medium",
+        Low: "low",
+    };
+})(DoseClassification || (DoseClassification = {}));

package/dist/esm/api/types/DosingData.d.mts

@@ -0,0 +1,14 @@
+import type * as SafeRx from "../index.mjs";
+/**
+ * Maximum daily dose information. Currently based on WHO Defined Daily Dose
+ * (DDD) from the adverse effects database. A dedicated dose-checking database
+ * is under development.
+ */
+export interface DosingData {
+    /** Maximum daily dose details */
+    daily_limit?: (SafeRx.DailyLimit | null) | undefined;
+    /** Dose-response classification */
+    classification?: (SafeRx.DoseClassification | null) | undefined;
+    /** Data source (currently `WHO_DDD`) */
+    source?: string | undefined;
+}

package/dist/esm/api/types/DosingData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DrugClinicalData.d.mts

@@ -0,0 +1,7 @@
+import type * as SafeRx from "../index.mjs";
+export interface DrugClinicalData {
+    /** Population-specific data keyed by population name */
+    populations?: Record<string, SafeRx.ClinicalConcern> | undefined;
+    /** Condition-specific data keyed by condition name */
+    conditions?: Record<string, SafeRx.ClinicalConcern> | undefined;
+}

package/dist/esm/api/types/DrugClinicalData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DrugSafetyCheckResponse.d.mts

@@ -0,0 +1,28 @@
+import type * as SafeRx from "../index.mjs";
+export interface DrugSafetyCheckResponse {
+    /** Always `"success"` for 200 responses */
+    status: DrugSafetyCheckResponse.Status;
+    /** Successfully resolved drugs with full product details */
+    drugs: SafeRx.ResolvedDrug[];
+    /**
+     * Drug names that could not be resolved to a SafeRx product.
+     * These are not errors — they simply did not match any product
+     * with sufficient confidence (similarity score >= 0.5).
+     */
+    unresolved: string[];
+    safety: SafeRx.SafetyData;
+    /**
+     * High-severity safety issues bubbled up from all domains, sorted
+     * by severity (CRITICAL first). Use this array for quick triage —
+     * it contains the most actionable items from the full safety data.
+     */
+    alerts: SafeRx.Alert[];
+    meta: SafeRx.Meta;
+}
+export declare namespace DrugSafetyCheckResponse {
+    /** Always `"success"` for 200 responses */
+    const Status: {
+        readonly Success: "success";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/DrugSafetyCheckResponse.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DrugSafetyCheckResponse;
+(function (DrugSafetyCheckResponse) {
+    /** Always `"success"` for 200 responses */
+    DrugSafetyCheckResponse.Status = {
+        Success: "success",
+    };
+})(DrugSafetyCheckResponse || (DrugSafetyCheckResponse = {}));

package/dist/esm/api/types/ErrorResponse.d.mts

@@ -0,0 +1,16 @@
+export interface ErrorResponse {
+    /** Error indicator or error message */
+    error?: ErrorResponse.Error_ | undefined;
+    /** Machine-readable error code */
+    code?: string | undefined;
+    /** Human-readable error description */
+    message?: string | undefined;
+    /** HTTP status code */
+    status?: number | undefined;
+}
+export declare namespace ErrorResponse {
+    /**
+     * Error indicator or error message
+     */
+    type Error_ = boolean | string;
+}

package/dist/esm/api/types/ErrorResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/FoodConflict.d.mts

@@ -0,0 +1,13 @@
+/**
+ * A specific food-drug interaction
+ */
+export interface FoodConflict {
+    /** Food item or food category involved */
+    food?: string | undefined;
+    /** Interaction severity (1-5) */
+    severity?: number | undefined;
+    /** Pharmacological interaction mechanism */
+    interaction_type?: string | undefined;
+    /** Dietary recommendation */
+    recommendation?: string | undefined;
+}

package/dist/esm/api/types/FoodConflict.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/FoodData.d.mts

@@ -0,0 +1,11 @@
+import type * as SafeRx from "../index.mjs";
+/**
+ * Food-drug interaction data for a single drug
+ */
+export interface FoodData {
+    timing?: SafeRx.MealTiming | undefined;
+    /** Specific food-drug conflicts */
+    conflicts?: SafeRx.FoodConflict[] | undefined;
+    /** Total number of food conflicts (may exceed items in `conflicts` array) */
+    conflict_count?: number | undefined;
+}

package/dist/esm/api/types/FoodData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Interaction.d.mts

@@ -0,0 +1,36 @@
+export interface Interaction {
+    /** SFX_ID of the first drug in the interaction pair */
+    drug_1_id?: string | undefined;
+    /** SFX_ID of the second drug in the interaction pair */
+    drug_2_id?: string | undefined;
+    /**
+     * Interaction severity level.
+     * - `2` — Minor: minimal clinical significance
+     * - `3` — Moderate: may require monitoring or dose adjustment
+     * - `4` — Major: avoid combination if possible, close monitoring required
+     * - `5` — Contraindicated: do not use together
+     */
+    severity?: number | undefined;
+    /** Human-readable severity label */
+    severity_name?: Interaction.SeverityName | undefined;
+    /** Interaction mechanism or clinical description (English) */
+    description?: string | undefined;
+    /** Interaction description in Arabic */
+    description_ar?: string | undefined;
+    /** Clinical recommendation for managing this interaction (English) */
+    recommendation?: string | undefined;
+    /** Clinical recommendation in Arabic */
+    recommendation_ar?: string | undefined;
+    /** Data source */
+    source?: string | undefined;
+}
+export declare namespace Interaction {
+    /** Human-readable severity label */
+    const SeverityName: {
+        readonly Minor: "MINOR";
+        readonly Moderate: "MODERATE";
+        readonly Major: "MAJOR";
+        readonly Contraindicated: "CONTRAINDICATED";
+    };
+    type SeverityName = (typeof SeverityName)[keyof typeof SeverityName];
+}

package/dist/esm/api/types/Interaction.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+export var Interaction;
+(function (Interaction) {
+    /** Human-readable severity label */
+    Interaction.SeverityName = {
+        Minor: "MINOR",
+        Moderate: "MODERATE",
+        Major: "MAJOR",
+        Contraindicated: "CONTRAINDICATED",
+    };
+})(Interaction || (Interaction = {}));

package/dist/esm/api/types/InteractionSummary.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Interaction count by severity level for quick triage
+ */
+export interface InteractionSummary {
+    /** Number of contraindicated (severity 5) interactions */
+    contraindicated?: number | undefined;
+    /** Number of major (severity 4) interactions */
+    major?: number | undefined;
+    /** Number of moderate (severity 3) interactions */
+    moderate?: number | undefined;
+    /** Number of minor (severity 2) interactions */
+    minor?: number | undefined;
+}

package/dist/esm/api/types/InteractionSummary.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/InteractionsData.d.mts

@@ -0,0 +1,11 @@
+import type * as SafeRx from "../index.mjs";
+/**
+ * Drug-drug interaction results. Requires 2 or more resolved drugs.
+ * If only 1 drug is resolved, returns count=0 with empty interactions array.
+ */
+export interface InteractionsData {
+    /** Total number of interactions found */
+    count?: number | undefined;
+    summary?: SafeRx.InteractionSummary | undefined;
+    interactions?: SafeRx.Interaction[] | undefined;
+}

package/dist/esm/api/types/InteractionsData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MealTiming.d.mts

@@ -0,0 +1,26 @@
+/**
+ * Meal timing recommendation
+ */
+export interface MealTiming {
+    /**
+     * Timing category code.
+     * Common values: `WITH_FOOD`, `EMPTY_STOMACH`, `WITH_OR_WITHOUT_FOOD`,
+     * `NO_RESTRICTION`, `BEFORE_MEALS`, `AFTER_MEALS`
+     */
+    category?: string | undefined;
+    /**
+     * How important is adherence to this timing.
+     * Values: `MUST`, `PREFERRED`, `OPTIONAL`, `NO_RESTRICTION`
+     */
+    importance?: string | undefined;
+    /** Full recommendation text (English) */
+    recommendation?: string | undefined;
+    /** Full recommendation text (Arabic) */
+    recommendation_ar?: string | undefined;
+    /** Evidence source for this recommendation */
+    evidence_level?: string | undefined;
+    /** Severity of non-adherence consequences (1-5) */
+    severity?: number | undefined;
+    /** Clinical rationale for the timing recommendation */
+    rationale?: string | undefined;
+}

package/dist/esm/api/types/MealTiming.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/Meta.d.mts

@@ -0,0 +1,27 @@
+import type * as SafeRx from "../index.mjs";
+/**
+ * Request metadata and performance information
+ */
+export interface Meta {
+    /** Server-side processing time in milliseconds */
+    processing_time_ms?: number | undefined;
+    /** Domains that were actually checked */
+    domains_checked?: SafeRx.DomainCode[] | undefined;
+    /** Number of drugs submitted */
+    drug_count?: number | undefined;
+    /** Number of drugs successfully resolved */
+    resolved_count?: number | undefined;
+    /** Number of drugs that could not be resolved */
+    unresolved_count?: number | undefined;
+    /** Caller's current tier */
+    tier?: Meta.Tier | undefined;
+}
+export declare namespace Meta {
+    /** Caller's current tier */
+    const Tier: {
+        readonly Free: "free";
+        readonly Pro: "pro";
+        readonly Enterprise: "enterprise";
+    };
+    type Tier = (typeof Tier)[keyof typeof Tier];
+}

package/dist/esm/api/types/Meta.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var Meta;
+(function (Meta) {
+    /** Caller's current tier */
+    Meta.Tier = {
+        Free: "free",
+        Pro: "pro",
+        Enterprise: "enterprise",
+    };
+})(Meta || (Meta = {}));

package/dist/esm/api/types/MetadataResponse.d.mts

@@ -0,0 +1,79 @@
+import type * as SafeRx from "../index.mjs";
+export interface MetadataResponse {
+    status: MetadataResponse.Status;
+    /** Maximum drugs allowed per request for your tier */
+    max_drugs_per_request?: number | undefined;
+    /** All available safety domains */
+    available_domains: SafeRx.DomainCode[];
+    /** Valid values for the `patient_profile` field */
+    patient_profile_options: MetadataResponse.PatientProfileOptions;
+    /** Risk/severity scales used across domains */
+    risk_scales: MetadataResponse.RiskScales;
+    /** Current database versions */
+    database_versions?: MetadataResponse.DatabaseVersions | undefined;
+    /** Database coverage statistics */
+    database_stats?: MetadataResponse.DatabaseStats | undefined;
+    /** Supported response languages */
+    supported_languages?: string[] | undefined;
+    /** Caller's current tier */
+    tier?: MetadataResponse.Tier | undefined;
+}
+export declare namespace MetadataResponse {
+    const Status: {
+        readonly Success: "success";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /**
+     * Valid values for the `patient_profile` field
+     */
+    interface PatientProfileOptions {
+        populations?: SafeRx.Population[] | undefined;
+        conditions?: SafeRx.Condition[] | undefined;
+    }
+    /**
+     * Risk/severity scales used across domains
+     */
+    interface RiskScales {
+        /** Pregnancy risk scale: integer key → label */
+        pllr_pregnancy?: Record<string, string> | undefined;
+        /** Lactation risk scale: integer key → label */
+        pllr_lactation?: Record<string, string> | undefined;
+        /** Adverse effect risk levels */
+        ae_risk_levels?: string[] | undefined;
+        /** DDI severity scale: integer key → label */
+        ddi_severity?: Record<string, string> | undefined;
+    }
+    /**
+     * Current database versions
+     */
+    interface DatabaseVersions {
+        ae?: string | undefined;
+        ddi?: string | undefined;
+        clinical?: string | undefined;
+        pllr?: string | undefined;
+        food?: string | undefined;
+        dose?: string | undefined;
+    }
+    /**
+     * Database coverage statistics
+     */
+    interface DatabaseStats {
+        /** Products with adverse effect data */
+        ae_products?: number | undefined;
+        /** Percentage of products with AE coverage */
+        ae_coverage_percent?: number | undefined;
+        /** Total drug-drug interaction pairs */
+        ddi_total_pairs?: number | undefined;
+        /** Number of supported conditions */
+        clinical_conditions?: number | undefined;
+        /** Number of supported populations */
+        clinical_populations?: number | undefined;
+    }
+    /** Caller's current tier */
+    const Tier: {
+        readonly Free: "free";
+        readonly Pro: "pro";
+        readonly Enterprise: "enterprise";
+    };
+    type Tier = (typeof Tier)[keyof typeof Tier];
+}

package/dist/esm/api/types/MetadataResponse.mjs

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+export var MetadataResponse;
+(function (MetadataResponse) {
+    MetadataResponse.Status = {
+        Success: "success",
+    };
+    /** Caller's current tier */
+    MetadataResponse.Tier = {
+        Free: "free",
+        Pro: "pro",
+        Enterprise: "enterprise",
+    };
+})(MetadataResponse || (MetadataResponse = {}));