[docs] Clinical Notes concept, flows and reference fix - #56
Open
github-actions[bot] wants to merge 1 commit into
Open
[docs] Clinical Notes concept, flows and reference fix#56github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Deploying coredocs with
|
| Latest commit: |
0acabd1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://11f35aba.coredocs.pages.dev |
| Branch Preview URL: | https://docs-clinical-notes-ffd0fe5d.coredocs.pages.dev |
rithviknishad
marked this pull request as ready for review
August 10, 2026 12:28
Contributor
Author
There was a problem hiding this comment.
Generated by Docs Reviewer for #56 · opus50 · 132.4 AIC · ⌖ 15.8 AIC · ⊞ 11K
| A **[clinical note](https://build.fhir.org/communication.html)** in Care is written commentary about a patient. The care team uses notes for narrative, hand-offs, and discussion, in their own words. Care groups notes into discussion threads, so one topic stays together as a conversation. A note does not replace structured clinical data, such as a condition, an allergy, or an observation. | ||
|
|
||
| ## What it represents | ||
| ## Key Attributes |
Contributor
Author
There was a problem hiding this comment.
Template conformance (checklist item 8): the concept template requires a ## Definition section as the first heading, holding the opening paragraph. This page goes from the H1 straight to prose and then ## Key Attributes, so the required section is missing. Add ## Definition above the opening paragraph (line 7). The same fix is needed in the 3.1 mirror.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ezhuthachan
Documents Clinical Notes (patient view and encounter view), traced to the Care and care_fe checkouts.
Files
Authored in
version-3.0and mirrored byte-identical toversion-3.1.concepts/clinical/notes.mdx. The old page predated the concept template: it used## What it represents,## Threads and messages,## Edit historyand a## Permissionstable full of permission slugs. It now follows the template (## Definition,## Key Attributes,## Related), is strictly user-facing, and uses the labels the user sees (Discussions, Threads, New).flows/clinical/start-a-note-discussion.mdx,flows/clinical/add-a-note-message.mdx.references/clinical/notes.mdx— themessage_historyblock used ajsoncfence; changed totextper the reference structure rule. No content change.versioned_sidebars/version-3.0-sidebars.jsonandversioned_sidebars/version-3.1-sidebars.json— both flows added to the manual Clinical flow list.The request named a single slug (
clinical/clinical notes) with no doc types, so all three layers are covered. Notes is a task with two distinct user actions, so it produced two flows: start a discussion first, then post a message in it.Traced to
code/care/care/emr/models/notes.py—NoteThread,NoteMessage,message_history.code/care/care/emr/resources/notes/thread_spec.py,notes_spec.py— title limit, encounter validation, server-side edit history.code/care/care/emr/api/viewsets/notes.py— authorization per action.code/care/care/security/authorization/patient.py,encounter.py→care/security/permissions/patient.py,encounter.py→care/security/roles/role.pyfor the permission display names in the flows: Can view clinical data about patients, Can Read encounter related clinical data, Can Update a Patient's data, Update Encounter related clinical data. Encounter writes are blocked once the encounter is completed, which is why both flows list an open encounter as a pre-requisite.code/care/care_fe/src/components/Notes/NoteManager.tsx,src/pages/Encounters/tabs/notes.tsx,src/components/Patient/PatientDetailsTab/PatientNotes.tsx,src/types/notes/thread.ts— UI steps, discussion templates, duplicate-title error.code/care/care_fe/public/locale/en.json— every user-visible label.code/care/care_fe/src/config/keyboardShortcuts.json—g nfor the encounter Notes tab,shift+enterfor submit. No other shortcut applies.Left out
NoteManager.tsxrenders no edit control, so the UI steps could not be verified. The backend supports it and only the message author may edit.patient_notes_thread__Doctors) exist only in legacy locale keys, so they are not documented.Validation
Corruption scan clean.
npm run buildreturns[SUCCESS]forbuildandbuild/ml, exit code 0.