Skip to main content

​
clinik.healthcareServices

Healthcare services describe the services offered by an organization — specialties, availability, referral methods, and eligibility requirements.

​
create

const { data, meta } = await clinik.healthcareServices.create(request): Promise<ApiResponse<HealthcareService>>
FieldTypeRequiredDescription
namestringYesService name
activebooleanNoWhether active (default: true)
providedByIdstringNoOrganization providing the service
categorystring[]NoBroad categories
typestring[]NoService types
specialtystring[]NoSpecialties handled
locationNamesstring[]NoLocation names
commentstringNoAdditional description
phonestringNoContact phone
emailstringNoContact email
appointmentRequiredbooleanNoWhether appointment is required
availableTimeArrayNoAvailability schedules
notAvailableArrayNoUnavailable periods
availabilityExceptionsstringNoFree-text exceptions
programstring[]NoPrograms this service is part of
referralMethodstring[]NoAccepted referral methods
communicationstring[]NoLanguages offered

​
Example

const { data } = await clinik.healthcareServices.create({
  name: 'Cardiology Consultation',
  providedById: 'org_sunrise_medical',
  category: ['specialist'],
  type: ['cardiology'],
  specialty: ['Cardiology'],
  appointmentRequired: true,
  availableTime: [
    { daysOfWeek: ['mon', 'wed', 'fri'], availableStartTime: '09:00:00', availableEndTime: '17:00:00' },
  ],
  notAvailable: [
    { description: 'Holiday closure', during: { start: '2025-12-24', end: '2025-12-26' } },
  ],
  referralMethod: ['phone', 'fax', 'electronic'],
  communication: ['en', 'es'],
});
Same pattern as other resources. Search supports name, type, specialty, active filters.