---
updatedAt: 2025-06-23T01:25:53.000Z
agentTools:
  projectIndex: https://developers.halaxy.com/llms.txt
---

# Slot

The Slot resource represents timeslots in a practitioner's schedule that are used to book or hold an appointment.

## Endpoints

| Endpoint                    | Operation      | Description                                                                                                     |
| :-------------------------- | :------------- | :-------------------------------------------------------------------------------------------------------------- |
| **`GET`** `/main/Slot`      | **List Slots** | Retrieves a collection of time intervals that are available for booking appointments within a specific schedule |
| **`GET`** `/main/Slot/{id}` | **Show Slot**  | Retrieves an individual time interval available for booking appointments within a specific schedule             |

<br />

## Schema

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Property
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **schedule**
      </td>

      <td>
        `array of objects` <br />
        The schedule that contains this slot

        `"reference": "/main/Schedule/{id}"` <br />
        `"type": "Schedule"`

        See also: [Schedule](https://halaxy.readme.io/reference/schedule#/)
      </td>
    </tr>

    <tr>
      <td>
        **status**
      </td>

      <td>
        `string`\
        The availability status of this slot <br />
        e.g. `"free"` `"busy"`

        See also: [Slot status](https://hl7.org/fhir/R4B/valueset-slotstatus.html)
      </td>
    </tr>

    <tr>
      <td>
        **start**
      </td>

      <td>
        `date-time`\
        The date and time that the slot begins
      </td>
    </tr>

    <tr>
      <td>
        **end**
      </td>

      <td>
        `date-time`\
        The date and time that the slot ends
      </td>
    </tr>

    <tr>
      <td>
        **overbooked**
      </td>

      <td>
        `boolean`\
        If `true`, appointments cannot be made during this time
      </td>
    </tr>

    <tr>
      <td>
        **actor**
      </td>

      <td>
        `array of objects`\
        Identifiers of the practitioner that this schedule is for

        [Practitioner](https://halaxy.readme.io/reference/practitioner#/)\
        The practitioner ID within the practice group <br />
        `"reference": "/main/Practitioner/PR-1234567"` <br />
        `"type": "Practitioner"`

        [Organization](https://halaxy.readme.io/reference/organization#/)\
        The clinic location <br />
        `"reference": "/main/Organization/CL-123456"` <br />
        `"type": "Organization"`

        [PractitionerRole](https://halaxy.readme.io/reference/practitionerrole#/)\
        The practitioner ID for this clinic location <br />
        `"reference": "/main/PractitionerRole/PR-1234567"` <br />
        `"type": "PractitionerRole"`
      </td>
    </tr>
  </tbody>
</Table>