ISAppointmentAddress.Suburb

Description

The suburb of the appointment address.

Syntax

object.Suburb

Part Attribute Type Description
object Required
The object always implements the ISAppointmentAddress interface
Restriction: This property is readonly.

Return Value

string

Example

Display the suburb of the appointment address.

Dim aPatient
Dim aProvider
Dim aFilter 
Dim aAppointments
Dim aFirstAppointment
Dim aApptAddress

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#

set aAppointments = Profile.LoadAppointments(aFilter)
if aAppointments.Count > 0 then
  set aFirstAppointment = aAppointments.Item(0)
  set aApptAddress = aFirstAppointment.Address
  if not aApptAddress is nothing then
    Profile.MsgBox(aApptAddress.Suburb)
  else
    Profile.MsgBox("App has no address")
  end if 
else
  Profile.MsgBox("aAppointments.Count = 0")
end if  
Note: Check the 'Show suburb line for AUS, CAN, NZL, UK, USA' box in Organisation/Preferences/Patient/Other tab.

In Profile Client v8 on User Interface Suburb can be found in Organisation > People&Places > POS > Suburb field.

Version information

Added in v7.9.2