Package com.ibm.fhir.model.resource

Class Slot

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Slot
extends DomainResource
    A slot of time on a schedule that may be available for booking appointments.

    Maturity level: FMM3 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        External Ids for this item.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getServiceCategory

        public java.util.List<CodeableConcept> getServiceCategory()
        A broad categorization of the service that is to be performed during this appointment.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getServiceType

        public java.util.List<CodeableConcept> getServiceType()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getSpecialty

        public java.util.List<CodeableConcept> getSpecialty()
        The specialty of a practitioner that would be required to perform the service requested in this appointment.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getAppointmentType

        public CodeableConcept getAppointmentType()
        The style of appointment or patient that may be booked in the slot (not service type).
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSchedule

        public Reference getSchedule()
        The schedule resource that this slot defines an interval of status information.
        Returns:
        An immutable object of type Reference that is non-null.

      • getStatus

        public SlotStatus getStatus()
        busy | free | busy-unavailable | busy-tentative | entered-in-error.
        Returns:
        An immutable object of type SlotStatus that is non-null.

      • getStart

        public Instant getStart()
        Date/Time that the slot is to begin.
        Returns:
        An immutable object of type Instant that is non-null.

      • getEnd

        public Instant getEnd()
        Date/Time that the slot is to conclude.
        Returns:
        An immutable object of type Instant that is non-null.

      • getOverbooked

        public Boolean getOverbooked()
        This slot has already been overbooked, appointments are unlikely to be accepted for this time.
        Returns:
        An immutable object of type Boolean that may be null.

      • getComment

        public String getComment()
        Comments on the slot to describe any extended information. Such as custom constraints on the slot.
        Returns:
        An immutable object of type String that may be null.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object