Indications


Fetch Indications

Overview

This endpoint retrieves indications to a condition based on specified condition name(s). This endpoint provide detailed information about the indications of various conditions, including related conditions and drug details.

HTTP Request

GET https://www.britelink.io/api/v1/indications

URL Parameters

ParameterRequiredDescription
qYesA comma-separated list of condition names .

Request Examples

Curl Example:

curl -X GET 'https://www.britelink.io/api/v1/indications?q=pain,fever' \
-H 'Authorization: Bearer BRITE_API_KEY'

Response Structure

The response consists of a JSON array where each object represents an indication, structured as follows:

  • resourceType: (String) Specifies the type of the FHIR resource, in this case, "Indications".
  • britelinkId: (String) A unique identifier for the indication.
  • kind: (String) A brief description of the type or category of the indication.
  • offLabel: (Boolean) Indicates whether the usage of the drug for this indication is off-label.
  • otcUse: (Boolean) Indicates whether the drug for this indication is available over-the-counter.
  • doseStrengths: (String) Information regarding the dosage strengths recommended for this indication.
  • combinationType: (String) The type of drug combination (if any) associated with this indication.
  • indicatedDrug: (Object) Contains details about the drug associated with the indication.
    • id: (String) The unique identifier of the drug.
    • details: (Object) Detailed information about the drug, including:
      • tradeName: (String) The trade name of the drug.
      • genericName: (String) The generic name of the drug.
      • simpleDescription: (String) A brief description of the drug, its uses, and other relevant information.
  • condition: (Object) Details about the medical condition associated with the indication.
    • britelinkId: (String) The unique identifier of the associated condition.
    • name: (String) The name of the medical condition.
    • severity: (String) The severity level of the condition.
    • status: (String) The current status of the condition.
    • stage: (String) The stage of the condition, if applicable.

Response Example

[
  {
    "resourceType": "Indications",
    "britelinkId": "clrw9ar1w0000jq081pukhhhu",
    "kind": "Pain relief (analgesic) Fever reduction (antipyretic)",
    "offLabel": false,
    "otcUse": true,
    "doseStrengths": " 500 mg for adults, 160 mg for children per tablet/syrup dose",
    "combinationType": "Single",
    "indicatedDrug": {
      "id": "clqjl06p4000449l7qe6kop1g",
      "details": {
        "tradeName": "Tylenol",
        "genericName": "Acetaminophen",
        "simpleDescription": "Tylenol, containing acetaminophen, is an analgesic and antipyretic for mild to moderate pain and fever reduction. Adult dosage: 500-1000 mg every 4-6 hours, max 4000 mg/day. Rapid GI absorption, liver metabolism, urinary excretion. Side effects: rare but may include hepatotoxicity. Use cautiously in liver impairment and avoid overdose. Antidote for overdose: N-acetylcysteine (NAC)"
      }
    },
    "condition": {
      "resourceType": "Condition",
      "britelinkId": "clqklnm4u001j49c9h2a0u05i",
      "name": "Mild to Moderate Pain, Fever",
      "severity": "All severities for pain and fever, as recommended",
      "status": "Active pain or fever",
      "stage": "Not specifically applicable"
    }
  }
]

Error Handling

  • 400 Bad Request: Returned if the 'indications' parameter is missing or empty.
  • 404 Not Found: Returned if no matching indications are found for the specified names.
  • 500 Internal Server Error: Returned if there's an error processing the request.

Usage Notes

This endpoint is useful for healthcare applications, drug information systems, and medical research platforms that require detailed information about conditions and associated indications.