Package org.hl7.fhir.dstu2016may.model

Class Schedule

  • 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 Schedule
extends DomainResource
    A container for slot(s) of time that may be available for booking appointments.
    See Also:
    Serialized Form

    • Field Detail

      • specialty

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

      • actor

        protected Reference actor
        The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.

      • actorTarget

        protected Resource actorTarget
        The actual object that is the target of the reference (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)

      • planningHorizon

        protected Period planningHorizon
        The period of time that the slots that are attached to 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.

      • comment

        protected StringType comment
        Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.

      • SP_ACTOR

        public static final String SP_ACTOR
        Search parameter: actor

        Description: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
        Type: reference
        Path: Schedule.actor

        See Also:
        Constant Field Values

      • ACTOR

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

        Description: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
        Type: reference
        Path: Schedule.actor

      • INCLUDE_ACTOR

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Schedule:actor".

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Search for Schedule resources that have a period that contains this date specified
        Type: date
        Path: Schedule.planningHorizon

        See Also:
        Constant Field Values

      • DATE

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

        Description: Search for Schedule resources that have a period that contains this date specified
        Type: date
        Path: Schedule.planningHorizon

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: The type of appointments that can be booked into associated slot(s)
        Type: token
        Path: Schedule.serviceType

        See Also:
        Constant Field Values

      • TYPE

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

        Description: The type of appointments that can be booked into associated slot(s)
        Type: token
        Path: Schedule.serviceType

      • IDENTIFIER

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

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

    • Method Detail

      • addSpecialty

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

      • getActor

        public Reference getActor()
        Returns:
        actor (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)

      • setActor

        public Schedule setActor​(Reference value)
        Parameters:
        value - actor (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)

      • getActorTarget

        public Resource getActorTarget()
        Returns:
        actor 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 resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)

      • setActorTarget

        public Schedule setActorTarget​(Resource value)
        Parameters:
        value - actor 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 resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.)

      • getPlanningHorizon

        public Period getPlanningHorizon()
        Returns:
        planningHorizon (The period of time that the slots that are attached to 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.)

      • setPlanningHorizon

        public Schedule setPlanningHorizon​(Period value)
        Parameters:
        value - planningHorizon (The period of time that the slots that are attached to 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.)

      • getCommentElement

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

      • setCommentElement

        public Schedule setCommentElement​(StringType value)
        Parameters:
        value - comment (Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.). 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 availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.

      • setComment

        public Schedule setComment​(String value)
        Parameters:
        value - Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.

      • 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