Doc on Report Template

[john-d03]

/document admin/Report Template

[github-actions]

✅ Ezhuthachan completed successfully!

[github-actions]

Ezhuthachan

I opened a pull request with the report template docs.

What I wrote

Authored in version-3.0 and mirrored to version-3.1:

• Concept — concepts/definitions/report-template.mdx
• Flow — flows/definitions/create-a-report-template.mdx
• Flow — flows/definitions/generate-a-report-from-a-template.mdx
• Reference — references/definitions/report-template.mdx

The two flows were added to the manual flow sidebar in both versions, under a new Definitions & Terminology category. The build is [SUCCESS] for both en and ml.

One interpretation you should check

The command said admin/Report Template, but admin is not one of the docs domains. A report template defines the structure of a document that other records are generated from, so I filed it under definitions, as definitions/report-template. Tell me if you wanted it elsewhere, and I will move it.

No doc types were given, so I wrote all three. The slug named a resource, so I looked for the user tasks in care_fe and found two: creating a template, and generating a report from one.

Open question

1. versioned_docs/version-3.{0,1}/references/platform/report.mdx ("Report & Templates") already documents both ReportUpload and Template on one page, which the one-primitive-per-page rule does not allow. I left it alone and only added a link to the new page, because trimming it was outside this request. Do you want a follow-up that reduces it to ReportUpload only?

Bugs and inconsistencies

1. One status value, two user-facing names. The status filter on the template list labels the retired status Archived (care_fe/src/pages/Encounters/TemplateBuilder/TemplateList.tsx, the SelectItem with value="retired" rendering t("archived")), while the status field in the builder labels the same value Retired. A user who retires a template must then filter for "Archived" to find it. High confidence.

2. A registered report type the UI cannot use. care/emr/reports/report_types.py registers encounter_report, but care_fe/src/types/emr/template/template.ts lists only discharge_summary, patient_summary and account_report. encounter_report also has no template_type__encounter_report key in care_fe/public/locale/en.json. So the type cannot be selected in the builder, and a template created through the API with that type would show a raw key in the list. High confidence.

3. Slug validation disagrees with its own message. The builder's zod schema (TemplateBuilder) allows 5 to 25 characters and the pattern ^[a-z0-9-]+$, but the message it shows is built from character_count_validation with a maximum of 36, and slug_format_message reads "Slug must only contain letters, numbers, underscores, and hyphens" although the pattern rejects underscores and uppercase. The backend SlugType allows 5 to 50 characters and does permit underscores. Three different limits for one field. High confidence on the mismatch, medium on which one is intended.

4. A permission with no handler. can_generate_report_for_completed_encounter is defined in care/security/permissions/template.py, but TemplateAccess in care/security/authorization/template.py has no method for it. It is used only from care/security/authorization/encounter.py. It works there, so this may be deliberate placement rather than a defect, but the permission sits in the template module while only encounter authorization reads it. Medium confidence.

Generated by Ezhuthachan for #70 · opus50 · 468.5 AIC · ⌖ 18.4 AIC · ⊞ 14.4K · ◷
_{Comment /document to run again}