Skip to main content
Use this endpoint to modify an existing clinical assessment. All body fields are optional — only fields you include are updated. A typical use case is transitioning an in-progress assessment to completed, or appending newly identified findings to the findings array.

​
Request

PATCH https://api.clinikapi.com/v1/assessments/:id

​
Headers

​
x-api-key
string
required
Your ClinikAPI secret key (clk_live_* or clk_test_*).
​
Content-Type
string
required
Must be application/json.

​
Path parameters

​
id
string
required
The ID of the assessment to update (e.g. assess_abc123).

​
Body

​
status
string
Updated status. One of: in-progress, completed.
​
summary
string
Updated clinical summary. Replaces the existing summary in full.
​
findings
array
Updated findings list. Replaces the existing findings array in full.
​
note
string
Updated additional notes. Replaces the existing note in full.
​
description
string
Updated short description of the assessment context.
​
effectiveDateTime
string
Updated ISO 8601 timestamp for when the assessment was conducted.

​
Response

Returns 200 OK with the updated assessment wrapped in the standard envelope.
​
data.id
string
Assessment ID.
​
data.status
string
Updated assessment status.
​
data.summary
string
Updated clinical summary.
​
data.findings
array
Updated findings array.
​
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

​
Examples

​
curl

curl -X PATCH https://api.clinikapi.com/v1/assessments/assess_abc123 \
  -H "x-api-key: clk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "completed",
    "summary": "Updated summary with additional findings.",
    "findings": [
      { "code": "I10", "text": "Essential hypertension — well controlled" },
      { "code": "E11.9", "text": "Type 2 diabetes — at goal" },
      { "text": "New finding: mild vitamin D deficiency" }
    ],
    "note": "Added vitamin D supplementation 2000 IU daily to plan."
  }'

​
TypeScript SDK

import { Clinik } from '@clinikapi/sdk';

const clinik = new Clinik(process.env.CLINIKAPI_SECRET_KEY!);

const { data: assessment } = await clinik.assessments.update('assess_abc123', {
  status: 'completed',
  summary: 'Updated summary with additional findings.',
  findings: [
    { code: 'I10', text: 'Essential hypertension — well controlled' },
    { code: 'E11.9', text: 'Type 2 diabetes — at goal' },
    { text: 'New finding: mild vitamin D deficiency' },
  ],
  note: 'Added vitamin D supplementation 2000 IU daily to plan.',
});

console.log(assessment.status); // "completed"