Overview#
The Docus Lab API provides AI-powered health reports for patient visits. When an AI-interpreted report is generated for a patient’s test results, this webhook sends the report to the partner’s system. Additionally, reports can also be retrieved via the REST API Get AI report by visit ID, and this behavior is configurable via the Partner Web Console.
Webhook Endpoint#
Partners must provide an endpoint to receive the health reports.Content-Type: application/json
https://partner-api.example.com/webhooks/ai-reports
The webhook sends a JSON payload containing the visit_id, patient_id, and the AI-interpreted health report.| 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."
}
}
Partners must return a 200 OK response upon successful receipt of the report.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" } |
Modified at 2025-07-29 12:43:15