Skip to main content

clinik.assessments

create

const { data, meta } = await clinik.assessments.create(request: AssessmentCreateRequest): Promise<ApiResponse<ClinicalImpression>>
FieldTypeRequiredDescription
statusstringYesin-progress, completed
statusReasonstringNoReason for current status
patientIdstringYesPatient reference
encounterIdstringNoEncounter reference
practitionerIdstringNoAssessor reference
codestringNoKind of assessment (initial-assessment, follow-up, discharge)
descriptionstringNoDescription of the assessment
summarystringYesClinical summary
findingsAssessmentFinding[]NoClinical findings with optional basis
notestringNoAdditional notes
effectiveDateTimestringNoWhen assessment was made
datestringNoWhen documented (defaults to now)
previousAssessmentIdstringNoReference to previous assessment
problemIdsstring[]NoCondition/AllergyIntolerance IDs being assessed
investigationsAssessmentInvestigation[]NoSets of investigations
protocolstring[]NoClinical protocol URIs followed
prognosisArray<{ code?, text }>NoPrognosis codes
supportingInfoIdsstring[]NoSupporting information references

Finding Structure

findings: [
  { code: 'I10', text: 'Essential hypertension', basis: 'Blood pressure readings' },
  { text: 'No signs of end-organ damage' },
]

Investigation Structure

investigations: [
  { name: 'Initial labs', itemIds: ['obs_glucose', 'obs_creatinine'] },
  { name: 'Imaging', itemIds: ['dr_chest_xray'] },
]

Example

const { data: assessment } = await clinik.assessments.create({
  status: 'completed',
  code: 'initial-assessment',
  patientId: 'pt_abc123',
  encounterId: 'enc_xyz789',
  practitionerId: 'prac_def456',
  summary: 'Patient presents with well-controlled hypertension.',
  findings: [
    { code: 'I10', text: 'Essential hypertension — well controlled', basis: 'BP 128/82' },
    { text: 'No signs of end-organ damage' },
  ],
  investigations: [
    { name: 'Lab panel', itemIds: ['obs_cmp_001', 'obs_cbc_001'] },
  ],
  problemIds: ['cond_hypertension_001'],
  prognosis: [{ text: 'Good — well controlled with current regimen' }],
  note: 'Follow up in 3 months.',
});
ParameterTypeDescription
patientIdstringFilter by patient
practitionerIdstringFilter by assessor
statusstringFilter by status
encounterIdstringFilter by encounter

read / update / delete

Same pattern as other resources.