[docs] Report template docs: concept, flows and reference

[github-actions]

Ezhuthachan

Closes the request in #70 (/document admin/Report Template).

Interpretation of the request

The request named the domain admin, which is not one of the docs domains. A report template is a reusable definition that instance records are generated from, so it is filed under definitions with the slug report-template. Please say so if you wanted a different home.

No <doc-types> was given, so all three layers were written. Because the slug names a resource, the flows were discovered from care_fe and one flow was written per user task.

Files added

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

• concepts/definitions/report-template.mdx
• flows/definitions/create-a-report-template.mdx
• flows/definitions/generate-a-report-from-a-template.mdx
• flows/definitions/_category_.json (new flows domain folder)
• references/definitions/report-template.mdx

Files changed

• versioned_sidebars/version-3.0-sidebars.json, versioned_sidebars/version-3.1-sidebars.json — added the manual Definitions & Terminology flow category with the two new flow ids.
• versioned_docs/version-3.{0,1}/references/platform/report.mdx — one added line only, linking the new template reference from Related. No document was rewritten.

The existing references/platform/report.mdx ("Report & Templates") still covers both ReportUpload and Template in one page, which the one-primitive-per-page rule does not allow. It was left in place rather than trimmed, because splitting it is a change to a page that was not part of this request. It should be reduced to ReportUpload in a follow-up.

Sources traced

code/care:

• care/emr/models/report/template.py, care/emr/models/base.py (slug prefixing)
• care/emr/resources/report/template/spec.py (statuses, formats, validators, the four specs)
• care/emr/api/viewsets/report/template.py, care/emr/api/viewsets/report/report_upload.py
• care/security/permissions/template.py, care/security/authorization/template.py, care/security/authorization/encounter.py
• care/emr/reports/report_types.py, care/emr/reports/context_builder/data_points/, care/emr/reports/renderer/

code/care_fe:

• src/pages/Encounters/TemplateBuilder/ (TemplatePage, TemplateList, TemplateCard, TemplateBuilder, TemplateReportSheet)
• src/components/Files/ReportSubTab.tsx, src/components/ui/sidebar/facility/facility-nav.tsx
• public/locale/en.json for every user-visible label

Left out because it could not be verified

• No keyboard shortcut is documented for template actions. src/config/keyboardShortcuts.json binds shortcuts for the Reports tab and for viewing or printing a report, but none for creating a template or generating a report from one.
• The encounter_report report type is registered in the backend but is not offered in the builder, so it is listed in the reference table only and is absent from the concept and the flows.

Validation

• Corruption scan returns nothing.
• npm run build is [SUCCESS] for both en and ml.

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

[cloudflare-workers-and-pages]

Deploying coredocs with    Cloudflare Pages

Latest commit:	f2eee76
Status:	✅  Deploy successful!
Preview URL:	https://88d68065.coredocs.pages.dev
Branch Preview URL:	https://docs-report-template-144e4d0.coredocs.pages.dev

View logs