IaBulaDocs API V1English
Navegar na documentação
API Reference

Princípios ativos, ingredientes e DCB

.md

Consulte ingredientes pelo UUID canônico e entenda a diferença entre DCB, texto da fonte e identidade de princípio ativo.

Nesta página

Ingrediente canônico versus texto publicado#

active_ingredient_text em um medicamento é um campo textual. Não é um UUID de ActiveIngredient e não confirma sozinho um vínculo estruturado. GET /v1/ingredients/{id} exige um UUID real de ingrediente canônico obtido de um vínculo aprovado do catálogo.

Consulta pelo identificador#

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

Defina IABULA_INGREDIENT_ID com um identificador canônico existente. O objeto de resposta contém id, name, dcbs e evidence. Cada DCB inclui id, code, denomination e evidence. Um ingrediente inexistente retorna HTTP 404; isso não é uma prova de inexistência da substância no mundo real.

O que a DCB acrescenta#

DCB significa Denominação Comum Brasileira. O conjunto adotado fornece número e denominação pública. Não deduza propriedades clínicas, equivalência terapêutica ou recomendações a partir de uma denominação. A evidência indica a origem do dado e os vínculos disponíveis no catálogo.

GET /v1/ingredients/{id}#

Contrato e tipos
ParâmetroLocalObrigatórioTipo e limites
idpathyesstring (uuid)
Contrato e tipos
HTTPContent-TypeSchema
200application/jsonIngredientDetail
400application/jsonProblem
401application/jsonProblem
403application/jsonProblem
429application/jsonProblem
500application/jsonProblem
503application/jsonProblem
404application/jsonProblem
422application/jsonHTTPValidationError

Campos do contrato OpenAPI#

Contrato e tipos
Schema.campoTipo e limitesObrigatório
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