Letter Template Tags

Letter templates in HealthTrack support a tag system that automatically inserts patient, booking, clinical, and practice data into your documents. Tags are inserted into the body of a letter template and replaced with live data when the letter is created.

If you cannot find the tag you need, contact HealthTrack support.


Tag Structure

A standard tag has up to four components. All components are separated by hyphens.

All tags are case sensitive.

  1. Tag markers

    • Standard tags use <HMS-…>.
    • Barcode tags use <HMSBC-…> or <HMSBC417-…>.
    • PDF tags use <<…>>.
    • Request tags (used only in PDF-based request forms) have no marker.

  1. Data Source

The first component after the marker identifies where the data comes from. An underscore _ separates the source from the field name.

Source Data pulled from
Patient Currently selected patient.
ReferringDoctor Doctor from a selected referral - requires input prompt.
Booking A selected booking - requires input prompt.
MO Doctor from a selected booking - requires input prompt.
User The currently logged-in user.
Location Location from a selected booking - requires input prompt.
Document_ReferenceDate The document's reference date.
Document_Filename The document's server-based filename.

  1. Field Name

The field name specifies the piece of data to return. For example, you could use <HMS-Patient_Surname> to retrieve the current patient’s surname directly from the patient record’s surname field.

  • Table field names must have the first letter of the field name capitalised.
  • A hyphen after the field name is required only if you are adding a formatting component.

  1. Formatting (Optional)

An optional fourth component controls how the returned value is displayed.

Format Result
Title First letter capitalised, rest lower case. e.g. Robert
Initial Returns the first letter only.
Upper All letters upper-case. e.g. ROBERT
Lower All letters lower-case. e.g. robert
Date_Short Short date format. e.g. 01/06/2006
Date_Long Long date format. e.g. 1 June 2006
Custom Custom date/number formatting - see Advanced Formatting below.

Advanced Formatting

The Custom format lets you control date/time display patterns and number formatting. Use CustomEx to output fallback text when no data is available.


Example - custom date format: <HMS-Document_ReferenceDate-Custom-[[0:d MMMM yyyy]]>

Returns: 25 January 2008

Tag Result
<HMS-Document_ReferenceDate-Custom-[[ 0:d MMMM yyyy ]]> 25 January 2008
<HMS-Document_ReferenceDate-Custom-[[0:ddd d/MM/yyyy]]> Wed 25/01/2008
<HMS-Document_ReferenceDate-Custom-[[0:dddd dd MMM yy]]> Wednesday 07 Jan 08
<HMS-Patient_DVA-Custom-[DVA [0]]> DVA QX34907 (or blank if no DVA number)
<HMS-Patient_DVA-CustomEx-[No DVA number]> "No DVA number" if the patient has no DVA number
<HMSBC417-Patient_ID-Custom-[+/BC[0]/S20]> PDF417 barcode for HIBC scanning (S20 must match a document category)

Example - referral fallback (CustomEx):

<HMS-ReferringDoctor_Surname-CustomEx-[ your fallback text here ]>

If no referral is attached to the letter, the fallback text is inserted instead. The letter cannot be zero-length, so must contain other content.


Checking and repairing tags

Because tags are typed straight into the template body as text, and there is no insert-a-tag picker, a small typing mistake can stop a tag from filling. When a tag does not resolve, HealthTrack leaves the tag text in the finished letter instead of replacing it with data. A stray tag such as <HMS-Patient_Surname> showing in a letter is the usual sign that something is wrong with the tag.

Preview a template before you use it

Before you rely on a template, use the template preview in Admin > Letter Template Manager, to fill it with sample data. The preview shows which tags resolve and which are left unfilled, so you can find a broken tag without creating a real letter.


Why a tag does not fill

Work through these causes if a tag stays as text in the finished letter:

  • A typo in the tag. Check the tag name letter for letter against the tables below. Tags are case sensitive, the parts of a tag are separated by hyphens, and an underscore separates the source from the field name (for example <HMS-Patient_Surname>).
  • A table field name that is not capitalised. Field names taken from a table must start with a capital letter (see Field Name above).
  • The tag needs data that was not selected. Some sources only fill when the matching record is chosen at letter creation. For example, referral and referring-doctor tags stay blank if no referral is attached, and booking tags stay blank if no booking is selected. Select the relevant Additional Information Prompts on the template in Admin > Letter Template Manager so the user is asked to choose the record. To show fallback text when there is no data, use the CustomEx format (see Advanced Formatting above).

If a tag is spelled correctly and still will not fill, the field may hold no data for that patient, or the tag may not be available for the type of document you are creating (see PDF Tags and Request Tags for the limited sets those documents support). If you cannot find or fix the tag you need, contact HealthTrack support.

Standard Tags


Patient Tags

Populated from the patient's Demographic tab.

Tag Description
<HMS-Patient_FormattedName> Formatted name with title, given name, middle initials, and family name. e.g. Mr Ian J. Rutherford
<HMS-Patient_Title> Patient’s title.
<HMS-Patient_Firstname> Patient’s given name.
<HMS-Patient_FirstName> Patient’s given name.
<HMS-Patient_KnownAs> Patient’s preferred name.
<HMS-Patient_Initials> Patient’s middle initial/s.
<HMS-Patient_Surname> Patient’s family name.
<HMS-Patient_DOB> Date of birth (dd/mm/yyyy).
<HMS-Patient_Age> Patient’s age.
<HMS-Patient_MRN> Patient’s MRN.
<HMS-Patient_ID> Patient’s HealthTrack patient ID.
<HMS-Patient_Sex> Patient’s sex (“M”, “F”, etc.).
<HMS-Patient_SexFull> Patient’s sex in full (“male”, “female”, etc.).
<HMS-Patient_Gender> Patient’s gender (“Man”, “Woman”, “Non-Binary”, etc.).
<HMS-Patient_GenderFull> Patient’s gender in full.
<HMS-Patient_Pronouns> Patient’s preferred pronouns.
<HMS-Patient_Medicare> Medicare number.
<HMS-Patient_MedicareRefNo> Medicare reference number.
<HMS-Patient_MediExpYYYY> Medicare expiry year.
<HMS-Patient_MediExpMM> Medicare expiry month.
<HMS-Patient_DVA> DVA number.
<HMS-Patient_PensionNumber> Pension number.
<HMS-Patient_HFundName> Health fund name.
<HMS-Patient_FundNumber> Health fund number.
<HMS-Patient_FundUPI> Health fund UPI number.
<HMS-Patient_FundExpYYYY> Health fund expiry year.
<HMS-Patient_FundExpMM> Health fund expiry month.
<HMS-Patient_NHI> NHI number (NZ only).
<HMS-Patient_FormattedAddress> Street address, suburb/city, state, postcode.
<HMS-Patient_Address> Street address lines on one line.
<HMS-Patient_Address_L1> Street address on one line.
<HMS-Patient_Address_L2> Street address on two lines.
<HMS-Patient_Address1> First street address line.
<HMS-Patient_Address2> Second street address line.
<HMS-Patient_Suburb> Suburb.
<HMS-Patient_City> City (NZ only).
<HMS-Patient_Postcode> Postcode.
<HMS-Patient_State> State (e.g. “QLD”, “NSW”).
<HMS-Patient_Country> Country.
<HMS-Patient_AddressMail_L1> Mailing address on one line.
<HMS-Patient_AddressMail_L2> Mailing address on two lines.
<HMS-Patient_Address1Mail> First mailing address line.
<HMS-Patient_Address2Mail> Second mailing address line.
<HMS-Patient_SuburbMail> Mailing suburb.
<HMS-Patient_CityMail> Mailing city (NZ only).
<HMS-Patient_PostcodeMail> Mailing postcode.
<HMS-Patient_StateMail> Mailing state.
<HMS-Patient_CountryMail> Mailing country.
<HMS-Patient_PatientPreferredPhone> Preferred phone number.
<HMS-Patient_HomePhone> Home phone number.
<HMS-Patient_WorkPhone> Work phone number.
<HMS-Patient_Mobile> Mobile phone number.
<HMS-Patient_Email> Email address.
<HMS-Patient_JobTitle> Job title.
<HMS-Patient_Occupation> Occupation.
<HMS-Patient_CompanyName> Name of the company the patient works for.

Patient tags also work with the AccHolder_ prefix for account holder data. e.g. <HMS-AccHolder_FormattedName>.


Patient Company Details Tags

Populated from the Company record linked to the patient's Demographic tab.

Tag Description
<HMS-Patient_CompanyID> Company’s HealthTrack ID number.
<HMS-Patient_CompanyEmployeeScale> Company size / number of employees.
<HMS-Patient_CompanyABN> Company ABN.
<HMS-Patient_CompanyACN> Company ACN.
<HMS-Patient_CompanyIndustry> Industry (e.g. Construction).
<HMS-Patient_CompanyPhone> Company phone number.
<HMS-Patient_CompanyFax> Company fax number.
<HMS-Patient_CompanyParentCompany> Parent company name.
<HMS-Patient_CompanyAccountsPayableEmail> Accounts payable email address.
<HMS-Patient_Company_ContactDetails_Title> Contact person’s title.
<HMS-Patient_Company_ContactDetails_GivenName> Contact person’s given name.
<HMS-Patient_Company_ContactDetails_FamilyName> Contact person’s family name.
<HMS-Patient_Company_ContactDetails_Role> Contact person’s role.
<HMS-Patient_Company_ContactDetails_SubCompany> Contact person’s sub-company.
<HMS-Patient_Company_ContactDetails_Email> Contact person’s email address.
<HMS-Patient_Company_ContactDetails_Phone> Contact person’s phone number.
<HMS-Patient_Company_ContactDetails_Mobile> Contact person’s mobile number.
<HMS-Patient_Company_PrimaryAddress_Department> Primary address department.
<HMS-Patient_Company_PrimaryAddress_Address1> Primary address line 1.
<HMS-Patient_Company_PrimaryAddress_Address2> Primary address line 2.
<HMS-Patient_Company_PrimaryAddress_Suburb> Primary address suburb.
<HMS-Patient_Company_PrimaryAddress_Postcode> Primary address postcode.
<HMS-Patient_Company_PrimaryAddress_State> Primary address state.
<HMS-Patient_Company_PrimaryAddress_Country> Primary address country.
<HMS-Patient_Company_PostalAddress_Department> Postal address department.
<HMS-Patient_Company_PostalAddress_Address1> Postal address line 1.
<HMS-Patient_Company_PostalAddress_Address2> Postal address line 2.
<HMS-Patient_Company_PostalAddress_Suburb> Postal address suburb.
<HMS-Patient_Company_PostalAddress_Postcode> Postal address postcode.
<HMS-Patient_Company_PostalAddress_State> Postal address state.
<HMS-Patient_Company_PostalAddress_Country> Postal address country.

Patient Company Lung Screening Tags

Populated from the Lung Screening tab of the linked company record (Practice Wide > Companies).

Tag Description
<HMS-Patient_Company_LungScreening_ABNStatus> Company ABN/Employer Status.
<HMS-Patient_Company_LungScreening_CoCValidFrom> Certificate of Currency start date.
<HMS-Patient_Company_LungScreening_CoCValidTo> Certificate of Currency end date.
<HMS-Patient_Company_LungScreening_CompanyAccountCode> Company account code.
<HMS-Patient_Company_LungScreening_WorkersCompPolicyNumber> Workers Compensation Policy Number.
<HMS-Patient_Company_LungScreening_IndustryActivity> Industry activity.
<HMS-Patient_Company_LungScreening_IndustryHazardRisk> Industry hazard risk level.
<HMS-Patient_Company_LungScreening_HazardousDustType> Type/s of hazardous dust.
<HMS-Patient_Company_LungScreening_HazardousDustTypeOther> Other hazardous dusts.
<HMS-Patient_Company_LungScreening_PreferredScreeningFacility> Preferred lung screening facility.
<HMS-Patient_Company_LungScreening_PrimaryWICCode> Primary Workers Compensation Industry Classification.
<HMS-Patient_Company_LungScreening_SecondaryClassification> Secondary Workers Compensation Industry Classification.
<HMS-Patient_Company_LungScreening_Other> Other Workers Compensation Industry Classification.
<HMS-Patient_Company_LungScreening_HealthMonitoringYears> Years to repeat health monitoring.
<HMS-Patient_Company_LungScreening_HealthMonitoringNotes> Health Monitoring notes.
<HMS-Patient_Company_LungScreening_ResearchConsent> Consent for Research & Development participation.
<HMS-Patient_Company_LungScreening_ResearchConsentNotes> Research & Development participation notes.

Coding Tags

Available when the Coding feature is enabled. Coding fields are entered on the patient's Demographic tab. Use the field name from the Coding screen (without spaces).


Format: <HMS-Coding_DescriptionOfCodingField>

Coding field Tag
Country Of Birth <HMS-Coding_CountryOfBirth>
Ethnicity <HMS-Coding_Ethnicity>
Marital Status <HMS-Coding_MaritalStatus>
Preferred Language <HMS-Coding_PreferredLanguage>

Current Date and Time Tags

Populated with the actual date and time the letter is created.

Tag field Description
<HMS-Now_DateShort> Current date in dd/MM/yyyy format. e.g. 27/04/2024
<HMS-Now_Date> Current date in dd MMMM yyyy format. e.g. 27 April 2024
<HMS-Now_Time> Current time in hh:mm tt format. e.g. 03:59 PM
<HMS-Now_Time24h> Current time in 24-hour format hh:mm. e.g. 15:59

Document Tags

Populated from the document itself.

Tag field Description
<HMS-Document_ReferenceDate> Document’s reference date.
<HMS-Document_Filename> Document’s server-based filename.

MO Tags

Populated from the doctor on the selected booking.

Tag field Description
MO_Fullname Full name with title, title case. e.g. Dr David Copeland
MO_Title Title (e.g. "Dr", "Prof").
MO_Firstname Given name.
MO_Surname Family name.
MO_Initials Diary name from the Diary Code field.
MO_LetterSignature Two-line letter signature.
MO_LetterSignature_L1 First line of letter signature.
MO_LetterSignature_L2 Second line of letter signature.
MO_ProfessionalTitle Professional title (e.g. "Consultant Cardiologist").
MO_ProfessionalQualifications Qualifications (e.g. "MBBS", "FRACP").
MO_ProvNum Provider number.

Attending Doctor Tags

Populated from the Attending MO listed on the patient's Demographic tab (Admin > Internal MO > Manage Internal MOs).

Tag field Description
<HMS-MO_Fullname> Full name with title, title case.
<HMS-MO_Title> Title.
<HMS-MO_Firstname> Given name.
<HMS-MO_Surname> Family name.
<HMS-MO_Initials> Diary name from the Diary Code field.
<HMS-MO_LetterSignature> Two-line letter signature.
<HMS-MO_LetterSignature_L1> First line of letter signature.
<HMS-MO_LetterSignature_L2> Second line of letter signature.
<HMS-MO_ProfessionalTitle> Professional title.
<HMS-MO_ProfessionalQualifications> Qualifications.
<HMS-MO_ProvNum> Provider number.

Originator Tags

Populated from the Owner/Approver set in the Classify screen. If a doctor: sourced from Admin > Internal MO > Manage Internal MOs. If a non-doctor user: sourced from File > User Preferences.

Tag field Description
<HMS-Originator_Fullname> Full name with title, title case.
<HMS-Originator_Title> Title.
<HMS-Originator_Firstname> Given name.
<HMS-Originator_Surname> Family name.
<HMS-Originator_Initials> Diary name from the Diary Code field.
<HMS-Originator_LetterSignature> Two-line letter signature.
<HMS-Originator_LetterSignature_L1> First line of letter signature.
<HMS-Originator_LetterSignature_L2> Second line of letter signature.
<HMS-Originator_ProfessionalTitle> Professional title (doctor only).
<HMS-Originator_ProfessionalQualifications> Qualifications (doctor only).
<HMS-Originator_ProvNum> Provider number (doctor only).

User Tags

Populated from the logged-in user's profile (File > User Preferences).

Tag field Description
<HMS-User_Fullname> Full name with title, title case. e.g. Ms Jane Jones
<HMS-User_Name_Title> Title.
<HMS-User_Name> Username.
<HMS-User_Name_First> Given name.
<HMS-User_Name_Surname> Family name.
<HMS-User_Initials> Initials.
<HMS-User_Position> Position/role (e.g. "Reception", "Nurse", "Typist").
<HMS-User_LetterSignature> Two-line letter signature.
<HMS-User_LetterSignature_L1> First line of letter signature.
<HMS-User_LetterSignature_L2> Second line of letter signature.
<HMS-User_ProvNum> Default provider number (doctors only).
<HMS-User_Workstation_ID> Workstation name.

Referral Tags

Populated from the referral specified on the booking, or selected at letter creation. To prompt the user to choose a referral, tick the relevant Additional Information Prompts on the template in Admin > Letter Template Manager.

Tag field Description
<HMS-Referral_ReferralPurpose> Purpose of the referral.
<HMS-Referral_ReferralToDate> Valid To date (dd/mm/yyyy).
<HMS-Referral_ReferralFromDate> First Use date (dd/mm/yyyy).
<HMS-Referral_ReferralIssueDate> Issued date (dd/mm/yyyy).
<HMS-Referral_ReferralReceivedDate> Received date (dd/mm/yyyy).

Referring Doctor Tags

Populated from the patient's referring doctor based on the selected referral.

Tag field Description
<HMS-ReferringDoctor_Fullname> Full name with title, title case.
<HMS-ReferringDoctor_Title> Title.
<HMS-ReferringDoctor_FirstName> Given name.
<HMS-ReferringDoctor_Firstname> Given name.
<HMS-ReferringDoctor_Prefname> Preferred name.
<HMS-ReferringDoctor_Surname> Family name.
<HMS-ReferringDoctor_ProviderNo> Provider number.
<HMS-ReferringDoctor_CompanyName> Company/practice name.
<HMS-ReferringDoctor_Address> Street address lines on separate lines.
<HMS-ReferringDoctor_Address1> First street address line.
<HMS-ReferringDoctor_Address2> Second street address line.
<HMS-ReferringDoctor_Address3> Third street address line.
<HMS-ReferringDoctor_Suburb> Suburb.
<HMS-ReferringDoctor_City> City (NZ only).
<HMS-ReferringDoctor_Postcode> Postcode.
<HMS-ReferringDoctor_State> State.
<HMS-ReferringDoctor_Phonew> Phone number.
<HMS-ReferringDoctor_Phonef> Fax number.

General Practitioner Tags

Populated from the GP listed on the patient's Demographic tab.

Tag field Description
<HMS-GP_Fullname> Full name with title, title case.
<HMS-GP_Title> Title.
<HMS-GP_FirstName> Given name.
<HMS-GP_Firstname> Given name.
<HMS-GP_Prefname> Preferred name.
<HMS-GP_Surname> Family name.
<HMS-GP_ProviderNo> Provider number.
<HMS-GP_CompanyName> Company/practice name.
<HMS-GP_Address> Street address lines on separate lines.
<HMS-GP_Address1> First street address line.
<HMS-GP_Address2> Second street address line.
<HMS-GP_Address3> Third street address line.
<HMS-GP_Suburb> Suburb.
<HMS-GP_City> City (NZ only).
<HMS-GP_Postcode> Postcode.
<HMS-GP_State> State.
<HMS-GP_Phonew> Phone number.
<HMS-GP_Phonef> Fax number.

Interested Parties Tags

Populated from the recipients selected when creating the letter. The record highlighted green in the IP screen is the primary addressee.

Tag field Description
<HMS-IP_SalutationWithDear> Salutation for the primary addressee (e.g. "Dear David" or "To Whom It May Concern").
<HMS-IP_Addressee> Pre-formatted address block including name.
<HMS-IP_AddresseeName> Addressee's full name (Title-Given-Family).
<HMS-IP_AddresseeProvNumber> Addressee's provider number.
<HMS-IP_Addressee_Title> Addressee's title.
<HMS-IP_Addressee_FirstName> Addressee's given or preferred name.
<HMS-IP_Addressee_Surname> Addressee's family name.
<HMS-IP_Addressee_AddressOnly> Pre-formatted address only (no name).
<HMS-IP_AddresseeNameAddress_SingleLine> Name and address on one line.
<HMS-IP_Addressee_ExternalPhone> Work phone number (external doctors only).
<HMS-IP_Addressee_ExternalFax> Fax number (external doctors only).
<HMS-IP_CopyTo> All copy-to recipients with pre-formatted addresses.
<HMS-IP_CopyTo_SingleLine> All copy-to recipients with addresses on a single line.
<HMS-IP_CopyToNameOnly> Copy-to recipients' names only (no address).
<HMS-IP_CopyToNameOnly_SingleLine> Copy-to recipients' names only on a single line.

Booking Tags

Populated from the booking selected at letter creation. To prompt the user, tick the relevant Additional Information Prompts on the template in Admin > Letter Template Manager.

Tag field Description
<HMS-Booking_Date> Booking start date in long format. e.g. 01 June 2024
<HMS-Booking_DateShort> Booking start date in short format. e.g. 01/06/2024
<HMS-Booking_Time> Booking start time. e.g. 11:45 AM
<HMS-Booking_DateTimeEnd-Custom-[[0:h:mm tt]]> Booking end time. e.g. 1:30 PM
<HMS-Booking_SelectedStaffName1> Full name of the first staff member on the booking.
<HMS-Booking_SelectedStaffName2> Full name of the second staff member.
<HMS-Booking_SelectedStaffName3> Full name of the third staff member.
<HMS-Booking_SelectedStaffName4> Full name of the fourth staff member.
<HMS-Booking_SelectedStaffRole1> Role of the first staff member (e.g. "Nurse", "Technician").
<HMS-Booking_SelectedStaffRole2> Role of the second staff member.
<HMS-Booking_SelectedStaffRole3> Role of the third staff member.
<HMS-Booking_SelectedStaffRole4> Role of the fourth staff member.

Booking Type Tags

Populated from the Booking Type configuration (Admin > Booking Type Manager).

Tag field Description
<HMS-BookingType_BtLongName> Long name of the Booking Type.
<HMS-BookingType_BtDuration> Estimated duration in minutes.

Booking Location Tags

Populated from the location on the selected booking.

Tag Description
<HMS-BookingLocation_Name> Location name.
<HMS-BookingLocation_Address1> Mailing address line 1.
<HMS-BookingLocation_Address2> Mailing address line 2.
<HMS-BookingLocation_Suburb> Mailing suburb.
<HMS-BookingLocation_City> Mailing city.
<HMS-BookingLocation_State> Mailing state.
<HMS-BookingLocation_Postcode> Mailing postcode.
<HMS-BookingLocation_Phone> Phone number.
<HMS-BookingLocation_Fax> Fax number.
<HMS-BookingLocation_Email> Email address.
<HMS-BookingLocation_MailFormattedAddress> Full mailing address block (includes company name and department).
<HMS-BookingLocation_PrimFormattedAddress> Full primary address block.
<HMS-BookingLocation_PrimFormattedAddressDirections> Primary address on one line.
<HMS-BookingLocation_PrimCompanyName> Primary company name.
<HMS-BookingLocation_PrimAddress1> Primary address line 1.
<HMS-BookingLocation_PrimAddress2> Primary address line 2.
<HMS-BookingLocation_PrimSuburb> Primary suburb.
<HMS-BookingLocation_PrimCity> Primary city.
<HMS-BookingLocation_PrimState> Primary state.
<HMS-BookingLocation_PrimPostcode> Primary postcode.
<HMS-BookingLocation_RemitFormattedAddress> Full remittance address block.
<HMS-BookingLocation_RemitAddress1> Remittance address line 1.
<HMS-BookingLocation_RemitAddress2> Remittance address line 2.
<HMS-BookingLocation_RemitSuburb> Remittance suburb.
<HMS-BookingLocation_RemitCity> Remittance city.
<HMS-BookingLocation_RemitState> Remittance state.
<HMS-BookingLocation_RemitPostcode> Remittance postcode.

Billing Location Tags

Populated from the creator’s logged-in location.

Tag Description
<HMS-BillLocation_Name> Location name.
<HMS-BillLocation_Address1> Mailing address line 1.
<HMS-BillLocation_Address2> Mailing address line 2.
<HMS-BillLocation_Suburb> Mailing suburb.
<HMS-BillLocation_City> Mailing city.
<HMS-BillLocation_State> Mailing state.
<HMS-BillLocation_Postcode> Mailing postcode.
<HMS-BillLocation_Phone> Phone number.
<HMS-BillLocation_Fax> Fax number.
<HMS-BillLocation_Email> Email address.
<HMS-BillLocation_MailFormattedAddress> Full mailing address block.
<HMS-BillLocation_PrimFormattedAddress> Full primary address block.
<HMS-BillLocation_PrimFormattedAddressDirections> Primary address on one line.
<HMS-BillLocation_PrimCompanyName> Primary company name.
<HMS-BillLocation_PrimAddress1> Primary address line 1.
<HMS-BillLocation_PrimAddress2> Primary address line 2.
<HMS-BillLocation_PrimSuburb> Primary suburb.
<HMS-BillLocation_PrimCity> Primary city.
<HMS-BillLocation_PrimState> Primary state.
<HMS-BillLocation_PrimPostcode> Primary postcode.
<HMS-BillLocation_RemitFormattedAddress> Full remittance address block.
<HMS-BillLocation_RemitAddress1> Remittance address line 1.
<HMS-BillLocation_RemitAddress2> Remittance address line 2.
<HMS-BillLocation_RemitSuburb> Remittance suburb.
<HMS-BillLocation_RemitCity> Remittance city.
<HMS-BillLocation_RemitState> Remittance state.
<HMS-BillLocation_RemitPostcode> Remittance postcode.

Seen At Tags

Populated from the Seen At information on the patient’s Demographic tab.

Tag Description
<HMS-SeenAt_Name> Location name.
<HMS-SeenAt_Address1> Address line 1.
<HMS-SeenAt_Address2> Address line 2.
<HMS-SeenAt_Suburb> Suburb.
<HMS-SeenAt_City> City.
<HMS-SeenAt_State> State.
<HMS-SeenAt_Postcode> Postcode.
<HMS-SeenAt_Phone> Phone number.
<HMS-SeenAt_Fax> Fax number.
<HMS-SeenAt_Email> Email address.
<HMS-SeenAt_MailFormattedAddress> Full mailing address block.

Patient Connect Tags

Available for letters and SMS created from a Patient Connect program.

Tag Description
<HMS-PC_Program> Patient Connect program name.
<HMS-PC_NoteText> Contents of the Notes box in the program’s Details tab.
<HMS-PC_AttendingMO> Attending MO selected on the program.

Record Location Tags

Populated from the Location set in the Classify screen when creating the letter.

Tag Description
<HMS-RecordLocation_Name> Location name.
<HMS-RecordLocation_Address1> Mailing address line 1.
<HMS-RecordLocation_Address2> Mailing address line 2.
<HMS-RecordLocation_Suburb> Mailing suburb.
<HMS-RecordLocation_City> Mailing city.
<HMS-RecordLocation_State> Mailing state.
<HMS-RecordLocation_Postcode> Mailing postcode.
<HMS-RecordLocation_Phone> Phone number.
<HMS-RecordLocation_Fax> Fax number.
<HMS-RecordLocation_Email> Email address.
<HMS-RecordLocation_MailFormattedAddress> Full mailing address block.
<HMS-RecordLocation_PrimFormattedAddress> Full primary address block.
<HMS-RecordLocation_PrimFormattedAddressDirections> Primary address on one line.
<HMS-RecordLocation_PrimCompanyName> Primary company name.
<HMS-RecordLocation_PrimAddress1> Primary address line 1.
<HMS-RecordLocation_PrimAddress2> Primary address line 2.
<HMS-RecordLocation_PrimSuburb> Primary suburb.
<HMS-RecordLocation_PrimCity> Primary city.
<HMS-RecordLocation_PrimState> Primary state.
<HMS-RecordLocation_PrimPostcode> Primary postcode.
<HMS-RecordLocation_RemitFormattedAddress> Full remittance address block.
<HMS-RecordLocation_RemitAddress1> Remittance address line 1.
<HMS-RecordLocation_RemitAddress2> Remittance address line 2.
<HMS-RecordLocation_RemitSuburb> Remittance suburb.
<HMS-RecordLocation_RemitCity> Remittance city.
<HMS-RecordLocation_RemitState> Remittance state.
<HMS-RecordLocation_RemitPostcode> Remittance postcode.

Medication Tags

Populated from the medications listed in the patient’s Clinical Summary tab. No user input is required. Tags report on the currently selected patient.

Tag Description
<HMS-Medication_CurrentInternal> All current internally prescribed medications.
<HMS-Medication_CurrentExternal> All current externally prescribed medications.
<HMS-Medication_CurrentInAndEx> All current internally and externally prescribed medications.
<HMS-Medication_PastAll> All past internally and externally prescribed medications.
<HMS-Medication_Past18months> Past medications from within the last 18 months (by prescribed date).
<HMS-Medication_MostRecent> All current medications prescribed on the most recent date.

Clinical Summary Tags

Populated from the patient’s Clinical Summary tab. Tags print information line by line.

Tag Description
<HMS-ClinicalSummary_Measurements> First measurement record from the Clinical Summary.
<HMS-ClinicalSummary_Medications> All medications from the Clinical Summary.
<HMS-ClinicalSummary_MedicationsNoDates> All medications without dates.
<HMS-ClinicalSummary_Conditions> All conditions (date at end).
<HMS-ClinicalSummary_ConditionsDateFirst> All conditions (date at start).
<HMS-ClinicalSummary_ConditionsNoDates> All conditions without dates.
<HMS-ClinicalSummary_Conditions_WithDetails> All conditions with details (date at end).
<HMS-ClinicalSummary_ConditionsDateFirst_WithDetails> All conditions with details (date at start).
<HMS-ClinicalSummary_ConditionsNoDates_WithDetails> All conditions with details, no dates.
<HMS-ClinicalSummary_Procedures> All procedures (date at end).
<HMS-ClinicalSummary_ProceduresDateFirst> All procedures (date at start).
<HMS-ClinicalSummary_Procedures_WithDetails> All procedures with details (date at end).
<HMS-ClinicalSummary_ProceduresDateFirst_WithDetails> All procedures with details (date at start).
<HMS-ClinicalSummary_Notes> All notes from the Clinical Summary.
<HMS-ClinicalSummary_CustomFields> All custom fields from the Clinical Summary.

Program Register Tags

Populated from the patient’s selected weight loss program.

Tag Description
<HMS-ProgramRegister_Name> Program name.
<HMS-ProgramRegister_StartDate> Start date in long format. e.g. 01 June 2024
<HMS-ProgramRegister_StartDateShort> Start date in short format. e.g. 01/06/2024
<HMS-ProgramRegister_EndDate> End date in long format.
<HMS-ProgramRegister_EndDateShort> End date in short format.
<HMS-ProgramRegister_Status> Current program status.
<HMS-ProgramRegister_LocationName> Location name.

Barcode Tags

Format: <HMSBC-…> or <HMSBC417-…>


Barcode tags use the same field names as standard tags. Use HMSBC417 for PDF417 barcodes.

Tag Result
<HMSBC-Patient_MRN> (barcode of the patient MRN)
<HMS-Patient_MRN-Custom-[URN:[0]]> URN:987654321

PDF Tags

Format: <<…>>


PDF tags use double angle brackets and support a subset of standard tag fields. The following tag groups are supported:

Supported tag group Note
Patient Tags All patient tag fields.
MO Tags All MO tag fields.
Interested Parties Tags All IP tag fields.

Request Tags

Request tags are used in Pathology and Radiology test request forms only.

Tag Description
TestsRequested Tests to be ordered, comma-separated.
ClinicalNotes Clinical notes.
TestRequestDate Date the request was generated.
PlacerGroupNum Request ID.
RequestingDocDetails Requesting doctor (e.g. Dr Fred Nerd).
RequestingDocAddress Requesting doctor address (multiple lines).
RequestingDoc_ProviderNumber Requesting doctor’s provider number.
CopyReportsTo CC distribution parties.
FeePrivate Billing class — Practice Fee.
FeeSchedule Billing class — Schedule Fee.
FeeBulkBill Billing class — Medicare Rebate.
PatientMRN Patient MRN.
LocationAddress Site location address.
LocationName Site location name.
GenericProviderName Generic form provider name.
GenericProviderAddressLine1 Generic provider address line 1.
GenericProviderAddressLine2 Generic provider address line 2.
GenericProviderAddress Generic provider address on one line.
SpecialRequirementFasting Fasting requirement.
SpecialRequirementNonFasting Non-fasting requirement.
SpecialRequirementPregnant Pregnant.
SpecialRequirementHormTherapy Hormone therapy.
SpecialRequirementLNMP LNMP.
SpecialRequirementEDC EDC.
SpecialRequirementCervicalCytologyCervix Cervical cytology — cervix.
SpecialRequirementCervicalCytologyVaginalVault Cervical cytology — vaginal vault.
SpecialRequirementCervicalCytologyEndometrium Cervical cytology — endometrium.
SpecialRequirementCervicalCytologyOth Cervical cytology — other.
SpecialRequirementPostNatal Post natal.
SpecialRequirementPostMenopausal Post menopausal.
SpecialRequirementRadioTherapy Radio therapy.
SpecialRequirementIUCD IUCD.
SpecialRequirementAbnormalBleeding Abnormal bleeding.
SpecialRequirementCervixAppearanceBenign Cervix appearance — benign.
SpecialRequirementCervixAppearanceSuspicious Cervix appearance — suspicious.
SpecialRequirementWarfarin Warfarin.
Urgent Urgent flag.

Still need help? Contact Us Contact Us