Class Appointment

  • 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 Appointment
    extends DomainResource
    A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
      • status

        protected Enumeration<Appointment.AppointmentStatus> status
        The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
      • cancellationReason

        protected CodeableConcept cancellationReason
        The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
      • specialty

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

        protected List<CodeableReference> reason
        The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
      • priority

        protected CodeableConcept priority
        The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
      • description

        protected StringType description
        The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
      • replaces

        protected List<Reference> replaces
        Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).
      • start

        protected InstantType start
        Date/Time that the appointment is to take place.
      • end

        protected InstantType end
        Date/Time that the appointment is to conclude.
      • minutesDuration

        protected PositiveIntType minutesDuration
        Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
      • slot

        protected List<Reference> slot
        The slots from the participants' schedules that will be filled by the appointment.
      • account

        protected List<Reference> account
        The set of accounts that is expected to be used for billing the activities that result from this Appointment.
      • created

        protected DateTimeType created
        The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
      • patientInstruction

        protected List<CodeableReference> patientInstruction
        While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
      • basedOn

        protected List<Reference> basedOn
        The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
      • subject

        protected Reference subject
        The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.
      • requestedPeriod

        protected List<Period> requestedPeriod
        A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
      • SP_ACTOR

        public static final String SP_ACTOR
        Search parameter: actor

        Description: Any one of the individuals participating in the appointment
        Type: reference
        Path: Appointment.participant.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: Any one of the individuals participating in the appointment
        Type: reference
        Path: Appointment.participant.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 "Appointment:actor".
      • SP_APPOINTMENT_TYPE

        public static final String SP_APPOINTMENT_TYPE
        Search parameter: appointment-type

        Description: The style of appointment or patient that has been booked in the slot (not service type)
        Type: token
        Path: Appointment.appointmentType

        See Also:
        Constant Field Values
      • APPOINTMENT_TYPE

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

        Description: The style of appointment or patient that has been booked in the slot (not service type)
        Type: token
        Path: Appointment.appointmentType

      • SP_BASED_ON

        public static final String SP_BASED_ON
        Search parameter: based-on

        Description: The service request this appointment is allocated to assess
        Type: reference
        Path: Appointment.basedOn

        See Also:
        Constant Field Values
      • BASED_ON

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
        Fluent Client search parameter constant for based-on

        Description: The service request this appointment is allocated to assess
        Type: reference
        Path: Appointment.basedOn

      • INCLUDE_BASED_ON

        public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:based-on".
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Appointment date/time.
        Type: date
        Path: (start | requestedPeriod.start).first()

        See Also:
        Constant Field Values
      • DATE

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

        Description: Appointment date/time.
        Type: date
        Path: (start | requestedPeriod.start).first()

      • SP_GROUP

        public static final String SP_GROUP
        Search parameter: group

        Description: One of the individuals of the appointment is this patient
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)

        See Also:
        Constant Field Values
      • GROUP

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

        Description: One of the individuals of the appointment is this patient
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group)

      • INCLUDE_GROUP

        public static final ca.uhn.fhir.model.api.Include INCLUDE_GROUP
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:group".
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: An Identifier of the Appointment
        Type: token
        Path: Appointment.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: An Identifier of the Appointment
        Type: token
        Path: Appointment.identifier

      • SP_LOCATION

        public static final String SP_LOCATION
        Search parameter: location

        Description: This location is listed in the participants of the appointment
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Location)

        See Also:
        Constant Field Values
      • LOCATION

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

        Description: This location is listed in the participants of the appointment
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Location)

      • INCLUDE_LOCATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:location".
      • SP_PART_STATUS

        public static final String SP_PART_STATUS
        Search parameter: part-status

        Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
        Type: token
        Path: Appointment.participant.status

        See Also:
        Constant Field Values
      • PART_STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PART_STATUS
        Fluent Client search parameter constant for part-status

        Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
        Type: token
        Path: Appointment.participant.status

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: One of the individuals of the appointment is this patient
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient)

        See Also:
        Constant Field Values
      • PATIENT

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

        Description: One of the individuals of the appointment is this patient
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient)

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:patient".
      • SP_PRACTITIONER

        public static final String SP_PRACTITIONER
        Search parameter: practitioner

        Description: One of the individuals of the appointment is this practitioner
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Practitioner)

        See Also:
        Constant Field Values
      • PRACTITIONER

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

        Description: One of the individuals of the appointment is this practitioner
        Type: reference
        Path: Appointment.participant.actor.where(resolve() is Practitioner)

      • INCLUDE_PRACTITIONER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:practitioner".
      • SP_REASON_CODE

        public static final String SP_REASON_CODE
        Search parameter: reason-code

        Description: Reference to a concept (by class)
        Type: token
        Path: Appointment.reason.concept

        See Also:
        Constant Field Values
      • REASON_CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam REASON_CODE
        Fluent Client search parameter constant for reason-code

        Description: Reference to a concept (by class)
        Type: token
        Path: Appointment.reason.concept

      • SP_REASON_REFERENCE

        public static final String SP_REASON_REFERENCE
        Search parameter: reason-reference

        Description: Reference to a resource (by instance)
        Type: reference
        Path: Appointment.reason.reference

        See Also:
        Constant Field Values
      • REASON_REFERENCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REASON_REFERENCE
        Fluent Client search parameter constant for reason-reference

        Description: Reference to a resource (by instance)
        Type: reference
        Path: Appointment.reason.reference

      • INCLUDE_REASON_REFERENCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:reason-reference".
      • SP_REQUESTED_PERIOD

        public static final String SP_REQUESTED_PERIOD
        Search parameter: requested-period

        Description: During what period was the Appointment requested to take place
        Type: date
        Path: requestedPeriod

        See Also:
        Constant Field Values
      • REQUESTED_PERIOD

        public static final ca.uhn.fhir.rest.gclient.DateClientParam REQUESTED_PERIOD
        Fluent Client search parameter constant for requested-period

        Description: During what period was the Appointment requested to take place
        Type: date
        Path: requestedPeriod

      • SP_SERVICE_CATEGORY

        public static final String SP_SERVICE_CATEGORY
        Search parameter: service-category

        Description: A broad categorization of the service that is to be performed during this appointment
        Type: token
        Path: Appointment.serviceCategory

        See Also:
        Constant Field Values
      • SERVICE_CATEGORY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_CATEGORY
        Fluent Client search parameter constant for service-category

        Description: A broad categorization of the service that is to be performed during this appointment
        Type: token
        Path: Appointment.serviceCategory

      • SP_SERVICE_TYPE

        public static final String SP_SERVICE_TYPE
        Search parameter: service-type

        Description: The specific service that is to be performed during this appointment
        Type: token
        Path: Appointment.serviceType

        See Also:
        Constant Field Values
      • SERVICE_TYPE

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

        Description: The specific service that is to be performed during this appointment
        Type: token
        Path: Appointment.serviceType

      • SP_SLOT

        public static final String SP_SLOT
        Search parameter: slot

        Description: The slots that this appointment is filling
        Type: reference
        Path: Appointment.slot

        See Also:
        Constant Field Values
      • SLOT

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

        Description: The slots that this appointment is filling
        Type: reference
        Path: Appointment.slot

      • INCLUDE_SLOT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SLOT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:slot".
      • SP_SPECIALTY

        public static final String SP_SPECIALTY
        Search parameter: specialty

        Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
        Type: token
        Path: Appointment.specialty

        See Also:
        Constant Field Values
      • SPECIALTY

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

        Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
        Type: token
        Path: Appointment.specialty

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The overall status of the appointment
        Type: token
        Path: Appointment.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 overall status of the appointment
        Type: token
        Path: Appointment.status

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: One of the individuals of the appointment is this patient
        Type: reference
        Path: Appointment.subject

        See Also:
        Constant Field Values
      • SUBJECT

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

        Description: One of the individuals of the appointment is this patient
        Type: reference
        Path: Appointment.subject

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:subject".
      • SP_SUPPORTING_INFO

        public static final String SP_SUPPORTING_INFO
        Search parameter: supporting-info

        Description: Additional information to support the appointment
        Type: reference
        Path: Appointment.supportingInformation

        See Also:
        Constant Field Values
      • SUPPORTING_INFO

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPORTING_INFO
        Fluent Client search parameter constant for supporting-info

        Description: Additional information to support the appointment
        Type: reference
        Path: Appointment.supportingInformation

      • INCLUDE_SUPPORTING_INFO

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPORTING_INFO
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:supporting-info".