Add Encounter flow docs and remove the loose care-team flow - #77
Conversation
Publish the Encounter concept and nine flows from the care_docs sources into flows/clinical/encounter/. Removes the care-team flow that sat directly under flows/clinical/, replacing it with the authored version in the Encounter module, and repoints the 3.1 Care Team concept and reference at the new path.
Deploying coredocs with
|
| Latest commit: |
5602625
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://742c9b51.coredocs.pages.dev |
| Branch Preview URL: | https://docs-encounter-flows.coredocs.pages.dev |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Care docs review — Encounter flows
Substantial, well-researched work. The nine flows follow the flow template closely, the prose is largely STE-compliant, no corruption markers or MDX hazards ({#, bare { }) appear anywhere in the diff, and the relative links all resolve against the tree as it will be after this PR. The move of manage-encounter-care-team into flows/clinical/encounter/ is right, and both inbound links (the 3.1 care-team concept and reference) are repointed.
Worth fixing
- Roles are wrong throughout. Every permission table says "Administrator, Doctor, Nurse and Facility Administrator".
EncounterPermissionsusesCLINICAL_DATA_ACCESS_ROLES=ADMIN_ROLE, DOCTOR_ROLE, NURSE_ROLE, FACILITY_ADMIN_ROLE, whose display names are Admin, Doctor, Nurse, Facility Admin.Administratoris a distinct role and is not granted these. This repeats in all nine flows and in the concept. mthencis attributed to the discharge indischarge-patient.mdx.keyboardShortcuts.jsonbindsm ctomark-as-completed; there is no discharge shortcut. The same key is correctly attributed incomplete-encounter.mdx.- The concept has grown a
## Where to find Encounterssection, which is navigation, not "what is this?". It is outside the concept template and duplicates the flows. - The concept's
## Relateddrops the technical reference.references/clinical/encounter.mdxwas linked before and should stay. - "Care follows the FHIR R5 Encounter resource" narrates the mapping — the FHIR link on first mention is enough.
- 3.0 is not mirrored. The flows, the concept rewrite and the care-team link fixes land only in
version-3.1. Flag whether this is deliberate.
Smaller: ### 6. Rules that Care applies in the location flow is not a step; link text title-cases "Encounter" while the H1s are sentence case; two of the restart pre-requisites are UI behaviour rather than the reader's situation.
Not verified
I could not confirm from source, and would like the reference checked before merge:
- The Encounter Actions palette contents, the side-panel action list, the tab list, and the "5 open encounters" and "0 hours restart" configuration defaults.
- The exact toast strings ("Encounter Completed", "Member added successfully", "Conflict in schedule", "Tag Parent is already set") — these should come from
care_fe/public/locale/en.json. - The tag category list and the claim that a user in the department owning the patient's current bed can open the encounter.
None of this blocks; treat the review as informative.> Generated by Docs Reviewer for #77 · opus50 · 266.1 AIC · ⌖ 11.2 AIC · ⊞ 11K
| Note: Your deployment sets the maximum number of open encounters for one patient at a facility. The default maximum is 5. | ||
|
|
||
| An encounter is not the patient and not the whole medical record. One patient accumulates many encounters over time; each encounter is the bounded slice of activity for a single episode, and the [patient](../clinical/patient) record is the thread that ties them together. Think of the patient as the chart and each encounter as a dated chapter within it. | ||
| Care follows the FHIR R5 Encounter resource. An encounter links to these records: |
There was a problem hiding this comment.
Checklist item 7 (FHIR): linking the FHIR resource page is right, but narrating the mapping must go. Drop this clause — the linked **[encounter]((build.fhir.org/redacted) in the line above is enough. Suggested: An encounter links to these records:
|
|
||
| Note: Your deployment sets how long after its last change someone can restart a completed encounter. The default is zero hours, which stops all restarts. | ||
|
|
||
| ## Where to find Encounters |
There was a problem hiding this comment.
Checklist item 2 (layer discipline) and 8 (template conformance). The concept template allows only ## Definition, ## Key Attributes, ## Status sub-section and ## Related. ## Where to find Encounters is an invented section, and its content (sidebar groups, tabs, side-panel actions, the Shift+E palette) is navigation — that belongs in the flow docs, which already carry it. Please remove this section from the concept.
| - Flow: [Manage Encounter tags](../../flows/clinical/encounter/manage-encounter-tags.mdx) | ||
| - Flow: [Discharge a patient](../../flows/clinical/encounter/discharge-patient.mdx) | ||
| - Flow: [Complete an Encounter](../../flows/clinical/encounter/complete-encounter.mdx) | ||
| - Flow: [Restart an Encounter](../../flows/clinical/encounter/restart-encounter.mdx) |
There was a problem hiding this comment.
Checklist item 8: the concept template requires the ## Related list to include the technical reference. references/clinical/encounter.mdx exists and was linked before this change, but the rewrite drops it. Please add - Reference: [Encounter](../../references/clinical/encounter.mdx), and restore the sibling concept links (Patient, Condition, Notes) that the previous version carried.
| @@ -0,0 +1,104 @@ | |||
| --- | |||
There was a problem hiding this comment.
Checklist item 11 (mirroring): the whole Encounter flow folder, the concept rewrite and the care-team link fixes land in version-3.1 only. The conventions require version-3.0 and version-3.1 to stay identical, so the same nine flows plus _category_.json, the concept versioned_docs/version-3.0/concepts/clinical/encounter.mdx, and the 3.0 care-team concept/reference links are missing. If 3.0 is intentionally frozen here, please say so in the PR description.
| Open the encounter. Start the discharge from one of these entry points: | ||
|
|
||
| - On the **Overview** tab side panel, select the bottom button **Mark for discharge**. | ||
| - Open **Encounter Actions**, then select **Mark for discharge**. The shortcut for **Encounter Actions** is `Shift+E`. The shortcut for the discharge is `m` then `c`. |
There was a problem hiding this comment.
Checklist item 16: care_fe/src/config/keyboardShortcuts.json binds m c in the encounter scope to mark-as-completed, not to the discharge. There is no shortcut defined for the discharge action, so please drop "The shortcut for the discharge is m then c." and keep only the Shift+E palette shortcut.
|
|
||
| - The encounter shows the current bed or room of the patient. | ||
| - While the patient occupies a bed, Care shows the bed as reserved. When the stay closes, Care shows the bed as available again. | ||
| - The **History** tab lists each stay of the patient for this encounter. |
There was a problem hiding this comment.
Checklist item 8: ### 6. Rules that Care applies is not a step — it is reference material, and the reader is given no instruction to carry out. Fold these constraints into steps 2 and 5 where the reader meets them, or move them under the Expected Outcome, so the Steps section holds only actions.
|
|
||
| Flows: | ||
|
|
||
| - [Create an Encounter](./create-encounter.mdx) |
There was a problem hiding this comment.
Checklist items 9 and 14: the page H1s are sentence case ("Manage encounter departments", "Create an encounter"), but every cross-link title-cases Encounter ("Manage Encounter departments", "Create an Encounter"). Link text should match the target H1. This mismatch runs through the Related lists of all nine flows and the concept.
|
|
||
| | Permission | Access | | ||
| | --- | --- | | ||
| | Update Encounter non clinical | Restart a completed encounter. Administrator, Doctor, Nurse and Facility Administrator hold this permission. | |
There was a problem hiding this comment.
Checklist item 12 and slug naming: the flow slugs here are create-encounter, restart-encounter, discharge-patient. The existing Patient flows use the same shape, so this is consistent — no change needed. Noting only that restart-encounter reads as a noun phrase; restart-an-encounter would match the H1 more closely if you prefer the verb-phrase form used in the flow skill.
|
|
||
| This flow describes how to reopen a completed [encounter](../../../concepts/clinical/encounter.mdx) in Care. Care sets the status back to In Progress, and the care team can record clinical data again. | ||
|
|
||
| ## Pre-requisites |
There was a problem hiding this comment.
Checklist item 6: two of these pre-requisites are not the reader’s situation. "You open the encounter itself. Care hides the action when you look at another encounter..." is UI behaviour that belongs in step 1, and "Your deployment allows restarts. Read the note in the Steps section before you start." forward-references the flow. Please move both into the Steps, and keep the pre-requisites to conditions the reader can check.
| ] | ||
| }, | ||
| "flows/clinical/manage-encounter-care-team" | ||
| { |
There was a problem hiding this comment.
Good — the manual flow sidebar (checklist item 10) is handled: all nine flows are listed, and the removed flows/clinical/manage-encounter-care-team entry is gone, so no dangling id. Note that flows/clinical/encounter/_category_.json is then redundant for this version, since the sidebar is explicit here rather than autogenerated; it is harmless, but worth keeping in mind when mirroring to 3.0.
1 participant
What
Publishes the Encounter documentation from
care_docsinto the docs site (version 3.1), and fixes the structural oddity in the Clinical flows.flows/clinical/encounter/:Encountercategory underFlows > Clinical, besidePatient.Removes the loose care-team flow
flows/clinical/manage-encounter-care-team.mdx(added in #59) sat directly underclinical/rather than inside a module folder, so it rendered as a page beside thePatientcategory instead of within one.It is removed here. The authored
Manage the encounter care teamflow replaces it, in its proper place atflows/clinical/encounter/manage-encounter-care-team.mdx.The Care Team concept and reference pages in 3.1 linked to the old path and are repointed. Version 3.0 keeps its own copy and is untouched.
Route change
/flows/clinical/manage-encounter-care-teambecomes/flows/clinical/encounter/manage-encounter-care-team.Verification
Docusaurus build passes for both
enandmllocales.