tooluniverse 0.2.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

tooluniverse/data/fda_drug_adverse_event_tools.json

@@ -0,0 +1,491 @@
+[
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_reactions_by_drug_event",
+      "description": "Count the number of adverse reactions reported for a given drug, filtered by patient details, event seriousness, and reaction outcomes. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." },
+          "patientsex": { "type": "string", "enum": ["Male", "Female"], "description": "Patient sex, leave it blank if you don't want to apply a filter." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate", "Infant", "Child", "Adolescent", "Adult", "Elderly"], "description": "Patient age group." },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country where event occurred." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Whether the event was serious." },
+          "seriousnessdeath": { "type": "string", "enum": ["Yes", "No"], "description": "Was death reported?" }
+        },
+        "required": ["medicinalproduct"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"],
+          "serious": ["serious"],
+          "seriousnessdeath": ["seriousnessdeath"]
+        },
+        "return_fields": ["patient.reaction.reactionmeddrapt.exact"]
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_drugs_by_drug_event",
+      "description": "Count the number of different drugs involved in FDA adverse event reports, filtered by patient details, country, and seriousness. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "patientsex": { "type": "string", "enum": ["Male", "Female"], "description": "Patient sex, leave it blank if you don't want to apply a filter." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate", "Infant", "Child", "Adolescent", "Adult", "Elderly"], "description": "Patient age group." },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country where event occurred." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Whether the event was serious." }
+        },
+        "required": []
+      },
+      "fields": {
+        "search_fields": {
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["patient.drug.medicinalproduct.exact"]
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_country_by_drug_event",
+      "description": "Count the number of adverse event reports per country of occurrence, filtered by drug, patient demographics, and seriousness. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." },
+          "patientsex": { "type": "string", "enum": ["Male", "Female"], "description": "Patient sex, leave it blank if you don't want to apply a filter." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate", "Infant", "Child", "Adolescent", "Adult", "Elderly"], "description": "Patient age group." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Whether the event was serious." }
+        },
+        "required": []
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["occurcountry.exact"]
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_reportercountry_by_drug_event",
+      "description": "Count the number of FDA adverse event reports grouped by the country of the primary reporter. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." },
+          "patientsex": { "type": "string", "enum": ["Male", "Female"], "description": "Patient sex, leave it blank if you don't want to apply a filter." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate", "Infant", "Child", "Adolescent", "Adult", "Elderly"], "description": "Patient age group." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Whether the event was serious." }
+        },
+        "required": []
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["primarysource.reportercountry.exact"]
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_seriousness_by_drug_event",
+      "description": "Count the number of adverse event reports classified as serious or non-serious, filtered by drug and patient demographics. In results, term Serious means: 'The adverse event resulted in death, a life threatening condition, hospitalization, disability, congenital anomaly, or other serious condition', term Non-serious means 'The adverse event did not result in any of the above' Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." },
+          "patientsex": { "type": "string", "enum": ["Male", "Female"], "description": "Patient sex, leave it blank if you don't want to apply a filter." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate", "Infant", "Child", "Adolescent", "Adult", "Elderly"], "description": "Patient age group." },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Country where event occurred." }
+        },
+        "required": []
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"]
+        },
+        "return_fields": ["serious"],
+        "return_fields_mapping": {
+          "serious": {
+            "1": "Serious",
+            "2": "Non-serious"
+          }
+        }
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_outcomes_by_drug_event",
+      "description": "Count the outcome of adverse reactions (recovered, recovering, fatal, unresolved) filtered by drug, seriousness, and demographics. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." },
+          "patientsex": { "type": "string", "enum": [ "Male", "Female"] },
+          "patientagegroup": { "type": "string", "enum": ["Neonate", "Infant", "Child", "Adolescent", "Adult", "Elderly"] },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$" }
+        },
+        "required": ["medicinalproduct"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"]
+        },
+        "return_fields": ["patient.reaction.reactionoutcome"],
+        "return_fields_mapping": {
+           "patient.reaction.reactionoutcome": {
+            "1": "Recovered/resolved",
+            "2": "Recovering/resolving",
+            "3": "Not recovered/not resolved",
+            "4": "Recovered/resolved with sequelae (consequent health issues)",
+            "5": "Fatal",
+            "6": "Unknown"
+          }
+        }
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_drug_routes_by_event",
+      "description": "Count the most common routes of administration for drugs involved in adverse event reports. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Seriousness of event." }
+        },
+        "required": ["medicinalproduct"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["patient.drug.drugadministrationroute.exact"],
+        "return_fields_mapping": {
+          "patient.drug.drugadministrationroute.exact": {
+            "001": "Auricular (otic)",
+            "002": "Buccal",
+            "003": "Cutaneous",
+            "004": "Dental",
+            "005": "Endocervical",
+            "006": "Endosinusial",
+            "007": "Endotracheal",
+            "008": "Epidural",
+            "009": "Extra-amniotic",
+            "010": "Hemodialysis",
+            "011": "Intra corpus cavernosum",
+            "012": "Intra-amniotic",
+            "013": "Intra-arterial",
+            "014": "Intra-articular",
+            "015": "Intra-uterine",
+            "016": "Intracardiac",
+            "017": "Intracavernous",
+            "018": "Intracerebral",
+            "019": "Intracervical",
+            "020": "Intracisternal",
+            "021": "Intracorneal",
+            "022": "Intracoronary",
+            "023": "Intradermal",
+            "024": "Intradiscal (intraspinal)",
+            "025": "Intrahepatic",
+            "026": "Intralesional",
+            "027": "Intralymphatic",
+            "028": "Intramedullar (bone marrow)",
+            "029": "Intrameningeal",
+            "030": "Intramuscular",
+            "031": "Intraocular",
+            "032": "Intrapericardial",
+            "033": "Intraperitoneal",
+            "034": "Intrapleural",
+            "035": "Intrasynovial",
+            "036": "Intratumor",
+            "037": "Intrathecal",
+            "038": "Intrathoracic",
+            "039": "Intratracheal",
+            "040": "Intravenous bolus",
+            "041": "Intravenous drip",
+            "042": "Intravenous (not otherwise specified)",
+            "043": "Intravesical",
+            "044": "Iontophoresis",
+            "045": "Nasal",
+            "046": "Occlusive dressing technique",
+            "047": "Ophthalmic",
+            "048": "Oral",
+            "049": "Oropharingeal",
+            "050": "Other",
+            "051": "Parenteral",
+            "052": "Periarticular",
+            "053": "Perineural",
+            "054": "Rectal",
+            "055": "Respiratory (inhalation)",
+            "056": "Retrobulbar",
+            "057": "Sunconjunctival",
+            "058": "Subcutaneous",
+            "059": "Subdermal",
+            "060": "Sublingual",
+            "061": "Topical",
+            "062": "Transdermal",
+            "063": "Transmammary",
+            "064": "Transplacental",
+            "065": "Unknown",
+            "066": "Urethral",
+            "067": "Vaginal"
+          }
+        }
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_patient_age_distribution",
+      "description": "Analyze the age distribution of patients experiencing adverse events for a specific drug. The age groups are: Neonate (0-28 days), Infant (29 days - 23 months), Child (2-11 years), Adolescent (12-17 years), Adult (18-64 years), Elderly (65+ years). Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." }
+        },
+        "required": ["medicinalproduct"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"]
+        },
+        "return_fields": ["patient.patientagegroup"],
+        "return_fields_mapping": {
+          "patient.patientagegroup": {
+            "1": "Neonate",
+            "2": "Infant",
+            "3": "Child",
+            "4": "Adolescent",
+            "5": "Adult",
+            "6": "Elderly"
+          }
+        }
+      }
+    },
+    {
+      "type": "FDADrugAdverseEventTool",
+      "name": "FAERS_count_death_related_by_drug",
+      "description": "Count adverse events associated with patient death for a given drug. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproduct": { "type": "string", "description": "Drug name." }
+        },
+        "required": ["medicinalproduct"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproduct": ["patient.drug.medicinalproduct"],
+          "seriousnessdeath": ["seriousnessdeath"]
+        },
+        "return_fields": ["seriousnessdeath"],
+        "return_fields_mapping": {
+          "seriousnessdeath": {
+            "1": "death",
+            "2": "alive"
+          }
+        }
+      }
+    },
+    {
+      "type": "FDACountAdditiveReactionsTool",
+      "name": "FAERS_count_additive_adverse_reactions",
+      "description": "Additive multi-drug data: Aggregate adverse reaction counts across specified medicinal products, stratified by demographics, seriousness, and outcomes. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproducts": { "type": "array", "items": { "type": "string" }, "description": "Array of medicinal product names." },
+          "patientsex": { "type": "string", "enum": ["Male","Female"], "description": "Filter by patient sex." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate","Infant","Child","Adolescent","Adult","Elderly"], "description": "Filter by patient age group." },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "Filter by ISO2 country code of occurrence." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Filter by seriousness classification." },
+          "seriousnessdeath": { "type": "string", "enum": ["Yes","No"], "description": "Filter for fatal outcomes." }
+        },
+        "required": ["medicinalproducts"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproducts": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"],
+          "serious": ["serious"],
+          "seriousnessdeath": ["seriousnessdeath"]
+        },
+        "return_fields": ["patient.reaction.reactionmeddrapt.exact"]
+      }
+    },
+    {
+      "type": "FDACountAdditiveReactionsTool",
+      "name": "FAERS_count_additive_event_reports_by_country",
+      "description": "Additive multi-drug data: Aggregate report counts by country of occurrence across specified medicinal products. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproducts": { "type": "array", "items": { "type": "string" }, "description": "Array of medicinal product names." },
+          "patientsex": { "type": "string", "enum": ["Male","Female"], "description": "Filter by sex." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate","Infant","Child","Adolescent","Adult","Elderly"], "description": "Filter by age group." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Filter by seriousness." }
+        },
+        "required": ["medicinalproducts"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproducts": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["occurcountry.exact"]
+      }
+    },
+    {
+      "type": "FDACountAdditiveReactionsTool",
+      "name": "FAERS_count_additive_reports_by_reporter_country",
+      "description": "Additive multi-drug data: Aggregate adverse event reports by primary reporter country across medicinal products. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproducts": { "type": "array", "items": { "type": "string" }, "description": "Array of medicinal product names." },
+          "patientsex": { "type": "string", "enum": ["Male","Female"], "description": "Filter by sex." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate","Infant","Child","Adolescent","Adult","Elderly"], "description": "Filter by age group." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Filter by seriousness." }
+        },
+        "required": ["medicinalproducts"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproducts": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["primarysource.reportercountry.exact"]
+      }
+    },
+    {
+      "type": "FDACountAdditiveReactionsTool",
+      "name": "FAERS_count_additive_seriousness_classification",
+      "description": "Additive multi-drug data: Quantify serious vs non-serious classifications across medicinal products, annotated per regulatory definitions. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproducts": { "type": "array", "items": { "type": "string" }, "description": "Array of medicinal product names." },
+          "patientsex": { "type": "string", "enum": ["Male","Female"], "description": "Filter by sex." },
+          "patientagegroup": { "type": "string", "enum": ["Neonate","Infant","Child","Adolescent","Adult","Elderly"], "description": "Filter by age group." },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "ISO2 country code filter." }
+        },
+        "required": ["medicinalproducts"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproducts": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"]
+        },
+        "return_fields": ["serious"],
+        "return_fields_mapping": { "serious": { "1": "Serious", "2": "Non-serious" } }
+      }
+    },
+    {
+      "type": "FDACountAdditiveReactionsTool",
+      "name": "FAERS_count_additive_reaction_outcomes",
+      "description": "Additive multi-drug data: Determine reaction outcome counts (e.g., recovered, resolving, fatal) across medicinal products using standardized outcome mappings. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproducts": { "type": "array", "items": { "type": "string" }, "description": "Array of medicinal product names." },
+          "patientsex": { "type": "string", "enum": ["Male","Female"] },
+          "patientagegroup": { "type": "string", "enum": ["Neonate","Infant","Child","Adolescent","Adult","Elderly"] },
+          "occurcountry": { "type": "string", "pattern": "^[A-Z]{2}$" }
+        },
+        "required": ["medicinalproducts"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproducts": ["patient.drug.medicinalproduct"],
+          "patientsex": ["patient.patientsex"],
+          "patientagegroup": ["patient.patientagegroup"],
+          "occurcountry": ["occurcountry"]
+        },
+        "return_fields": ["patient.reaction.reactionoutcome"],
+        "return_fields_mapping": {
+          "patient.reaction.reactionoutcome": {
+            "1": "Recovered/resolved",
+            "2": "Recovering/resolving",
+            "3": "Not recovered/not resolved",
+            "4": "Recovered/resolved with sequelae",
+            "5": "Fatal",
+            "6": "Unknown"
+          }
+        }
+      }
+    },
+    {
+      "type": "FDACountAdditiveReactionsTool",
+      "name": "FAERS_count_additive_administration_routes",
+      "description": "Additive multi-drug data: Enumerate and count administration routes for adverse events across specified medicinal products, using standardized route codes. Data source: FDA Adverse Event Reporting System (FAERS).",
+      "parameter": {
+        "type": "object",
+        "properties": {
+          "medicinalproducts": { "type": "array", "items": { "type": "string" }, "description": "Array of medicinal product names." },
+          "serious": { "type": "string", "enum": ["Yes","No"], "description": "Filter by seriousness." }
+        },
+        "required": ["medicinalproducts"]
+      },
+      "fields": {
+        "search_fields": {
+          "medicinalproducts": ["patient.drug.medicinalproduct"],
+          "serious": ["serious"]
+        },
+        "return_fields": ["patient.drug.drugadministrationroute.exact"],
+        "return_fields_mapping": {
+          "patient.drug.drugadministrationroute.exact": {
+            "001": "Auricular (otic)", "002": "Buccal", "003": "Cutaneous", "004": "Dental",
+            "005": "Endocervical", "006": "Endosinusial", "007": "Endotracheal", "008": "Epidural",
+            "009": "Extra-amniotic", "010": "Hemodialysis", "011": "Intra corpus cavernosum",
+            "012": "Intra-amniotic", "013": "Intra-arterial", "014": "Intra-articular",
+            "015": "Intra-uterine", "016": "Intracardiac", "017": "Intracavernous",
+            "018": "Intracerebral", "019": "Intracervical", "020": "Intracisternal",
+            "021": "Intracorneal", "022": "Intracoronary", "023": "Intradermal",
+            "024": "Intradiscal (intraspinal)", "025": "Intrahepatic", "026": "Intralesional",
+            "027": "Intralymphatic", "028": "Intramedullar (bone marrow)", "029": "Intrameningeal",
+            "030": "Intramuscular", "031": "Intraocular", "032": "Intrapericardial",
+            "033": "Intraperitoneal", "034": "Intrapleural", "035": "Intrasynovial",
+            "036": "Intratumor", "037": "Intrathecal", "038": "Intrathoracic",
+            "039": "Intratracheal", "040": "Intravenous bolus", "041": "Intravenous drip",
+            "042": "Intravenous (not otherwise specified)", "043": "Intravesical",
+            "044": "Iontophoresis", "045": "Nasal", "046": "Occlusive dressing technique",
+            "047": "Ophthalmic", "048": "Oral", "049": "Oropharingeal", "050": "Other",
+            "051": "Parenteral", "052": "Periarticular", "053": "Perineural",
+            "054": "Rectal", "055": "Respiratory (inhalation)", "056": "Retrobulbar",
+            "057": "Sunconjunctival", "058": "Subcutaneous", "059": "Subdermal",
+            "060": "Sublingual", "061": "Topical", "062": "Transdermal",
+            "063": "Transmammary", "064": "Transplacental", "065": "Unknown",
+            "066": "Urethral", "067": "Vaginal"
+          }
+        }
+      }
+    }
+  ]

tooluniverse/data/fda_drug_labeling_tools.json

@@ -6902,4 +6902,4 @@
             "FDA"
         ]
     }
-]
+]