Get Drug Indications

Overview

This API endpoint retrieves a list of indications linked to a specific drug. It provides detailed information about each indication, including its kind, off-label status, OTC use, and related conditions.

Endpoint

GET https://www.britelink.io/api/v1/drugs/{drugId}/indications

URL Parameters

drugId (required): The unique identifier for the drug for which indications are being requested.

Request

To retrieve indications for a specific drug, make a GET request to the endpoint with the drug's ID. The drug ID is typically obtained from a previous API call or from the application's interface.

Example request using cURL:

curl -L 'http://britelink.io/api/v1/drugs/{drugId}/indications' \
-H 'Authorization: Bearer YOUR_API_KEY'

Replace {drugId} with the actual Drug ID of the drug.

Response

The response is a JSON array containing objects with detailed information about each indication. Each object includes the following fields:

kind: The kind of indication (e.g., 'used_in_combination_to_treat').
off_label: A boolean indicating whether the indication is off-label.
otc_use: A boolean indicating over-the-counter use.
route: Array of routes of administration.
dose_form: Array of dose forms.
dose_strength: Array of dose strengths.
combination_type: The type of combination (e.g., 'regimen').
drug: Object containing the name and Drug ID of the drug.
condition: Object containing details of the condition associated with the indication.
combination_drugs: Array of drugs involved in the combination treatment.

Example response:

{
  "indications": [
    {
      "id": "clrw9ar1w0000jq081pukhhhu",
      "kind": "Pain relief (analgesic) Fever reduction (antipyretic)",
      "offLabel": false,
      "otcUse": true,
      "route": [],
      "doseForm": [
        {
          "value": "Oral"
        },
        {
          "value": "tablet"
        }
      ],
      "doseStrength": " 500 mg for adults, 160 mg for children per tablet/syrup dose",
      "combinationType": "Single",
      "drug": {
        "tradeName": "Tylenol",
        "id": "clqjl06p4000449l7qe6kop1g"
      },
      "condition": {
        "name": "Mild to Moderate Pain, Fever",
        "id": "clqklnm4u001j49c9h2a0u05i",
        "severity": "All severities for pain and fever, as recommended",
        "status": "Active pain or fever",
        "stage": "Not specifically applicable"
      },
      "combinationDrugs": []
    }
  ]
}

Error Handling

The API returns the following HTTP status codes in case of errors:

400 Bad Request: The request is invalid or missing required parameters.
404 Not Found: No drug found with the provided ID.
500 Internal Server Error: An error occurred on the server while processing the request.

Pagination and Filtering

This endpoint does not supports pagination for large data sets.

Filtering options are available for off_label and otc_use, attributes of the indications. These can be appended as query parameters to the URL. Certainly, here's an updated documentation snippet for the API endpoint that includes information about the filtering options for off_label and otc_use attributes of the indications:

Query Parameters for Filtering:

off_label: Filters the indications based on whether they are used off-label or not. Set this to true to only retrieve off-label indications.
otc_use: Filters the indications based on whether they are available for over-the-counter (OTC) use. Set this to true to only retrieve indications available for OTC use.

Example Usage:

To fetch indications for a drug with a specific Drug ID, with optional filtering:

curl -L 'https://www.britelink.iov1/drugs/{drugId}/indications?off_label=true&otc_use=true' \
-H 'Authorization: Bearer BRITE_API_KEY'

This will return indications that are both off-label and available for OTC use for the specified drug.

Note: The filtering parameters are optional; you can add one and omit the other. If a parameter is omitted, it defaults to false.

Security

Requests to this endpoint must include an authorization header with a valid API key.

BriteAPI