Skip to main content

clinik.encounters

create

const { data, meta } = await clinik.encounters.create(request: EncounterCreateRequest): Promise<ApiResponse<Encounter>>
FieldTypeRequiredDescription
statusstringYesplanned, arrived, triaged, in-progress, onleave, finished, cancelled
classstringYesAMB, IMP, EMER, HH, VR
patientIdstringYesPatient reference
practitionerIdstringNoPrimary practitioner reference
participantsArray<{ practitionerId, role? }>NoAdditional participants
typestringNoEncounter type
serviceTypestringNoService type
prioritystringNoPriority
reasonCodestringNoReason for encounter
period{ start?, end? }NoTime period
lengthMinutesnumberNoDuration in minutes
locationstringNoLocation name
serviceProviderstringNoOrganization name
diagnosisArray<{ condition, use?, rank? }>NoDiagnoses
appointmentIdstringNoAppointment that scheduled this encounter
basedOnIdstringNoServiceRequest that initiated this encounter
partOfIdstringNoParent encounter (for sub-encounters)
hospitalizationobjectNoInpatient details (admitSource, dischargeDisposition, etc.)

Hospitalization

For inpatient encounters (class: 'IMP'), include hospitalization details:
FieldTypeDescription
admitSourcestringWhere admitted from (physician referral, transfer, ER)
dischargeDispositionstringDischarge destination (home, SNF, expired)
reAdmissionstringRe-admission type if applicable
dietPreferencestring[]Diet preferences (vegetarian, kosher, etc.)
specialArrangementstring[]Wheelchair, translator, stretcher, etc.
destinationstringDischarge destination facility
originstringOriginating facility

read

const { data, meta } = await clinik.encounters.read(id: string, options?: ReadOptions): Promise<ApiResponse<Encounter>>

update

const { data, meta } = await clinik.encounters.update(id: string, request: EncounterUpdateRequest): Promise<ApiResponse<Encounter>>

delete

const { data, meta } = await clinik.encounters.delete(id: string): Promise<ApiResponse<void>>
const { data, meta } = await clinik.encounters.search(params?: ResourceSearchParams): Promise<ApiResponse<PaginatedResponse<Encounter>>>
ParameterTypeDescription
patientIdstringFilter by patient
statusstringFilter by status
dateFromstringStart date filter
dateTostringEnd date filter
sortstringSort field (prefix with - for descending)
countnumberResults per page
cursorstringPagination cursor