IaBulaDocs API V1Português
Browse documentation
API Reference

Pharmaceutical relationships with evidence

.md

Retrieve typed medication relationships and correctly interpret empty responses and regulatory evidence.

On this page

Relationships of a record#

GET /v1/medications/{id}/relations returns a data list with typed relationships available for the identified medication. Each relationship includes source and target identifiers, type, direction, evidence and validity dates when available.

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

An empty list describes coverage#

The explicit regulatory relationship dataset is not populated in the documented V1 baseline. The route is operational, but consumers must treat empty lists as valid results. HTTP 404 indicates an unknown medication identifier.

Relationships are not recommendations#

Regulatory relationships require traceable evidence. Textual similarity or shared ingredients do not establish interchangeability. The API does not recommend substitution or treatment.

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

Contract and types
ParameterLocationRequiredType and bounds
idpathyesstring (uuid)
Contract and types
HTTPContent-TypeSchema
200application/jsonRelationPage
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
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