For the complete documentation index, see llms.txt. This page is also available as Markdown.

Report templates

A report template is a reusable report layout. It decides which sections a report has, in what order, under what headings, and with what standard wording. It also defines the findings sections that contributors file variants under. Every new report is pre-populated from a template.

A workspace can hold as many templates as your lab needs, for example one for exome cases, one for rare-disease genomes, and one for carrier screening. One of them is the default, and new reports are created from it.

Managing templates needs the Sign Off Reports capability (admins). Contributors don't see the Report Templates tab. See Workspaces & roles.

The template list

  1. Click Settings in the left navigation.

  2. Open the Report Templates tab.

Each row shows the template's name, a default badge on the default template, and when and by whom it was last edited. Click a row, or Edit, to open it in the editor. The … menu on each row offers:

Action
What it does

Duplicate

Creates a copy named "name (copy)" with the same sections and wording.

Rename

Renames the template.

Set as default

Makes this the template new reports are created from.

Delete

Permanently deletes the template. Reports already created from it are unaffected. You can't delete the default template; make another template the default first.

Creating a template

  1. On the Report Templates tab, click Add template.

  2. Enter a Name.

  3. Under Start from, choose either:

    • Standard sections (no wording): the built-in set of sections with no lab wording, or

    • an existing template, to copy its sections and wording.

  4. Click Create. The new template opens in the editor.

Editing a template

The template editor lists the template's sections on the left and shows a live Report preview on the right. On narrow screens, click Preview to see it.

For each section you can:

  • Turn it on or off with the toggle. A section that's off isn't printed.

  • Reorder it by dragging the handle, or by focusing the handle and pressing the up and down arrow keys.

  • Rename its heading by clicking the heading. Press Enter to keep the change or Esc to cancel. Every section's heading can be renamed, including the default findings section and the sign-off.

  • Write its standard wording: click Edit to open a rich-text editor. This wording pre-fills every report created from the template, and contributors can change it on each report.

The chip beside each section shows its kind: Statement (standard wording), Findings (a findings section), or Findings · default (the default findings section).

When you're done, click Save. The editor doesn't save automatically; its header shows Unsaved changes until you save, and you're warned if you try to leave with unsaved changes. Click Activity to see who changed the template and when.

Editing a template doesn't change reports already created from it. A draft report can pick up structural changes with Update from template. See Filling in a report.

Built-in sections

Every template includes these sections. Their order in this table is the order of the standard template.

Section
Content
Wording in the template?
Notes

Letterhead

Your report branding plus the case ID, analysis type, and report date.

No; click Edit in Report Branding.

Always first and always on.

Patient, Specimen & Provider Information

Filled in automatically: proband ID, sex, affected status and, where available, family ID and parental IDs.

No

Clinical Phenotypes

Filled in automatically from the sample's HPO terms.

No

Left out of the report if the case has no phenotype terms.

Primary Findings — genes known to be associated

The variants filed under this section.

No

The default findings section. It can be moved and renamed, but not removed or turned off.

Clinical Interpretation

Written by the contributor on each report.

No

Recommendations

Standard wording, editable per report.

Yes

Methods

Standard wording, plus the workflow, run ID, and number of variants reported, filled in automatically.

Yes

Limitations

Standard wording, editable per report.

Yes

References

Standard wording, editable per report.

Yes

Report Sign-Off

The signer's role and name, the date signed, the disclaimer, the version, and any amendment reason.

No

Always last and always on.

Adding your own sections

Click Add a section and choose:

  • Statement: standard wording printed on every report, for example a lab note or a test description.

  • Findings section: a heading that contributors can file variants under.

New sections are added just above the sign-off. Give each one a title; you can't save a template with an untitled section. Remove a section you added with its delete icon.

You can switch a section you added between Statement and Findings section from its kind chip. A statement that already has wording must have its wording cleared first.

Findings sections (categories)

Findings sections let a lab divide reported variants into categories, each printed as its own table. For example, you might add Secondary Findings and Carrier Status alongside the default Primary Findings section.

  • Every template has one default findings section, Primary Findings — genes known to be associated. Variants added to a report go here unless a contributor files them elsewhere.

  • Add further categories with Add a section → Findings section. There's no limit on how many.

  • On each report, contributors choose which section each variant prints under. See Filling in a report.

  • A findings section you added is left out of the printed report if no variants are filed under it. The default findings section always prints; with nothing filed under it, it states that no reportable variants were identified.

Choosing the default template

New reports are created from the default template. To change it, open the … menu on a template's row and choose Set as default.

A template can be made the default only once the report branding has an Organization name and a Brand colour. Until a workspace has a default template, no report can be created.

Using multiple templates

When a workspace has more than one template:

  • Every new report starts from the default template.

  • While a report is in Draft, the contributor can switch it to another template from the Template menu on the Report tab. See Choosing a template for a report.

Keep the template most of your cases use as the default, so most reports need no switching.

Last updated

Was this helpful?