Skip to main content
Use this endpoint to fetch a specific structured clinical document by its unique ID. The response includes the complete document with all sections, metadata, and associated patient, practitioner, and encounter identifiers.

Request

GET https://api.clinikapi.com/v1/documents/:id

Headers

x-api-key
string
required
Your ClinikAPI secret key (clk_live_* or clk_test_*).

Path parameters

id
string
required
The ID of the document to retrieve (e.g. doc_abc123).

Response

Returns 200 OK with the document wrapped in the standard envelope.
data.id
string
Document ID.
data.patientId
string
ID of the patient this document belongs to.
data.practitionerId
string
ID of the practitioner who authored the document.
data.encounterId
string
ID of the associated encounter, if set.
data.status
string
Document status: preliminary, final, or amended.
data.type
string
Document type (e.g. discharge-summary, referral-letter).
data.title
string
Document title.
data.sections
array
Ordered array of section objects, each containing title, code, text, and optionally resourceIds.
data.confidentiality
string
Confidentiality level: N, R, or V.
data.date
string
Document date in YYYY-MM-DD format.
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

Examples

curl

curl https://api.clinikapi.com/v1/documents/doc_abc123 \
  -H "x-api-key: clk_live_abc123"

TypeScript SDK

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

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

const { data: doc } = await clinik.documents.read('doc_abc123');

console.log(doc.title);          // "Discharge Summary - Jane Doe - Jan 15, 2025"
console.log(doc.sections.length); // 4