Skip to content

[docs] Add encounter flow docs - #47

Closed
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/encounter-flows-46-f94412d7354209e4
Closed

[docs] Add encounter flow docs#47
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/encounter-flows-46-f94412d7354209e4

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Ezhuthachan

Closes #46.

/document clinical/encounter requested all three doc layers. The concept (concepts/clinical/encounter.mdx) and the reference (references/clinical/encounter.mdx) already exist and are accurate against the checked-out Care source, so this PR adds only the missing flow layer.

Files added (version-3.0 and mirrored byte-identical to version-3.1)

  • flows/clinical/create-an-encounter.mdx
  • flows/clinical/update-encounter-location.mdx
  • flows/clinical/close-an-encounter.mdx

Files changed

  • versioned_sidebars/version-3.0-sidebars.json and versioned_sidebars/version-3.1-sidebars.json — the three new flow ids appended to the manual Clinical flows list.

Sources traced

  • care_fe/src/components/Encounter/CreateEncounterForm.tsx — the Initiate Patient Encounter form, its fields, the required department, and the future-date rule.
  • care_fe/src/pages/Patient/PatientHome.tsx, care_fe/src/components/Patient/PatientDetailsTab/EncounterHistory.tsx, care_fe/src/pages/Appointments/AppointmentDetail.tsx — entry points, including Start Consultation and Create Planned Encounter.
  • care_fe/src/pages/Encounters/tabs/overview/summary-panel-actions.tab.tsx, care_fe/src/pages/Encounters/utils/EncounterProvider.tsx, care_fe/src/pages/Encounters/utils/useEncounterProgressController.ts, care_fe/src/pages/Encounters/MarkEncounterAsCompletedDialog.tsx — the Actions panel, Mark as Completed, Mark for discharge, and the appointment and token close.
  • care_fe/src/components/Location/LocationSheet.tsx and care_fe/src/components/Location/views/LocationAssignmentView.tsx — the Update Location panel and the bed actions.
  • care_fe/src/components/Questionnaire/QuestionTypes/EncounterQuestion.tsx — the discharge questionnaire fields.
  • care_fe/src/components/ui/sidebar/facility/facility-nav.tsx — navigation labels.
  • care_fe/public/locale/en.json — every user-facing label.
  • care_fe/src/config/keyboardShortcuts.json — the e shortcut for Create Encounter, Shift+Enter for submit, and Enter for confirm.
  • care/care/security/permissions/encounter.py and care/care/security/authorization/encounter.py — create encounter and update encounter permissions, held by Admin, Doctor, Nurse, and Facility Admin.

Left out because it could not be verified

  • Which encounter types a deployment allows. care.config.ts reads REACT_ALLOWED_ENCOUNTER_CLASSES, so the flow states that the deployment controls this rather than naming a fixed list.
  • Print steps for the discharge summary. The report templates are deployment-specific.

Validation

  • Corruption scan returns nothing.
  • npm run build succeeds for both the en and the ml locales.

Generated by Ezhuthachan for #46 · opus50 · 325 AIC · ⌖ 11.8 AIC · ⊞ 12.9K ·
Comment /document to run again

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Aug 10, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploying coredocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: cf1b04d
Status: ✅  Deploy successful!
Preview URL: https://74e0fa3e.coredocs.pages.dev
Branch Preview URL: https://docs-encounter-flows-46-f944.coredocs.pages.dev

View logs

@rithviknishad
rithviknishad marked this pull request as ready for review August 10, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation on Clinical / Encounter

1 participant