Skip to main content
Use this endpoint to update an existing lab report. Only the fields you include are changed. Common use cases include advancing a report’s status from preliminary to final, amending a clinical conclusion after review, or attaching a PDF report after it has been generated.

Request

PATCH https://api.clinikapi.com/v1/labs/: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 lab report to update (e.g. lab_abc123).

Body

status
string
Updated report status. One of: registered, partial, preliminary, final, amended, corrected, appended, cancelled.
conclusion
string
Updated clinical conclusion text.
conclusionCodes
array
Updated SNOMED coded findings. Replaces the existing list.
resultIds
string[]
Updated list of linked observation IDs. Replaces the existing list.
effectiveDateTime
string
Updated ISO 8601 clinically relevant timestamp.
performer
string
Updated performer practitioner ID.
resultsInterpreter
string
Updated results interpreter practitioner ID.
presentedForm
array
Updated attached documents. Replaces the existing list.

Response

Returns 200 OK with the full updated lab report resource.
data.id
string
The lab report ID.
data.status
string
Updated report status.
data.conclusion
string
Updated conclusion text, if changed.
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

Examples

curl

curl -X PATCH https://api.clinikapi.com/v1/labs/lab_abc123 \
  -H "x-api-key: clk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "final",
    "conclusion": "All values within normal limits.",
    "presentedForm": [
      {
        "contentType": "application/pdf",
        "url": "https://storage.clinic.com/reports/lab-2025-001.pdf",
        "title": "CMP Lab Report - Jan 2025"
      }
    ]
  }'

TypeScript SDK

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

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

const { data } = await clinik.labs.update('lab_abc123', {
  status: 'final',
  conclusion: 'All values within normal limits.',
  presentedForm: [
    {
      contentType: 'application/pdf',
      url: 'https://storage.clinic.com/reports/lab-2025-001.pdf',
      title: 'CMP Lab Report - Jan 2025',
    },
  ],
});

console.log(data.status); // 'final'