ISAppointment.GetOccurenceAppointment

Description

This function returns an occurrence of the recurring appointment.

Syntax

object.GetOccurenceAppointment(aDateTime)

Part	Attribute	Type	Description
`object`	Required	ISAppointment	The `object` always implements the ISAppointment interface
`aDateTime`	In, Required	DateTime	The date and time of the occurrence

Return Value

ISAppointment

Returns an occurrence of the recurring appointment.

Example

Display the date, the time and the reason description of the occurrence of the recurring appointment.

Dim aPatient
Dim aProvider
Dim aFilter 
Dim aAppointments
Dim aFirstAppointment
Dim aIsRecurrenceTemplate

Set aPatient = Profile.SelectPatient
set aProvider = Profile.LoadProvider("PROV")
set aFilter = Profile.CreateAppointmentFilter

aFilter.ProviderID = aProvider.Id
aFilter.PatientId = aPatient.Id
aFilter.DateFrom = #01/01/2018#
aFilter.DateTo = #01/01/2019#
aFilter.IncludeRecurrent = 1
set aAppointments = Profile.LoadAppointments(aFilter)

if aAppointments.Count > 0 then
  set aFirstAppointment = aAppointments.Item(0)
  set aAppTemplate = aFirstAppointment.GetRecurrenceTemplateForOccurence
  aIsRecurrenceTemplate = aAppTemplate.IsRecurrenceTemplate
  set aAppOnDate = aAppTemplate.GetOccurenceAppointment(#13/12/2018#)
  
  Profile.MsgBox(aAppOnDate.BookedTime & " " & aAppOnDate.ReasonDescription)
else
  Profile.MsgBox("aAppointments.Count = 0")
end if

Note:

In Profile Client v8 on User Interface Occurrence Appointment can be found in Appointment Window > Booking.

Version information

Added in v7.8.0