/ Development View source
Projects/ImmuKnow/Finding Code Reference
Development documentation from main. Features may not be released. Read the current release.

Finding code reference

Use the code column in findings.csv to find the check below. Its message and page describe the particular observation; run.json retains the full checks and measurements. Inspect the actual notice and source information before acting. Checks describe supplied data and document output, not a clinical assessment or immunization status. The upstream system assesses status.

A check may pass, warn, fail, be not applicable, or be not run. Default severity depends on the observation. Supported rules can change the effective severity or disable a check, with a recorded reason; mandatory checks cannot be disabled or downgraded. The report retains observed and effective results. An effective failure blocks the normal bundle; warnings can be included under the active rules. A not_run result blocks delivery unless the check was disabled by an effective rule. See PDF checks and review and configuration.

The entries below explain issue outcomes; many of the same checks also produce a passing result. A component-absence result is informational and not applicable. Raw compiler messages may also produce a warning even when no separate finding code is present; findings.csv includes them as compiler findings.

Source and reference

source.history_unusable

The source immunization history cannot be parsed safely. Correct its dates, agent names, validity values or separators and run again. The source row remains in the report without invented facts or a PDF; other valid rows continue.

source.intended_reader_invalid

The intended reader must be blank, student or guardian. Correct this source value and run again. This row has no prepared notice or PDF; other valid rows continue.

data.history_cohort_incomplete

Some source histories could not be parsed. The run reports the total row count and failed-history count once, and marks cohort validity coverage as incomplete. Each invalid source row has its own failure. Successfully parsed histories remain available for the other notices.

source.client_id_missing

The source client ID is empty. Verify the person and supply the correct ID in the source before rerunning.

source.first_name_missing

The source first name is empty. Verify and correct the source if a name is required for this notice.

source.last_name_missing

The source last name is empty. Verify and correct the source if a name is required for this notice.

source.school_name_missing

The source school name is empty. Verify the school and correct the source if needed.

source.board_name_missing

The source board name is empty. Verify the board and correct the source if needed.

source.client_id_format

A nonempty Panorama client ID does not contain exactly ten ASCII digits. Check leading zeroes and the source value, then rerun.

source.address_incomplete

One or more mailing address fields are missing. The message identifies them. Verify the address and update the source before mailing.

source.age_unknown

Age could not be calculated from the birth and delivery dates. Check both dates and their formats, and rerun.

source.overdue_unusable

An overdue disease, dose, or agent fragment could not be interpreted fully. Compare the message and source value with the input format; correct it and rerun. The original value is retained.

data.school_match

The source school name and ID were compared with the configured reference. A name-only match warns; mismatched IDs, an ID associated with another name, or no match fail. Compare the source and the referenced snapshot and correct the appropriate file before rerunning.

data.duplicate_client_id

This ID occurs on multiple rows and was explicitly allowed in configuration. All rows are retained and use the same notice assignment. Review each row and its notice before sending; warnings are eligible for delivery.

data.duplicate_overdue_diseases

An overdue disease appears more than once with the same explicit positive dose after disease names are standardized. Review the source and dose numbers; the facts are retained and this warning allows delivery.

data.duplicate_overdue_agents

An overdue agent appears more than once. Source data should list each agent once per client; coverage of multiple diseases does not justify repeating the agent. Review and correct the source. The facts are retained and this warning allows delivery.

data.forecast_coverage

The configured agent lookup compares forecasted agents with supplied overdue diseases. Missing coverage fails an agent-based notice and warns for a disease-based notice. Extra diseases or unmapped agents warn. Review the source, notice and lookup measurements.

Assignment

assignment.extra_manifest_row

This run-level finding reports distinct assignment client IDs absent from the CSV. Compare the two files and remove or explain extra assignments before rerunning.

notice.requirements

The notice must place one valid requirements declaration. A missing, duplicate or invalid declaration fails the check and sends a readable original to review. Ask the notice maintainer to correct the declaration.

notice.eligibility

The selected notice does not match its stated requirements for the supplied facts. Review the source information and notice assignment before regenerating.

Content

content.agent_display

All source agents were excluded from an agent-based notice and no intentional replacement was placed. Review the exclusions and the notice; the source facts remain available.

content.translation_missing

A requested translation was unavailable. Inspect the notice text and language; ask the template maintainer to provide the missing translation.

content.history_mapping

The history component could not map one or more agents. Review the source history and configured agent reference, correct the mapping or source, and rerun.

content.history_validity

Validity coverage varies across the cohort. Review the displayed history and source validity information with the data owner.

content.history_age_unknown

A history displaying vaccination ages lacks a usable birth date. Verify the birth date in the source and rerun, or review the notice without ages.

content.address_reader_unknown

The intended reader is unknown, so a neutral addressee is used. Confirm the intended recipient and update the source or template if needed.

content.birth_date_unknown

The component expects to display a birth date but none is available. Verify the source date and review the notice.

A web link or QR destination lacks HTTPS or a host, or contains spaces. Check the destination in the template or configuration. This is a format check and does not test reachability.

A link or QR destination does not match the supported HTTPS, mailto: or tel: address formats. Correct the destination and inspect the resulting notice. This check does not contact the destination.

More than one distinct link or QR destination is present. Inspect each destination and confirm that the differences are intended.

Layout and components

Inspect the indicated notice page and measurements where available. Ask the template maintainer to correct the component or page settings and regenerate the notice when needed.

layout.history_width

History columns need more width than is available. Reduce columns or adjust template widths, then inspect the history.

layout.header_title_lines

The title exceeds the measured space. Review the header and adjust the title or layout.

layout.address_outside_window

The address falls outside the configured envelope window. Compare the printed page with the actual envelope and adjust placement or window settings.

layout.client_details_in_window

Client details overlap the envelope window. Inspect the page and adjust the template to keep unintended details out of the window.

layout.envelope_window_missing

An address component was placed without an envelope window definition, so its window placement could not be checked. Define the correct window or inspect placement manually.

layout.signature_page

The signature block does not fit as expected. Inspect the page break and adjust the layout or overflow setting.

layout.privacy_page

The privacy notice is on a different page from the expected page. Inspect the indicated pages and adjust page breaks or the expected page.

layout.section_pages

A section spans pages when overflow was not allowed. Inspect the section and adjust its layout or overflow setting.

A displayed link needs more width than is available. Inspect the link and adjust its text or available width.

component.*.absent

The named shared component was not used in the notice; this is recorded as not applicable. Confirm the template uses the component if it is required for that notice. Its absence alone does not establish that the notice is incorrect.

Generation and output

compiler.warning

The notice compiler reported a warning. Open notice creation messages, inspect the resulting PDF and ask the template maintainer to resolve the cause.

compiler.font_substitution

A font was substituted. Inspect the notice for text and layout changes; provide the intended font or update the template.

compiler.layout_nonconvergent

Layout did not converge reliably. Ask the template maintainer to review the compiler messages and layout dependencies, then regenerate and inspect the notice.

rendering.failed

Notice compilation failed. Inspect the original error or creation messages, correct the template, fonts or inputs identified there, and run again.

render.evidence_failed

The PDF was created but its required render evidence was missing, invalid or inconsistent. A readable original remains available for review. Ask the template maintainer to correct the evidence and regenerate it.

output.readable

PDF export returned no pages or no bytes. Ask the template maintainer to inspect the creation error and regenerate the notice. ImmuKnow trusts successful Typst PDF export and uses the page count from the same compiled document; it does not parse the exported bytes again. Older runs also used this code for a failed PDF inspection or inconsistent page count.

encryption.failed

A requested encrypted copy could not be created. Check the error, encryption settings and required source fields; correct them and rerun. A readable original goes to review.

delivery.original_unusable

The original PDF is missing or unreadable during bundle assembly. Restore or regenerate a usable original before rebuilding bundles.

delivery.notice_length

The original page count differs from the configured required notice length. Inspect the original and the setting; correct the template or setting and rebuild. Pages are not added to meet the count.

Artifact filenames and grouping

output.filename_fallback

A filename template referenced a missing value, a value that differs across bundle members, or produced no usable filename characters. A deterministic fallback was used and the artifact remains available. Review the recorded path, pattern and grouping; supply the value or choose a supported consistent field. This warning does not change delivery eligibility.