Package org.hl7.fhir.dstu2.model

Class Appointment

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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:

  • Field Details

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

    • type

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

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

    • comment

      protected StringType comment
      Additional comments about the appointment.

    • participant

      protected List<Appointment.AppointmentParticipantComponent> participant
      List of participants involved in the appointment.

    • SP_DATE

      public static final String SP_DATE
      See Also:

    • SP_ACTOR

      public static final String SP_ACTOR
      See Also:

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      See Also:

    • SP_PRACTITIONER

      public static final String SP_PRACTITIONER
      See Also:

    • SP_PARTSTATUS

      public static final String SP_PARTSTATUS
      See Also:

    • SP_PATIENT

      public static final String SP_PATIENT
      See Also:

    • SP_LOCATION

      public static final String SP_LOCATION
      See Also:

    • SP_STATUS

      public static final String SP_STATUS
      See Also:

  • Constructor Details

  • Method Details

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

    • hasIdentifier

      public boolean hasIdentifier()

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

    • addIdentifier

      public Appointment addIdentifier(Identifier t)

    • 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

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

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

    • hasReason

      public boolean hasReason()

    • setReason

      public Appointment setReason(CodeableConcept value)
      Parameters:
      value - 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

    • hasPriorityElement

      public boolean hasPriorityElement()

    • hasPriority

      public boolean hasPriority()

    • 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

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • 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

    • hasStartElement

      public boolean hasStartElement()

    • hasStart

      public boolean hasStart()

    • 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

    • hasEndElement

      public boolean hasEndElement()

    • 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

    • hasMinutesDurationElement

      public boolean hasMinutesDurationElement()

    • hasMinutesDuration

      public boolean hasMinutesDuration()

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

    • addSlot

      public Appointment addSlot(Reference t)

    • 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

    • hasCommentElement

      public boolean hasCommentElement()

    • hasComment

      public boolean hasComment()

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

    • setComment

      public Appointment setComment(String value)
      Parameters:
      value - Additional comments about the appointment.

    • getParticipant

      public List<Appointment.AppointmentParticipantComponent> getParticipant()
      Returns:
      participant (List of participants involved in the appointment.)

    • hasParticipant

      public boolean hasParticipant()

    • addParticipant

      public Appointment.AppointmentParticipantComponent addParticipant()
      Returns:
      participant (List of participants involved in the appointment.)

    • addParticipant

      public Appointment addParticipant(Appointment.AppointmentParticipantComponent t)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

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

    • copy

      public Appointment copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected Appointment typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource