Variables
Using Variables in HIPAAtizer
HIPAAtizer supports the use of variables to dynamically insert values into various parts of your form ecosystem, including:
- Web forms
- Printable forms
- Success pages
- Notification emails
- Webhooks
- Secure messages
- External integrations
Form Variables
When you add a component to a form, its Unique Name automatically becomes a form variable. These variables represent the values entered by the user during form submission.
A component with the Unique Name firstName can be used as a variable:
${firstName} → renders the value the user entered in that field.
You can use form variables inside Paragraphs or Checkboxes to dynamically display information on the form.
For example, including ${date-today} in a paragraph will render the current date during preview and when the form is filled out.
You can insert any available variable, including:
- System variables like
${date-today} - Component variables based on Unique Names, such as
${firstName}or${appointmentDate}
Extended Variables
Some components expose additional sub-fields through extended variables. For example:
Address Component Variables
${address}- full address string${address.street}${address.streetNumber}${address.streetName}${address.street2}${address.city}${address.state}${address.zipcode}${address.country}
Use clear and unique component names to avoid confusion when referencing variables.
Entry Grid (Repeatable Table) Variables
An Entry Grid lets the user add multiple rows, so each field is referenced once per row. Combine the grid's Unique Name Prefix, the row index, and the component's Unique Name:
${<prefix>.<rowIndex>.<componentName>}
The row index starts at 0. For an Entry Grid whose Unique Name Prefix is medications, containing a component named medication_name, the first three rows are:
${medications.0.medication_name}${medications.1.medication_name}${medications.2.medication_name}
Rows beyond the grid's Max Rows setting can never be filled, so you only need to reference indexes up to that maximum.
In a Question & Answer table, each question is its own Single Choice or Multiple Choice component with its own Unique Name. Reference those components directly, with no prefix and no row index, exactly like any other form variable. To reference whether a specific option was selected, use the option composite ${<componentName>=<optionValue>}.
Built-in Form Variables
These variables are either always available or conditionally available based on form configuration or submission status.
Some variables (like ${submissionId}) are only available after the form is partially or fully submitted.
| Variable Name | Syntax | Description |
|---|---|---|
| Form Name | ${form-name} | The name of the current form. |
| Increment | ${increment} | A unique auto-incremented ID for the submission. ¹ |
| Location Title | ${locationTitle} | The title of the selected form location. ² |
| Location Address | ${locationAddress} | The full address of the selected location. ² |
| Location Email | ${locationEmail} | Email address associated with the location. ² |
| Location Phone | ${locationPhone} | Phone number associated with the location. ² |
| Submission ID | ${submissionId} | Unique ID for the current submission. ¹ |
| Form Submission Limit | ${form-submission-limit} | The maximum number of allowed submissions. ³ |
Annotations
- [¹] Available only after the submission is partially or fully completed.
- [²] Available if the form or submission is associated with a location.
- [³] Available only if a submission limit is enabled for the form.
System Variables
HIPAAtizer also provides predefined system variables, grouped by context. These are automatically populated and do not require user input.
📂 Profile Variables
| Variable Name | Syntax | Description |
|---|---|---|
| Profile Business Name | ${profile-business-name} | The organization or business name. |
| Profile Business Address | ${profile-business-address} | Primary address line 1. |
| Profile Business Address 2 | ${profile-business-address2} | Secondary address line 2. |
| Profile Business City | ${profile-business-city} | Business city. |
| Profile Business State | ${profile-business-state} | Business state or province. |
| Profile Business Zip | ${profile-business-zip} | Postal/ZIP code. |
| Profile Business Phone | ${profile-business-phone} | Business phone number. |
| Profile Business Fax | ${profile-business-fax} | Business fax number. |
| Profile Business Email | ${profile-business-email} | Contact email for the business. |
📅 Date Variables
| Variable Name | Syntax | Description |
|---|---|---|
| Date Today | ${date-today} | Renders the current date. |
| YYMMDDHHMMSS | ${YYMMDDHHMMSS} | Compact date-time stamp (e.g., 240528153022). |
| MMDDYYHHMMSS | ${MMDDYYHHMMSS} | Alternative compact date-time format. |
| DDMMYYHHMMSS | ${DDMMYYHHMMSS} | Alternative compact date-time format. |
| MM-DD-YYYY | ${MM-DD-YYYY} | Date in dash-separated format. |
| MM.dd.yyyy HH.mm | ${MM_DD_YYYY_HH_mm} | Date-time in dot-separated format. |
| Previous Year | ${previousYear} | Last calendar year (e.g., 2024). |
| Time Now | ${time-now} | Current time only (e.g., 03:30 PM). |
| Submission Created Date | ${submission-created-date} | Date the submission was initially started. |
🔗 Link Variables
| Variable Name | Syntax | Description |
|---|---|---|
| View Submission Link | ${viewSubmissionLink} | Opens the submitted form in view mode. ⁴ |
| Edit Submission Link | ${editSubmissionLink} | Link to edit the current submission. ⁴ |
| Download PDF Link | ${downloadPdfLink} | Direct download link to the submission PDF. ⁴ |
| Download Access Log Link | ${downloadAccessLogLink} | PDF link to access history (who opened the form). ⁴ |
| Download Merged PDF Link | ${downloadMergedPdfLink} | PDF with merged forms in packets (if applicable). ⁴ |
| Download CSV Link | ${downloadCsvLink} | Submission data as CSV. ⁴ |
| Download Merged CSV Link | ${downloadMergedCsvLink} | Packet data exported as a single CSV. ⁴ |
| Download Attachments Link | ${downloadAttachmentsLink} | ZIP of all uploaded files from the submission. ⁴ |
| Next Step Link | ${nextStepLink} | URL to the next workflow step. ⁵ |
| Notification Template Settings Link | ${formSettingsNotificationTemplateLink} | Link to notification template settings in the form builder. ⁴ |
| Submissions Filtered Table Link | ${submissionsFilteredTableLink} | Pre-filtered link to view submissions in the dashboard. ⁴ |
| Current Workflow URL | ${currentWorkflowLink} | URL of the current workflow step. ⁵ |
Annotations