From 90b2c317dc15d25091df75abba44019e989b898f Mon Sep 17 00:00:00 2001 From: Aravind Mahadevan Date: Wed, 12 Aug 2026 16:12:47 +0530 Subject: [PATCH] Add Tag and Report Template docs for 3.1 Publish the Tag and Report Template modules from the care_docs sources under the platform domain. Refreshes the tagging concept, adds a new report template concept, and adds ten flows under a new Platform category in the 3.1 flows sidebar. --- .../concepts/platform/report-template.mdx | 77 +++++++++++++ .../version-3.1/concepts/platform/tagging.mdx | 106 +++++++++++------- .../flows/platform/_category_.json | 5 + .../platform/report-template/_category_.json | 5 + .../create-a-report-template.mdx | 79 +++++++++++++ .../edit-a-report-template.mdx | 73 ++++++++++++ .../generate-and-view-a-report.mdx | 85 ++++++++++++++ .../report-template/preview-a-template.mdx | 67 +++++++++++ .../report-template/view-report-templates.mdx | 63 +++++++++++ .../flows/platform/tagging/_category_.json | 5 + .../platform/tagging/archive-a-child-tag.mdx | 59 ++++++++++ .../platform/tagging/create-a-child-tag.mdx | 69 ++++++++++++ .../flows/platform/tagging/create-a-tag.mdx | 79 +++++++++++++ .../flows/platform/tagging/edit-a-tag.mdx | 70 ++++++++++++ .../flows/platform/tagging/view-tags.mdx | 92 +++++++++++++++ versioned_sidebars/version-3.1-sidebars.json | 31 +++++ 16 files changed, 925 insertions(+), 40 deletions(-) create mode 100644 versioned_docs/version-3.1/concepts/platform/report-template.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/_category_.json create mode 100644 versioned_docs/version-3.1/flows/platform/report-template/_category_.json create mode 100644 versioned_docs/version-3.1/flows/platform/report-template/create-a-report-template.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/report-template/edit-a-report-template.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/report-template/generate-and-view-a-report.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/report-template/preview-a-template.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/report-template/view-report-templates.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/tagging/_category_.json create mode 100644 versioned_docs/version-3.1/flows/platform/tagging/archive-a-child-tag.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/tagging/create-a-child-tag.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/tagging/create-a-tag.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/tagging/edit-a-tag.mdx create mode 100644 versioned_docs/version-3.1/flows/platform/tagging/view-tags.mdx diff --git a/versioned_docs/version-3.1/concepts/platform/report-template.mdx b/versioned_docs/version-3.1/concepts/platform/report-template.mdx new file mode 100644 index 00000000..6bf92373 --- /dev/null +++ b/versioned_docs/version-3.1/concepts/platform/report-template.mdx @@ -0,0 +1,77 @@ +--- +sidebar_position: 2 +--- + +# Report Template + +## Definition + +A **report template** in Care is a facility-level definition of a reusable, printable document, such as a discharge summary. A facility admin builds the template one time. Care team members then generate reports from the template for a patient's encounter, for a patient, or for a billing account. The type of the template decides which of these the report covers. + +Note: A report template is native to Care. It has no matching FHIR R5 resource. + +## Key Attributes + +| Components | What it captures | +| --- | --- | +| Name | The name of the template. Care team members see this name when they choose a template. | +| Status | Whether the template is Draft, Active, or Retired. | +| Default Format | The file format that Care produces for a report, either PDF or HTML. | +| Template Type | The kind of record that the template is for: Discharge Summary, Patient Summary, or Account Report. | +| Context | The set of data fields that the template can use. Care matches the context to the template type. | +| Description | A short explanation of the purpose of the template. | +| Template Body | The content and layout of the document. You write the body in the Jinja2 templating language, with placeholders that pull in real data when Care generates a report. | + +### Template Type and Context + +The template type states which kind of record the template describes. Select one of these values: + +- Discharge Summary +- Patient Summary +- Account Report + +The context is the set of data fields that the template can use. Care matches the context to the template type. The placeholders in the template body read their values from this context. + +### Generated Reports + +A report template is only the definition of a document. When a care team member generates a report from the template, Care creates a separate generated report with its own file in PDF or HTML format. Care stores the generated report, so that you can view it, download it, print it, or generate it again later. + +You can archive a generated report, and you must give a reason for the archive. The generated report stays available after you retire the template that produced it. + +## Status + +| Status | Description | +| --- | --- | +| Draft | The template is still in preparation. You cannot generate a report from it. | +| Active | The template is ready for use. Only an Active template can produce a report. | +| Retired | Care no longer offers the template for new reports. | + +Note: Care has no delete action for a report template. To take a template out of use, edit it and set the status to Retired. + +## Permissions + +| Permission | Roles | +| --- | --- | +| Can Create Template on Facility | Facility Admin, Admin, Doctor, Nurse | +| Can Read Template | Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, Pharmacist | +| Can Preview Template | Facility Admin, Admin | +| Can generate report from template | Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, Pharmacist | +| Can generate report for completed encounter | Facility Admin, Admin | + +Note: If the encounter is complete, you need Can generate report for completed encounter as well as Can generate report from template. + +## Where to find it + +Care shows report templates on the **Templates** page of a facility. This page holds the list of templates and the template builder. + +Care shows generated reports in the **Reports** section of the **Overview** tab of an encounter. This section lists the Active Discharge Summary templates that you can generate a report from. + +## Related + +- Flow: [Create a report template](../../flows/platform/report-template/create-a-report-template.mdx) +- Flow: [Preview a template](../../flows/platform/report-template/preview-a-template.mdx) +- Flow: [Edit a report template](../../flows/platform/report-template/edit-a-report-template.mdx) +- Flow: [View report templates](../../flows/platform/report-template/view-report-templates.mdx) +- Flow: [Generate and view a report](../../flows/platform/report-template/generate-and-view-a-report.mdx) +- Concept: [Encounter](../../concepts/clinical/encounter.mdx) +- Concept: [Diagnostic Report](../../concepts/clinical/diagnostic-report.mdx) diff --git a/versioned_docs/version-3.1/concepts/platform/tagging.mdx b/versioned_docs/version-3.1/concepts/platform/tagging.mdx index 730eaa38..8ef9e5a8 100644 --- a/versioned_docs/version-3.1/concepts/platform/tagging.mdx +++ b/versioned_docs/version-3.1/concepts/platform/tagging.mdx @@ -2,69 +2,95 @@ sidebar_position: 1 --- -# Tagging +# Tag -A **tag** in Care is a reusable label you attach to a record — a patient, an encounter, an order — to classify it and find it again later. Tagging is how a deployment layers its own vocabulary on top of Care's clinical model: priority flags, dietary restrictions, drug categories, safety alerts, and any other grouping a workflow needs. +## Definition -## What it represents +A **tag** in Care is a label that you define once and then attach to records such as encounters, service requests, and accounts. You define a tag for one facility, and staff at that facility can then apply it. A superuser can also define an instance-wide tag that every facility can use. -A tag is not free text typed onto a record. Each label is a controlled definition — the `TagConfig` resource — created ahead of time, then reused across many records. That separation is the whole point: because every "Penicillin Allergy" tag traces back to one definition, you can filter, count, and report on it reliably instead of chasing a dozen spellings. +Note: Care has no FHIR R5 resource for a tag. A tag works like a coded value that your organization defines for its own use. -A definition carries the things that make a label usable: a human-readable name and category (`diet`, `drug`, `lab`, `admin`, `clinical`, `safety`, `advance_directive`, and a few more), display hints like a color and icon, an ordering priority, the one resource type it targets, the owner that governs it, and its place in the tag tree. The sections below cover the three of those that shape how tags behave: target, ownership, and hierarchy. +Note: This document covers the tag definition only. To attach a tag to a record or remove it, read the documentation of that record. For encounters, read [Manage Encounter tags](../../flows/clinical/encounter/manage-encounter-tags.mdx). -## How it connects +## Key Attributes -A tag never lives inside the thing it labels. The definition is created once and then *applied* to records of its target type, and each tagged record simply stores which tags it carries: +| Components | What it captures | +| --- | --- | +| Display | The name of the tag that Care shows to users. | +| Category | The subject area of the tag. | +| Resource | The type of record that you can attach the tag to. You select this when you create the tag, and you cannot change it later. | +| Priority | A number that sets the order of the tag in lists. The default value is 100. | +| Status | Whether staff can apply the tag. | +| Description | A short text that explains the purpose of the tag. | +| Managing Organization | The facility organization that manages the tag. For an instance-wide tag, this is an instance-level organization. | +| Has Children | Whether the tag has child tags under it. | -- A **patient** can carry instance-wide tags and facility-specific tags. -- An **encounter** carries its own set of tags. -- Orders and financial records — service requests, prescriptions, charge items, supply requests, accounts, and more — each accept tags scoped to their resource type. +### Category -Because a definition declares exactly **one** target resource, a patient tag can never be applied to an encounter, and vice versa. This is a deliberate guardrail: it keeps each resource type's vocabulary clean and stops one sprawling, mixed-up pile of labels from forming. +Category groups tags by subject area. Select one of these values: -Ownership works the same way — a tag belongs to exactly one scope: an instance-wide organization, a facility-scoped organization, or a single facility. Instance tags give a deployment shared vocabulary everywhere; facility-scoped tags let a site add labels that only make sense locally. +- Diet +- Drug +- Lab +- Admin +- Contact +- Clinical +- Behavioral +- Research +- Advance Directive +- Safety -## Tree structure +### Resource -Tags form a hierarchy, so a deployment can model a vocabulary from broad to narrow: +Resource sets the type of record that staff can attach the tag to. Select one of these values: -```text -Allergy → Drug Allergy → Penicillin Allergy -``` +- Encounter +- Service Request +- Charge Item +- Charge Item Definition +- Account +- Token Booking +- Medication Request Prescription +- Supply Request Order +- Supply Delivery Order +- Patient -A tag with no parent is a **root** — the top of a vocabulary. A **child** narrows its parent, and must target the **same resource type**, so a branch never mixes patient labels with encounter labels. The hierarchy lets you filter at any depth: ask for everything under "Allergy," or drill into just "Penicillin Allergy." You only choose each tag's parent; the platform maintains the tree positions behind it. +### Parent and child tags -## Lifecycle +You can arrange tags in a tree. A root tag holds one or more child tags. A child tag takes the Category and the Resource of its parent tag, and you cannot change these two fields on the child tag. -```text -active → archived -``` +Child tags under the same parent work as a set of choices. Staff can apply only one child tag from a parent group to a record at a time. If staff select a different child tag under the same parent, Care replaces the earlier selection. A root tag without children has no such limit, and staff can combine it with other tags. -- **active** — the tag can be applied to new records. -- **archived** — the tag is retired from new use but kept for history, so records labelled in the past stay correctly classified and auditable. +## Status -Archiving rather than deleting is what lets a vocabulary evolve without rewriting the past. +Care has no delete action for a tag. To stop the use of a tag, set its status to Archived. -## Permissions +| Status | Description | +| --- | --- | +| Active | Staff can apply the tag to records. | +| Archived | Staff can no longer apply the tag to records. | + +To archive a root tag, edit the tag. Change the Status field to Archived. Care has no one-click archive action for a root tag. For a child tag, Care shows an Archive action. Care asks you to confirm before it archives the child tag. -Access to tags separates three actions: defining them, applying them, and reading them. +## Permissions -| Permission | Description | System Roles | +| Permission | Who has it | What it allows | | --- | --- | --- | -| `can_write_tag_config` | Create new tag definitions and edit existing ones within a facility (the viewset checks this for both create and update) | Facility Admin, Admin | -| `can_read_tag_config` | List and retrieve tag definitions in a facility | Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, Pharmacist | -| `can_apply_tag_config` | Attach an existing tag to records of its target type (patients, encounters, and other resources) | Facility Admin, Admin, Staff, Doctor, Nurse, Pharmacist | +| Can Create Tag Config on Facility | Facility Admin, Admin | Create and update a tag. | +| Can Apply Tag Config to Resources | Facility Admin, Admin, Staff, Doctor, Nurse, Pharmacist | Attach a tag to a record and remove it. | +| Can Read Tag Config | Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, Pharmacist | View tags. | -Permissions cascade down the organization tree, so curating the shared vocabulary stays with administrators while frontline clinical staff can apply and read tags during care. +Note: Only a superuser can create or update an instance-wide tag. -## Related +## Where to find tags -- Reference: [Tag Config (technical)](../../references/platform/tag-config.mdx) -- Concept: [Patient](../clinical/patient) — carries instance and facility tags -- Concept: [Encounter](../clinical/encounter.mdx) — carries its own tags -- Concept: [Organization](../access-governance/organization.mdx) — tags can be org-scoped and reuse its tree pattern -- Concept: [Facility](../facility/facility.mdx) — facility-scoped tags +Care shows facility tags in the Settings area of a facility, under Tag config. Care shows instance-wide tags in a separate global Admin area. -## FHIR reference +## Related -Care's tagging is a platform extension rather than a single FHIR resource. It plays the role FHIR fills with coded `tag` and `category` elements on a resource's `meta` — a controlled, hierarchical vocabulary applied to records for classification and filtering. +- Flow: [Create a tag](../../flows/platform/tagging/create-a-tag.mdx) +- Flow: [Create a child tag](../../flows/platform/tagging/create-a-child-tag.mdx) +- Flow: [View tags](../../flows/platform/tagging/view-tags.mdx) +- Flow: [Edit a tag](../../flows/platform/tagging/edit-a-tag.mdx) +- Flow: [Archive a child tag](../../flows/platform/tagging/archive-a-child-tag.mdx) +- Concept: [Encounter](../../concepts/clinical/encounter.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/_category_.json b/versioned_docs/version-3.1/flows/platform/_category_.json new file mode 100644 index 00000000..49f4627e --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Platform", + "position": 7, + "key": "platform-flows" +} diff --git a/versioned_docs/version-3.1/flows/platform/report-template/_category_.json b/versioned_docs/version-3.1/flows/platform/report-template/_category_.json new file mode 100644 index 00000000..38b8b67c --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/report-template/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Report Template", + "position": 2, + "key": "platform-report-template-flows" +} diff --git a/versioned_docs/version-3.1/flows/platform/report-template/create-a-report-template.mdx b/versioned_docs/version-3.1/flows/platform/report-template/create-a-report-template.mdx new file mode 100644 index 00000000..bf78c41a --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/report-template/create-a-report-template.mdx @@ -0,0 +1,79 @@ +--- +sidebar_position: 1 +--- + +# Create a report template + +## Overview + +This flow describes how to create a new [report template](../../../concepts/platform/report-template.mdx) for a facility in Care. + +## Pre-requisites + +- You are a member of the facility that you create the template for. +- You know which data the report must show, so that you can pick the correct template type and context. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Create Template on Facility | Create a report template for the facility. Facility Admin, Admin, Doctor, and Nurse have this permission. | + +## Steps + +### 1. Open the template builder + +Open the **Templates** page of the facility. + +Select **Create Template**. Care opens the template builder. + +### 2. Fill in the template details + +Complete the fields in the builder. + +| Components | What it captures | +| --- | --- | +| Name | The name of the template. This field is required. Care creates a matching short name for the URL from the name. You can change the short name. The short name has 5 to 25 characters. Use lowercase letters, numbers, and hyphens only. | +| Status | The state of the template: Draft, Active, or Retired. A new template normally starts as Draft. | +| Template Type | The kind of document that the template produces: Discharge Summary, Patient Summary, or Account Report. This field is required. | +| Context | The set of data fields that the template can use. This field is required. The context must match the template type that you select. | +| Default Format | The output format of the report: PDF or HTML. This field is required. | +| Description | A short text about the purpose of the template. This field is optional. | +| Template Body | The content of the document. This field is required. Write the content in the Jinja2 templating language in the large text area. | + +### 3. Insert data fields into the template body + +The builder shows the available data fields for the context that you select in a side panel. + +Put the cursor in the template body at the position for the data field. + +Select a data field in the side panel. Care inserts a placeholder for that field at the cursor position. + +The placeholder shows the real value in the report. For example, insert the patient name or the discharge advice. + +### 4. Check the result + +Render a sample of the template before you save it. See [Preview a template](./preview-a-template.mdx). + +### 5. Save the template + +Select **Save**. + +## Expected Outcome + +- Care shows the message "Template saved". +- Care opens the builder page of the new template, so that you can continue to edit it. + +## Related + +Concepts: + +- [Report Template](../../../concepts/platform/report-template.mdx) + +Flows: + +- [Preview a template](./preview-a-template.mdx) +- [Edit a report template](./edit-a-report-template.mdx) +- [View report templates](./view-report-templates.mdx) +- [Generate and view a report](./generate-and-view-a-report.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/report-template/edit-a-report-template.mdx b/versioned_docs/version-3.1/flows/platform/report-template/edit-a-report-template.mdx new file mode 100644 index 00000000..a7656911 --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/report-template/edit-a-report-template.mdx @@ -0,0 +1,73 @@ +--- +sidebar_position: 3 +--- + +# Edit a report template + +## Overview + +This flow describes how to change an existing [report template](../../../concepts/platform/report-template.mdx) 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](./view-report-templates.mdx). + +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](./generate-and-view-a-report.mdx). + +### 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. + +## Related + +Concepts: + +- [Report Template](../../../concepts/platform/report-template.mdx) + +Flows: + +- [Create a report template](./create-a-report-template.mdx) +- [Preview a template](./preview-a-template.mdx) +- [View report templates](./view-report-templates.mdx) +- [Generate and view a report](./generate-and-view-a-report.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/report-template/generate-and-view-a-report.mdx b/versioned_docs/version-3.1/flows/platform/report-template/generate-and-view-a-report.mdx new file mode 100644 index 00000000..0b16885e --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/report-template/generate-and-view-a-report.mdx @@ -0,0 +1,85 @@ +--- +sidebar_position: 5 +--- + +# Generate and view a report + +## Overview + +This flow describes how to generate a report for an encounter from a [report template](../../../concepts/platform/report-template.mdx). You can then view the report, download it, print it, or generate it again. + +## Pre-requisites + +- The patient is registered in Care, and the patient has an encounter at the facility. +- The facility has at least one Discharge Summary template with the status Active. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Read Template | See the report templates in the Reports section. Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, and Pharmacist have this permission. | +| Can generate report from template | Generate a report from a template. Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, and Pharmacist have this permission. | +| Can generate report for completed encounter | Generate a report when the encounter is complete. Facility Admin and Admin have this permission. | + +Note: If the encounter is complete, you need both Can generate report from template and Can generate report for completed encounter. + +## Steps + +### 1. Open the encounter + +Open the encounter of the patient. + +Go to the **Overview** tab. + +### 2. Open the Reports section + +Go to the **Reports** section of the Overview tab. + +Care shows a button for each Discharge Summary template with the status Active at the facility. Each button carries the name of the template. + +### 3. Select a template + +Select the button of the template that you want. + +Care opens the report viewer for that template and that encounter. + +If no report exists for this template and encounter, Care generates one. + +Note: Care generates the report in the background. Care checks the progress until the file is ready, or until the time limit ends. + +### 4. View the report + +Care shows the rendered PDF or HTML file in the viewer. + +From the viewer, you can do these actions: + +- Download the report. +- Print the report. +- Generate the report again. Generate the report again after the encounter data changes. + +### 5. Open an earlier report + +The viewer lists the reports that Care generated before for this template and this encounter. + +Select an earlier report to open that version instead of the latest one. + +## Expected Outcome + +- Care generates a report for the encounter from the selected template. +- Care shows the report in the viewer, and you can download it or print it. +- Care keeps the earlier reports for the template and the encounter, and you can open them again. + +## Related + +Concepts: + +- [Report Template](../../../concepts/platform/report-template.mdx) +- [Encounter](../../../concepts/clinical/encounter.mdx) + +Flows: + +- [Create a report template](./create-a-report-template.mdx) +- [Preview a template](./preview-a-template.mdx) +- [Edit a report template](./edit-a-report-template.mdx) +- [View report templates](./view-report-templates.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/report-template/preview-a-template.mdx b/versioned_docs/version-3.1/flows/platform/report-template/preview-a-template.mdx new file mode 100644 index 00000000..91d4201c --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/report-template/preview-a-template.mdx @@ -0,0 +1,67 @@ +--- +sidebar_position: 2 +--- + +# Preview a template + +## Overview + +This flow describes how to preview a [report template](../../../concepts/platform/report-template.mdx) in the template +builder. Care renders a sample document, so you can check the layout before you +make the template active. + +## Pre-requisites + +- You create a new report template, or you edit an existing report template, and the template builder is open. +- You entered the template body. You selected a Context and a Default Format. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Preview Template | Lets a Facility Admin or an Admin preview a report template. | + +## Steps + +### 1. Open the template in the builder + +Create a new report template, or edit an existing report template. The builder shows the +template body, the Context, and the Default Format. + +### 2. Preview the template + +Select **Preview** in the builder. Care renders the template body with sample data for +the selected Context and Default Format. + +### 3. Check the rendered sample + +Care shows the sample document in the builder as a PDF or an HTML preview. Read the +sample, and check the layout and the wording. + +Note: Care uses sample placeholder data for the preview. Care does not generate a +report for a patient in this flow. + +### 4. Correct any errors + +If the template body has a syntax problem, Care shows a validation error. Read the +error, correct the template body, and select **Preview** again. + +## Expected Outcome + +- Care shows the message "Template preview generated". +- Care shows the sample document in the builder. +- You confirm the layout and the wording before you set the Status to Active. + +## Related + +Concepts: + +- [Report Template](../../../concepts/platform/report-template.mdx) + +Flows: + +- [Create a report template](./create-a-report-template.mdx) +- [Edit a report template](./edit-a-report-template.mdx) +- [View report templates](./view-report-templates.mdx) +- [Generate and view a report](./generate-and-view-a-report.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/report-template/view-report-templates.mdx b/versioned_docs/version-3.1/flows/platform/report-template/view-report-templates.mdx new file mode 100644 index 00000000..fa049f46 --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/report-template/view-report-templates.mdx @@ -0,0 +1,63 @@ +--- +sidebar_position: 4 +--- + +# View report templates + +## Overview + +This flow describes how to view the [report templates](../../../concepts/platform/report-template.mdx) of a facility in Care. You can search and filter the templates. + +## Pre-requisites + +- You are a member of the facility. +- The facility has at least one report template. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Read Template | View the report templates of the facility. Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, and Pharmacist have this permission. | + +## Steps + +### 1. Open the Templates page + +Open the facility. Select **Templates**. Care shows a grid of template cards. + +### 2. Search for a template + +Enter the name of the template in the search field. Care shows the template cards that match the name. + +### 3. Filter the templates + +Use the filters to reduce the number of template cards. + +| Filter | What it selects | +| --- | --- | +| Status | Draft, Active, or Retired templates | +| Template Type | Discharge Summary, Patient Summary, or Account Report templates | + +### 4. Open a template + +Select a template card. Care opens the builder page of the template. The page shows the current details of the template. To change the details, see [Edit a report template](./edit-a-report-template.mdx). + +## Expected Outcome + +- Care shows the report templates of the facility as cards. +- Care shows only the templates that match your search text and your filters. +- Care opens the builder page of the template that you select. + +## Related + +Concepts: + +- [Report Template](../../../concepts/platform/report-template.mdx) + +Flows: + +- [Create a report template](./create-a-report-template.mdx) +- [Preview a template](./preview-a-template.mdx) +- [Edit a report template](./edit-a-report-template.mdx) +- [Generate and view a report](./generate-and-view-a-report.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/tagging/_category_.json b/versioned_docs/version-3.1/flows/platform/tagging/_category_.json new file mode 100644 index 00000000..465ba230 --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/tagging/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Tag", + "position": 1, + "key": "platform-tagging-flows" +} diff --git a/versioned_docs/version-3.1/flows/platform/tagging/archive-a-child-tag.mdx b/versioned_docs/version-3.1/flows/platform/tagging/archive-a-child-tag.mdx new file mode 100644 index 00000000..c09b894d --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/tagging/archive-a-child-tag.mdx @@ -0,0 +1,59 @@ +--- +sidebar_position: 5 +--- + +# Archive a child tag + +## Overview + +This flow describes how to archive a child [tag](../../../concepts/platform/tagging.mdx) from the parent tag's detail page. Care sets the child tag's status to Archived. + +## Pre-requisites + +- You or another administrator created the child tag under a root tag. +- The tag that you archive is a child tag. Care shows the Archive action only for child tags. +- To archive a root tag, use the [Edit a tag](./edit-a-tag.mdx) flow. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Create Tag Config on Facility | Lets you archive a child tag. Facility Admin and Admin have this permission. | + +## Steps + +### 1. Open the parent tag + +Open the detail page of the parent tag. The parent tag is the root tag that holds the child tag. See [View tags](./view-tags.mdx) for the steps. + +### 2. Find the child tag + +Go to the Child Tags table. Find the row of the child tag that you want to archive. + +### 3. Select Archive + +Select Archive on that row. Care opens the Archive Child Tag confirmation dialog. + +### 4. Confirm the action + +Read the warning in the dialog. The dialog states that you cannot undo this action. Confirm the action to archive the child tag. + +## Expected Outcome + +- Care sets the child tag's Status to Archived. +- Care shows the message "Child tag archived successfully". +- If the action fails, Care shows the message "Failed to archive child tag". + +## Related + +Concepts: + +- [Tag](../../../concepts/platform/tagging.mdx) + +Flows: + +- [Create a tag](./create-a-tag.mdx) +- [Create a child tag](./create-a-child-tag.mdx) +- [View tags](./view-tags.mdx) +- [Edit a tag](./edit-a-tag.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/tagging/create-a-child-tag.mdx b/versioned_docs/version-3.1/flows/platform/tagging/create-a-child-tag.mdx new file mode 100644 index 00000000..41712b5f --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/tagging/create-a-child-tag.mdx @@ -0,0 +1,69 @@ +--- +sidebar_position: 2 +--- + +# Create a child tag + +## Overview + +This flow describes how to add a child tag under a root [tag](../../../concepts/platform/tagging.mdx) in Care. + +A child tag gives users a fixed set of choices under one parent. When a user applies tags to a record, only one child tag from the same parent applies at a time. If the user selects another child under the same parent, Care replaces the current selection. Root tags without children do not have this limit. Users can combine them freely. + +## Pre-requisites + +- You or another administrator created the root tag that you want to extend. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Create Tag Config on Facility | Lets you create a tag in the facility. Facility Admin and Admin have this permission. | + +## Steps + +### 1. Open the root tag + +Open the detail page of the root tag. See the [View tags](./view-tags.mdx) flow. + +### 2. Start the child tag form + +Go to the Child Tags section. Select **Add child tag**. Care opens the same tag form that you use for a root tag. Care links the new tag to the parent tag. + +### 3. Complete the tag form + +Enter the details of the child tag. + +| Components | What it captures | +| --- | --- | +| Display name | The name that users see for this tag. | +| Category | The category of the tag. Care fills this field from the parent tag. | +| Resource | The record type that the tag applies to. Care disables this field. A child tag always uses the resource type of its parent. | +| Priority | The order of the tag in lists. Care sets the priority of the parent as the default value. | +| Status | The status of the tag. | +| Description | More information about the tag. | + +You enter Display name, Status, and Description in the same way as for a root tag. + +### 4. Save the tag + +Select the submit button. + +## Expected Outcome + +- Care shows the message "Tag Config created successfully". +- The new tag is in the Child Tags list of the parent tag. + +## Related + +Concepts: + +- [Tag](../../../concepts/platform/tagging.mdx) + +Flows: + +- [Create a tag](./create-a-tag.mdx) +- [View tags](./view-tags.mdx) +- [Edit a tag](./edit-a-tag.mdx) +- [Archive a child tag](./archive-a-child-tag.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/tagging/create-a-tag.mdx b/versioned_docs/version-3.1/flows/platform/tagging/create-a-tag.mdx new file mode 100644 index 00000000..5db2c186 --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/tagging/create-a-tag.mdx @@ -0,0 +1,79 @@ +--- +sidebar_position: 1 +--- + +# Create a tag + +## Overview + +This flow describes how to create a root [tag](../../../concepts/platform/tagging.mdx) in Care. A root tag has no parent tag. + +## Pre-requisites + +- You are a member of the facility where you create the tag. +- If you create a tag for the whole instance without a facility, you are a superuser. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Create Tag Config on Facility | Lets you create a tag for the facility. Facility Admin and Admin have this permission. | + +## Steps + +### 1. Open the tag configuration list + +Open the Settings area of the facility. + +Select **Tag config**. + +### 2. Start a new tag + +Select **Add tag config**. + +Care opens a sheet on desktop. On mobile, Care opens a drawer. + +### 3. Complete the tag form + +Enter the details of the tag. + +| Components | What it captures | +| --- | --- | +| Display name | The name of the tag that users see. This field is required. | +| Category | The type of the tag. Select Diet, Drug, Lab, Admin, Contact, Clinical, Behavioral, Research, Advance Directive, or Safety. The default value is Clinical. This field is required. | +| Resource | The record type that accepts the tag, for example Encounter, Service Request, Patient, or Account. This field is required. | +| Priority | The sort order of the tag. The default value is 100. This field is required. | +| Status | The state of the tag. Select Active or Archived. The default value is Active. This field is required. | +| Description | More information about the use of the tag. This field is optional. | +| Managing Organization | The organization that owns the tag. This field is optional. | + +Note: You cannot change the Resource value after you create the tag. + +Note: The Priority value must not be negative. + +Note: The Managing Organization field shows facility organizations when you create the tag from the settings of a facility. The field shows instance-level organizations when you create the tag from the Admin area. + +### 4. Save the tag + +Select the submit button. + +Note: The submit button stays disabled until you change a field in the form. + +## Expected Outcome + +- Care shows the message "Tag Config created successfully". +- The new tag appears in the tag list. + +## Related + +Concepts: + +- [Tag](../../../concepts/platform/tagging.mdx) + +Flows: + +- [Create a child tag](./create-a-child-tag.mdx) +- [View tags](./view-tags.mdx) +- [Edit a tag](./edit-a-tag.mdx) +- [Archive a child tag](./archive-a-child-tag.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/tagging/edit-a-tag.mdx b/versioned_docs/version-3.1/flows/platform/tagging/edit-a-tag.mdx new file mode 100644 index 00000000..e48b7287 --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/tagging/edit-a-tag.mdx @@ -0,0 +1,70 @@ +--- +sidebar_position: 4 +--- + +# Edit a tag + +## Overview + +This flow describes how to change the details of an existing [tag](../../../concepts/platform/tagging.mdx) in Care. Use this flow also to archive a root tag. + +## Pre-requisites + +- You or another administrator created the tag at your facility. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Create Tag Config on Facility | Lets you update a tag. Facility Admin and Admin have this permission. | + +## Steps + +### 1. Open the tag + +Open the detail page of the tag that you want to change. See [View tags](./view-tags.mdx) for the steps. + +### 2. Select Edit tag + +Select **Edit tag**. Care opens the same form that you use to create a tag. The form shows the current values of the tag. + +### 3. Change the details + +Change the fields that you want to update. + +| Components | What it captures | +| --- | --- | +| Display name | The name of the tag that users see. | +| Category | The group that the tag belongs to. | +| Priority | The order of the tag against other tags. | +| Status | The state of the tag, for example Active or Archived. | +| Description | More information about the purpose of the tag. | +| Managing Organization | The organization that owns the tag. | + +Note: The Resource field stays disabled. You cannot change the record type that a tag applies to after you create the tag. + +To archive a root tag, set **Status** to **Archived**. A root tag has no separate **Archive** button. A child tag has a one-click archive action. See [Archive a child tag](./archive-a-child-tag.mdx). + +### 4. Save the tag + +Select the submit button. Care shows the message "Tag Config updated successfully". + +## Expected Outcome + +- Care stores the new details of the tag. +- Care shows the message "Tag Config updated successfully". +- If you set the status to Archived, the tag is archived. + +## Related + +Concepts: + +- [Tag](../../../concepts/platform/tagging.mdx) + +Flows: + +- [Create a tag](./create-a-tag.mdx) +- [Create a child tag](./create-a-child-tag.mdx) +- [View tags](./view-tags.mdx) +- [Archive a child tag](./archive-a-child-tag.mdx) diff --git a/versioned_docs/version-3.1/flows/platform/tagging/view-tags.mdx b/versioned_docs/version-3.1/flows/platform/tagging/view-tags.mdx new file mode 100644 index 00000000..0c53bebc --- /dev/null +++ b/versioned_docs/version-3.1/flows/platform/tagging/view-tags.mdx @@ -0,0 +1,92 @@ +--- +sidebar_position: 3 +--- + +# View tags + +## Overview + +This flow describes how to view the [tags](../../../concepts/platform/tagging.mdx) of a facility in Care. You can filter the list and open a tag to see its details. + +## Pre-requisites + +- You are a member of the facility. +- The facility has at least one tag. +- You have the permissions listed below. + +## Permissions + +| Permission | Access | +| --- | --- | +| Can Read Tag Config | Lets you open the tag list and the details of a tag. Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, and Pharmacist have this permission. | + +## Steps + +### 1. Open the tag list + +Open the facility. + +Select **Settings**. + +Select **Tag config**. + +Care shows the list of tags for the facility. The list also shows the instance-wide tags. + +The table shows these columns: + +| Column | What it shows | +| --- | --- | +| Display | The name of the tag. | +| Category | The category of the tag. | +| Resource | The resource that the tag applies to. | +| Priority | The priority of the tag. | +| Status | The status of the tag. | +| Children | Care shows this column only for tags that can have child tags. | +| Actions | The actions that you can do on the tag. | + +### 2. Filter the list + +Enter text in the search box to find a tag by display name. + +Select a **Status** filter to show Active or Archived tags. + +Select a **Category** filter to show the tags of one category. + +Select a **Resource** filter to show the tags of one resource. + +### 3. Open the details of a tag + +Select **View** on the row of the tag. + +Care opens the detail page of the tag. The page shows this information: + +| Information | What it shows | +| --- | --- | +| Category | The category of the tag. | +| Resource | The resource that the tag applies to. | +| Status | The status of the tag. | +| Priority | The priority of the tag. | +| Children | Whether the tag has children. | +| Managing Organization | The organization that manages the tag. | +| Description | The description of the tag. | +| Parent Tag | A link to the parent tag. Shown only if the tag is a child tag. | + +If the tag is a root tag, the page also shows the child tags in a separate table. + +## Expected Outcome + +- Care shows the tags of the facility in a list. +- Care shows the details of the tag that you select. + +## Related + +Concepts: + +- [Tag](../../../concepts/platform/tagging.mdx) + +Flows: + +- [Create a tag](./create-a-tag.mdx) +- [Create a child tag](./create-a-child-tag.mdx) +- [Edit a tag](./edit-a-tag.mdx) +- [Archive a child tag](./archive-a-child-tag.mdx) diff --git a/versioned_sidebars/version-3.1-sidebars.json b/versioned_sidebars/version-3.1-sidebars.json index 5a43fb98..958ccb9b 100644 --- a/versioned_sidebars/version-3.1-sidebars.json +++ b/versioned_sidebars/version-3.1-sidebars.json @@ -419,6 +419,37 @@ ] } ] + }, + { + "type": "category", + "label": "Platform", + "key": "platform-flows", + "items": [ + { + "type": "category", + "label": "Tag", + "key": "platform-tagging-flows", + "items": [ + "flows/platform/tagging/create-a-tag", + "flows/platform/tagging/create-a-child-tag", + "flows/platform/tagging/view-tags", + "flows/platform/tagging/edit-a-tag", + "flows/platform/tagging/archive-a-child-tag" + ] + }, + { + "type": "category", + "label": "Report Template", + "key": "platform-report-template-flows", + "items": [ + "flows/platform/report-template/create-a-report-template", + "flows/platform/report-template/preview-a-template", + "flows/platform/report-template/edit-a-report-template", + "flows/platform/report-template/view-report-templates", + "flows/platform/report-template/generate-and-view-a-report" + ] + } + ] } ] },