Skip to main content

​
clinik.locations

Locations represent physical places where healthcare services are provided — clinics, hospitals, rooms, buildings, or mobile units.

​
create

const { data, meta } = await clinik.locations.create(request): Promise<ApiResponse<Location>>
FieldTypeRequiredDescription
namestringYesLocation name
statusstringNoactive, suspended, inactive (default: active)
descriptionstringNoAdditional details about the location
modestringNoinstance (specific place) or kind (class of locations)
typestring[]NoLocation type codes
aliasstring[]NoAlternate names
phonestringNoPhone number
emailstringNoEmail address
addressAddressNoPhysical address
physicalTypestringNoPhysical form (building, wing, room, bed, etc.)
positionobjectNoGPS coordinates (longitude, latitude, altitude)
managingOrganizationIdstringNoOrganization that manages this location
partOfIdstringNoParent location ID
hoursOfOperationArrayNoOperating hours (daysOfWeek, allDay, openingTime, closingTime)
availabilityExceptionsstringNoDescription of availability exceptions

​
Example

const { data } = await clinik.locations.create({
  name: 'Sunrise Medical Center — Main Building',
  status: 'active',
  description: 'Primary care facility with 3 floors and 40 exam rooms',
  mode: 'instance',
  type: ['HOSP'],
  phone: '555-0100',
  email: '[email protected]',
  address: {
    line: ['100 Health Blvd'],
    city: 'Austin',
    state: 'TX',
    postalCode: '78701',
    country: 'US',
  },
  physicalType: 'building',
  position: { longitude: -97.7431, latitude: 30.2672 },
  managingOrganizationId: 'org_sunrise',
  hoursOfOperation: [
    { daysOfWeek: ['mon', 'tue', 'wed', 'thu', 'fri'], openingTime: '08:00:00', closingTime: '18:00:00' },
    { daysOfWeek: ['sat'], openingTime: '09:00:00', closingTime: '13:00:00' },
  ],
  availabilityExceptions: 'Closed on federal holidays',
});
Same pattern as other resources. Search supports name, status, type, address filters.