Package org.hl7.fhir.dstu2016may.model

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.

      • specialty

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

      • reason

        protected CodeableConcept reason
        The reason that this appointment is being scheduled. This is more clinical than administrative.

      • priority

        protected UnsignedIntType 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.

      • 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 (where actual time of appointment is only an estimate or is a planned appointment request).

      • slot

        protected List<Reference> slot
        The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.

      • slotTarget

        protected List<Slot> slotTarget
        The actual objects that are the target of the reference (The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.)

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

      • 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

        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

      • 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_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_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

        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

      • 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_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

        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

      • 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_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_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_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_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_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Appointment date/time.
        Type: date
        Path: Appointment.start

        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: Appointment.start

      • 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

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Returns:
        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).)

      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        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).)

      • getStatusElement

        public Enumeration<Appointment.AppointmentStatus> getStatusElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • setStatusElement

        public Appointment setStatusElement​(Enumeration<Appointment.AppointmentStatus> value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • getStatus

        public Appointment.AppointmentStatus getStatus()
        Returns:
        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.

      • setStatus

        public Appointment setStatus​(Appointment.AppointmentStatus value)
        Parameters:
        value - 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.

      • addSpecialty

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

      • getReason

        public CodeableConcept getReason()
        Returns:
        reason (The reason that this appointment is being scheduled. This is more clinical than administrative.)

      • getPriorityElement

        public UnsignedIntType getPriorityElement()
        Returns:
        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).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

      • setPriorityElement

        public Appointment setPriorityElement​(UnsignedIntType value)
        Parameters:
        value - 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).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

      • getPriority

        public int getPriority()
        Returns:
        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).

      • setPriority

        public Appointment setPriority​(int value)
        Parameters:
        value - 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).

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • setDescriptionElement

        public Appointment setDescriptionElement​(StringType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • getDescription

        public String getDescription()
        Returns:
        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.

      • setDescription

        public Appointment setDescription​(String value)
        Parameters:
        value - 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.

      • getStartElement

        public InstantType getStartElement()
        Returns:
        start (Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

      • setStartElement

        public Appointment setStartElement​(InstantType value)
        Parameters:
        value - start (Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

      • getStart

        public Date getStart()
        Returns:
        Date/Time that the appointment is to take place.

      • setStart

        public Appointment setStart​(Date value)
        Parameters:
        value - Date/Time that the appointment is to take place.

      • getEndElement

        public InstantType getEndElement()
        Returns:
        end (Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

      • hasEnd

        public boolean hasEnd()

      • setEndElement

        public Appointment setEndElement​(InstantType value)
        Parameters:
        value - end (Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

      • getEnd

        public Date getEnd()
        Returns:
        Date/Time that the appointment is to conclude.

      • setEnd

        public Appointment setEnd​(Date value)
        Parameters:
        value - Date/Time that the appointment is to conclude.

      • getMinutesDurationElement

        public PositiveIntType getMinutesDurationElement()
        Returns:
        minutesDuration (Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value

      • setMinutesDurationElement

        public Appointment setMinutesDurationElement​(PositiveIntType value)
        Parameters:
        value - minutesDuration (Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value

      • getMinutesDuration

        public int getMinutesDuration()
        Returns:
        Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

      • setMinutesDuration

        public Appointment setMinutesDuration​(int value)
        Parameters:
        value - Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).

      • getSlot

        public List<Reference> getSlot()
        Returns:
        slot (The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.)

      • hasSlot

        public boolean hasSlot()

      • addSlot

        public Reference addSlot()
        Returns:
        slot (The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.)

      • getSlotTarget

        public List<Slot> getSlotTarget()
        Returns:
        slot (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.)

      • addSlotTarget

        public Slot addSlotTarget()
        Returns:
        slot (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.)

      • getCreatedElement

        public DateTimeType getCreatedElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

      • setCreatedElement

        public Appointment setCreatedElement​(DateTimeType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

      • getCreated

        public Date getCreated()
        Returns:
        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.

      • setCreated

        public Appointment setCreated​(Date value)
        Parameters:
        value - 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.

      • getCommentElement

        public StringType getCommentElement()
        Returns:
        comment (Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

      • setCommentElement

        public Appointment setCommentElement​(StringType value)
        Parameters:
        value - comment (Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

      • getComment

        public String getComment()
        Returns:
        Additional comments about the appointment.

      • 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