BriteAPI

Fetch Indications for a Condition

Overview

This endpoint is designed to retrieve detailed indications associated with a specified medical condition. It returns a comprehensive list of indications, including drug information, formatted according to FHIR standards.

Endpoint Details

• HTTP Method: GET
• Endpoint: https://www.britelink.io/api/v1/conditions/{conditionId}/indications

URL Parameters

Request Headers

Response Format

The response is a JSON array where each object represents an indication linked to the condition. The structure is compliant with the FHIR standard.

Object Structure

• resourceType: String - The type of the FHIR resource.
• britelinkId: String - Unique identifier of the indication.
• kind: String - Description of the indication.
• offLabel: Boolean - Indicates off-label use.
• otcUse: Boolean - Over the counter availability.
• doseStrengths: String - Dosage strength details.
• combinationType: String - Type of combination for the drug.
• indicatedDrug: Object - Drug details including:
  • id: String - Drug identifier.
  • details: Object - Drug information like trade name, generic name, and description.

Example Usage

Here's how to use this endpoint in a JavaScript function:

async function fetchIndicationsForCondition(conditionId) {
  const response = await fetch(
    `https://www.britelink.io/api/v1/conditions/${conditionId}/indications`,
    {
      method: "GET",
      headers: {
        Authorization: `Bearer ${apiKey}`,
      },
    }
  );

  if (!response.ok) {
    throw new Error("Error fetching indications");
  }

  return await response.json();
}

CURL Example

curl -L 'https://www.britelink.io/api/v1/conditions/{conditionId}/indications' \
-H 'Authorization: Bearer BRITE_API_KEY'

Sample Response

[
  {
    "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, an analgesic and antipyretic."
      }
    }
  }
]

Error Handling

• 400 Bad Request: Indicates missing or incorrect conditionId.
• 404 Not Found: No indications found for the given condition ID.
• 500 Internal Server Error: Server-related errors.

Use Cases

• Ideal for healthcare applications needing condition-specific medication data.
• Can be utilized in patient education platforms to provide detailed drug information.
• Useful for clinicians seeking information for treatment planning.

Version and Updates

• Current Version: 1.0
• Last Updated: [Date]
• Change Log:
  • Initial release with indication fetching capabilities.