IaBulaDocs API V1Português
Browse documentation
API Reference

Active ingredients and Brazilian DCB records

.md

Retrieve ingredients by canonical UUID and understand DCB records, source text and active-ingredient identity.

On this page

Canonical ingredient versus published text#

A medication's active_ingredient_text is a text field. It is not an ActiveIngredient UUID and does not independently confirm a structured link. GET /v1/ingredients/{id} requires a real canonical ingredient UUID from an approved catalog link.

Retrieve by identifier#

bash
curl --fail-with-body "$IABULA_API_BASE/v1/ingredients/$IABULA_INGREDIENT_ID" \
  --header "X-API-Key: $IABULA_API_KEY"

Set IABULA_INGREDIENT_ID to an existing canonical identifier. The response contains id, name, dcbs and evidence. Each DCB contains id, code, denomination and evidence. An unknown ingredient returns HTTP 404; this is not evidence that the substance does not exist.

What DCB records add#

DCB means Denominação Comum Brasileira, the Brazilian common denomination. The adopted dataset provides the public number and denomination. Do not infer clinical properties, therapeutic equivalence or recommendations from a name. Evidence identifies source data and supported catalog links.

GET /v1/ingredients/{id}#

Contract and types
ParameterLocationRequiredType and bounds
idpathyesstring (uuid)
Contract and types
HTTPContent-TypeSchema
200application/jsonIngredientDetail
400application/jsonProblem
401application/jsonProblem
403application/jsonProblem
429application/jsonProblem
500application/jsonProblem
503application/jsonProblem
404application/jsonProblem
422application/jsonHTTPValidationError

OpenAPI contract fields#

Contract and types
Schema.fieldType and boundsRequired
DCBDetail.idstring (uuid)yes
DCBDetail.codestringyes
DCBDetail.denominationstringyes
DCBDetail.evidenceEvidenceyes
Evidence.classstringyes
Evidence.sourcestring | nullno
Evidence.datasetstring | nullno
Evidence.retrieved_atstring (date-time) | nullno
Evidence.source_versionstring | nullno
Evidence.source_record_idstring | nullno
Evidence.source_run_idstring | nullno
Evidence.attributestring | nullno
Evidence.rule_versionstring | nullno
HTTPValidationError.detailarray<ValidationError>no
IngredientDetail.idstring (uuid)yes
IngredientDetail.namestringyes
IngredientDetail.dcbsarray<DCBDetail>yes
IngredientDetail.evidencearray<Evidence>yes
Problem.typestringyes
Problem.titlestringyes
Problem.statusintegeryes
Problem.codestringyes
Problem.detailstring | nullno
Problem.request_idstringyes
ValidationError.locarray<string | integer>yes
ValidationError.msgstringyes
ValidationError.typestringyes
ValidationError.inputobjectno
ValidationError.ctxobjectno