How to Edit an Infectious Disease Patient Report

This article describes what is editable on an existing Ovation-generated generic infectious disease patient report, and where to make those edits.

A report is considered a generic infectious disease report if it uses one of the following values for remote_function_name:

  • generic_infectiousDiseaseReportTemplateV2
  • generic_infectiousDiseaseReportTemplateV3

The remote_function_name can be determined by going to the applicable Project > Settings tab > select applicable requisition template > Reports. Look to see what value is set for remote_function_name in the Report Configuration.

Where to Make Report Configuration Edits

Report Configuration

Unless otherwise noted, all edits to the infectious disease patient reports can be made in the Report Configuration of that particular requisition template.

  1. Go to the applicable Project > Settings tab > select applicable requisition template > Reports
  2. Click the 3 dots on the far right of the applicable report configuration > choose Edit
  3. Make needed updates, click Save

Test or Test Panel

Some information on infectious disease patient reports come from the Test Panels or the Tests within those Test Panels.

  1. Go to More menu > Lab > Test Panels OR Tests > select applicable test panel or test
  2. To update Name, click on the Name field, edit & Save
  3. To add attributes
    1. Click Add Attribute button under the Custom Attributes title
    2. Add Key & Value, click Save

Note: Changing Test Configurations, Test Panel Codes or Test Codes may seriously impact sample routing and interpretation. If you are not sure how the change you are making will affect the rest of your workflows, please check with an Ovation configuration specialist by contacting support@ovation.io.

Anatomy of an Infectious Disease Patient Report

Notes:

  • Any attributes listed below in snake case (snake_case) are controlled within the display_settings section of the report configuration
  • Attributes in display_settings should have quotes (“) on either side of the attribute and be followed by a colon (:)
  • The value for each attribute should have quotes (“) on either side of the value (except where otherwise noted)

General Report Settings

  • Colors can be set using words or HTML color codes in the following attributes:
    • primary_color
    • secondary_color
    • third_color
    • Screenshots in the below sections are set as such:
      • “primary_color”: “blue”
      • “secondary_color”: “red”
      • “third_color”: “#1E7C26” (green)
  • Page margins can be set using document_margins
    • Values are set as such: [top, right, bottom, left]
    • Example: [8, 8, 6, 8]

Report Header

All report header values are set in either the Report Configuration or System Settings (More menu > Settings > System Settings).

  • Width of the top 3 columns (logo, lab info, report title) can be set using (sum of widths must equal 12):
    • logo_column_width
    • lab_info_column_width
    • report_title_column_width
  • Any value in the Report Configuration will override values set in System Settings
  • For corrected reports:
    • The correction reason will display at the bottom of the Patient Information section after the title ‘Correction Reason' (title cannot be edited) if using the custom_addendum_page of "Reports::RequestIsoAddendumPage"
    • The correction notice can be displayed in the header (above the report title) using:
      • display_header_correction_text (set to true)
      • header_correction_text to edit the default text of ‘Corrected Report - Created on {report_date}’
      • header_correction_text_color to edit the default color of black

Detected Targets

This section will display any targets that were Detected/Positive.

  • Section can be removed using display_detected_organisms (set to “false”)
  • Detected targets can be removed from this section by setting the individual Test attribute isControl to true
  • Column widths of table controlled using assay_column_width, result_column_width and qualitative_column_width (sum of widths must equal 12)
    • Note: column widths cannot be adjusted if only displaying 2 columns of data
  • Font size in the tables can be set using results_font_size
  • Sort order of targets can be set using sort_tests_by_name
    • Setting value to “true” will sort the tests alphabetically
    • Setting the value to “false” will sort the tests in the same order as in the uploaded data file

Tested Targets

This section will display all the targets included in the ordered test panel(s).

  • Targets can be removed from this section by setting the individual Test attribute isControl to true
  • Column widths of table controlled using assay_column_width, result_column_width and qualitative_column_width (sum of widths must equal 12)
    • Note: column widths cannot be adjusted if only displaying 2 columns of data
  • Font size in the tables can be set using results_font_size
  • A page break can be inserted before this section using page_break_before_tested_organisms (set to “true”)
  • Sort order of targets can be set using sort_tests_by_name
    • Setting value to “true” will sort the tests alphabetically
    • Setting the value to “false” will sort the tests in the same order as in the uploaded data file
  • This table can be removed and instead display a comma separated list of tested targets by setting the following:
    • display_tested_organisms_as_table (set to "false")
    • display_tested_organisms_as_list (set to "true")

Disclaimer / Methodology

These sections will always display on the last page of the report.

  • Format of the text in these sections can be further altered using HTML
  • A static table can be added to the end of this section using the Test Panel attribute disclaimerTable. Values for this attribute should be entered in a comma separated value format.
    • This table can be further edited using Test Panel attributes disclaimerTableWidth (value in pixels, default is 650) and disclaimerTableFontSize (default is 10)
  • Signature images (or other static images) can be added to the end of this section using static_signature_images (value is http image link and must be entered as an array); the margin above the signature image can be set using signature_margin

Footer

This section will be displayed on the bottom of every page of the report.

  • Footer margin (space between horizontal line and section above footer) is set using footer_margin

Corrected Report Footer:

    Addendum Page

    If enabled, this page is added as the last page of the patient report after the report is signed.

    • Addendum page is enabled using the ‘Append signature addendum page?’ toggle in the applicable report configuration
    • Page numbering will be included on this page if the newest addendum page is configured using the custom_addendum_page of “Reports::RequestIsoAddendumPage”
    • For corrected reports, Comment box will display as ‘Correction Reason’

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.