# Slot

Canonical page: https://docs.ovok.com/api/fhir/r4/slot

A slot of time on a schedule that may be available for booking appointments.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Slot/[id]` |
| Vread | `GET` | `/fhir/R4/Slot/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Slot/[id]` |
| Patch | `PATCH` | `/fhir/R4/Slot/[id]` |
| Delete | `DELETE` | `/fhir/R4/Slot/[id]` |
| Create | `POST` | `/fhir/R4/Slot` |
| Search | `GET` | `/fhir/R4/Slot` |
| History | `GET` | `/fhir/R4/Slot/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | External Ids for this item |
| <span id="element-service-category"></span>`serviceCategory` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | A broad categorization of the service that is to be performed during this appointment |
| <span id="element-service-type"></span>`serviceType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource |
| <span id="element-specialty"></span>`specialty` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The specialty of a practitioner that would be required to perform the service requested in this appointment |
| <span id="element-appointment-type"></span>`appointmentType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | The style of appointment or patient that may be booked in the slot (not service type) |
| <span id="element-schedule"></span>`schedule` | [Reference](/fhir-elements/complex/reference) | `1..1` | The schedule resource that this slot defines an interval of status information |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | busy \| free \| busy-unavailable \| busy-tentative \| entered-in-error |
| <span id="element-start"></span>`start` | [instant](/fhir-elements/primitive/instant) | `1..1` | Date/Time that the slot is to begin |
| <span id="element-end"></span>`end` | [instant](/fhir-elements/primitive/instant) | `1..1` | Date/Time that the slot is to conclude |
| <span id="element-overbooked"></span>`overbooked` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | This slot has already been overbooked, appointments are unlikely to be accepted for this time |
| <span id="element-comment"></span>`comment` | [string](/fhir-elements/primitive/string) | `0..1` | Comments on the slot to describe any extended information. Such as custom constraints on the slot |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `appointment-type` | token | The style of appointment or patient that may be booked in the slot (not service type) |
| `identifier` | token | A Slot Identifier |
| `schedule` | reference | The Schedule Resource that we are seeking a slot within |
| `service-category` | token | A broad categorization of the service that is to be performed during this appointment |
| `service-type` | token | The type of appointments that can be booked into the slot |
| `specialty` | token | The specialty of a practitioner that would be required to perform the service requested in this appointment |
| `start` | date | Appointment date/time. |
| `status` | token | The free/busy status of the appointment |

## Reference [#reference]

Official FHIR R4 spec: [Slot](https://hl7.org/fhir/R4/slot.html).  
Maturity: Trial Use 3 (FMM 3).
