Skip to main content
GET
/
v1
/
tenants
/
{tenantCode}
/
assessments
/
{assessmentId}
Retrieve an assessment by identifier
curl --request GET \
  --url https://cds.marmar.life/v1/tenants/{tenantCode}/assessments/{assessmentId} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Tenant-Code: <api-key>'
{
  "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "riskLevel": "SEVERE",
  "summary": "<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>"
      }
    ]
  },
  "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>"
      }
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "patientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-Tenant-Code
string
header
required

Tenant slug returned during registration.

​
X-API-Key
string
header
required

Tenant API key. The server also accepts the lowercase x-api-key header for convenience.

Path Parameters

​
tenantCode
string
required

Human-readable tenant slug returned during registration.

​
assessmentId
string<uuid>
required

Assessment identifier returned by the API.

Response

Assessment details

​
assessmentId
string<uuid>
required
​
riskLevel
enum<string>
required
Available options:
SEVERE,
MODERATE,
MILD
​
summary
string
required
​
narrative
object
required
​
dosageFindings
object[]
required
​
symptoms
object
required
​
createdAt
string<date-time>
required
​
patientId
string<uuid> | null