Class Schedule

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Schedule
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Schedule Resource (workflow.scheduling)

    Definition: A container for slot(s) of time that may be available for booking appointments.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/Schedule

    See Also:
    Serialized Form
    • Field Detail

      • SP_ACTOR

        public static final String SP_ACTOR
        Search parameter constant for 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

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter constant for type

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

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

      • SP_DATE

        public static final String SP_DATE
        Search parameter constant for 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_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

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

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

      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition:

      • addIdentifier

        public Schedule addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition:

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition:

      • getType

        public List<CodeableConceptDtgetType()
        Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

        Definition:

      • addType

        public Schedule addType​(CodeableConceptDt theValue)
        Adds a given new value for type (class)

        Definition:

        Parameters:
        theValue - The type to add (must not be null)
      • getTypeFirstRep

        public CodeableConceptDt getTypeFirstRep()
        Gets the first repetition for type (class), creating it if it does not already exist.

        Definition:

      • getActor

        public ResourceReferenceDt getActor()
        Gets the value(s) for actor (who.focus). creating it if it does not exist. Will not return null.

        Definition:

      • getPlanningHorizon

        public PeriodDt getPlanningHorizon()
        Gets the value(s) for planningHorizon (when.planned). creating it if it does not exist. Will not return null.

        Definition:

      • getCommentElement

        public ca.uhn.fhir.model.primitive.StringDt getCommentElement()
        Gets the value(s) for comment (). creating it if it does not exist. Will not return null.

        Definition:

      • getComment

        public String getComment()
        Gets the value(s) for comment (). creating it if it does not exist. This method may return null.

        Definition:

      • setComment

        public Schedule setComment​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for comment ()

        Definition:

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource