How to Use Placeholders
Why Use This Function:
Placeholders save time by eliminating the need to manually enter repetitive Patient, Debtor, Practitioner, or Practice-related information, pulling pre-filled data from various sources within the GoodX system—such as Patient files, Debtor records, and booking details—to ensure consistency and reduce errors, while being inserted into templates and replaced with actual data when used, thus personalising communications for each Patient or entity.
This function helps you personalise communications quickly, maintain uniformity, and avoid manual data entry mistakes. If a linked field is empty, the placeholder will stay blank—always check your data sources.The Contents of This User Manual:
- Adding a Template with Placeholders
- Selecting and Inserting Placeholders
- Placeholder Categories Overview
- This user manual starts on the Workflow Event Templates screen.
Adding a Template with Placeholders
Create a new Workflow Event Template to start adding placeholders for automated data insertion.
- Click on the Choose event type to add template for... drop-down.
- Click on an option from the preloaded template list to select it as a Workflow Event.
- For an explanation of the events listed, please refer to the user manual: Workflow Event Template List.
- Click on the + Add template button to create the template.
- The Workflow Event Template screen will open.
Selecting and Inserting Placeholders
Insert placeholders into your template to auto-fill data like Patient names or booking times.
- Click on the Placeholders drop-down menu to view available options.
- Click on a placeholder (e.g. patient.fullname) to insert it into the template.
💡 Please Note: If the source field is empty, the placeholder will remain blank in the output.
- For a detailed explanation of placeholder usage, please refer to the user manual: Workflow Event Template: Event Template.
- To create new Workflow Event Templates, please refer to the user manual: Workflow Event Templates.
Placeholder Categories Overview
Placeholders are grouped by data type for easy selection, covering bookings, Debtors, and more.
- The Placeholders will be grouped in the following sections:
- Booking
- Debtor
- Employer/Employee
- Entity
- Hospital
- Invoice
- myGC
- Date and Time
- Patient
- Referring Doctor
- Service Centre
- Treating Doctor
- User
Booking
These placeholders pull data from the last booking on the Main Diary screen.
- An explanation for each Booking placeholder will be given:
- booking.start_date - Date of Booking (YYYY-MM-DD): Shows the booking date, e.g., 2025-09-16.
- booking.start_datetime - Date and Time of Booking: Displays date and time, e.g., 2025-09-16 12:40.
- booking.start_time - Time of Booking (HH:MM): Shows time, e.g., 12:40.
- booking.type - Booking Type: Indicates the booking purpose, e.g., consultation.
- booking.uuid - Booking UUID: Shows the system-generated booking ID.
- case.id - Case ID: Displays the hospital case number if applicable.
- ctx - Context Data: Pulls the full script code of Patient data and triggers.
- For more information, please refer to the user manual: Book Existing Patient.
Debtor
These placeholders use demographic data from the Debtor’s file.
- An explanation for each Debtor placeholder will be given:
- debtor.address - Debtor Full Address: Shows the complete physical address.
- debtor.address1 - Debtor Address 1st Line: Displays the street name and number.
- debtor.address2 - Debtor Address 2nd Line: Shows the suburb/city.
- debtor.address3 - Debtor Address 3rd Line: Displays the province/country.
- debtor.cellnr - Debtor Cellphone Number: Shows the mobile number (min. 10 digits).
- debtor.debtor_outstanding - Debtor Outstanding: Displays the total owed amount.
- debtor.email - Debtor Email Address: Shows the email address.
- debtor.filenumber - File Number: Displays the hardcopy file number.
- debtor.fullname - Debtor Name and Surname: Shows the full name.
- debtor.gender - Debtor Gender: Displays the medical gender.
- debtor.home_tel - Debtor Home Telephone Number: Shows the landline number.
- debtor.id - Debtor ID: Displays the account ID (e.g., DEB11).
- debtor.idnumber - Debtor ID Number: Shows the ID number (6-13 digits).
- debtor.idtype - Debtor ID Type: Displays the ID document type.
- debtor.initials - Debtor Initials: Shows the first letters of names.
- debtor.iod_date - Debtor Injury on Duty Date: Displays the IOD incident date.
- debtor.iod_description - IOD Description: Shows the injury details.
- debtor.language - Debtor Language: Displays the preferred language.
- debtor.last_visit_date - Last Visit Date: Shows the last visit date.
- debtor.ma_number - Debtor Medical Aid Number: Displays the medical aid number.
- debtor.ma_optioncode - Debtor Medical Aid Option Code: Shows the option code.
- debtor.ma_optionname - Debtor Medical Aid Option Name: Displays the plan name.
- debtor.ma_schemecode - Debtor Medical Aid Scheme Code: Shows the scheme code.
- debtor.ma_schemename - Debtor Medical Aid Scheme Name: Displays the scheme name.
- debtor.medical_aid_outstanding - Medical Aid Outstanding: Shows the medical aid owed amount.
- debtor.name - Debtor Name: Displays the first name.
- debtor.number - Debtor Number: Shows the account number.
- debtor.postaladdress - Debtor Full Postal Address: Displays the full postal address.
- debtor.postaladdress1 - Debtor Postal Address 1st Line: Shows the street/PO box.
- debtor.postaladdress2 - Debtor Postal Address 2nd Line: Displays the suburb.
- debtor.postaladdress3 - Debtor Postal Address 3rd Line: Shows the province/country.
- debtor.postalpostcode - Debtor Postal Address Post Code: Displays the postal code.
- debtor.postcode - Debtor Address Post Code: Shows the physical address postal code.
- debtor.surname - Debtor Surname: Displays the last name.
- debtor.title - Debtor Title: Shows the status or profession.
- 0ebtor.total_outstanding - Total Outstanding: Displays the total owed (Patient + Medical Aid).
- debtor.type - Debtor Type: Shows the billing type.
- debtor.worknr - Debtor Work Number: Displays the work telephone number.
- For more information, please refer to the user manual: Create New Debtor.
Employer/Employee
These placeholders use data from the Debtor’s file and employer details.
- An explanation for each Employer/Employee placeholder will be given:
- employer.address - Employee Full Address: Shows the employer’s full address.
- employer.address1 - Employee Address 1st Line: Displays the street name and number.
- employer.address2 - Employee Address 2nd Line: Shows the suburb/city.
- employer.address3 - Employee Address 3rd Line: Displays the province/country.
- employer.fax - Employer Fax: Shows the fax number.
- employer.id - Employee ID: Displays the employee ID number.
- employer.name - Employer Name: Shows the employer’s name.
- employer.postcode - Employee Address Post Code: Displays the postal code.
- employer.registration - Employee Registration: Shows the business registration number.
- For more information, please refer to the user manual: Create New Employer.
Entity
These placeholders use data from the Entity setup.
- An explanation for each Entity placeholder will be given:
- entity.account_name - Entity Account Name: Shows the registered entity name.
- entity.account_number - Entity Account Number: Displays the bank account number.
- entity.branch_code - Entity Branch Code: Shows the bank branch code.
- entity.branch_name - Entity Name: Displays the bank name.
- entity.dispencing_license - Entity Dispencing License: Shows the dispensing license number.
- entity.email_address - Entity Email Address: Displays the email address.
- entity.fax_number - Entity Fax Number: Shows the fax number.
- entity.postal_address1 - Entity Postal Address 1st Line: Displays the first line of the postal address.
- entity.postal_address2 - Entity Postal Address 2nd Line: Shows the suburb/city.
- entity.postal_address3 - Entity Postal Address 3rd Line: Displays the province/country.
- entity.postal_postcode - Entity Postal Address Post Code: Shows the postal code.
- entity.practice_name - Entity Practice Name: Displays the practice name.
- entity.practice_number - Entity Practice Number: Shows the BHF practice number.
- entity.registration_number - Entity Registration Number: Displays the business registration number.
- entity.street_address - Entity Full Street Address: Shows the full physical address.
- entity.street_address1 - Entity Street Address 1st Line: Displays the first line of the physical address.
- entity.street_address2 - Entity Street Address 2nd Line: Shows the suburb/city.
- entity.street_address3 - Entity Street Address 3rd Line: Displays the province/country.
- entity.street_postcode - Entity Street Address Post Code: Shows the physical address postal code.
- entity.telephone1 - Entity Telephone Number: Displays the main landline number.
- entity.telephone2 - Entity Telephone Number 2: Shows an alternative landline number.
- entity.vat_number - Entity VAT Number: Displays the VAT number if registered.
- entity.website - Entity Website Address: Shows the website URL.
- For more information, please refer to the user manual: Entity Setup.
Hospital
These placeholders use data from hospital case records.
- An explanation for each Hospital placeholder will be given:
- hospital_case.admission_date - Hospital Case Admission Date: Shows the admission date.
- hospital_case.admission_icd10 - Hospital Case Admission ICD10: Displays the admission ICD10 code.
- hospital_case.admission_time - Hospital Case Admission Time: Shows the admission time.
- hospital_case.case_number - Hospital Case Case Number: Displays the case number.
- hospital_case.discharge_date - Hospital Case Discharge Date: Shows the discharge date.
- hospital_case.discharge_icd10 - Hospital Case Discharge Date ICD10: Displays the discharge ICD10 code.
- hospital_case.discharge_time - Hospital Case Discharge Time: Shows the discharge time.
- For more information, please refer to the user manual: Hospital Case Management.
Invoice
These placeholders use data from the Account Details screen.
- An explanation for each Invoice placeholder will be given:
- invoice.id - Invoice ID: Shows the system-generated invoice number.
- invoice.invoice_amount - Invoice Amount: Displays the total invoice amount.
- invoice.med_outstanding - Medical Aid Outstanding: Shows the medical aid owed amount.
- invoice.pat_outstanding - Patient Outstanding: Displays the patient owed amount.
- invoice.to_outstanding - Invoice Total Outstanding: Shows the total owed amount.
- invoice.transaction_date - Transaction Date: Displays the service date.
- For more information, please refer to the user manual: Invoice Management.
myGC
These placeholders use data from Online Presence Settings.
- An explanation for each myGC placeholders will be given:
- mygc_booking_link - myGC URL: Shows the booking link.
- mygc_url - myGC URL: Displays the practice myGC link.
- For more information, please refer to the user manual: myGC Setup.
Date and Time
These placeholders use the system’s current date and time.
- An explanation for each Date and Time placeholder will be given:
- now - Current Date and Time: Shows the current date and time, e.g., 2025-09-16 12:40.
- now.date - Current Date: Displays today’s date, e.g., 2025-09-16.
- now.time - Current Time: Shows the current time, e.g., 12:40.
- For more information, please refer to the user manual: Date and Time Settings.
Patient
These placeholders use data from the Patient’s file.
- An explanation for each Patient placeholder will be given:
- patient.address - Patient Address: Shows the full physical address.
- patient.address1 - Patient Address 1st Line: Displays the street name and number.
- patient.address2 - Patient Address 2nd Line: Shows the suburb/city.
- patient.address3 - Patient Address 3rd Line: Displays the province.
- patient.address4 - Patient Address 4th Line: Shows the country.
- patient.age - Patient Age: Displays the current age in years.
- patient.cellnr - Patient Cellphone Number: Shows the mobile number (min. 10 digits).
- patient.dateofbirth - Patient Date of Birth: Displays the birth date, e.g., 1990-05-12.
- patient.debpasnr - Patient DebPasNr: Shows the debtor patient number.
- patient.dependant_nr - Patient Dependent Nr: Displays the dependant number.
- patient.email - Patient Email Address: Shows the email address.
- patient.fullname - Patient Fullname: Displays the full name.
- patient.gc_id - Patient Grand Central ID: Shows the myGC ID.
- patient.gender - Patient Gender: Displays the medical gender.
- patient.id - Patient ID: Shows the system-generated ID.
- patient.idnumber - Patient ID Number: Displays the official ID number.
- patient.idtype - Patient ID Type: Shows the ID document type.
- patient.initials - Patient Initials: Displays the initials.
- patient.name - Patient Name: Shows the first name.
- patient.postcode - Patient Address Post Code: Displays the postal code.
- patient.surname - Patient Surname: Shows the last name.
- patient.title - Patient Title: Displays the status or profession.
- patient.type - Patient Type: Shows the relation to the account (e.g., main member).
- For more information, please refer to the user manual: Add New Dependants.
Referring Doctor
These placeholders use data from the referring practitioner’s details.
- An explanation for each Referring Doctor placeholder will be given:
- referring_doc.address - Referring Doctor Address: Shows the physical address.
- referring_doc.cell - Referring Doctor Cellphone Number: Displays the mobile number.
- referring_doc.email - Referring Doctor Email: Shows the email address.
- referring_doc.fullname - Referring Doctor Fullname: Displays the full name.
- referring_doc.id - Referring Doctor ID: Shows the system ID.
- referring_doc.initials - Referring Doctor Initials: Displays the initials.
- referring_doc.pens - Referring Doctor Practice Nr: Shows the BHF practice number.
- referring_doc.postcode - Referring Doctor Post Code: Displays the postal code.
- referring_doc.qualification - Referring Doctor Qualification: Shows the university qualification.
- referring_doc.samdc - Referring Doctor South African Medical and Dental Council Nr: Displays the HPCSA number.
- referring_doc.surname - Referring Doctor Surname: Shows the last name.
- referring_doc.tel - Telephone Number: Displays the landline number.
- For more information, please refer to the user manual: Add a Referring Doctor.
Service Centre
These placeholders use data from the Service Centre setup.
- An explanation for each Service Centre placeholder will be given:
- service_center - Service Center Name: Shows the default service centre name.
- service_center.address - Service Center Full Address: Displays the full physical address.
- service_center.address1 - Service Center Address 1st Line: Shows the street name and number.
- service_center.address2 - Service Center Address 2nd Line: Displays the suburb/city.
- service_center.address3 - Service Center Address 3rd Line: Shows the province/country.
- service_center.id - Service Center ID: Displays the unique ID.
- service_center.postcode - Service Center Address Post Code: Shows the postal code.
- service_center.telephone - Service Center Telephone Number: Displays the contact number.
- For more information, please refer to the user manual: Create a Service Centre.
Treating Doctor
These placeholders use data from the treating practitioner’s details.
- An explanation for each Treating Doctor placeholder will be given:
- treating_doc.address - Treating Doctor Address: Shows the physical address.
- treating_doc.cell - Treating Doctor Cellphone Number: Displays the mobile number.
- treating_doc.email - Treating Doctor Email Address: Shows the email address.
- treating_doc.fullname - Treating Doctor Fullname: Displays the full name.
- treating_doc.id - Treating Doctor ID: Shows the system ID.
- treating_doc.initials - Treating Doctor Initials: Displays the initials.
- treating_doc.pcns - Treating Doctor Practice Nr: Shows the BHF practice number.
- treating_doc.postcode - Treating Doctor Post Code: Displays the postal code.
- treating_doc.qualification - Treating Doctor Qualification: Shows the university qualification.
- treating_doc.samdc - Treating Doctor South African Medical and Dental Council number: Displays the HPCSA number.
- treating_doc.speccode - Treating Doctor Specialist Code: Shows the speciality code (e.g., 014).
- treating_doc.surname - Treating Doctor Surname: Displays the last name.
- treating_doc.tel - Treating Doctor Telephone Number: Shows the landline number.
- treatment_date - Treatment Date: Displays the last treatment date.
- For more information, please refer to the user manual: List of Doctors.
User
These placeholders use data from the User Management settings.
- An explanation for each User placeholder will be given:
- user.fullname - User Fullname: Shows the full name of the logged-in user.
- user.name - User First Name: Displays the first name.
- user.surname - User Surname: Shows the last name.
- user.username - Username: Displays the login credentials.
- For more information, please refer to the user manual: User Management.