Custom Documents
This document explains the Custom Documents feature found under General > Settings in HelloClinic. Clinics can create their own document content, such as certificates, medical reports, referral documents, or other commonly used internal documents, and automatically insert clinic, doctor, patient, and consultation data using variables.
Feature Overview
Custom Documents are useful when your clinic needs a fixed document format, but each generated or printed document should contain different patient-specific information. Administrators can write fixed template text and insert {{variable.path}}; when the document is generated, HelloClinic replaces each variable with the corresponding real data.
Common use cases include:
- Clinic certificates: Such as attendance certificates, health certificates, or other general certificates.
- Doctor reports: Automatically insert patient details, diagnosis, findings, and treatment plans into reports.
- Referral or follow-up documents: Fill in doctor, patient, and consultation date details without repeated manual input.
- Internal clinic documents: Standardize routine administrative or clinical document formats.
How to Use Variables
In custom template text, wrap the full variable path with double curly braces. For example:
This is to certify that {{patient.nameEn}} attended our clinic on {{caseInfo.date}}.When the document is generated, the system replaces {{patient.nameEn}} with the patient's English name and {{caseInfo.date}} with the consultation date.
Currently Supported Variables
| Category | Variable | Example Value |
|---|---|---|
| Header Title | {{title.clinicName}} | 康健醫務中心 |
| Header Title | {{title.clinicNameEn}} | Health & Care Medical Centre |
| Header Title | {{title.clinicAddress}} | 香港九龍尖沙咀廣東道30號新港中心 |
| Header Title | {{title.clinicAddressEn}} | Silvercord Tower... |
| Header Title | {{title.tel}} | +852 2123-4567 |
| Header Title | {{title.fax}} | +852 2123-4568 |
| Clinic | {{clinic.name}} | 康健醫務中心 |
| Clinic | {{clinic.nameEn}} | Health & Care Medical Centre |
| Clinic | {{clinic.address}} | 香港九龍尖沙咀廣東道30號新港中心 |
| Clinic | {{clinic.addressEn}} | Silvercord Tower... |
| Clinic | {{clinic.tel}} | +852 2123-4567 |
| Clinic | {{clinic.fax}} | +852 2123-4568 |
| Clinic | {{clinic.openAt}} | 09:00 AM |
| Clinic | {{clinic.closeAt}} | 06:00 PM |
| Doctor | {{doctor.name}} | 陳大文 |
| Doctor | {{doctor.nameEn}} | Dr. David Chan |
| Doctor | {{doctor.tel}} | +852 9123-4567 |
| Doctor | {{doctor.email}} | doctor@... |
| Doctor | {{doctor.major}} | 全科醫學 |
| Doctor | {{doctor.subject}} | 內科 |
| Patient | {{patient.name}} | 李志明 |
| Patient | {{patient.nameEn}} | Chi Ming Lee |
| Patient | {{patient.gender}} | 男 |
| Patient | {{patient.idNo}} | A123456(7) |
| Patient | {{patient.dob}} | 1990-01-01 |
| Patient | {{patient.age}} | 33 |
| Patient | {{patient.mobileNo}} | +852 9876-5432 |
| Patient | {{patient.code}} | VV12345 |
| Consultation | {{caseInfo.date}} | 2025-01-23 |
| Consultation | {{caseInfo.appointmentTime}} | 09:30 AM |
| Consultation | {{caseInfo.channel}} | Outpatient |
| Signature | {{sign.clinicName}} | 康健醫務中心 |
| Signature | {{sign.clinicNameEn}} | Health & Care Medical Centre |
| Signature | {{sign.doctorName}} | 陳大文 |
| Signature | {{sign.doctorNameEn}} | Dr. David Chan |
| Signature | {{sign.major}} | 全科醫學 |
| Signature | {{sign.majorEn}} | General Practice |
| Report | {{report.complaint}} | 咳嗽, 喉嚨痛... |
| Report | {{report.findings}} | 發燒, 咽喉紅腫... |
| Report | {{report.diagnosis}} | 上呼吸道感染 |
| Report | {{report.treatmentPlan}} | 服藥, 多飲水... |
Recommended Setup Workflow
- Go to HelloClinic > General > Settings > Custom Documents.
- Add or edit a custom document.
- Enter the fixed document text and insert the variables that should be populated automatically.
- Use preview or test generation to check whether the content is correct.
- Save the document after confirming that the format and variable output are correct.
Notes
- Variables must keep the complete format, including the opening and closing double curly braces.
- Variable names must match exactly, including capitalization, for example
{{patient.mobileNo}}. - If a data field has not been filled in, the generated document may leave that variable value blank.
- Use a test patient or sample data to preview the document before using it in daily clinic workflows.