Generating a report
Last updated
Was this helpful?
Each analysis has a single clinical report — the signed-off conclusion of the interpretation. This page covers how the report is assembled, the sign-off workflow it moves through, and how amendments work after release.
A report has two parts:
Findings — the curated set of variants you're reporting. The candidate pool is every variant you've classified (see Classifying variants); you choose which of those to include and set their order. A variant's presence on the report is its inclusion — remove it to exclude it.
Body — a single free-form, rich-text section for the clinical narrative. It autosaves as you type.
The report also records provenance automatically: reference genome, pipeline version, and caller versions for the analysis. See Pipeline & caller versions.
A report moves through four phases. The flow separates drafting (any Contributor) from sign-off (an Admin with the Sign Off Reports capability), so a report can't be released without an authorized approval.
DRAFT ──Submit──▶ IN REVIEW ──Approve──▶ CLOSED (unreleased) ──Close──▶ CLOSED (released)
▲ │ ▲ │ ▲ │
└── Return to ────┘ └────── Reopen ─────┘ └──── Reopen (reason) ──────┘
draftDraft
Being written. Findings and body are editable.
Contributor submits.
In review
Submitted, awaiting sign-off.
Admin approves, or returns to draft.
Closed (unreleased)
Approved and locked, but not yet released. Recoverable.
Admin closes to release, or reopens.
Closed (released)
A signed version exists and can be downloaded.
Admin may reopen to amend.
Available actions by phase:
Draft → Submit (moves to In review).
In review → Approve (Closed unreleased) or Return to draft.
Closed (unreleased) → Close (releases a signed version) or Reopen (back to In review).
Closed (released) → Reopen — requires a reason and starts an amendment.
Submit and Return to draft are available to contributors. Approve, Reopen, and Close are admin-only; non-admins never see these buttons.
Closing a report from Closed (unreleased) releases an immutable signed version. The first release is version 1. The working report stays editable through reopen, but each released version is frozen and never changed.
To change a report after it has been released, an admin reopens it. Reopening a released report:
requires a reason, and
bumps the amendment version (v2, v3, …).
The reason is printed on the amended report's cover page. Once the amended report is re-approved and closed, it releases as the next version, preserving the earlier one.
Every phase transition is recorded — the action, who performed it, when, and (for amendments) the reason. This activity log gives a complete, append-only history of how the report reached its current state.
A released report can be downloaded as PDF, HTML, or JSON.
Last updated
Was this helpful?
Was this helpful?

