Medication search and canonical records

Name search and filters#

GET /v1/medications/search matches a literal substring of the official name, case-insensitively. Search returns a list of records; it does not declare that the query identifies one unique variant. %, _ and ! are not wildcards.

curl --fail-with-body --get "$IABULA_API_BASE/v1/medications/search" \
  --header "X-API-Key: $IABULA_API_KEY" \
  --data-urlencode 'q=dipirona' \
  --data-urlencode 'limit=20'

When provided, q accepts 1–256 characters. limit accepts 1–100, default 20. ingredient_id and category_id are canonical UUIDs. dosage_form matches the canonical dosage form case-insensitively. Filters depend on links actually present in the catalog.

Stable cursor pagination#

Each page contains data and next_cursor. Pass the returned cursor without decoding or modifying it. Search cursors are bound to the filters; restart without a cursor when changing q or another filter. Invalid or mismatched cursors return HTTP 400.

curl --fail-with-body --get "$IABULA_API_BASE/v1/medications/search" \
  --header "X-API-Key: $IABULA_API_KEY" \
  --data-urlencode "q=dipirona" \
  --data-urlencode "cursor=$IABULA_CURSOR"

Exact identifier lookup#

GET /v1/medications/lookup accepts EAN, CMED_GGREM or CMED_REGISTRO and a literal value. matched identifies one candidate; ambiguous retains separate candidates; unresolved does not invent a name match. Each candidate includes reusable IDs and source evidence.

curl --fail-with-body --get "$IABULA_API_BASE/v1/medications/lookup"   --header "X-API-Key: $IABULA_API_KEY"   --data-urlencode "scheme=EAN"   --data-urlencode "value=7891058021580"

Details using a returned UUID#

Use an id returned by search in GET /v1/medications/{id}. Details include product_id and lists of presentations, registrations, companies and categories when available. Do not invent UUIDs or derive an ID from a name. Unknown IDs return HTTP 404.

curl --fail-with-body "$IABULA_API_BASE/v1/medications/$IABULA_MEDICATION_ID" \
  --header "X-API-Key: $IABULA_API_KEY"

Interpret fields with evidence#

product_name, brand_name, dosage_form and active_ingredient_text have distinct meanings. Unmapped fields may be null. active_ingredient_text preserves source text and does not prove a link to ActiveIngredient. Regulatory categories are not clinical indications.

GET /v1/medications/search#

GET /v1/medications/lookup#

GET /v1/medications/{id}#

OpenAPI contract fields#