Skip to content

[docs] Condition docs: concept, reference, and symptom/diagnosis flows - #57

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/clinical-condition-5de4d9a877239b07
Open

[docs] Condition docs: concept, reference, and symptom/diagnosis flows#57
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/clinical-condition-5de4d9a877239b07

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Ezhuthachan

Closes the /document clinical/condition request in #55.

What changed

Rewritten (both existed, both predated the current templates):

  • concepts/clinical/condition.mdx — full rewrite to the concept template (## Definition, ## Key Attributes with ### Status, ## Related). Removed the FHIR-mapping narration, the permission slugs, and the raw enum values that leaked into user-facing prose. Framed the page around Symptom and Diagnosis.
  • references/clinical/condition.mdx — restructured to the reference skill's page structure. Removed the FHIR-mapping narration and deleted the false criticality field claim (ConditionReadSpec has no such field). Added the two viewsets, their routes, filters, and the traced authorization table.

Added:

  • flows/clinical/record-a-symptom.mdx
  • flows/clinical/record-a-diagnosis.mdx

Sidebars: both flow doc ids appended to the clinical-flows items array in versioned_sidebars/version-3.0-sidebars.json and versioned_sidebars/version-3.1-sidebars.json (flows are a manual list).

Versions: authored in version-3.0 and mirrored byte-identical to version-3.1.

Free-form instruction

The issue said: "Condition involves symptoms and diagnosis. ignore about chronic conditions as of now."

  • The concept and both flows are framed entirely around symptoms and diagnoses. No chronic-condition framing appears in either user-facing layer.
  • The reference doc still lists chronic_condition in the CategoryChoices table and ChronicConditionUpdateSpec in the spec table, because they are real API surface and omitting them would make the reference wrong. No chronic-condition workflow is described.
  • Flows were discovered from care_fe, not guessed: recording a symptom and recording a diagnosis are the two real user tasks for this resource. Symptom is listed first.

Traced to

code/care:

  • care/emr/models/condition.py
  • care/emr/resources/condition/spec.py, care/emr/resources/condition/valueset.py
  • care/emr/api/viewsets/condition.py, care/emr/api/viewsets/encounter_authz_base.py
  • care/security/authorization/encounter.py, care/security/authorization/patient.py
  • care/security/permissions/encounter.py, care/security/permissions/patient.py, care/security/roles/role.py

code/care_fe:

  • src/components/Questionnaire/QuestionTypes/SymptomQuestion.tsx, DiagnosisQuestion.tsx
  • src/components/Encounter/EncounterCommandDialog.tsx, src/pages/Encounters/EncounterShow.tsx, src/pages/Patient/History/index.tsx
  • src/config/keyboardShortcuts.json (confirms the s and d shortcuts in the encounter context)
  • public/locale/en.json (every user-facing label)

Left out

  • body_site and recorded_date are storage-only — noted in the reference as unexposed rather than documented as fields.
  • The unknown clinical status exists in the backend enum but the UI never offers it, so the user-facing status table omits it. The reference lists it.

Validation

  • Corruption scan returns nothing.
  • npm run build[SUCCESS] for en and ml, exit 0.

Generated by Ezhuthachan for #55 · opus50 · 489.7 AIC · ⌖ 18.7 AIC · ⊞ 13.5K ·
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: 93abec4
Status: ✅  Deploy successful!
Preview URL: https://88dd475b.coredocs.pages.dev
Branch Preview URL: https://docs-clinical-condition-5de4.coredocs.pages.dev

View logs

@rithviknishad
rithviknishad marked this pull request as ready for review August 10, 2026 12:29

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generated by Docs Reviewer for #57 · opus50 · 225.3 AIC · ⌖ 10.1 AIC · ⊞ 11K


## Expected Outcome

- The symptoms show in the **Symptoms** list on the **Overview** tab of the encounter.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The encounter tab is labelled Updates, not Overview. EncounterShow.tsx keys the tab updates and renders t("ENCOUNTER_TAB__updates"), which public/locale/en.json resolves to Updates (the component file is named tabs/overview.tsx, but that is a source path, not a display label). Checklist item 4 — use the display label.

Suggested: - The symptoms show in the **Symptoms** list on the **Updates** tab of the encounter.

The same line needs the same fix in versioned_docs/version-3.1/flows/clinical/record-a-symptom.mdx.

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.

0 participants