Slot

This topic describes information for the Slot resource.

To interact with the REST endpoints in the Slot resource, see Slot.

Overview

The Slot resource returns time slots from a schedule which are available for booking an appointment. Slots contain no information about actual appointments, only availability and type.

Appointment types for use in FHIR scheduling workflows must be resource list based. The ability to retrieve slots and book appointments that are order role based are not supported in FHIR workflows.

When integrating your application with a client's production environment you will work with the client to determine the Practitioner and Location ids (Millennium personnel and location codes, respectively) which they want to make available to third-party applications for enabling scheduling functionality.

We understand this is a bit cumbersome, but we are always evaluating community feedback and look to improve the API in the future.

The following fields are returned if valued:

  • Slot id
  • ServiceType
  • Schedule
  • Status
  • Start
  • End
  • Scheduling Location Extension (for more information, see the Extensions section of this topic).
  • General Resource Extension (for more information, see the Extensions section of this topic).

Terminology Bindings

  • Slot.serviceType

    Description: 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.

    • Details: Practice Setting Code Value Set

      System: http://snomed.info/sct

    • Details: Millennium Scheduling Appointment Synonyms or Types (for more information, see Code Set 14249 Scheduling Appointment Type Synonyms under the List of Code Sets section in Proprietary Codes and Systems.

      System: https://fhir.cerner.com/<EHR source id>/codeSet/14249

Extensions

All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}

Table - Custom Extensions

ID Value[x] Type Description

scheduling-location

Reference

Reference to the location corresponding to this schedule, where the appointment can be booked.

general-resource

string

A value string referencing a general string resource corresponding with the schedule.