Package org.hl7.fhir.dstu2.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

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

      • getType

        public CodeableConcept getType()
        Returns:
        type (The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).)

      • hasType

        public boolean hasType()

      • setType

        public Appointment setType​(CodeableConcept value)
        Parameters:
        value - type (The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).)

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

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

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource