Package org.hl7.fhir.dstu2016may.model

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:
    Serialized Form

    • Field Detail

      • serviceType

        protected List<CodeableConcept> 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

        protected List<CodeableConcept> specialty
        The specialty of a practitioner that would be required to perform the service requested in this appointment.

      • schedule

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

      • scheduleTarget

        protected Schedule scheduleTarget
        The actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)

      • end

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

      • overbooked

        protected BooleanType 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_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:
        Constant Field Values

      • 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_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:
        Constant Field Values

      • 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

      • 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_SLOT_TYPE

        public static final String SP_SLOT_TYPE
        Search parameter: slot-type

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

        See Also:
        Constant Field Values

      • SLOT_TYPE

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

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

      • 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

    • Method Detail

      • getServiceType

        public List<CodeableConcept> getServiceType()
        Returns:
        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.)

      • addServiceType

        public CodeableConcept addServiceType()
        Returns:
        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.)

      • addSpecialty

        public CodeableConcept addSpecialty()
        Returns:
        specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)

      • getSchedule

        public Reference getSchedule()
        Returns:
        schedule (The schedule resource that this slot defines an interval of status information.)

      • setSchedule

        public Slot setSchedule​(Reference value)
        Parameters:
        value - schedule (The schedule resource that this slot defines an interval of status information.)

      • getScheduleTarget

        public Schedule getScheduleTarget()
        Returns:
        schedule The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The schedule resource that this slot defines an interval of status information.)

      • setScheduleTarget

        public Slot setScheduleTarget​(Schedule value)
        Parameters:
        value - schedule The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The schedule resource that this slot defines an interval of status information.)

      • getStatusElement

        public Enumeration<Slot.SlotStatus> getStatusElement()
        Returns:
        status (busy | free | busy-unavailable | busy-tentative.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • setStatusElement

        public Slot setStatusElement​(Enumeration<Slot.SlotStatus> value)
        Parameters:
        value - status (busy | free | busy-unavailable | busy-tentative.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • getStartElement

        public InstantType getStartElement()
        Returns:
        start (Date/Time that the slot is to begin.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

      • setStartElement

        public Slot setStartElement​(InstantType value)
        Parameters:
        value - start (Date/Time that the slot is to begin.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

      • getStart

        public Date getStart()
        Returns:
        Date/Time that the slot is to begin.

      • setStart

        public Slot setStart​(Date value)
        Parameters:
        value - Date/Time that the slot is to begin.

      • getEndElement

        public InstantType getEndElement()
        Returns:
        end (Date/Time that the slot is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

      • hasEnd

        public boolean hasEnd()

      • setEndElement

        public Slot setEndElement​(InstantType value)
        Parameters:
        value - end (Date/Time that the slot is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

      • getEnd

        public Date getEnd()
        Returns:
        Date/Time that the slot is to conclude.

      • setEnd

        public Slot setEnd​(Date value)
        Parameters:
        value - Date/Time that the slot is to conclude.

      • getOverbookedElement

        public BooleanType getOverbookedElement()
        Returns:
        overbooked (This slot has already been overbooked, appointments are unlikely to be accepted for this time.). This is the underlying object with id, value and extensions. The accessor "getOverbooked" gives direct access to the value

      • setOverbookedElement

        public Slot setOverbookedElement​(BooleanType value)
        Parameters:
        value - overbooked (This slot has already been overbooked, appointments are unlikely to be accepted for this time.). This is the underlying object with id, value and extensions. The accessor "getOverbooked" gives direct access to the value

      • getOverbooked

        public boolean getOverbooked()
        Returns:
        This slot has already been overbooked, appointments are unlikely to be accepted for this time.

      • setOverbooked

        public Slot setOverbooked​(boolean value)
        Parameters:
        value - This slot has already been overbooked, appointments are unlikely to be accepted for this time.

      • getCommentElement

        public StringType getCommentElement()
        Returns:
        comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

      • setCommentElement

        public Slot setCommentElement​(StringType value)
        Parameters:
        value - comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

      • getComment

        public String getComment()
        Returns:
        Comments on the slot to describe any extended information. Such as custom constraints on the slot.

      • setComment

        public Slot setComment​(String value)
        Parameters:
        value - Comments on the slot to describe any extended information. Such as custom constraints on the slot.

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource