Variables for use in letter, message and encounter templates

🎞️ View video tutorial: Adding variables to letter, message, and encounter templates

You can add the following variables to your letter, message, and encounter templates. These variables pull data from various parts of your clinic's CHR domain and patient charts and populate the templates.

The available data variables are:

Patient data. For example, you could bring in the patient's age or smoking status.
Chart data. For example, you could bring in all of the patient’s surgical history or medication list.
Appointment. For example, you could bring in the appointment date.
Pronouns make it easier to have pre-configured sentences with correct grammar, for example, I saw “him”. For more information, refer to Patient preferred pronouns.
Contacts. For example, Contact Full Name pulls in a letter recipient's name.

Patient and chart variables are similar; patient data variables are linked with a specific data point and chart variables are linked to an entire chart section. For example, a patient data variable can be linked to the field Number of Cigarettes Per Day in the patient’s social history, and only pull in the number of cigarettes, while a chart variable can be linked to Social History and pull in the entire social history.

Variables specific to letter templates:

Variables	Description
Contact Title	Letter recipient's title.
Contact Full Name	Letter recipient's full name (first and last name).
Contact First Name	Letter recipient's first name.
Contact Last Name	Letter recipient's last name.
Contact Billing Number	Letter recipient's billing number.
Contact Phone Number	Letter recipient's phone number.
Contact Fax Number	Letter recipient's fax number.
Contact Full Address	Letter recipient's facility address.
Facility Phone Number	Letter recipient's facility phone number.
Facility Fax Number	Letter recipient's facility fax number.

Variables specific to letter, message, and encounter templates:

Variables	Description
He/She/They/Sie/Zie Him/Her/Them/Sir/Zim His/Her/Their/Hir/Zir Himself/Herself/Themself/ Hirself/ Zirself	Gender Identity under Patient demographics.

Allergies	Allergies in the patient chart. It appears in a table format with the columns: Name, Status, Reaction, Other Reaction, Reported by, and Comments.
Medications Table	Active Medications in the patient chart. It appears in a list format: Name, Dose, Start at.
Medications List	Active Medication in the patient chart. It appears in a list format: Name of medication, Dose, Route, Frequency, and Duration.
Injections	Injections in the patient chart. It appears in a table format with columns: Name, Dose, Date Administered.
Goals of Care	Health Profile > Goals of Care in the patient chart. It appears in a table format with columns: Goal and Status; and list format: Advanced Directives, Organ or Tissue Donation, Notes.
Medical Conditions Table	Health Profile > Medical History in the patient chart. It appears in a table format with columns: Diagnosis, Status, Onset Date
Surgical History Table	Health Profile > Surgical History in the patient chart. It appears in a table format with columns: Procedures and Procedure Date.
Family History Table	Health Profile > Family History in the patient chart. It appears in a table format with columns: Diagnoses, Life Stage, Start Date, Age at Onset, Treatment, Relationship.
Social History Table	Health Profile > Social History in the patient chart. It appears in a table format with columns: Type, Life Stage, Start Date, End Date, Age of Onset.
Risk Factors Table	Health Profile > Risk Factors in the patient chart. It appears in a table format with columns: Risk Factor, Life Stage, Start date.
Health Profile List	Displays Medical Conditions, Surgical History, Family History, Social History, Risk Factors, Obstetrical care (past) or Obstetrical care (current) as a list instead of a table. After clicking the variable name, select the Category and choose to view the data with or without notes. 📌 Note: The Obstetrical care (past) variable inserts the values in one line, separated by commas. 💡 Tip: You can easily change the information in the list without affecting the patient chart data.
Obstetrical Care Table	Health Profile > Obstetrical Care > Past pregnancies in the patient chart. It appears in a table format with columns: Delivery date, Place, Final GA, Labour duration, Delivery type, Notes/Complications. 💡 Tip: Click in the table to edit the data. Any changes you make are reflected in the patient's Health Profile.

Appointment Practitioner	When you click on this variable, you can select from a list of all appointments made for the specific patient. Once selected, it populates the appointment practitioner. 📌 Note: If you use the appointment date and time variables, they will also automatically populate.
Appointment Start Time	When you click on this variable, the user can select from a list of all appointments made for the specific patient. Once selected, it populates the appointment start time. 📌 Note: If you use the appointment practitioner and date variables, they will also automatically populate.
Appointment Date	When you click on this variable, you can select from a list of all appointments made for the specific patient. Once selected, it populates the appointment date. 📌 Note: If you use the appointment practitioner and time variables, they will also automatically populate.

Add Patient Data Variable	Custom patient data in the patient chart. This variable appears as a blue bubble in the template. 📌 Note: You must configure the variable to pull specific items: Category, Data Property, Visible Data, Sentence Prefix and/or Sentence Suffix. For more information, refer to Adding data variables to letter, message and encounter templates.
Add Health Profile Variable	This variable appears as a blue bubble in the template and pulls data from the Health Profile > Social History and Health Profile > Obstetrical Care. You must choose the category (social history or obstetrical care), variable, and data point. For example, Social history record > Smoking > Number of cigarettes per day. For more information, refer to Adding data variables to letter, message and encounter templates.
Add Lab Result Variable	This variable appears as a green bubble in the template and pulls data from the Lab Results section of the patient chart. Select the desired lab from the Lab Result field. 💡 Tip: You must have the lab result in at least one patient chart for it to show in the list. For more information, refer to Adding data variables to letter, message and encounter templates.
Add Instant Variable	This variable appears as a pink bubble in the template. For more information, refer to Adding instant variables in message, letter, and encounter templates.

Updated November 29, 2024