Fetch Therapeutic Alternatives for a Drug

Overview

This API endpoint retrieves lists of drugs as therapeutic alternatives based on the provided drug’s therapeutic categorizations. Each category where the provided drug is considered therapeutic will return a separate list of drug alternatives.

HTTP Request

GET https://www.britelink.io/api/v1/drugs/<ID>/therapeutic_alternatives

URL Parameters

ID: The ID or equivalent unique identifier of the drug for which to retrieve the linked therapeutic alternatives.

Headers

Authorization: Your API key

Example Request

curl -L 'https://www.britelink.io/api/v1/drugs/DB09156/therapeutic_alternatives' \
-H 'Authorization: Bearer yourapikey'

Response Structure

The response is an array of therapeutic alternative categories. Each category includes the category details and a list of alternative drugs within that category.

JSON Response Example

[
  {
    "briteLinkId": "BR4565",
    "name": "Non-Steroidal Anti-Inflammatory Drug (NSAID)",
    "meshId": "D007052",
    "meshTreeNumbers": [
      "D02.241.223.100.085.500",
      "D02.455.426.559.389.657.239.500"
    ],
    "atcCode": "M01AE01",
    "atcLevel": null,
    "categorizationKind": "non-selective COX inhibitor",
    "synonyms": ["Advil", "Motrin", "Nurofen."],
    "description": "Used for pain relief, fever reduction, and inflammation control. It works by blocking the production of prostaglandins, substances in the body that cause pain and inflammation.",
    "drug": {
      "tradeName": "Tylenol",
      "id": "clqjl06p4000449l7qe6kop1g"
    }
  }
]

Fields

briteLinkId: A unique identifier for the therapeutic category.
name: Name of the therapeutic category.
meshId: Medical Subject Headings (MeSH) ID of the category.
meshTreeNumbers: MeSH tree numbers for the category.
atcCode: Anatomical Therapeutic Chemical (ATC) code.
atcLevel: Level of the ATC code.
categorizationKind: The kind of categorization (e.g., "non-selective COX inhibitor").
synonyms: Synonyms or alternative names for the category.
description: Description of the therapeutic category.
drug: Contains tradeName and unique id of the primary drug.

Use Cases

This endpoint is particularly useful for healthcare professionals and researchers looking for alternative medication options for a particular drug. It helps in identifying alternative treatments based on therapeutic categories.

Error Handling

Errors will be returned in the following format:

{
  "error": {
    "code": "ErrorCode",
    "message": "Error message describing what went wrong"
  }
}

Common Error Responses

400 Bad Request: The request was invalid or cannot be served. This is often due to missing a required parameter.
401 Unauthorized: The API key is missing or invalid.
404 Not Found: The specified drug ID was not found.
500 Internal Server Error: An error has occurred within the server.

Handling Errors

Clients should handle these errors gracefully, displaying relevant messages to the end-user and potentially logging error details for debugging purposes.

BriteAPI