Tutorials › Pharmacometric Workflows and Reproducible Modeling › Documenting Independent Review and Sign-Off

Quality Control and Independent Review · Tutorial 357 of 399

Documenting Independent Review and Sign-Off

Build a review record that makes clear what was examined, what was reproduced, how findings were resolved, and exactly which analysis version the sign-off covers.

Intermediate 11 min read

What You'll Learn

  • Identify the version and artifacts a review record must uniquely link.
  • Record reproduction checks with their inputs, expected results, observed results, and tolerances.
  • Connect each finding to its resolution evidence and status.
  • Distinguish review completion from approval for a specified use.
  • Recognize incomplete traceability and version mismatches that invalidate a sign-off.

Why the Review Record Matters

An independent review can be technically careful and still be difficult to rely on if its evidence is scattered across messages, scripts, and working folders. The review record is the concise map through that evidence: it identifies the analysis that was reviewed, what the reviewer examined or reproduced, what they found, how each finding was handled, and what decision was made. Its purpose is not to replace the model files, review comments, or reproduction outputs. It makes their relationship to the final analysis version explicit.

A sign-off is meaningful only for a defined scope. “Reviewed” on its own does not tell a later reader which model, data, code, or simulation settings were covered, nor whether the reviewer reproduced results or inspected them. A useful record answers those questions without implying that every possible property of the analysis has been checked.

Definition: An independent-review record is a controlled summary linking the reviewed analysis version to the artifacts examined, review and reproduction evidence, findings and their dispositions, and a dated decision by an identified reviewer. A sign-off is that reviewer’s recorded conclusion about the specified version and review scope; it is not a general claim that the analysis is correct for every purpose.

What the Record Must Identify

Start by defining the object of review precisely. A project name or model label is not enough if it can refer to several changing files or runs. Record a version identifier and the identifying information needed to distinguish it from nearby versions. Depending on the workflow, that may include the model and control-stream versions, analysis-data version, code revision, execution environment, and run configuration. Record a checksum or other immutable identifier when available. Such identifiers help establish file identity; they do not establish that the file is correct.

Next, list the artifacts in scope and the evidence created by the review. A compact register can include an artifact identifier, version or location, what was examined, and the associated evidence location. Separate “examined” from “available”: an artifact present in the project folder was not necessarily reviewed. For reproduction checks, retain enough detail for another qualified person to understand the procedure: the input version, command or procedure, expected result, observed result, comparison rule, and output location.

A concise record commonly includes the following:

  • Review identity: record identifier, review date, reviewer name and role, and the basis for treating the review as independent of the work being reviewed.
  • Analysis identity: final version identifier and the relevant model, data, code, environment, and run-configuration identifiers.
  • Scope and evidence: artifacts examined, checks performed, results, and paths or identifiers for retained evidence.
  • Findings: a unique identifier for each finding, its severity or priority as assigned in the review process, and its current disposition.
  • Decision: the sign-off status, its scope, date, reviewer, and any conditions or limitations.

The record should be brief enough to use, but not so brief that it loses traceability. “Simulation checked; OK” is not traceable. A stronger entry names the simulation configuration, the output examined, the independent procedure or comparison performed, the result, and where the evidence is retained.

Linking Evidence to a Final Version

The central control is a direct link between the evidence and the exact version receiving sign-off. If a model, dataset, script, or run configuration changes after review, the record should distinguish the reviewed version from the changed version. A reviewer can then determine whether the change is outside the review scope or requires a targeted check or renewed review. Do not silently update a file in place while leaving its old review record unchanged.

This requirement follows from a simple logical structure. Let \(I\) mean that the analysis identity is unambiguous, \(E\) that the stated evidence is linked to that identity, \(F\) that findings have documented dispositions, and \(D\) that the decision states its scope. A sign-off record is traceable only when all four conditions hold:

$$ \text{Traceable sign-off} = I \land E \land F \land D $$

If any condition fails, the conclusion does not follow. For example, complete reproduction evidence tied to an unidentified run cannot establish what was reviewed. Likewise, an identified final model with an unresolved finding cannot be described as having all findings closed. The record should expose such gaps rather than hide them behind a broad approval label.

Worked Example: Finding an Incomplete Artifact Register

A reviewer is assigned to review hypothetical analysis version PK-17. The agreed scope lists six artifacts: model control stream, analysis dataset, estimation output, diagnostic output, simulation script, and simulation output. The record marks five as examined, but has no entry for the simulation script.

A simple coverage summary can help identify the gap. Define the examined-artifact fraction as the number marked examined divided by the number in the agreed scope:

$$ \text{Examined fraction} = \frac{\text{artifacts marked examined}}{\text{artifacts in scope}} = \frac{5}{6} = 0.8333 $$

Thus, 83.3% of the listed artifacts are marked examined, and one of six is not. This fraction is a tracking aid, not a statistical measure of model quality or an automatic approval threshold. The missing script matters because it may define how the simulation output was produced. The reviewer should either examine the identified script and record the evidence, or revise the scope transparently and explain why the script is excluded. The record must not say that all six artifacts were reviewed while one remains unexamined.

Recording Reproduction Checks

A reproduction result is interpretable only alongside its comparison rule. State what quantity was reproduced, which version and inputs were used, what reference was compared, and what degree of difference was permitted. Exact equality may be appropriate for some deterministic checks; numerical tolerances may be needed where rounding or computational implementation affects output. The tolerance should be justified and specified before judging the result, not selected after seeing the discrepancy.

For a numerical output with a nonzero reference value, a relative absolute difference can be calculated as the absolute difference divided by the absolute reference value, expressed as a percentage. This summary is useful only when the chosen output and tolerance are appropriate to the question being checked. It does not replace inspection of other outputs or diagnostics.

Worked Example: Documenting a Numerical Reproduction

In a hypothetical check, the reference output for a specified prediction is 12.50 mg/L. An independently reproduced output is 12.48 mg/L. The pre-specified comparison rule allows a relative absolute difference no greater than 0.50%.

Calculate the difference in the output’s units:

$$ |12.48 - 12.50| = 0.02\ \text{mg/L} $$

Then calculate its relative absolute difference from the reference:

$$ \frac{|12.48 - 12.50|}{|12.50|}\times 100\% = \frac{0.02}{12.50}\times 100\% = 0.16\% $$

Because \(0.16\% \leq 0.50\%\), this specified comparison meets its stated tolerance. A useful record would also identify the prediction, input and software versions, procedure, retained output, and reviewer. The conclusion is limited: this one reproduced prediction met the stated rule. It does not establish that all model components, data, or outputs are correct.

Findings, Resolutions, and the Decision

Each finding should have a stable identifier that persists as it is discussed and resolved. Record the observation clearly enough that a reader can locate it in the relevant artifact or evidence. Then link it to the response: what changed, what was clarified, or why no change was made. A resolution is not confirmed merely because a response says “fixed.” The reviewer should record what they rechecked and the result, including the version on which that confirmation was performed.

Keep the finding’s status precise. Examples include open, awaiting confirmation, resolved and confirmed, or closed with an explicitly documented rationale where the review process permits that disposition. The status terms should be defined consistently within the project. An accepted limitation or an agreed deferral should not be relabelled as a technically resolved issue; state the rationale and any condition attached to the decision.

Worked Example: Connecting Findings to Sign-Off

A hypothetical review of version PK-17.2 produced three findings. Finding F-01 concerned an undocumented run setting; F-02 concerned a mismatch between a plotted label and its underlying quantity; F-03 asked for clarification of the intended scope. The model author supplied responses, and the reviewer checked each response against version PK-17.2.

The record links F-01 to the updated run documentation and a check that the recorded setting matches the run configuration. It links F-02 to the corrected plot and a recheck of the label against the plotted quantity. It links F-03 to the clarified scope statement and records that no model change was required. All three entries identify the reviewer’s confirmation evidence and the version checked.

The closure count is:

$$ \text{Confirmed findings} = 1 + 1 + 1 = 3 $$

There are three findings in total, and all three have confirmation evidence. Therefore, the finding log supports the statement “3 of 3 findings confirmed closed for PK-17.2.” It would not support the broader statement “the model is error-free.” The reviewer can sign off only on the defined scope and decision, such as “independent review completed for the listed artifacts and checks; no open findings remain in this review record.” The record should state any excluded checks or other limitations rather than allowing the wording to imply unlimited assurance.

Choose a Decision That Matches the Evidence

A sign-off should communicate a decision, not merely that a review meeting occurred. Use terms with defined meanings in the project, and distinguish completion of review activity from approval for a particular use. For example, a reviewer may document that review checks are complete while a separate decision-maker retains responsibility for release or use. Do not imply that the reviewer has authority they do not hold.

Record statusWhat it can communicateWhat it should not imply
Review incompleteSome planned checks or evidence are missing.That missing work is immaterial or implicitly passed.
Findings awaiting confirmationResponses exist, but the reviewer has not verified the relevant changes.That a response alone proves resolution.
Review complete, with limitationsThe stated review scope is complete and limitations are visible.That excluded analyses or checks were covered.
Approved for a specified useAn authorized decision-maker has approved the identified version for the stated purpose.That the version is suitable for every other purpose.

A signature or electronic approval should be tied to the record identifier and final version, with the signer’s identity and date captured by the applicable process. If the record is later amended, preserve the earlier decision and document the amendment; do not make the history appear as though the new information was available at the original sign-off.

Diagnostics and Common Failure Modes

Before finalizing a record, inspect it for breaks in traceability. A reviewer should be able to move from the sign-off to the analysis version, from that version to each listed artifact, and from each finding to its evidence and disposition. If any step depends on an informal explanation that is not retained, the record is fragile.

  • Version drift: the sign-off names one version while evidence comes from another. Record the mismatch, identify the actual reviewed version, and determine whether the changed version needs further review.
  • Unverifiable reproduction: the record says “reproduced” but omits inputs, procedure, expected result, or comparison rule. Add those details and link the retained output.
  • Closure by assertion: a response is recorded as a resolution without reviewer confirmation. Keep it awaiting confirmation until the stated recheck is documented.
  • Ambiguous scope: “model reviewed” does not say which files, outputs, or checks were included. Name the scope and disclose exclusions.
  • Overbroad sign-off: “validated” or “correct” may imply much more than the checks support. State the actual decision and its boundaries.
  • Uncontrolled record changes: edits overwrite what was signed. Preserve the original record and make amendments identifiable and dated.

A checklist can improve consistency, while a narrative memo can explain unusual decisions and limitations. Neither format is inherently sufficient: a checklist may be too terse to explain a discrepancy, and a memo may omit a needed artifact link. A practical record combines structured fields for identity, evidence, status, and decision with brief narrative where context is needed. A repository log or issue tracker can hold detailed evidence, provided the review record points to stable, accessible entries and identifies the version they concern.

Key takeaway: Sign-off is traceable when the record identifies one analysis version, links the claimed review evidence to that version, gives every finding a documented disposition, and states exactly what the decision covers. A concise record is not a broad assurance claim; it is a precise account of evidence and scope.

Check Your Understanding

Answer each question, then compare your reasoning with the solutions.

  1. A reproduction output matches the reference, but the record does not identify the dataset version. What is missing, and why does it matter?
  2. A review log has four findings. Three are confirmed closed and one has a response but no reviewer recheck. What status should the fourth finding have?
  3. A reviewer examined five of six in-scope artifacts. Calculate the examined fraction and explain what it can and cannot establish.
  4. Why should a sign-off name its scope and analysis version rather than simply state “approved”?

Solutions. (1) The dataset identity is missing, so the reproduced result cannot be unambiguously linked to the data used; record its version or immutable identifier and retain the relevant evidence. (2) The fourth finding is awaiting confirmation, not confirmed closed, because a response is not evidence that the change resolves the issue. (3) The fraction is \(5/6 = 0.8333\), or 83.3%. It tracks coverage of the listed artifacts, but does not measure model quality or justify approval; the missing artifact needs examination or an explicit scope change. (4) Scope and version define what was actually reviewed and approved. Without them, the decision could be mistakenly applied to different artifacts, later changes, or uses that were not covered.

Clinical Biostats