What is the context?
Patient Template Codes query Patient Demographic datils, incl. Employer details and can be used in document Templates, Email Templates, Structured Templates and automated messages.
Some Patient Template Codes can also be used in Online Portal email templates and structured templates.
What is the purpose of the article?
This article outlines the different codes that can be used to include Patient information in templates located in Admin > Configuration > Online Portal
List of template codes for Patient supported in Online Portal templates and a related description
Below is a list of template codes for patients and an associated description for each item. These codes can be used in Online Portal templates.
To help match them to what you see in the Meddbase application, they have been grouped into sections.
These sections are similar to those shown in the Personal Details screen for the patient.
Code |
Details |
---|---|
Personal Details template codes |
|
{Patient.Title} |
Patient's Title |
{Patient.FullName} |
Patient's Full Name |
{Patient.FirstName} |
Patient's First Name |
{Patient.Surname} |
Patient's Surname |
{Patient.FirstNameInitial} |
Patient's First Name Initial, e.g. 'J.' for 'John' |
{Patient.SurnameInitial} |
Patient's Surname Initial, e.g. 'S.' for 'Smith' |
{Patient.InitialsOnly} |
Patient's Initials, e.g. 'J.S.' for 'John Smith' |
{Patient.TitleInitials} |
Patient's Title and Initials, e.g. 'Mr. J.S.' for 'Mr. John Smith' |
{Patient.TitleInitialsSurname} |
Patient's Title, First Name Initial and Surname, e.g. 'Mr. J. Smith' for 'Mr. John Smith' |
{Patient.Sex} |
Patient's Sex
[Note: When Using this Template Code for a condition in a Structured Template for conditions of "Male" or "Female", please copy the following conditions as the formatting is very specific due to spacing: Patient.Sex="Male " Patient.Sex="Female " ] |
{Patient.Dob} |
Patient's Date Of Birth |
{Patient.Age} |
Patient's Age |
{Patient.Status} |
Status Type - i.e. In Patient, Discharged etc. |
{Patient.Referrer} |
Patient's Referrer |
Patient Contact Info template codes |
|
{Patient.HomePhone} |
Patient's Home Phone |
{Patient.WorkPhone} |
Patient's Work Number |
{Patient.Mobile} |
Patient's Mobile Number |
{Patient.Email} |
Patient's Email Address |
Patient Home Address & Billing Address template codes |
|
{Patient.HomeAddress} {Patient.HomeAddressOneLine} |
Full Home Address of patient Displays the home address of the patient on one line |
{Patient.BillingAddress} {Patient.BillingAddressOneLine} |
Full Billing Address of patient Displays the billing address of the patient on one line |
Patient Next of Kin template codes |
|
{Patient.NokName} |
Next Of Kin Name |
{Patient.NokPhone} |
Next Of Kin Phone Number |
{Patient.NokRelationship} |
Next Of Kin Relationship |
{Patient.NokAddress} |
Next of Kin Address |
Patient Specialist / GP template codes | |
{Patient.Gp} |
Patient GP's ID |
{Patient.Gp.FullName} |
Default Doctor Name [not NHS] |
{Patient.Gp.Surname} |
Default Doctor Surname Only [not NHS] |
{Patient.Gp.HomeAddress} {Patient.Gp.HomeAddressOneLine} |
Patient's GP Address Displays the address on one line |
{Patient.Specialist} |
Patient Specialist's ID |
Patient NHS details template codes |
|
{Patient.NhsNumber} |
NHS Number |
{Patient.NhsSurgery} |
NHS Surgery Name |
{Patient.NhsGpName} |
NHS GP Name |
{Patient.NhsSurgeryPhone} |
NHS Surgery Phone Number |
{Patient.NhsSurgeryAddress} |
NHS Surgery Full Address |
{Patient.NhsSurgeryAddressOneLine} |
NHS Address 1 line |
Patient Insurance template codes |
|
{Patient.Insurer} |
Patient's Insurance Company |
{Patient.InsuranceMemberNo} |
Patient's Insurance Company Member Number |
{Patient.InsurerContactName} |
Patient's Insurer Contact |
{Patient.InsurerContactTitle} |
Patient's Insurer Contact Title |
{Patient.InsurerContactDetails} |
Patient's Insurer Details |
{Patient.InsurerContactAddress} |
Patient's Insurer Address |
{Patient.InsurerContactAddressOneLine} |
Insurers Contact Address 1 Line |
{Patient.InsurerContactPhone} |
Patient's Insurer Phone Number |
Patient Employer template codes |
|
{Patient.Employer} |
Patient's Employer |
{Patient.EmployerObject} |
Patient's Employer Company ID |
{Patient.EmployeeNo} |
Patient's Employee Number |
{Patient.EmployerContactName} |
Employer Contact Name |
{Patient.EmployerContactTitle} |
Employer Contact Title |
{Patient.EmployerContactDetails} |
Employer Contact Details |
{Patient.EmployerContactAddress} |
Employer Contact Address |
{Patient.EmployerContactAddressOneLine} |
Employer Contact Address 1 Line |
{Patient.EmployerContactPhone} |
Employer Phone Number |
Further patient related template codes |
|
{Patient.LastAppointmentDate} |
Last Appointment Date |
{Patient.Id} |
The patient's unique Meddbase identification number. |
List of Online Portal templates where Patient Demographic and Patient Employer template codes can be used
Below is a list of templates where Patient template codes, e.g. {Patient.FullName} and Patient Employer template codes, e.g. {Patient.Employer} listed above can be used
Template | Location | Email trigger(s) |
Patient portal templates | ||
Registration email template | Admin > Configuration > Online Portal > Patient portal templates |
|
Reset blocked user email template | Admin > Configuration > Online Portal > Patient portal templates |
|
Reset password email template | Admin > Configuration > Online Portal > Patient portal templates |
|
Unknown email address |
Admin > Configuration > Online Portal > Patient portal templates |
|
Password manual change email template | Admin > Configuration > Online Portal > Patient portal templates |
|
New shared items email template | Admin > Configuration > Online Portal > Patient portal templates |
|
Occupational health portal templates | ||
Registration email template | Admin > Configuration > Online Portal > Occupational health portal templates |
|
Reset blocked user email template | Admin > Configuration > Online Portal > Occupational health portal templates |
|
Password reset email template | Admin > Configuration > Online Portal > Occupational health portal templates |
|
Unknown email address | Admin > Configuration > Online Portal > Occupational health portal templates |
|
Password change email template | Admin > Configuration > Online Portal > Occupational health portal templates |
|
Pre-placement questionnaire | ||
Request email template | Admin > Configuration > Online Portal > Pre-placement questionnaire |
|
Structured Online Portal templates where Patient Demographic and Patient Employer template codes can be used
For any of the email templates listed above, Meddbase allows using Structured Templates where the listed Template Codes can be used to set conditions for sections of the structured template.
These conditions allow including or excluding the respective section of the structured template from the email depending on whether the condition was met or not.
E.g.:
A Structured Email Template containing 2 sections (templates inserted into the Structured Template) is used to send a password reset email, and the message should display either section 1 or 2 depending on who the patient's employer is.
The templates inserted are:
- Template 1 - a template containing instructions for password reset and Employer 1 logo
- Template 2 - a template containing instructions for password reset and Employer 2 logo
The conditions may look like this:
Template | Condition |
Template 1 | Patient.Employer = "Employer 1" |
Template 2 | Patient.Employer = "Employer 2" |
[Click on the below image to enlarge]
Click here for full details on Structured Templates and setting conditions.
Review date
This article was last updated on 12th of April 2023 in the context of Meddbase version 1.266.1.17349