Class Slot

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Slot extends DomainResource
A slot of time on a schedule that may be available for booking appointments.
See Also:
  • Field Details

    • identifier

      External Ids for this item.
    • serviceCategory

      A broad categorization of the service that is to be performed during this appointment.
    • serviceType

      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.
    • specialty

      The specialty of a practitioner that would be required to perform the service requested in this appointment.
    • appointmentType

      The style of appointment or patient that may be booked in the slot (not service type).
    • schedule

      protected Reference schedule
      The schedule resource that this slot defines an interval of status information.
    • status

      busy | free | busy-unavailable | busy-tentative | entered-in-error.
    • start

      protected InstantType start
      Date/Time that the slot is to begin.
    • end

      protected InstantType end
      Date/Time that the slot is to conclude.
    • overbooked

      This slot has already been overbooked, appointments are unlikely to be accepted for this time.
    • comment

      protected StringType comment
      Comments on the slot to describe any extended information. Such as custom constraints on the slot.
    • SP_APPOINTMENT_TYPE

      public static final String SP_APPOINTMENT_TYPE
      Search parameter: appointment-type

      Description: The style of appointment or patient that may be booked in the slot (not service type)
      Type: token
      Path: Slot.appointmentType

      See Also:
    • APPOINTMENT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam APPOINTMENT_TYPE
      Fluent Client search parameter constant for appointment-type

      Description: The style of appointment or patient that may be booked in the slot (not service type)
      Type: token
      Path: Slot.appointmentType

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: A Slot Identifier
      Type: token
      Path: Slot.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: A Slot Identifier
      Type: token
      Path: Slot.identifier

    • SP_SCHEDULE

      public static final String SP_SCHEDULE
      Search parameter: schedule

      Description: The Schedule Resource that we are seeking a slot within
      Type: reference
      Path: Slot.schedule

      See Also:
    • SCHEDULE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SCHEDULE
      Fluent Client search parameter constant for schedule

      Description: The Schedule Resource that we are seeking a slot within
      Type: reference
      Path: Slot.schedule

    • INCLUDE_SCHEDULE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SCHEDULE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Slot:schedule".
    • SP_SERVICE_CATEGORY

      public static final String SP_SERVICE_CATEGORY
      Search parameter: service-category

      Description: A broad categorization of the service that is to be performed during this appointment
      Type: token
      Path: Slot.serviceCategory

      See Also:
    • SERVICE_CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_CATEGORY
      Fluent Client search parameter constant for service-category

      Description: A broad categorization of the service that is to be performed during this appointment
      Type: token
      Path: Slot.serviceCategory

    • SP_SERVICE_TYPE

      public static final String SP_SERVICE_TYPE
      Search parameter: service-type

      Description: The type of appointments that can be booked into the slot
      Type: token
      Path: Slot.serviceType

      See Also:
    • SERVICE_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_TYPE
      Fluent Client search parameter constant for service-type

      Description: The type of appointments that can be booked into the slot
      Type: token
      Path: Slot.serviceType

    • SP_SPECIALTY

      public static final String SP_SPECIALTY
      Search parameter: specialty

      Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
      Type: token
      Path: Slot.specialty

      See Also:
    • SPECIALTY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIALTY
      Fluent Client search parameter constant for specialty

      Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
      Type: token
      Path: Slot.specialty

    • SP_START

      public static final String SP_START
      Search parameter: start

      Description: Appointment date/time.
      Type: date
      Path: Slot.start

      See Also:
    • START

      public static final ca.uhn.fhir.rest.gclient.DateClientParam START
      Fluent Client search parameter constant for start

      Description: Appointment date/time.
      Type: date
      Path: Slot.start

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The free/busy status of the appointment
      Type: token
      Path: Slot.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The free/busy status of the appointment
      Type: token
      Path: Slot.status

  • Constructor Details

  • Method Details