Skip to main content

Command-line interface to search MAUDE database for medical device adverse events via openFDA API

Project description

MAUDE CLI

Command-line interface, written in pure Python, for searching the MAUDE (Manufacturer and User Facility Device Experience) database through the openFDA API and local historical data. Search medical device adverse event reports directly from your terminal.

Note: The openFDA API is updated weekly but does not cover incidents before 2009. This CLI includes support for querying a local SQLite database of historical pre-2009 data!

Features

  • Command-line interface for searching the MAUDE database via the openFDA API.
  • Local database support for historical pre-2009 data not available through the API (~2.6M records).
  • Flexible term syntax: multiple groups combined with AND, terms within a group combined with OR.
  • Exclusion filtering with the same logical syntax as search terms.
  • Customizable search fields (default: mdr_text.text).
  • Pagination control: specify maximum pages and results per page.
  • Optional sorting of results using openFDA sort criteria.
  • Multiple output formats: Org-mode, JSON, CSV, and plain text.
  • Ability to select specific fields for output and define the item name field.
  • Configurable Org-mode heading level for hierarchical reports.
  • Direct file output with automatic format validation against file extension.
  • Graceful handling of stdout when no output file is specified.
  • Comprehensive logging for error reporting and debugging.
  • Fully type-annotated, lint-clean code base ready for extension or integration.

Installation

With uvx there's no need to install the tool before first use, just use:

uvx maude-cli --help

or to use uv as more traditional package manage, i.e. download the maude-cli locally before first use:

uv tool install maude-cli

or pip:

pip install maude-cli

Usage

maude-cli [OPTIONS] TERM_GROUPS...

Basic Example

Search for reports containing either "MRI" or "MAGNET" AND either "STAPES" or "TYMP":

maude-cli "MRI,MAGNET" "STAPES,TYMP"

Options

  • -x, --exclude: Term groups to exclude (comma-separated terms OR'd within groups, groups AND'd together). Example: 'ARTIFACT,SHADOW' 'METAL,SCREW'
  • -f, --search-fields: Fields to search (default: mdr_text.text)
  • -p, --max-pages: Maximum pages to retrieve (0=all)
  • -l, --limit: Results per page (default: 1000)
  • -s, --sort: Sort criteria
  • -o, --format: Output format (org, json, or text; default: org)
  • -O, --output: Output file. If not used then will print to standard out.
  • -n, --name: Field to use as item name (default: report_number)
  • -F, --fields: Comma-separated fields to include in output
  • -L, --level: Org heading level (default: 3)
  • -k, --api-key: Set the API key to avoid open FDA daily request limits.

Output Formats

  • org: Org-mode formatted output (default)
  • json: Pretty-printed JSON
  • text: Simple text format
  • csv : CSV format.

Exclusion Criteria

The CLI supports sophisticated exclusion filtering using the -x=/``--exclude option. Exclusion terms follow the same logic as search terms but filter OUT matching results:

  • Within each exclusion group: terms are OR'd (term1 OR term2)
  • Between exclusion groups: conditions are AND'd (group1 AND group2)
  • Results matching ALL exclusion groups will be filtered out

Examples

Note with all of these examples if you are using uvx (recommended) then you must prepend uvx before each command. That is maude-cli --help would become uvx maude-cli --help

Search with specific fields and output format:

maude-cli "pacemaker" -f device.device_name -o json -F device.brand_name,patient.age

Search with pagination control:

maude-cli "defibrillator" -p 2 -l 50

Search for all entries that contain either "MRI" or "MAGNET" AND also containing either "CARDIAC" or "VALVE" and output as a csv file.

maude-cli "mri,magnet" "cardiac,valve" -o csv

Exclusion Examples

Basic exclusion Find MRI-related reports but exclude artifacts:

maude-cli "MRI,MAGNET" -x "ARTIFACT,SHADOW"

Multi-group exclusion Find pacemaker reports but exclude both battery AND lead issues:

maude-cli "pacemaker" -x "BATTERY,POWER" "LEAD,WIRE"

(Excludes reports containing ("BATTERY" OR "POWER") AND ("LEAD" OR "WIRE"))

Field-specific exclusion Search device names for "catheter" but exclude infection-related reports:

maude-cli "catheter" -f device.device_name -x "INFECTION,SEPSIS" -F patient.problem

Manufacturer exclusion Find defibrillator reports but exclude two specific manufacturers:

maude-cli "defibrillator" -x "MEDTRONIC,ST_JUDE" "BOSTON_SCIENTIFIC"

Report type filtering Find stent reports but exclude follow-ups and summaries:

maude-cli "stent" -x "FOLLOW-UP,SUMMARY,ADDITIONAL"

Combined search/exclusion Find reports about "valve" in cardiac devices but exclude MRI-related artifacts:

maude-cli "valve" -f "device.device_name" -x "MRI,MAGNET" "ARTIFACT,SHADOW"

Complex scenario Search for infusion pump issues but exclude:

  • Software-related problems (group 1)
  • Baxter-manufactured devices (group 2)
  • Reports without patient injury (group 3)
maude-cli "infusion,pump" -x "SOFTWARE,ALGORITHM" "BAXTER" "NO INJURY,"

Local Historical Database

The CLI supports querying a local SQLite database containing historical MAUDE data from before 2009. The openFDA API only includes data from 2009 onwards, but the local database provides access to ~2.6 million historical incident reports.

The package ships with a pre-built local database, for information on building the database from the data files see here.

Automatic Query Integration

When the local database exists, the CLI automatically queries both the API and the local database, combining results:

# Searches both API (2009+) and local DB (pre-2009)
maude-cli "MRI" "pacemaker"

No additional flags are needed - the integration is transparent to the user.

For more details on database usage, see DATABASE_USAGE.md.

License

This code is licensed under the GNU GPL v3 license which can be found here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

maude_cli-0.3.3.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maude_cli-0.3.3-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file maude_cli-0.3.3.tar.gz.

File metadata

  • Download URL: maude_cli-0.3.3.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for maude_cli-0.3.3.tar.gz
Algorithm Hash digest
SHA256 a02513b6634f2ab2d9adfe8946844d8bdaa9223fcd4636d17fc3d5fd2f71b1e2
MD5 f1d2882019a3a340c7980af68e8c1680
BLAKE2b-256 34244bdde54224cd0dc2c9f6deb8b83c6175deb23a05ba2289c43809cb7536b7

See more details on using hashes here.

File details

Details for the file maude_cli-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: maude_cli-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for maude_cli-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aaec49af7a118789fee7a38dd125bf9db1264d7dbe2a44ca171524af8b32c50b
MD5 8158e2ca0e225d6831afda47aefbcfad
BLAKE2b-256 60568be8ac1299b6a8a1be0e831771ff21a6eacf7afcf433607d7f900b9ba876

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page