Understanding Merge Fields

Last updated: 16 April 2026

Understanding Merge Fields

Merge fields are dynamic placeholders in documents and templates that are replaced with real data when the document is created or exported. They ensure documents are accurate and consistent without manual data entry.

How Merge Fields Work

  1. A merge field is inserted into a document or template using the @ trigger in the editor
  2. The field appears as a highlighted badge showing its name
  3. When the document is saved, exported, or printed, each field is resolved with the actual value from the patient record, practice details, or other context

Field Categories

Category Examples
Patient Demographics Title, First Name, Last Name, Date of Birth, NHS Number, Address, Phone, Email
Patient Activity Last appointment date, last consultation date
Patient Clinical Active problems, current medications, allergies
Practice Practice name, address, phone, email, website
Clinician Full name, title, GMC number, qualifications, contact details, signature
Appointment Date, time, type, clinician, location
Recipient GP name, organisation, specialty, address
System Current date, current time
Referral Service, specialty, priority, status, reason
Links Document sharing URL, patient portal link

Where Merge Fields Work

Merge fields can be used in:

  • Document content - the main body of any Jump document
  • Document templates - pre-inserted fields that resolve when a document is created from the template
  • Document headers and footers - limited to practice, clinician, and system fields

Inserting Merge Fields

In the document or template editor:

  1. Type @ to open the merge field autocomplete
  2. Browse categories or type to search
  3. Click a field to insert it

The merge field panel on the right sidebar of the template editor also allows you to browse and insert fields by clicking.

Validation

Before saving, the editor checks for merge fields that cannot be resolved (e.g. the patient has no NHS number on file). A validation banner highlights any issues, and a missing fields dialog prompts you to address them.

Tip: In templates, use merge fields from every relevant category. When the template is used to create a document, all fields will be resolved automatically from the patient and practice context.