Skip to main content

​
clinik.imagingStudies

Imaging Studies (FHIR ImagingStudy) represent radiology and diagnostic imaging exams. ClinikAPI simplifies series to key fields and skips instance-level detail — use the FHIR passthrough for DICOM-level access.

​
create

const { data, meta } = await clinik.imagingStudies.create(request): Promise<ApiResponse<ImagingStudy>>
FieldTypeRequiredDescription
statusstringYesregistered, available, cancelled
patientIdstringYesPatient ID
encounterIdstringNoEncounter ID
modalitystring[]NoImaging modalities (CT, MR, US, XR, NM, PT)
startedstringNoWhen the study started
referrerIdstringNoReferring Practitioner ID
interpreterIdsstring[]NoInterpreting Practitioner IDs
numberOfSeriesnumberNoNumber of series
numberOfInstancesnumberNoNumber of instances
procedureCodestring[]NoProcedure codes
locationIdstringNoLocation ID
reasonCodestring[]NoReason codes
descriptionstringNoStudy description
notestringNoAdditional notes
basedOnstring[]NoServiceRequest/CarePlan IDs
seriesArrayNoSeries data

​
Series Object

FieldTypeRequiredDescription
uidstringYesSeries instance UID
numbernumberNoSeries number
modalitystringYesSeries modality
descriptionstringNoSeries description
numberOfInstancesnumberNoNumber of instances
bodySitestringNoBody site imaged
lateralitystringNoLeft, right, bilateral
startedstringNoWhen series started

​
Example

const { data } = await clinik.imagingStudies.create({
  status: 'available',
  patientId: 'pt_abc123',
  encounterId: 'enc_visit456',
  modality: ['CT'],
  started: '2024-03-15T10:00:00Z',
  referrerId: 'prac_dr789',
  numberOfSeries: 2,
  numberOfInstances: 120,
  procedureCode: ['CT chest with contrast'],
  description: 'CT Chest — rule out pulmonary embolism',
  reasonCode: ['Shortness of breath', 'Chest pain'],
  series: [
    {
      uid: '1.2.840.113619.2.55.3.604688119.969.1364202859.234',
      number: 1,
      modality: 'CT',
      description: 'Axial images',
      numberOfInstances: 80,
      bodySite: 'Chest',
    },
    {
      uid: '1.2.840.113619.2.55.3.604688119.969.1364202859.235',
      number: 2,
      modality: 'CT',
      description: 'Coronal reformats',
      numberOfInstances: 40,
      bodySite: 'Chest',
    },
  ],
});
Same pattern as other resources. Update supports status, description, note. Search supports patientId, status, modality, dateFrom, dateTo filters.