-
Notifications
You must be signed in to change notification settings - Fork 4
[docs] Clinical Notes concept, flows and reference fix #56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
github-actions
wants to merge
1
commit into
main
Choose a base branch
from
docs/clinical-notes-ffd0fe5d255456a5
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
69 changes: 69 additions & 0 deletions
69
versioned_docs/version-3.0/flows/clinical/add-a-note-message.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # How to add a note message | ||
|
|
||
| ## Overview | ||
|
|
||
| This flow describes how to post a message in a discussion in [Clinical Notes](../../concepts/clinical/notes.mdx). A message records your commentary about the patient for the rest of the care team. | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| - The patient has at least one discussion. If there is no discussion, start one first. | ||
| - You are a member of the facility that gives care to the patient. | ||
| - If the discussion belongs to an encounter, that encounter is open. You cannot post a message in a discussion of a completed encounter. | ||
| - You have the permissions listed below. | ||
|
|
||
| ## Permissions | ||
|
|
||
| | Permission | Access | | ||
| | --- | --- | | ||
| | Can view clinical data about patients | Read the discussions and messages of a patient | | ||
| | Can Read encounter related clinical data | Read the discussions and messages of an encounter | | ||
| | Can Update a Patient's data | Post a message in a discussion of a patient | | ||
| | Update Encounter related clinical data | Post a message in a discussion of an encounter | | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. Open the Notes tab | ||
|
|
||
| Open the patient or the encounter, then select **Notes**. In an encounter, you can also press `g n` to go to the **Notes** tab. | ||
|
|
||
| Care opens the most recent discussion. | ||
|
|
||
| ### 2. Select the discussion | ||
|
|
||
| Select the discussion in the **Discussions** list. | ||
|
|
||
| On a small screen, select **Threads** first, then select the discussion. | ||
|
|
||
| ### 3. Write the message | ||
|
|
||
| Enter your text in the **Type your message...** box. | ||
|
|
||
| | Components | What it captures | | ||
| | --- | --- | | ||
| | Message | Your commentary about the patient, as rich text | | ||
|
|
||
| ### 4. Send the message | ||
|
|
||
| Select the send button. On a computer, you can also press `Shift + Enter`. | ||
|
|
||
| ## Expected Outcome | ||
|
|
||
| - Care adds the message at the end of the discussion. | ||
| - Care shows your name and the time of the message. | ||
| - Care counts you in the participants of the discussion. | ||
| - The rest of the care team sees the message in the same discussion. | ||
|
|
||
| ## Related | ||
|
|
||
| Concepts: | ||
|
|
||
| - [Clinical Notes](../../concepts/clinical/notes.mdx) | ||
| - [Patient](../../concepts/clinical/patient) | ||
|
|
||
| Flows: | ||
|
|
||
| - [Start a note discussion](./start-a-note-discussion.mdx) |
70 changes: 70 additions & 0 deletions
70
versioned_docs/version-3.0/flows/clinical/start-a-note-discussion.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| --- | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # How to start a note discussion | ||
|
|
||
| ## Overview | ||
|
|
||
| This flow describes how to start a new discussion in [Clinical Notes](../../concepts/clinical/notes.mdx). A discussion groups the messages of the care team about one topic. | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| - The patient is registered in Care. | ||
| - You are a member of the facility that gives care to the patient. | ||
| - If you start the discussion for an encounter, that encounter is open. You cannot start a discussion for a completed encounter. | ||
| - You have the permissions listed below. | ||
|
|
||
| ## Permissions | ||
|
|
||
| | Permission | Access | | ||
| | --- | --- | | ||
| | Can view clinical data about patients | Open the Notes tab of a patient and read the discussions | | ||
| | Can Read encounter related clinical data | Open the Notes tab of an encounter and read its discussions | | ||
| | Can Update a Patient's data | Start a discussion for a patient | | ||
| | Update Encounter related clinical data | Start a discussion for an encounter | | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. Open the Notes tab | ||
|
|
||
| To start a discussion for a patient, open the patient and select **Notes**. | ||
|
|
||
| To start a discussion for an encounter, open the encounter and select **Notes**. In an encounter, you can also press `g n` to go to the **Notes** tab. | ||
|
|
||
| ### 2. Start a new discussion | ||
|
|
||
| Select **New**. On a small screen, select **New Thread**. | ||
|
|
||
| Care opens the **Start New Discussion** dialog. | ||
|
|
||
| ### 3. Give the discussion a title | ||
|
|
||
| Select one of the suggested titles, or enter your own title in the **Enter discussion title...** box. | ||
|
|
||
| | Components | What it captures | | ||
| | --- | --- | | ||
| | Discussion title | The topic of the discussion, up to 255 characters | | ||
|
|
||
| Care shows an error if the patient already has a discussion with that title. Enter a different title. | ||
|
|
||
| ### 4. Create the discussion | ||
|
|
||
| Select **Create**. | ||
|
|
||
| ## Expected Outcome | ||
|
|
||
| - Care shows the message "Thread created successfully". | ||
| - Care adds the discussion to the **Discussions** list. | ||
| - Care opens the new discussion, and you can post the first message. | ||
|
|
||
| ## Related | ||
|
|
||
| Concepts: | ||
|
|
||
| - [Clinical Notes](../../concepts/clinical/notes.mdx) | ||
| - [Encounter](../../concepts/clinical/encounter.mdx) | ||
|
|
||
| Flows: | ||
|
|
||
| - [Add a note message](./add-a-note-message.mdx) |
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
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
69 changes: 69 additions & 0 deletions
69
versioned_docs/version-3.1/flows/clinical/add-a-note-message.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # How to add a note message | ||
|
|
||
| ## Overview | ||
|
|
||
| This flow describes how to post a message in a discussion in [Clinical Notes](../../concepts/clinical/notes.mdx). A message records your commentary about the patient for the rest of the care team. | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| - The patient has at least one discussion. If there is no discussion, start one first. | ||
| - You are a member of the facility that gives care to the patient. | ||
| - If the discussion belongs to an encounter, that encounter is open. You cannot post a message in a discussion of a completed encounter. | ||
| - You have the permissions listed below. | ||
|
|
||
| ## Permissions | ||
|
|
||
| | Permission | Access | | ||
| | --- | --- | | ||
| | Can view clinical data about patients | Read the discussions and messages of a patient | | ||
| | Can Read encounter related clinical data | Read the discussions and messages of an encounter | | ||
| | Can Update a Patient's data | Post a message in a discussion of a patient | | ||
| | Update Encounter related clinical data | Post a message in a discussion of an encounter | | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. Open the Notes tab | ||
|
|
||
| Open the patient or the encounter, then select **Notes**. In an encounter, you can also press `g n` to go to the **Notes** tab. | ||
|
|
||
| Care opens the most recent discussion. | ||
|
|
||
| ### 2. Select the discussion | ||
|
|
||
| Select the discussion in the **Discussions** list. | ||
|
|
||
| On a small screen, select **Threads** first, then select the discussion. | ||
|
|
||
| ### 3. Write the message | ||
|
|
||
| Enter your text in the **Type your message...** box. | ||
|
|
||
| | Components | What it captures | | ||
| | --- | --- | | ||
| | Message | Your commentary about the patient, as rich text | | ||
|
|
||
| ### 4. Send the message | ||
|
|
||
| Select the send button. On a computer, you can also press `Shift + Enter`. | ||
|
|
||
| ## Expected Outcome | ||
|
|
||
| - Care adds the message at the end of the discussion. | ||
| - Care shows your name and the time of the message. | ||
| - Care counts you in the participants of the discussion. | ||
| - The rest of the care team sees the message in the same discussion. | ||
|
|
||
| ## Related | ||
|
|
||
| Concepts: | ||
|
|
||
| - [Clinical Notes](../../concepts/clinical/notes.mdx) | ||
| - [Patient](../../concepts/clinical/patient) | ||
|
|
||
| Flows: | ||
|
|
||
| - [Start a note discussion](./start-a-note-discussion.mdx) |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Template conformance (checklist item 8): the concept template requires a
## Definitionsection 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## Definitionabove the opening paragraph (line 7). The same fix is needed in the 3.1 mirror.