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 slots of time that may be available for booking appointments.
See Also:
Serialized Form
  • Field Details

    • identifier

      External Ids for this item.
    • active

      protected BooleanType active
      Whether this schedule record is in active use, or should not be used (such as was entered in error).
    • serviceCategory

      A broad categorisation of the service that is to be performed during this appointment.
    • serviceType

      The specific service that is to be performed during this appointment.
    • specialty

      The specialty of a practitioner that would be required to perform the service requested in this appointment.
    • actor

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

      The actual objects that are 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, PractitionerRole, Device, Patient or RelatedPerson.)
    • 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 slots 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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: 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

    • SP_ACTIVE

      public static final String SP_ACTIVE
      Search parameter: active

      Description: Is the schedule in active use
      Type: token
      Path: Schedule.active

      See Also:
      Constant Field Values
    • ACTIVE

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

      Description: Is the schedule in active use
      Type: token
      Path: Schedule.active

    • 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

  • Constructor Details

    • Schedule

      public Schedule()
      Constructor
  • Method Details