Drug-Drug Interaction (DDI)

Overview

The Drug-Drug Interaction (DDI) Endpoint delivers critical information on interactions between multiple drugs. This endpoint aids in identifying potential risks, interaction mechanisms, and necessary precautions associated with combining specific drugs.

Endpoint Specification

URL: https://www.britelink.io/api/v1/ddi
Method: GET
Authentication: Required (API key in the request header)

Request Structure

Headers

Header Name	Description	Example
`Authorization`	API key for access	`Bearer BRITE_API_KEY`

Query Parameters

Parameter	Description	Required	Example
`drug_Ids`	Comma-separated list of drug identifiers (IDs)	Yes	`id1,id2,id3`

Example Request

curl -X GET 'https://www.britelink.io/api/v1/ddi?drug_Ids=firstID,secondID' \
-H 'Authorization: Bearer BRITE_API_KEY'

Response Format

{
  "interactions": [
    {
      "ingredient": { "britelinkId": "1234", "name": "DrugA" },
      "affected_ingredient": [{ "britelinkId": "5678", "name": "DrugB" }],
      "description": "Increased risk of liver damage with alcohol",
      ...
    }
  ]
}

Successful Response

Status Code: 200 OK
Content-Type: application/json
Response Body: JSON structure with drug interaction details.

Response Fields

Field Name	Description	Type
`interactions`	Array of interaction objects	Array
`ingredient`	Primary drug involved in the interaction	Object
`affected_ingredient`	Other drugs involved in the interaction	Array
`description`	Brief description of the interaction	String
`severity`	Severity level of the interaction	String
`management`	Recommendations for managing the interaction	String
...	Additional fields as needed	...

Error Response

422 Unprocessable Entity: Less than two drug IDs provided.
404 Not Found: No interactions found for provided drug IDs.
500 Internal Server Error: Server error during request processing.

Use Cases

Clinical Decision Making: Assists healthcare professionals in evaluating drug compatibility.
Pharmaceutical Research: Facilitates research into drug interaction effects.
Patient Care: Supports patient safety by identifying risky drug combinations.

Notes and Limitations

Maximum query IDs: 40 per request.
Ensure up-to-date data usage as the API undergoes continuous enhancements.

Implementation Notes

The API expects at least two drug IDs for processing.
It retrieves interaction data including each drug's details, consolidating them into a structured response.

BriteAPI