[docs] document the clinical encounter

[github-actions]

Ezhuthachan

Closes #52 — /document clinical/encounter. No doc types were given, so all three layers were produced.

Added

Flows (new), in version-3.0 and version-3.1:

• flows/clinical/create-an-encounter.mdx
• flows/clinical/close-an-encounter.mdx
• flows/clinical/assign-a-location-to-an-encounter.mdx
• flows/clinical/manage-the-care-team-of-an-encounter.mdx

The slug named a resource, so one flow per user task was written, ordered the way a user meets them.

Rewritten

• concepts/clinical/encounter.mdx — replaced whole file. The old page predated the template: it narrated the FHIR mapping, printed a raw status diagram with code values (planned, in_progress), and used headings the template does not have. It now follows the concept template exactly: Definition, Key Attributes, Type of Encounter, Care Team, Status, Related. All values are the labels the user sees.
• references/clinical/encounter.mdx — small edit only. Removed the FHIR mapping narration from the opener and added a link to the concept.

Sidebars

Appended the four flow doc ids to the clinical-flows items in both versioned_sidebars/version-3.0-sidebars.json and versioned_sidebars/version-3.1-sidebars.json.

Traced to

code/care:

• care/emr/models/encounter.py
• care/emr/resources/encounter/{constants,spec,valueset}.py
• care/emr/api/viewsets/encounter.py
• care/security/authorization/encounter.py, care/security/permissions/encounter.py, care/security/roles/role.py
• config/settings/config.py

code/care_fe:

• src/components/Encounter/CreateEncounterForm.tsx, EncounterActions.tsx
• src/pages/Encounters/ — EncounterShow, MarkEncounterAsCompletedDialog, utils/EncounterProvider.tsx, utils/useEncounterProgressController.ts, tabs/overview/summary-panel-actions.tab.tsx
• src/components/Questionnaire/QuestionTypes/EncounterQuestion.tsx
• src/components/CareTeam/CareTeamSheet.tsx, src/components/Location/LocationSheet.tsx
• public/locale/en.json, src/config/keyboardShortcuts.json, care.config.ts

Permissions in the flows come from tracing the viewset authorize_* hooks, not from the permission enum.

Left out

• Exact numbers for the active-encounter limit and the restart time limit. Both are deployment settings, so the flows say that a limit exists without naming a value.
• The list of encounter types is deployment-configurable, so the concept describes the types without claiming every deployment shows all of them.

Version note

The two versions are no longer byte-identical for these pages: 3.1 moved the patient flows into flows/clinical/patient/, so the 3.1 copies link to patient/register-patient where the 3.0 copies link to create-patient. Everything else is identical.

Validation

Corruption scan returns nothing. npm run build is [SUCCESS] for build and build/ml, exit code 0.

Generated by Ezhuthachan for #52 · opus50 · 466.9 AIC · ⌖ 13.3 AIC · ⊞ 13.5K · ◷
_{Comment /document to run again}

[cloudflare-workers-and-pages]

Deploying coredocs with    Cloudflare Pages

Latest commit:	f3609f4
Status:	✅  Deploy successful!
Preview URL:	https://c6fe626e.coredocs.pages.dev
Branch Preview URL:	https://docs-clinical-encounter-04d0.coredocs.pages.dev

View logs