Ccn notereport.php MENU

From FMYiRCWiki

Freemed-YiRC: ccn_notereport.php Menu Help Page

Contents 1 Summary 2 Menu Overview 2.1 REPORT TEMPLATES 2.2 BASIC OPTIONS 2.3 SORT CRITERIA 2.4 OPTIONAL FILTERS 2.5 AESTHETIC OPTIONS 2.5.1 Optional Fields To Display 2.6 PRINT/PDF OPTIONS 2.7 CSV Options 2.8 Save As/Modify Report Template

Summary

This is the Clinical CaseNote (CCN) Report Generator. It's a highly configurable tool used to create a multitude of reports involving clinical casenotes.

Menu Overview

REPORT TEMPLATES

This section is used to:

• Select an existing template for use
• Access the Report Template Manager - Where report templates can be deleted or made inactive.

Changing anything in this section is optional.

BASIC OPTIONS

The fields in this section are required, but the defaults may be used.

• From and To - The date range of clinical casenotes to include
• Therapist(s) - The list of therapists whose notes are to be included.
  • This can be used to narrow down the list notes in the report.
  • Unless a user has the View Others Notes Security DB permission for the CCN module, the user will only be able to see their own name in this list (and hence, only notes they've written).

SORT CRITERIA

The fields in this section are required, but the defaults may be used. It is likely that a user will wish to modify the settings in this section as these fields define a large portion of how the returned report will look.

This section is used to determine in which order the notes are returned by specifying which sets of major fields are used for sorting. The user can choose up to seven fields to sort by. In addition to sorting/ordering, any fields specified here will show up in this order on the report itself.

To the right of each field are several checkboxes:

• Separate? - Checking this will produce a header for this field, there-by separating (or grouping) similar items. For example, if Resident is chosen here and the checkbox for Separate? is checked, then all the notes for a given Resident will be grouped together.
• Subtotal? - Similar to Separate?, but this provides a set of sub-totals for certain fields for a group. The Separate? checkbox is NOT required to be checked in order to create sub-totals.
• Blank Line After Subtotal? - This will simply add a blank line on the report after a given sub-total. This may be helpful to improve report readability.
• Background Color with Separate? - Checking this box will put the separate line header in a darker-colored background, which may help improve report readability.
• Background Color with Subtotal? - Similar to the above, but for sub-total lines.

OPTIONAL FILTERS

All fields in this section are optional. This section is helpful for situations where the report should be narrowed down in scope.

• Resident(s) - If one or more names are selected from this list, only notes belonging to them will show up on the report.
• Group(s) - If one or more groups are selected from this list, only notes written for those groups will show up on the report.
• Note Type(s) - If one or more items are selected from this list, only those types of notes (NIDs) will show up on the report.
• Billable - Here you can choose whether to narrow the scope of the list to notes that are or are not marked as billable.
• Billed - Here you can choose whether to narrow the scope of the list to notes that have or have not been billed.
• Files (ONLY for systems with the enable_file_attachments CCN module setting set to Enabled) - This can be used to limit the scope of notes returned to those that have or do not have files associated with them.
• Approved (ONLY for systems with the enable_clinical_billing_approval CCN module setting set to Enabled) - This can be used to limit the scope of notes returned to those that have or have not been marked as approved.

AESTHETIC OPTIONS

The fields in this section modify certain items about how the output report looks.

• Show Invoice #? - This is used to determine if a notes Invoice Number shows up on the report or not, and if it's to show up in the first or last column. For basic line-item oriented reports, the invoice number can be set to show up in a given location. However, for summary-type reports using the Separate? or Subtotal?? options in the SORT CRITERIA section, it is not wise to put the invoice number in the first column, as this may throw off the indentation an/or line-item coloring scheme. It's purely an aesthetic issue. For summary-type reports where line-items are not shown at all, the invoice number should not be set to show up.
• Show Table Border/Cell Divisions? - This is used to show the table border/frame/outlines. For a line-item report without separations/sub-totals this can be helpful as it makes columns a little easier to follow. However, for a summary-type report this can be less aesthetically pleasing. Therefore, if any of the Separate? or Subtotal? checkboxes are checked, this is turned off. It may be turned back on if wished.
• Show Line-Item Detail - This can be used to disable the display of line-items, i.e. individual notes. This is only helpful if you want to create a summary-only report and have selected one or more of the Subtotal? checkboxes in the SORT CRITERIA section.
  • Note: This will NOT affect .CSV reports. Even if this is turned off, line items will still show up in the .CSV file.
• Background Color For Line Items - This can be used to turn off row coloring for line-items. This is useful if you're interested in saving printer ink/toner.
• Background Color For Table Header/Footer - Same as above item, except this is for the top-most header and bottom-most grand total lines.

Optional Fields To Display

This section has checkboxes for fields which may be suppressed if wished.

PRINT/PDF OPTIONS

• Report Orientation - This can be used to change the printed/PDF report to Portrait or Landscape.
• Report Font Size (PDF-Only) - This is used to specify the size of the font on PDF reports ONLY... i.e., when viewing the PDF version of the report.

CSV Options

• Create .CSV File - When this is checked a .CSV file will be created containing line-items pertinent to the report. Separated headers/Sub-totals/grand totals will not be included in this file.
• Include Field Header - If this is checked (it is by default) the first line of the file will contain the column/field headers.
• Include Invoice # - If this is checked (it is by default) the last column will contain the invoice number of the note.

Save As/Modify Report Template

• Save Report Template? - If no report template is chosen in the top REPORT TEMPLATES section, then only the first two items below will be available. If a report template is chosen, an additional third option will show up:
  • Do not save - This indicates a report template will not be modified or saved based on the options chosen.
  • Save as New Report Template (Enter name below) - If this is selected, then the chosen options will be saved as a new report template. The name for this new report should be entered into the next field - New Report Template Name. This option can also be used to clone, make a copy of, the chosen report template.
  • Save Changes to Chosen Report Template - This option only shows up if a report template is chosen in the top REPORT TEMPLATES section. If this option is selected, the chosen template will be overwritten with the values on this page.
• New Report Template Name - If Save as New Report Template is chosen in the previous field, this field is used to enter the name the new report will be saved as.