Health reports
Overview
Webhook Endpoint
POST
application/json
https://partner-api.example.com/webhooks/ai-reports
Request Format
Request Headers
Header | Value | Description |
---|---|---|
x-webhook-key | YOUR_WEBHOOK_SECRET_KEY | API key for authentication |
Content-Type | application/json | Specifies JSON format |
Request Body
{
"visit_id": "V12345",
"patient_id": "12345",
"report": {
"intro": "Your recent lab tests indicate a potential vitamin D deficiency.",
"interpretation": "Your vitamin D levels are below the recommended range, which may affect bone health.",
"abnormalFindings": "Vitamin D: 15 ng/mL (Low - Normal range: 30-100 ng/mL).",
"clinicalSignificance": "Low vitamin D can lead to fatigue, bone pain, and weakened immunity.",
"recommendedFollowUpTests": "A repeat vitamin D test and calcium levels check are recommended.",
"riskManagement": "Increase sun exposure and consider dietary sources rich in vitamin D.",
"specialistRecommendations": "Consult an endocrinologist if symptoms persist.",
"lifestyleGuidelines": "Consume more vitamin D-rich foods such as fish, eggs, and fortified dairy products."
}
}
Response Format
Success Response:
{
"status": "success",
"message": "Report received successfully."
}
Error Responses:
Status Code | Meaning | Example Response |
---|---|---|
400 | Bad Request | { "error": "Invalid payload format" } |
401 | Unauthorized | { "error": "Invalid API key" } |
500 | Server Error | { "error": "Internal server issue" } |
Contact & Support
Modified at 2025-03-04 08:42:47