Portal Docs v4

Staff

Reports

How a report is read — each one a saved question with its own columns, never a query builder.

Access

How a member of staff reaches the screen, and what has to be true for it to open.

Element What it decides Permissions
Navigation Side menu → Reports. Me:reports.access

Header

What the band states before anything below it is actionable.

Element What it decides Permissions
Title “Reports”, grouped by category. —
Inside a report Its category and how many rows it holds, so the size of the answer is known before it is read. —

Main actions

What belongs to the page rather than to one report.

Element What it decides Permissions
Export A CSV of the report as filtered. Offered inside a report only, where its columns are known. Me:reports.export
Request Asks for a long report to be delivered once it is ready; each request is listed in Report requests. Client:reports.requestsRemote:request_report

Filters

Which reports, and which rows of a report, are shown.

Element What it decides Permissions
Category Narrows the list to one category. —
Date range Narrows a report to the period chosen. —
Search Finds reports by name, or rows within a report. —
Scope Filters belong to the report in view, and clear on leaving it. —

Table

The reports the practice can read, each with its own columns.

Element What it decides Permissions
Audit log Date & time · User · Role · Action · Details. —
Form changes Date & time · Form · Field changed · Old value · New value · User. —
Documents received Received · File name · Source · Type · Status · Size. —
Sync Date · Patient · Sync type · Status · Records synced. —
Report requests Requested · Report · Requested by · Status · Delivery. —
Notifications & SMS Sent · Recipient · Channel or message type · Status · Delivered. —
Calls Date · Caller · Duration · Outcome · Queue. —
Portal activity Date · Patient · Channel · Action · Portal login. —
Quality measures Measure · Numerator · Denominator · Percentage · Period. —
Tasks & productivity Task history, open tasks and staff productivity. —

Row actions

Where a row leads.

Element What it decides Permissions
Open A report in the list opens it; a row inside a report opens the record it describes. —

Errors

Not yet written from the code.

API calls

Not yet written from the code.