IaBulaDocs API V1English
Navegar na documentação
API Reference

Relações farmacêuticas com evidência

.md

Consulte relações tipadas entre medicamentos e interprete corretamente respostas vazias e evidências regulatórias.

Nesta página

Relações de um registro#

GET /v1/medications/{id}/relations retorna data com relações tipadas disponíveis para o medicamento identificado. Cada relação possui identificadores de origem e destino, tipo, direção, evidência e datas de validade quando disponíveis.

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

Uma lista vazia descreve a cobertura#

O dataset regulatório de relações explícitas ainda não está populado no baseline V1 documentado. A rota é operacional, mas consumidores devem tratar listas vazias como resultado válido. HTTP 404 indica que o identificador do medicamento não foi encontrado.

Relações não são recomendações#

Relações regulatórias precisam de evidência rastreável. Sem essa base, semelhança textual e ingredientes compartilhados não demonstram intercambialidade. A API não recomenda substituição ou tratamento.

GET /v1/medications/{id}/relations#

Contrato e tipos
ParâmetroLocalObrigatórioTipo e limites
idpathyesstring (uuid)
Contrato e tipos
HTTPContent-TypeSchema
200application/jsonRelationPage
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
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
MedicationRelation.idstring (uuid)yes
MedicationRelation.typestringyes
MedicationRelation.source_idstring (uuid)yes
MedicationRelation.target_idstring (uuid)yes
MedicationRelation.directionstringyes
MedicationRelation.evidenceEvidenceyes
MedicationRelation.valid_fromstring (date) | nullno
MedicationRelation.valid_tostring (date) | nullno
Problem.typestringyes
Problem.titlestringyes
Problem.statusintegeryes
Problem.codestringyes
Problem.detailstring | nullno
Problem.request_idstringyes
RelationPage.dataarray<MedicationRelation>yes
ValidationError.locarray<string | integer>yes
ValidationError.msgstringyes
ValidationError.typestringyes
ValidationError.inputobjectno
ValidationError.ctxobjectno