Openfda Tools

Configuration File: openfda_tools.json Tool Type: Local Tools Count: 12

This page contains all tools defined in the openfda_tools.json configuration file.

Available Tools

OpenFDA_search_animalvet_adverse_events (Type: BaseRESTTool)

Search the FDA animal & veterinary adverse-event database via openFDA. Contains reports of advers…

OpenFDA_search_animalvet_adverse_events tool specification

Tool Information:

  • Name: OpenFDA_search_animalvet_adverse_events

  • Type: BaseRESTTool

  • Description: Search the FDA animal & veterinary adverse-event database via openFDA. Contains reports of adverse drug experiences in animals (and humans exposed) involving veterinary drugs. Returns affected animal species/breed, reactions (VeDDRA terms), drug(s) involved, number of animals affected/treated, outcome/health assessment, and dates. Use for veterinary pharmacovigilance. Reports are voluntary and do not establish causation.

Parameters:

  • search (string) (required) Lucene query for animal/veterinary events (e.g., ‘animal.species:Dog’, ‘drug.active_ingredients.name:ivermectin’, ‘reaction.veddra_term_name:Vomiting’).

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • skip ([‘integer’, ‘null’]) (optional) Number of results to skip for pagination (max 25000)

Example Usage:

query = {
    "name": "OpenFDA_search_animalvet_adverse_events",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_device_510k (Type: BaseRESTTool)

Search the FDA 510(k) premarket notification database via openFDA. Contains clearances for medica…

OpenFDA_search_device_510k tool specification

Tool Information:

  • Name: OpenFDA_search_device_510k

  • Type: BaseRESTTool

  • Description: Search the FDA 510(k) premarket notification database via openFDA. Contains clearances for medical devices through the 510(k) pathway (substantial equivalence). Returns device names, applicant companies, decision dates, advisory committee classifications, and FDA decision types. Useful for medical device research, competitive landscape analysis, and understanding regulatory pathways for specific device categories.

Parameters:

  • search (string) (required) Lucene query for 510(k) devices (e.g., ‘device_name:stethoscope’, ‘applicant:siemens’, ‘decision_date_year:2023’, ‘advisory_committee_description:radiology’)

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

Example Usage:

query = {
    "name": "OpenFDA_search_device_510k",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_device_adverse_events (Type: BaseRESTTool)

Search the FDA MAUDE medical-device adverse-event database via openFDA. Contains voluntary and ma…

OpenFDA_search_device_adverse_events tool specification

Tool Information:

  • Name: OpenFDA_search_device_adverse_events

  • Type: BaseRESTTool

  • Description: Search the FDA MAUDE medical-device adverse-event database via openFDA. Contains voluntary and mandatory reports of device-associated injuries, malfunctions, and deaths. Returns event type (Death/Injury/Malfunction), device brand/generic name, manufacturer, product problems, patient outcomes, and report dates. Use for device safety signal detection and post-market surveillance. MAUDE reports are unverified and do not establish causation.

Parameters:

  • search (string) (required) Lucene query for MAUDE device events (e.g., ‘device.generic_name:pacemaker’, ‘event_type:Death’, ‘device.brand_name:”INSULIN PUMP”’, ‘date_received:[20230101+TO+20231231]’).

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • skip ([‘integer’, ‘null’]) (optional) Number of results to skip for pagination (max 25000)

Example Usage:

query = {
    "name": "OpenFDA_search_device_adverse_events",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_device_enforcement (Type: BaseRESTTool)

Search the FDA medical device enforcement (recall) database via openFDA. Contains medical device …

OpenFDA_search_device_enforcement tool specification

Tool Information:

  • Name: OpenFDA_search_device_enforcement

  • Type: BaseRESTTool

  • Description: Search the FDA medical device enforcement (recall) database via openFDA. Contains medical device recalls, corrections, and removals. Use Lucene query syntax: ‘classification:”Class I”’ (most serious), ‘status:Ongoing’, ‘recalling_firm:”Medtronic”’. Returns recall details including product description, reason for recall, and distribution pattern. Medical devices include implants, diagnostic equipment, surgical tools, and consumer medical devices.

Parameters:

  • search ([‘string’, ‘null’]) (optional) Lucene query for device recalls (e.g., ‘classification:”Class I”’, ‘status:Ongoing’, ‘product_description:pacemaker’, ‘recalling_firm:medtronic’). Leave null to get recent recalls.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • count ([‘string’, ‘null’]) (optional) Field to count by (e.g., ‘classification’, ‘status’, ‘recalling_firm.exact’)

Example Usage:

query = {
    "name": "OpenFDA_search_device_enforcement",
    "arguments": {
    }
}
result = tu.run(query)

OpenFDA_search_device_recalls (Type: BaseRESTTool)

Search the FDA medical-device recall database via openFDA. Returns device recalls with product de…

OpenFDA_search_device_recalls tool specification

Tool Information:

  • Name: OpenFDA_search_device_recalls

  • Type: BaseRESTTool

  • Description: Search the FDA medical-device recall database via openFDA. Returns device recalls with product description, recalling firm, recall status, FDA-determined cause, classification, associated 510(k)/PMA numbers, product code, and key dates (initiated/posted/terminated). Use for device safety research and tracking corrective actions. Distinct from device enforcement reports.

Parameters:

  • search (string) (required) Lucene query for device recalls (e.g., ‘product_description:catheter’, ‘recalling_firm:Medtronic’, ‘recall_status:Open’, ‘product_code:DXN’).

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • skip ([‘integer’, ‘null’]) (optional) Number of results to skip for pagination (max 25000)

Example Usage:

query = {
    "name": "OpenFDA_search_device_recalls",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_drug_enforcement (Type: BaseRESTTool)

Search the FDA drug enforcement (recall) database via openFDA. Contains drug recalls, withdrawals…

OpenFDA_search_drug_enforcement tool specification

Tool Information:

  • Name: OpenFDA_search_drug_enforcement

  • Type: BaseRESTTool

  • Description: Search the FDA drug enforcement (recall) database via openFDA. Contains drug recalls, withdrawals, and field corrections submitted to the FDA. Use Lucene query syntax: ‘classification:”Class I”’ (most serious, may cause death), ‘recalling_firm:pfizer’, ‘status:Ongoing’. Returns recall details including reason, product description, distribution pattern, classification, firm, and dates. Use count parameter for frequency analysis (e.g., count=’classification’ to see recall counts by class).

Parameters:

  • search ([‘string’, ‘null’]) (optional) Lucene query for drug recalls (e.g., ‘classification:”Class I”’, ‘status:Ongoing’, ‘recalling_firm:pfizer’, ‘reason_for_recall:contamination’). Leave null to get recent recalls.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • count ([‘string’, ‘null’]) (optional) Field to count by for frequency analysis (e.g., ‘classification’, ‘recalling_firm.exact’, ‘voluntary_mandated.exact’)

Example Usage:

query = {
    "name": "OpenFDA_search_drug_enforcement",
    "arguments": {
    }
}
result = tu.run(query)

OpenFDA_search_drug_events (Type: OpenFDADrugEventsTool)

Search the FDA Adverse Event Reporting System (FAERS) database via openFDA for drug safety report…

OpenFDA_search_drug_events tool specification

Tool Information:

  • Name: OpenFDA_search_drug_events

  • Type: OpenFDADrugEventsTool

  • Description: Search the FDA Adverse Event Reporting System (FAERS) database via openFDA for drug safety reports. Accepts convenience parameters drug_name and reaction (e.g., drug_name=’warfarin’, reaction=’haemorrhage’), or a raw Lucene ‘search’ string for advanced queries. Contains 20+ million adverse event reports. IMPORTANT: MedDRA reaction terms use British English spelling (e.g., ‘haemorrhage’ not ‘hemorrhage’, ‘haematoma’ not ‘hematoma’). Returns serious adverse events with outcomes (hospitalization, death), suspect drugs, and MedDRA reactions.

Parameters:

  • search (string) (optional) Lucene query for adverse event reports. Use AND/OR with spaces (not +AND+). Examples: ‘patient.drug.medicinalproduct:aspirin’, ‘patient.reaction.reactionmeddrapt:”myocardial infarction”’, ‘serious:1 AND patient.drug.medicinalproduct:warfarin’. Combine drugs: ‘patient.drug.medicinalproduct:metformin AND patient.drug.medicinalproduct:atorvastatin’.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of reports to return (default 1, max 100)

  • count ([‘string’, ‘null’]) (optional) Field to count by for frequency analysis (e.g., ‘patient.reaction.reactionmeddrapt.exact’ to get most common reactions)

  • drug_name ([‘string’, ‘null’]) (optional) Drug name to search for adverse events (e.g., ‘warfarin’, ‘metformin’). Alternative to writing a full Lucene ‘search’ query.

  • reaction ([‘string’, ‘null’]) (optional) MedDRA adverse reaction term (British spelling: ‘haemorrhage’ not ‘hemorrhage’, ‘haematoma’ not ‘hematoma’). Used with drug_name to filter by reaction.

  • adverse_event ([‘string’, ‘null’]) (optional) Alias for reaction. MedDRA adverse reaction term (British spelling).

Example Usage:

query = {
    "name": "OpenFDA_search_drug_events",
    "arguments": {
    }
}
result = tu.run(query)

OpenFDA_search_drug_labels (Type: BaseRESTTool)

Search the FDA drug label (SPL - Structured Product Labeling) database via openFDA. Contains appr…

OpenFDA_search_drug_labels tool specification

Tool Information:

  • Name: OpenFDA_search_drug_labels

  • Type: BaseRESTTool

  • Description: Search the FDA drug label (SPL - Structured Product Labeling) database via openFDA. Contains approved prescription and OTC drug labels including indications, warnings, dosage, adverse reactions, contraindications, and pharmacology sections. Use Lucene query syntax: ‘openfda.brand_name:aspirin’, ‘openfda.generic_name:ibuprofen’, ‘openfda.manufacturer_name:pfizer’. Returns label text sections and openFDA cross-references (brand name, generic name, substance name, product type).

Parameters:

  • search (string) (required) Lucene query to search drug labels (e.g., ‘openfda.brand_name:aspirin’, ‘openfda.generic_name:metformin’, ‘indications_and_usage:diabetes’, ‘openfda.pharm_class_epc:”beta blocker”’)

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 1, max 100)

Example Usage:

query = {
    "name": "OpenFDA_search_drug_labels",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_drug_ndc (Type: BaseRESTTool)

Search the FDA National Drug Code (NDC) Directory via openFDA. The NDC directory identifies drugs…

OpenFDA_search_drug_ndc tool specification

Tool Information:

  • Name: OpenFDA_search_drug_ndc

  • Type: BaseRESTTool

  • Description: Search the FDA National Drug Code (NDC) Directory via openFDA. The NDC directory identifies drugs listed under Section 510 of the FDA Act, covering finished dosage forms, unfinished APIs, and non-prescription drugs. Returns product/package codes, brand/generic names, dosage forms, routes of administration, active ingredients, and marketing information.

Parameters:

  • search (string) (required) Lucene query for NDC products (e.g., ‘brand_name:lipitor’, ‘generic_name:atorvastatin’, ‘active_ingredients.name:metformin’, ‘finished:true AND marketing_status:”Prescription”’)

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

Example Usage:

query = {
    "name": "OpenFDA_search_drug_ndc",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_drug_shortages (Type: BaseRESTTool)

Search the FDA drug shortages database via openFDA (added 2025). Returns current and resolved U.S…

OpenFDA_search_drug_shortages tool specification

Tool Information:

  • Name: OpenFDA_search_drug_shortages

  • Type: BaseRESTTool

  • Description: Search the FDA drug shortages database via openFDA (added 2025). Returns current and resolved U.S. drug shortages with generic name, dosage form, presentation, shortage status (Current/Resolved), reported reason for the shortage, therapeutic category, manufacturer, and availability/related info. Use for supply-chain monitoring, formulary planning, and identifying alternatives for drugs in shortage. NOT a substitute for the official FDA shortage list for clinical decisions.

Parameters:

  • search (string) (required) Lucene query for drug shortages (e.g., ‘status:Current’, ‘generic_name:amoxicillin’, ‘dosage_form:Injection’, ‘therapeutic_category:Antibiotic’). Combine with AND/OR.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • skip ([‘integer’, ‘null’]) (optional) Number of results to skip for pagination (max 25000)

Example Usage:

query = {
    "name": "OpenFDA_search_drug_shortages",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_food_adverse_events (Type: BaseRESTTool)

Search the FDA CAERS database (Center for Food Safety and Applied Nutrition Adverse Event Reporti…

OpenFDA_search_food_adverse_events tool specification

Tool Information:

  • Name: OpenFDA_search_food_adverse_events

  • Type: BaseRESTTool

  • Description: Search the FDA CAERS database (Center for Food Safety and Applied Nutrition Adverse Event Reporting System) via openFDA. Covers adverse events and product complaints for foods, dietary supplements, and cosmetics. Returns reported reactions (MedDRA terms), patient outcomes, product role/industry, and dates. Use for supplement/cosmetic/food safety surveillance. Reports are voluntary, unverified, and do not establish causation.

Parameters:

  • search (string) (required) Lucene query for CAERS food/supplement/cosmetic events (e.g., ‘reactions:NAUSEA’, ‘products.industry_name:Cosmetics’, ‘outcomes:”Hospitalization”’, ‘products.role:Suspect’).

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • skip ([‘integer’, ‘null’]) (optional) Number of results to skip for pagination (max 25000)

Example Usage:

query = {
    "name": "OpenFDA_search_food_adverse_events",
    "arguments": {
        "search": "example_value"
    }
}
result = tu.run(query)

OpenFDA_search_food_enforcement (Type: BaseRESTTool)

Search the FDA food enforcement (recall) database via openFDA. Contains food recalls, market with…

OpenFDA_search_food_enforcement tool specification

Tool Information:

  • Name: OpenFDA_search_food_enforcement

  • Type: BaseRESTTool

  • Description: Search the FDA food enforcement (recall) database via openFDA. Contains food recalls, market withdrawals, and safety alerts. Use Lucene query syntax: ‘classification:”Class I”’ (most serious), ‘status:Ongoing’, ‘recalling_firm:”Company Name”’. Returns recall details including product description, reason for recall, distribution pattern, and classification. Useful for food safety research, supply chain analysis, and identifying contamination patterns.

Parameters:

  • search ([‘string’, ‘null’]) (optional) Lucene query for food recalls (e.g., ‘classification:”Class I”’, ‘reason_for_recall:salmonella’, ‘status:Ongoing’, ‘product_description:peanut’). Leave null to get recent recalls.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of results (default 5, max 100)

  • count ([‘string’, ‘null’]) (optional) Field to count by (e.g., ‘classification’, ‘state’, ‘recalling_firm.exact’)

Example Usage:

query = {
    "name": "OpenFDA_search_food_enforcement",
    "arguments": {
    }
}
result = tu.run(query)