Report Formats

Executive Summary

Report Formats is where administrators define the layouts used for printed client face sheets. Each report format has a name, description, page header label and a list of sections (Form Context Fields, Care Documentation, Risks, Contacts and Care Plan). The list page shows every format and lets users add, delete and open formats. Opening a format shows its detail page, where, for formats that are not internal, the sections and their lines can be edited: which items print, in what order, under which section heading, and whether blank items are printed.

Key Features

Create a new client Face Sheet report format
Delete report formats that are not internal
Open a format to review its header details and each section on its own tab
Edit the format name, description, page header label and whether the client photo is printed
Turn whole sections on or off for printing
Add, edit and delete Form Context Field lines (including lines built from a formula) and Contacts lines
Edit the print options, labels and order of Care Documentation, Risks and Care Plan lines
Internal formats are read-only

Typical Workflow

Click Add, choose the Entity and Purpose, enter a Format Name and Description, and click Save. The standard sections are created automatically.
Click the edit icon on the new row (or right-click it and choose Edit) to open the format.
Click Edit to change the format name, description, header label or photo option, or to turn sections on or off, then click Save.
On each tab, add or edit lines to control what prints and in what order.
Use the back link in the page title to return to the list.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

Attribute	What It Controls
View	Open the list and the format detail page

Formats marked Internal cannot be edited or deleted, regardless of permissions.

Main Grid

The grid lists all report formats (14 rows per page).

Column	Description
Code	Report format number.
Format	Format name.
Description	Description of the format.
Template	Name of the report layout file used to print the format.
Internal	Checked for built-in formats that cannot be edited or deleted.
Manage Records	Delete icon and edit icon for the row.

Actions

Button	Description
Add	Opens the Report Format dialog to create a new format.
Edit icon on a row / right-click a row and choose Edit	Opens the format detail page. Any standard sections that are missing from the format are created first.
Delete icon on a row / right-click a row and choose Delete	Asks "Are you sure you want to delete this Report Format?" and deletes it on Yes. Internal formats show a warning and are not deleted.

Dialog Components

Report Format (add)

Opens from Add. Save checks the entries and creates the format; Cancel closes without saving.

Field	Purpose
Entity	What the report is about. Only Client is available. Required.
Purpose	Type of report. Only Face Sheet is available. Required.
Format Name	Name of the format. Required, and must be different from the other Face Sheet formats.
Description	Description of the format. Required.
Page Header Label	Label printed in the page header.
Print Entity Photo	Prints the client photo on the report.

New formats use the standard user-defined face sheet layout. The Form Context Fields, Contacts, Care Documentation, Risks and Care Plan sections are created for the format, with a starting set of lines: one Contacts line, five Care Documentation lines (Current Medical History, Past Medical History, Recent Hospitalizations, Infectious Diseases, Allergies), six Risks lines (Infectious Diseases, Allergy, Environment, Pets, Funder, General) and one Care Plan line (Diagnosis).

Report Format Detail Page

Opens from the edit actions in the main grid. The top of the page shows the Format, Description, Template, Header Label and Print Entity Photo for the format (read-only). The Edit button appears only for formats that are not internal. For internal formats, any attempt to change something shows the warning "Format cannot be modified".

The page has one tab per section.

Tabs

Tab	Purpose
Form Context Fields	Lines that print AlayaCare form context field values, grouped under section headings.
Care Documentation	Care documentation items (medical history, hospitalizations, infectious diseases, allergies) to print.
Risks	Risk categories to print.
Contacts	Which client contacts to print.
Care Plan	Care plan categories to print.

Form Context Fields — Grid

Column	Description
Sequence	Print order.
Section	Section heading the line prints under.
Description	Description of the form context field (or the formula, for a formula line).
Label	Label printed for the line.
Formula	Formula, for lines that use one.
Print Blank	Checked when the line prints even when it has no value.
Manage Records	Delete and edit icons.

Form Context Fields — Grid Actions

Button	Description
Add	Adds a line (shown only for non-internal formats).
Edit icon / right-click Edit	Opens the line for editing.
Delete icon / right-click Delete	Deletes the line after you confirm "Are you sure you want to delete this form context field from this report?".

Care Documentation — Grid

Column	Description
Sequence	Print order.
Section Label To Print On Report	Heading printed on the report.
AlayaCare Entity	The care documentation item the line refers to.
Print Blank	Checked when the item prints even when it has no data.
Include in Report	Checked when the item is printed.
Manage Records	Edit icon.

Care Documentation — Grid Actions

Button	Description
Edit icon / right-click Edit	Opens the line for editing. Lines cannot be added or deleted.

Risks — Grid

Column	Description
Sequence	Print order.
AlayaCare Entity	The risk category.
Include in Report	Checked when the category is printed.
Manage Records	Edit icon.

Risks — Grid Actions

Button	Description
Edit icon / right-click Edit	Opens the category for editing. Lines cannot be added or deleted.

Contacts — Grid

Column	Description
Sequence	Print order.
Section	Section heading the contacts print under.
Description	Contact types the line applies to.
Print Blank	Checked when the line prints even when there are no contacts.
Include in Report	Checked when the line is printed.
Manage Records	Delete and edit icons.

Contacts — Grid Actions

Button	Description
Add	Adds a contacts line (shown only for non-internal formats).
Edit icon / right-click Edit	Opens the line for editing.
Delete icon / right-click Delete	Deletes the line after you confirm "Are you sure you want to delete this contact category from this report?".

Care Plan — Grid

Column	Description
Sequence	Print order.
AlayaCare Entity	The care plan category.
Include in Report	Checked when the category is printed.
Print Blank	Checked when the category prints even when it has no data.
Manage Records	Edit icon.

Care Plan — Grid Actions

Button	Description
Edit icon / right-click Edit	Opens the category for editing. Lines cannot be added or deleted.

Report Format (edit)

Opens from Edit on the detail page. Save updates the format (Format Name is required); Cancel closes without saving.

Field	Purpose
Format Name	Name of the format.
Description	Description of the format.
Page Header Label	Label printed in the page header.
Print Entity Photo	Prints the client photo on the report.
Sections grid	Lists each section by Type with a Print Section checkbox. Click the edit icon (or right-click and choose Edit) to open the Report Format Section dialog.

Report Format Section

Opens from the Sections grid. Shows the section Type (read-only) and a Print Section checkbox that turns the whole section on or off. Save updates the section; Cancel closes.

Form Context Field

Opens from Add or edit on the Form Context Fields tab. Section is required, and you can pick an existing heading or type a new one.

Field	Purpose
Complex Formula	Switches the line between a single form context field and a formula.
Print Blanks	Prints the line even when it has no value.
Select A Form Context Field Code	Form context field to print (shown when Complex Formula is off; required, searchable).
Label Override	Label to print instead of the field's own label (shown when Complex Formula is off).
Label	Label to print (shown when Complex Formula is on).
Formula	Formula to evaluate (shown when Complex Formula is on; required).
Section	Section heading the line prints under.
Sequence	Print order.

Contacts

Opens from Add or edit on the Contacts tab. Section is required.

Field	Purpose
Include in Report	Prints the line.
Print Blanks	Prints the line even when there are no matching contacts.
Print All Contacts	Prints all contacts.
Emergency Contacts	Limits the line to emergency contacts.
Contact Types	Contact types the line applies to.
Relationships	Relationships the line applies to.
Form Context Field	Form context field used to select contacts.
Value	Value that the form context field must have.
Section	Section heading the contacts print under.
Sequence	Print order.

Care Documentation Detail

Opens from edit on the Care Documentation tab. Section Label To Print On Report is required.

Field	Purpose
Include in Report	Prints the item.
Print Blanks	Prints the item even when it has no data.
Section Label To Print On Report	Heading printed on the report.
Sequence	Print order.

Risk

Opens from edit on the Risks tab; the title shows the risk category. Fields: Print Detail (prints the category) and Sequence (print order).

Care Plan

Opens from edit on the Care Plan tab; the title shows the care plan category. Fields: Print Detail (prints the category), Print Blanks (prints the category even when it has no data) and Sequence (print order).

Dependencies

The following tables must be configured for lookups on this view to work:

Table	Description
Form Context Fields	Fields offered in the Select A Form Context Field Code dropdown.