Package com.ibm.fhir.model.resource

Class Schedule

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Schedule
extends DomainResource
    A container for slots of time that may be available for booking appointments.

    Maturity level: FMM3 (Trial Use)

    • Method Detail

      • getIdentifier

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

      • getActive

        public Boolean getActive()
        Whether this schedule record is in active use or should not be used (such as was entered in error).
        Returns:
        An immutable object of type Boolean that may be null.

      • getServiceCategory

        public 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 List<CodeableConcept> getServiceType()
        The specific service that is to be performed during this appointment.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getSpecialty

        public 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.

      • getActor

        public List<Reference> getActor()
        Slots that reference this schedule resource provide the availability details to these referenced resource(s).
        Returns:
        An unmodifiable list containing immutable objects of type Reference that is non-empty.

      • getPlanningHorizon

        public Period getPlanningHorizon()
        The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
        Returns:
        An immutable object of type Period that may be null.

      • getComment

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

      • accept

        public void accept​(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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object