Fetch Condition by ID
Overview
This endpoint provides detailed information about a specific medical condition by its unique identifier. It is particularly useful for healthcare applications, research, and data analysis related to medical conditions and their associated treatments.
HTTP Request
GET https://www.britelink.io/conditions/{conditionId}
URL Structure
- Base URL:
https://www.britelink.io
- Path:
/api/v1/conditions/{conditionId}
- Method:
GET
URL Parameters
conditionId
(required): The unique identifier of the condition.
Headers
Header | Value | Description |
---|---|---|
Authorization | Bearer BRITE_API_KEY | API key for authorization. |
Response Structure
The response will be a JSON object containing detailed information about the condition:
id
: Unique identifier of the condition.name
: Name of the condition.indications
: Array of related indications.drug
: Associated drug data, if applicable.
Example Response
{
"id": "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",
"drugId": "clqjl06p4000449l7qe6kop1g",
"indications": [
{
"id": "clrw9ar1w0000jq081pukhhhu",
"kind": "Pain relief (analgesic) Fever reduction (antipyretic)",
"offLabel": false,
"otcUse": true,
"doseStrength": " 500 mg for adults, 160 mg for children per tablet/syrup dose",
"combinationType": "Single",
"drugId": "clqjl06p4000449l7qe6kop1g",
"conditionId": "clqklnm4u001j49c9h2a0u05i"
}
],
"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 - Condition data retrieved. |
400 | Bad Request - Missing condition ID. |
404 | Not Found - Condition ID not found. |
500 | Internal Server Error - Processing error. |
Error Handling
- 400 Bad Request: Returned if the
conditionId
is missing. - 404 Not Found: Occurs when no condition 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/conditions/clqklnm4u001j49c9h2a0u05i' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer BRITE_API_KEY'
Use Cases
- Healthcare Applications: Integrating condition data into healthcare software for patient management and treatment planning.
- Medical Research: Researchers can access detailed condition information for studies and analysis.
- Educational Tools: Utilized in educational platforms for medical training and learning.
- Data Analysis: Analyzing trends and patterns in condition treatments and outcomes.