Class Appointment

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Appointment
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Appointment extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Appointment Resource ()

Definition:

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Appointment

See Also:
Serialized Form
  • Field Details

    • SP_DATE

      public static final String SP_DATE
      Search parameter constant for 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_STATUS

      public static final String SP_STATUS
      Search parameter constant for 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_ACTOR

      public static final String SP_ACTOR
      Search parameter constant for 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

    • SP_PART_STATUS

      public static final String SP_PART_STATUS
      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

      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 constant for 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

    • SP_PRACTITIONER

      public static final String SP_PRACTITIONER
      Search parameter constant for 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

    • SP_LOCATION

      public static final String SP_LOCATION
      Search parameter constant for 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

    • SP_IDENTIFIER

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

    • 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".
    • 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".
    • 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".
    • 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".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

      Definition: 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)

    • setIdentifier

      public Appointment setIdentifier(List<IdentifierDt> theValue)
      Sets the value(s) for identifier ()

      Definition: 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

      Adds and returns a new value for identifier ()

      Definition: 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(IdentifierDt theValue)
      Adds a given new value for identifier ()

      Definition: 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)

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (), creating it if it does not already exist.

      Definition: 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 ca.uhn.fhir.model.primitive.BoundCodeDt<AppointmentStatusEnum> getStatusElement()
      Gets the value(s) for status (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getStatus

      public String getStatus()
      Gets the value(s) for status (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.BoundCodeDt<AppointmentStatusEnum> theValue)
      Sets the value(s) for status ()

      Definition: 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

      Sets the value(s) for status ()

      Definition: 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

      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

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

    • setType

      public Appointment setType(CodeableConceptDt theValue)
      Sets the value(s) for type ()

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

    • getReason

      Gets the value(s) for reason (). creating it if it does not exist. Will not return null.

      Definition: The reason that this appointment is being scheduled. This is more clinical than administrative

    • setReason

      public Appointment setReason(CodeableConceptDt theValue)
      Sets the value(s) for reason ()

      Definition: The reason that this appointment is being scheduled. This is more clinical than administrative

    • getPriorityElement

      public ca.uhn.fhir.model.primitive.UnsignedIntDt getPriorityElement()
      Gets the value(s) for priority (). creating it if it does not exist. Will not return null.

      Definition: 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)

    • getPriority

      public Integer getPriority()
      Gets the value(s) for priority (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
      Sets the value(s) for priority ()

      Definition: 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 theInteger)
      Sets the value for priority ()

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: 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 theString)
      Sets the value for description ()

      Definition: 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 ca.uhn.fhir.model.primitive.InstantDt getStartElement()
      Gets the value(s) for start (). creating it if it does not exist. Will not return null.

      Definition: Date/Time that the appointment is to take place

    • getStart

      public Date getStart()
      Gets the value(s) for start (). creating it if it does not exist. This method may return null.

      Definition: Date/Time that the appointment is to take place

    • setStart

      public Appointment setStart(ca.uhn.fhir.model.primitive.InstantDt theValue)
      Sets the value(s) for start ()

      Definition: Date/Time that the appointment is to take place

    • setStartWithMillisPrecision

      Sets the value for start ()

      Definition: Date/Time that the appointment is to take place

    • setStart

      public Appointment setStart(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for start ()

      Definition: Date/Time that the appointment is to take place

    • getEndElement

      public ca.uhn.fhir.model.primitive.InstantDt getEndElement()
      Gets the value(s) for end (). creating it if it does not exist. Will not return null.

      Definition: Date/Time that the appointment is to conclude

    • getEnd

      public Date getEnd()
      Gets the value(s) for end (). creating it if it does not exist. This method may return null.

      Definition: Date/Time that the appointment is to conclude

    • setEnd

      public Appointment setEnd(ca.uhn.fhir.model.primitive.InstantDt theValue)
      Sets the value(s) for end ()

      Definition: Date/Time that the appointment is to conclude

    • setEndWithMillisPrecision

      Sets the value for end ()

      Definition: Date/Time that the appointment is to conclude

    • setEnd

      public Appointment setEnd(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for end ()

      Definition: Date/Time that the appointment is to conclude

    • getMinutesDurationElement

      public ca.uhn.fhir.model.primitive.PositiveIntDt getMinutesDurationElement()
      Gets the value(s) for minutesDuration (). creating it if it does not exist. Will not return null.

      Definition: 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)

    • getMinutesDuration

      Gets the value(s) for minutesDuration (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
      Sets the value(s) for minutesDuration ()

      Definition: 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 theInteger)
      Sets the value for minutesDuration ()

      Definition: 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

      Gets the value(s) for slot (). creating it if it does not exist. Will not return null.

      Definition: 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

    • setSlot

      Sets the value(s) for slot ()

      Definition: 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

      Adds and returns a new value for slot ()

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getCommentElement()
      Gets the value(s) for comment (). creating it if it does not exist. Will not return null.

      Definition: Additional comments about the appointment

    • getComment

      public String getComment()
      Gets the value(s) for comment (). creating it if it does not exist. This method may return null.

      Definition: Additional comments about the appointment

    • setComment

      public Appointment setComment(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for comment ()

      Definition: Additional comments about the appointment

    • setComment

      public Appointment setComment(String theString)
      Sets the value for comment ()

      Definition: Additional comments about the appointment

    • getParticipant

      Gets the value(s) for participant (). creating it if it does not exist. Will not return null.

      Definition: List of participants involved in the appointment

    • setParticipant

      Sets the value(s) for participant ()

      Definition: List of participants involved in the appointment

    • addParticipant

      Adds and returns a new value for participant ()

      Definition: List of participants involved in the appointment

    • addParticipant

      Adds a given new value for participant ()

      Definition: List of participants involved in the appointment

      Parameters:
      theValue - The participant to add (must not be null)
    • getParticipantFirstRep

      Gets the first repetition for participant (), creating it if it does not already exist.

      Definition: List of participants involved in the appointment

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource