Fetch Adverse by ID

Overview

This endpoint provides detailed information about a specific medical adverse by its unique identifier. It is particularly useful for healthcare applications, research, and data analysis related to medical adverses and their associated treatments.

HTTP Request

GET https://www.britelink.io/api/v1/adverses/{adverseId}

URL Structure

Base URL: https://www.britelink.io
Path: /api/v1/adverse_effects/{adverseId}
Method: GET

URL Parameters

adverseId (required): The unique identifier of the adverse.

Headers

Header	Value	Description
`Authorization`	`Bearer BRITE_API_KEY`	API key for authorization.

Response Structure

Example Response

{
  "id": "clqkl5z8g001349c9y5f40lj5",
  "description": " Nausea, rash, headache.  Allergic reactions, skin reddening, blisters. Liver damage (especially with overdose or in combination with alcohol), anaphylaxis, severe skin reactions.",
  "incidenceRate": " Varies, but generally low. Less Common Effects: Rare (exact rates vary). Rare Effects: Very rare, often associated with overdose or specific health conditions.",
  "evidenceType": "Based on clinical trials, post-marketing surveillance, and medical literature.",
  "admin": "Oral administration; adverse effects are generally dose-related and influenced by individual factors such as liver health and concurrent medication use.",
  "regions": "Global",
  "ageGroups": "Generally well-tolerated across all age groups. Caution advised in very young children, older adults, and those with liver impairment.",
  "drugId": "clqjl06p4000449l7qe6kop1g",
  "effects": [
    {
      "id": "clqkn8scv002749c9zja7nmai",
      "name": "Hypersensitivity",
      "description": "no data",
      "adverseEffectId": "clqkl5z8g001349c9y5f40lj5"
    },
    {
      "id": "clqv3v5di000349i5iakl8ngw",
      "name": "Sample",
      "description": "Q.NITP.F107.V6 – Guild ITP National Assignment One: MCQ Summary – Student Copy – January 2023",
      "adverseEffectId": "clqkl5z8g001349c9y5f40lj5"
    },
    {
      "id": "clqxjrklf000649rvh21hi0uy",
      "name": "Chemistry",
      "description": "Black and White ",
      "adverseEffectId": "clqkl5z8g001349c9y5f40lj5"
    }
  ],
  "drug": {
    "id": "clqjl06p4000449l7qe6kop1g",
    "tradeName": "Tylenol",
    "genericName": "Acetaminophen",
    "registrationNo": "123abc",
    "dateRegistered": "2023-12-25T00:00:00.000Z",
    "strength": "2mg",
    "form": "Tablet",
    "applicantName": "PharmaHealth Inc.",
    "principalName": "Active Pharmaceuticals",
    "categoryId": "clqjkjarq000049khgvkwz6gf",
    "foodInteractions": null,
    "levelOfAvailability": "A",
    "drugPriority": "N",
    "ispublished": false,
    "createdAt": "2023-12-24T14:25:24.712Z",
    "updatedAt": "2023-12-25T07:32:58.148Z"
  }
}

Response Codes

Status Code	Description
200	Success - Adverse data retrieved.
400	Bad Request - Missing adverse ID.
404	Not Found - Adverse ID not found.
500	Internal Server Error - Processing error.

Error Handling

400 Bad Request: Returned if the adverseId is missing.
404 Not Found: Occurs when no adverse matches the given ID.
500 Internal Server Error: Indicates server-side issues.

Usage Example

cURL Example

curl -X GET 'https://www.britelink.io/api/v1/adverse_effects/clqklnm4u001j49c9h2a0u05i' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer BRITE_API_KEY'

Use Cases

Healthcare Applications: Integrating adverse data into healthcare software for patient management and treatment planning.
Medical Research: Researchers can access detailed adverse information for studies and analysis.
Educational Tools: Utilized in educational platforms for medical training and learning.
Data Analysis: Analyzing trends and patterns in adverse treatments and outcomes.

BriteAPI