Appointment reminder merge fields
Merge fields are system defined words that begin and end with 2 carats (^^). They are used in reminder templates and they are the way diarybook personalises a reminder message for an appointment.
For example: ^^name^^ is a merge field representing the client’s first name.
The data for merge fields comes from
- the appointment
- the client
- the user
- the location
- additional sync fields
Appointment
These fields take information from the appointment
| Field | Information | Example |
|---|---|---|
| ^^time^^ | The start time | 14:30 |
| ^^date^^ | The date | 12/07/2023 |
| ^^dayname^^ | The name of the day | Thursday |
| ^^monthname^^ | The name of the month | July |
| ^^day^^ | The day of the month with an ordinal indicator | 12th |
| ^^year^^ | The year | 2023 |
| ^^procedure^^ | The public name of the appointment type. Only the first if more than one. | Blood test |
| ^^resource^^ | The public name of the resource. Only the first if more than one. | Room 1D |
| ^^datemade^^ | The date the appointment was added to diarybook |
Client
These fields take information from the client associated with the appointment and to whom the reminder is being sent
| Field | Information | Example |
|---|---|---|
| ^^first^^ or ^^name^^ | The first name | John |
| ^^last^^ | The last name | Smyth |
| ^^fullname^^ | The full name | John Smyth |
| ^^hifirst^^ | If a first name exists will put Hi followed by the name | Hi John |
| ^^dearfirst^^ | If a first name exists will put Dear followed by the name | Dear John |
| ^^email^^ | The email address | john.smyth@$$diarybook$$.net |
| ^^address1^^ | The first line of address for letter templates | |
| ^^address2^^ | The second line of address | |
| ^^address3^^ | The third line of address | |
| ^^address4^^ | The fourth line of address | |
| ^^address5^^ | The fifth line of address | |
| ^^id^^ | The patient number or id |
User
These fields take information from the service provider ( diarybook user) that is fulfilling the appointment
| Field | Information | Example |
|---|---|---|
| ^^user_first^^ | The first name | Paul |
| ^^user_last^^ | The last name | Pokealot |
| ^^user_email^^ | The email address | paul.pokealot@$$diarybook$$.net |
| ^^user_phone^^ | The phone number |
Location
These fields take information from the location record that is assigned to the reminder setting
| Field | Information | Example |
|---|---|---|
| ^^loc_name^^ | The location name | Building A Wellstown |
| ^^loc_contact^^ | The contact name | Dr Paul Pokealot |
| ^^loc_email^^ | The contact email address | |
| ^^loc_phone^^ | The contact phone number | |
| ^^loc_address1^^ | The location address | |
| ^^loc_address2^^ | ||
| ^^loc_address3^^ | ||
| ^^loc_address4^^ | ||
| ^^loc_address5^^ | ||
| ^^loc_directions | The directions to the location | |
| ^^loc_map^^ | A rendering of the map and pin | Email reminders only |
Sync fields
Sync fields are additional information that can be given to diarybook for each appointment. This only happens in integrated systems and they can contain any text relating to any other aspect of the appointment.
| Field |
|---|
| ^^syncfield1^^ |
| ^^syncfield2^^ |
| ^^syncfield3^^ |
| ^^syncfield4^^ |
| ^^syncfield5^^ |
| ^^syncfield6^^ |