Docus Lab SAAS Sandbox
  1. Webhooks
Docus Lab SAAS Sandbox
  • Getting Started
  • Initial Biomarkers and Biomarker Groups Setup
  • Flow Between Lab and API
  • Limitations
  • Support
  • Patient
    • Create a patient
      POST
    • Update a patient
      PUT
    • Get patient by ID
      GET
  • Visit
    • Create visit
      POST
    • Create composite visit
      POST
    • Generate AI report
      POST
    • Get AI report by visit ID
      GET
  • Lab Test
    • Create a plain lab test
      POST
    • Create a lab test with biomarkers
      POST
    • Create bulk plain lab tests
      POST
    • Create bulk lab tests with biomarkers
      POST
    • Get lab test by ID
      GET
  • Biomarker Group
    • Create a biomarker group
      POST
    • Update a biomarker group
      PUT
    • Get biomarker group by ID
      GET
  • Biomarker
    • Create a biomarker
      POST
    • Update biomarker by ID
      PUT
    • Get biomarker by ID
      GET
  • Branch
    • Create a branch
    • Update branch by ID
    • Get branch by ID
  • Webhooks
    • Health reports
    • Notifications
  • Schemas
    • Schemas
      • UpdateBiomarkerDto
      • CreateLabTestPlanDTO
      • UpdateBiomarkerGroupDto
      • LabTestReport
      • CreateCompositeVisitDto
      • MultipleTestIdsDto
      • CreateBulkLabTestsPlainDTO
      • CreateBulkLabTestsDTO
      • CreateBranchDto
      • UpdateBranchDto
      • Biomarker
      • CreateBiomarkerGroupDto
      • CreateBiomarkerDto
      • SingleReport
      • CreatePatientDto
      • UpdatePatientDto
      • CreateVisitDto
      • CreateLabTestDTO
  1. Webhooks

Health reports

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.
Method: POST
Content-Type: application/json
Example Endpoint:
https://partner-api.example.com/webhooks/ai-reports

Request Format#

The webhook sends a JSON payload containing the visit_id, patient_id, and the AI-interpreted health report.

Request Headers#

HeaderValueDescription
x-webhook-keyYOUR_WEBHOOK_SECRET_KEYAPI key for authentication
Content-Typeapplication/jsonSpecifies 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#

Partners must return a 200 OK response upon successful receipt of the report.

Success Response:#

{
  "status": "success",
  "message": "Report received successfully."
}

Error Responses:#

Status CodeMeaningExample Response
400Bad Request{ "error": "Invalid payload format" }
401Unauthorized{ "error": "Invalid API key" }
500Server Error{ "error": "Internal server issue" }

Contact & Support#

For assistance, contact our support team at: support@docus.ai
Modified at 2025-07-29 12:43:15
Previous
Get branch by ID
Next
Notifications
Built with