Skip to main content
WEBHOOK
assessmentCompleted
{
  "event": "assessment.completed",
  "assessment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "riskLevel": "SEVERE",
    "summary": "<string>",
    "dosageFindings": [
      {
        "medication": "<string>",
        "currentDosage": "<string>",
        "appropriatenessLevel": "APPROPRIATE",
        "explanation": "<string>",
        "recommendation": "<string>"
      }
    ],
    "symptoms": {
      "expected": [
        {
          "name": "<string>",
          "duration": "<string>",
          "explanation": "<string>"
        }
      ],
      "monitoring": [
        {
          "name": "<string>",
          "frequency": "<string>",
          "target": "<string>",
          "action": "<string>"
        }
      ],
      "concerning": [
        {
          "name": "<string>",
          "severity": "HIGH",
          "action": "<string>",
          "explanation": "<string>"
        }
      ]
    },
    "narrative": {
      "interactionRiskLevel": "SEVERE",
      "generalExplanation": "<string>",
      "detailedExplanation": "<string>",
      "generalAdvice": "<string>",
      "tailoredAdvice": "<string>",
      "symptoms": {
        "expected": [
          {
            "name": "<string>",
            "duration": "<string>",
            "explanation": "<string>"
          }
        ],
        "monitoring": [
          {
            "name": "<string>",
            "frequency": "<string>",
            "target": "<string>",
            "action": "<string>"
          }
        ],
        "concerning": [
          {
            "name": "<string>",
            "severity": "HIGH",
            "action": "<string>",
            "explanation": "<string>"
          }
        ]
      },
      "pharmacologicalExplanation": [
        {
          "explanation": "<string>",
          "referenceIndex": 123,
          "type": "Primary Interaction",
          "confidence": "HIGH"
        }
      ],
      "references": [
        {
          "citation": "<string>",
          "url": "<string>",
          "source": "<string>",
          "year": "<string>",
          "type": "<string>"
        }
      ],
      "dosageAnalysis": [
        {
          "medication": "<string>",
          "currentDosage": "<string>",
          "appropriatenessLevel": "APPROPRIATE",
          "explanation": "<string>",
          "recommendation": "<string>"
        }
      ],
      "alternativeMedications": [
        {
          "emoji": "<string>",
          "name": "<string>",
          "category": "<string>",
          "explanation": "<string>",
          "precautions": "<string>",
          "evidence": "<string>"
        }
      ],
      "dietaryPrecautions": [
        {
          "emoji": "<string>",
          "name": "<string>",
          "type": "<string>",
          "explanation": "<string>",
          "duration": "<string>",
          "alternatives": "<string>"
        }
      ]
    },
    "rulesVersion": "<string>",
    "llmModel": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "patientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "metadata": {
    "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attempt": 123,
    "dispatchedAt": "2023-11-07T05:31:56Z"
  }
}

Body

application/json
event
enum<string>
required
Available options:
assessment.completed
assessment
object
required
metadata
object
required