Skip to content

Commit

Permalink
Updated 3.0 technical documentation section
Browse files Browse the repository at this point in the history 
-fixed broken links
-updated cheatsheet links
-minor formatting changes
-removed "live team" wording
-updated images to no longer include team chat icon in top navbar
  • Loading branch information
@ljmoody
ljmoody committed Oct 19, 2024
1 parent dbccf36 commit 4eb9839
Showing 1 changed file with 27 additions and 29 deletions.
56 changes: 27 additions & 29 deletions 3.0_technical_documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,21 +96,21 @@ You must already have an account set up to log into the Sim UI. If you do not ha
2. A Please select a World pop-up will appear. The Sim will load teams and, **once you select a team, you will be directed to that team's Home page.**

- **Note:** The login dropdown only shows worlds in which you are a team lead or participant (not an Administrator).
- **Note:** If you have the Administrator role in any team and have been added into "administrator_login" in Epicenter, you will be allowed to login using the "administrator_login" choice. Upon logging in, Administrators are directed to the [Administrator Dashboard](#sim-ui-administrator_dashboard).
- **Note:** If you have the Administrator role in any team and have been added into "administrator_login" in Epicenter, you will be allowed to login using the "administrator_login" choice. Upon logging in, Administrators are directed to the [Administrator Dashboard](#sim-ui-administrator-dashboard).

<img alt="Image of Sim UI login page." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/sim_login_dropdown.png">

3. The screenshots below display what you will see upon logging in, depending on your role.

- **Note:** To familiarize yourself with a team's Home page, refer to [Orient to a Team's Home Page](#orient-to-a-team's-home-page)
- **Note:** To familiarize yourself with a team's Home page, refer to [Orient to a Team's Home Page](#orient-to-a-teams-home-page)

|Team Member login = team's Home page|Administrator login = Admin Dashboard |
|:---:|:---:|
|<img alt="Image of team Home page upon team member logging in." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/team_member_landing.png">|<img alt="Image of Administrator Dashboard upon Administrator logging in." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/admin_landing.png">

### Make, View, and Export Team Clinic Selections for Import to Sim UI

**Tip:** Refer to (or save) this one-page [Data Cheatsheet](https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_how_3.7_data_cheatsheet.pdf) when using the Data UI and making clinic and flow selections.
**Tip:** Refer to (or save) the one-page [Data Cheatsheet](https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_how_3.7_data_cheatsheet.pdf) when using the Data UI and making clinic and flow selections.

The general workflow for the Data UI is that teams:

Expand Down Expand Up @@ -310,7 +310,7 @@ If you do not have access to facilities that you believe you should, please veri

### Navigate to the Home Page of Any Team

**Tip:** Refer to this one-page [Sim UI Cheatsheet](https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_how_3.7_sim_ui_cheatsheet.png) when familiarizing yourself with the Home Page and Dynamic Decision Dashboard.
**Tip:** Refer to (or save) the one-page [Sim UI Cheatsheet](https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_how_3.7_sim_ui_cheatsheet.pdf) when familiarizing yourself with the Home Page and Dynamic Decision Dashboard.

1. Upon logging in to the Sim UI, **field users** will be automatically directed to the selected team's Home page.

Expand Down Expand Up @@ -420,41 +420,41 @@ Below is an orientation to the Dynamic Decision Dashboard.

<img alt="Image of Dynamic Decision Dashboard." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/ddd_initial_screen.png">

1. **Tutor**: Click for a guided tour of page features.
1. **Tutor:** Click for a guided tour of page features.

2. **Caret**: Click carets next to each module to contract or expand that module from view.
2. **Caret:** Click carets next to each module to contract or expand that module from view.

3. **Directives**: Click to show a Directive 1160.01 to _MTL_ crosswalk table that identifies specific references within Directive 1160.01 that requires actions by facilities that are supported by the Data UI and the Sim UI. These actions are linked to _MTL_ reports and _MTL_ use cases that reinforce how the directives are supported in application by other facilities.
3. **Directives:** Click to show a Directive 1160.01 to _MTL_ crosswalk table that identifies specific references within Directive 1160.01 that requires actions by facilities that are supported by the Data UI and the Sim UI. These actions are linked to _MTL_ reports and _MTL_ use cases that reinforce how the directives are supported in application by other facilities.

4. **More**: Click to reveal other key views of the Care Coordination module. All modules have this feature. Depending on the module selected, the More menu may include:
4. **More:** Click to reveal other key views of the Care Coordination module. All modules have this feature. Depending on the module selected, the More menu may include:

<img alt="Image of Dynamic Decision Dashboard More menu options" src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/ddd_more_dropdown.png">

- **1 - Feedback Loops**: Interactive diagrams that aid in visualizing how different variables in a system are causally interrelated. Clicking here will open a pop-up window that shows an associated loop diagram along with Causal Loop Dynamics selections.
- **1 - Feedback Loops:** Interactive diagrams that aid in visualizing how different variables in a system are causally interrelated. Clicking here will open a pop-up window that shows an associated loop diagram along with Causal Loop Dynamics selections.

- **2 - Flow**: Visualized in Sankey form, these diagrams help visualize the rate of flow into and out of stocks. A stock is a state of care in which patients can accumulate over time. Sankey is a type of flow diagram where the width of the arrows is proportional to the flow quantity.
- **2 - Flow:** Visualized in Sankey form, these diagrams help visualize the rate of flow into and out of stocks. A stock is a state of care in which patients can accumulate over time. Sankey is a type of flow diagram where the width of the arrows is proportional to the flow quantity.

- **3 - Decision Meters**: A quick method to visualize the relevance or significance of different aspects within a group.
- **3 - Decision Meters:** A quick method to visualize the relevance or significance of different aspects within a group.

- **4 - Episodes of Care**: Graphically shows evidence-based episode of care intervals to get a bird's eye view of how long the length of engagement will be.
- **4 - Episodes of Care:** Graphically shows evidence-based episode of care intervals to get a bird's eye view of how long the length of engagement will be.

- **5 - Play**: Enter the main Sim UI page to see the system story and run experiments.
- **5 - Play:** Enter the main Sim UI page to see the system story and run experiments.

- **6 - Team Data**: A quick link to the _Modeling to Learn_ Data User Interface that will open in a new browser tab.
- **6 - Team Data:** A quick link to the _Modeling to Learn_ Data User Interface that will open in a new browser tab.

- **7 - SAIL Data**: A quick link to Strategic Analytics for Improvement and Learning Value Model (SAIL), a system for summarizing hospital system performance within Veterans Health Administration (VHA). This will open in a new browser tab.
- **7 - SAIL Data:** A quick link to Strategic Analytics for Improvement and Learning Value Model (SAIL), a system for summarizing hospital system performance within Veterans Health Administration (VHA). This will open in a new browser tab.

5. **Learning Mode Labels**: Indicates which Learning Mode the data prioritizes. Click these buttons to change the learning modes directly from the DDD; the system will re-initialize based on the new learning mode selected. Existing Patients Return-to-Clinic Visit Interval (EPRVI) = learning mode "0" and New Patient Start Rate (NPSR) = learning mode "1".
5. **Learning Mode Labels:** Indicates which Learning Mode the data prioritizes. Click these buttons to change the learning modes directly from the DDD; the system will re-initialize based on the new learning mode selected. Existing Patients Return-to-Clinic Visit Interval (EPRVI) = learning mode "0" and New Patient Start Rate (NPSR) = learning mode "1".

6. **Team Care Services Radio Buttons**: Select desired service radio button to see stock values for specific services in Team Care (Intake, Care Coordination, Medication Management, Psychotherapy, Evidence-based Psychotherapy, Adjunctive Services, Group Therapy). The default display is Intake evaluations.
6. **Team Care Services Radio Buttons:** Select desired service radio button to see stock values for specific services in Team Care (Intake, Care Coordination, Medication Management, Psychotherapy, Evidence-based Psychotherapy, Adjunctive Services, Group Therapy). The default display is Intake evaluations.

7. **Medication Management Services Radio Buttons**: Select desired service radio button to see stock values for medication-specific services in Medication Management (Alcohol Use Disorder, Depression, Opioid Use Disorder, and Other). The defaut display is Alcolol Use Disorder.
7. **Medication Management Services Radio Buttons:** Select desired service radio button to see stock values for medication-specific services in Medication Management (Alcohol Use Disorder, Depression, Opioid Use Disorder, and Other). The defaut display is Alcolol Use Disorder.

8. **"i" icon**: Click "i" icons to read the definition of each stock label.
8. **"i" icon:** Click "i" icons to read the definition of each stock label.

9. **Team Flow Services Radio Buttons**: Select desired service radio button to see stock values for setting-specific services in Team Flow (General Mental Health, Specialty Mental Health, Primary Care/Primary Care Mental Health Integration). The default display is General Mental Health.
9. **Team Flow Services Radio Buttons:** Select desired service radio button to see stock values for setting-specific services in Team Flow (General Mental Health, Specialty Mental Health, Primary Care/Primary Care Mental Health Integration). The default display is General Mental Health.

10. **Community**: Click here to participate by sharing an idea, letting the team know what you like, asking a question, or joining our community.
10. **Community:** Click here to participate by sharing an idea, letting the team know what you like, asking a question, or joining our community.

##### Feedback Loops

Expand Down Expand Up @@ -583,7 +583,7 @@ This section explains how to enter and save an experiment in the Sim UI.

#### Orient to the Sim UI

**Tip:** Save this [Sim UI cheatsheet](https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_how_3.7_sim_ui_cheatsheet.pdf) to use when running an experiment.
**Tip:** Refer to the [Sim UI cheatsheet](https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_how_3.7_sim_ui_cheatsheet.png) to use when running an experiment.

Below is an orientation to the Play Page of the Sim UI.

Expand Down Expand Up @@ -617,7 +617,7 @@ Below is an orientation to the Play Page of the Sim UI.

<img alt="Image of the window icon highlighted in a browser window." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/window_view_click.png">

2. Drag the browser window to the desired size. **Notice how the Sim UI design responds by stacking top navigation menu icons.**
2. Drag the browser window to the desired size. **Notice how the Sim UI design responds by stacking top navigation menu icons and other page contents.**

<img alt="Image of browser window with arrow showing where to click and drag to resize the window." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/drag_window.png">

Expand All @@ -640,7 +640,7 @@ Below is an orientation to the Play Page of the Sim UI.

<img alt="Image of highlighted Report Bug icon in the top navigation menu." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/bug_click_icon.png">

2. Describe the issue in the field provided (please be detailed as possible). **Do not include PII or other Site identifiable information. Instead, use generic language such as “_MTL Blue_ live team on Mondays at 9am.”** If you have a screenshot you want to share, click the checkbox.
2. Describe the issue in the field provided (please be detailed as possible). **Do not include PII or other Site identifiable information. Instead, use generic language.** If you have a screenshot you want to share, click the checkbox.

<img alt="Image of bug reporting window." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/bug_describe_issue.png">

Expand All @@ -662,7 +662,7 @@ Below is an orientation to the Play Page of the Sim UI.

<img alt="Image of new GitHub issue page with the Get Started button highlighted." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/bug_select_issue.png">

4. Complete the Issue Form. **Do not include PII or other Site identifiable information. Instead, use generic language such as “_MTL Blue_ live team on Mondays at 9am.”**
4. Complete the Issue Form. **Do not include PII or other Site identifiable information. Instead, use generic language.**

<img alt="Image of GitHub Issue Form." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/bug_issue_form.png">

Expand Down Expand Up @@ -761,8 +761,6 @@ Within the Facility Team Setup area of this pop-up, several team setup options a

6. Use the Select Permissions dropdown to assign the team member's permission level on the team.

**Note:** At least one Team Lead member is required.

7. Use the Select VHA Primary Role dropdown to assign the team member's role on the team.

8. Click the Add icon.
Expand Down Expand Up @@ -901,7 +899,7 @@ The _MTL_ Maintenance Dashboards provide customizable information and messaging

#### Orient to the Maintenance Dashboards

The following screenshot will orient you to general features of the Maintenance Dashboards.
The following screenshot will orient you to general features of the Maintenance Dashboards, located in the top navigation bar of the Administrator Dashboard.

<img alt="Image identifying the Maintenance Dashboards." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/orient_maintenance_dash.png">

Expand Down Expand Up @@ -1055,7 +1053,7 @@ To access this, you must:
1. From the Administrator Dashboard, click on the "Tips" icon. The _MTL_ Quick Tip Loading Screen Administration page will open.
2. Click the "Add Tip" button. The page will scroll to the bottom of the list and present a new row to input information.
3. Click on the "upload" icon. An upload file pop up will appear. Navigate to your file and click "Save." The filename should appear immediately to the left of the upload icon and a thumbnail should appear to the right.
4. Click on the "Empty" icon. A text field will present. Type in the description and click save (the blue checkmark). You are finished!
4. Click on the "Empty" text. A text field will present. Type in the description and click save (the blue checkmark). You are finished!
5. Be sure to upload the .svg graphic you used to the [lzim/mtl/images/quick_tips_files](https://github.com/lzim/mtl/tree/gh-pages/images/quick_tips_files) folder.

<img alt="Image of navigation steps to update Quick Tips." src="https://raw.githubusercontent.com/lzim/mtl/gh-pages/images/mtl_tips_quick_tip_update.png">
Expand Down

0 comments on commit 4eb9839

Please sign in to comment.