Flows/Edit a report template: Difference between revisions

Content deleted Content added

VisualWikitext

Inline

Latest revision as of 17:25, 14 August 2026

flowplatformCARE 3.0+

Overview

This flow describes how to change an existing report template in Care. Use the same flow to retire a template.

Pre-requisites

The facility has a report template that you want to change.
You are a member of that facility.
You have the permissions listed below.

Permissions

Permission	Access
Can Create Template on Facility	Lets you create and edit report templates. Facility Admin, Admin, Doctor, and Nurse have this permission.

Steps

1. Open the template

Go to the Templates page of the facility. See View report templates.

Select the template that you want to change. Care opens the same builder that you use to create a template. The builder shows the current values of the template.

2. Change the template

Change any of the fields in the table below.

Components	What it captures
Name	The name of the template.
Status	The state of the template: Draft, Active, or Retired.
Template Type	The kind of document that the template produces: Discharge Summary, Patient Summary, or Account Report.
Context	The set of data fields that the template can use. The context must match the template type.
Default Format	The output format of the report: PDF or HTML.
Description	A short text about the purpose of the template.
Template Body	The content of the document.

📝 Note

Only a template with Status set to Active can generate a report. A template with Status set to Draft or Retired does not appear as an option. See Generate and view a report.

3. Retire the template

To stop staff from using the template for new reports, set Status to Retired.

📝 Note

Care has no delete action and no separate retire action for a report template. Use the Status field.

4. Save the template

Select Save.

Expected Outcome

Care saves your changes and shows the message “Template updated”.
If you set Status to Retired, staff can no longer use the template to generate a new report.

Concept: Concepts/Report Template
Reference: References/Report & Templates

@@ Line 3: / Line 3: @@
 |domain=platform
 |title=Edit a report template
-|summary=Update or retire an existing report template.
+|summary=This flow describes how to change an existing report template in Care. Use the same flow to retire a template.
 |order=3
 |introduced=3.0
@@ Line 9: / Line 9: @@
 |reference=References/Report & Templates
 }}
+== Overview ==
+This flow describes how to change an existing [[Concepts/Report Template|report template]] in Care. Use the same flow to retire a template.
+== Pre-requisites ==
+* The facility has a report template that you want to change.
+* You are a member of that facility.
+* You have the permissions listed below.
+== Permissions ==
+{| class="wikitable"
+|-
+! Permission
+! Access
+|-
+| Can Create Template on Facility
+| Lets you create and edit report templates. Facility Admin, Admin, Doctor, and Nurse have this permission.
+|}
 == Steps ==
-# Open the facility's Templates page and select the template.
+=== 1. Open the template ===
-# Edit its details or Jinja2 body.
-# Preview the output.
+Go to the '''Templates''' page of the facility. See [[Flows/View report templates|View report templates]].
-# Save the changes. To remove it from use, set Status to '''Retired'''.
+Select the template that you want to change. Care opens the same builder that you use to create a template. The builder shows the current values of the template.
+=== 2. Change the template ===
+Change any of the fields in the table below.
+{| class="wikitable"
+|-
+! Components
+! What it captures
+|-
+| Name
+| The name of the template.
+|-
+| Status
+| The state of the template: Draft, Active, or Retired.
+|-
+| Template Type
+| The kind of document that the template produces: Discharge Summary, Patient Summary, or Account Report.
+|-
+| Context
+| The set of data fields that the template can use. The context must match the template type.
+|-
+| Default Format
+| The output format of the report: PDF or HTML.
+|-
+| Description
+| A short text about the purpose of the template.
+|-
+| Template Body
+| The content of the document.
+|}
+{{Note|1=Only a template with Status set to Active can generate a report. A template with Status set to Draft or Retired does not appear as an option. See [[Flows/Generate and view a report|Generate and view a report]].}}
+=== 3. Retire the template ===
+To stop staff from using the template for new reports, set Status to Retired.
+{{Note|1=Care has no delete action and no separate retire action for a report template. Use the Status field.}}
+=== 4. Save the template ===
+Select '''Save'''.
 == Expected Outcome ==
-Care updates the template. Previously generated reports remain unchanged.
+* Care saves your changes and shows the message “Template updated”.
-{{Note|1=Care has no delete action for report templates.}}
+* If you set Status to Retired, staff can no longer use the template to generate a new report.
 {{Navbox platform}}