# cnpi-adila/aware_qi_inpatient architecture

> Architecture diagram of the GitHub repository cnpi-adila/aware_qi_inpatient, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cnpi-adila/aware_qi_inpatient
- Repository: https://github.com/cnpi-adila/aware_qi_inpatient

## Overview

AWaRe QI Inpatient is an R Shiny dashboard that uses Global-PPS-structured antimicrobial-use surveillance data to generate AWaRe prescribing quality indicators for stewardship decisions. The principal workflow is users exploring dashboard indicators and condition-specific views, then generating feedback reports; the README also describes dummy-data exploration and conversion guidance for facilities using other surveillance systems. The app and module source were not excerpted, so relationships beyond the README’s documented capabilities are omitted; module paths identify the relevant tree entries, not inspected implementation details.

Main entry points: [`app.R`](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/app.R) (Shiny dashboard), [`Markdown_Report`](https://github.com/cnpi-adila/aware_qi_inpatient/tree/main/Markdown_Report) (Feedback report examples), [`data/Global-PPS Template-Dummy Dataset.xlsx`](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/data/Global-PPS%20Template-Dummy%20Dataset.xlsx) (Dummy surveillance data), [`docs/04 PPS Data Input Guide for AWaRe QI Inpatient Dashboard (V.1.0).xlsx`](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/04%20PPS%20Data%20Input%20Guide%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).xlsx) (Data conversion guide)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Dashboard experience"]
  node_dashboard["Shiny dashboard<br/>[app.R]"]
end

subgraph group_indicators["Indicator views"]
  node_general["General summary"]
  node_sepsis["Sepsis indicators<br/>[sepsis_module.R]"]
  node_meningitis["Meningitis indicators"]
  node_pneumonia["Pneumonia indicators<br/>[pneumonia_module.R]"]
  node_iais["Intra-abdominal indicators<br/>[iais_module.R]"]
  node_uti["Urinary indicators<br/>[uti_module.R]"]
  node_ssti["Skin and soft-tissue indicators<br/>[ssti_module.R]"]
  node_bji["Bone and joint indicators<br/>[bji_module.R]"]
  node_surgical["Surgical prophylaxis<br/>[sp_module.R]"]
end

subgraph group_reports["Feedback reports"]
  node_report_templates["Feedback report examples"]
end

subgraph group_resources["Data and guidance"]
  node_dummy_data["Dummy surveillance data"]
  node_qi_lookup["QI lookup data<br/>[QIs-Lookup.csv]"]
  node_conversion_guide["Data conversion guide"]
  node_user_manual["User manual"]
  node_graph_guide["Graph interpretation"]
  node_stewardship_guide["Stewardship interpretation"]
end

node_users(("AMS users"))

node_users -->|"explore indicators"| node_dashboard
node_dashboard -->|"uses example data"| node_dummy_data
node_dashboard -->|"supports report generation"| node_report_templates
node_dashboard -->|"accepts standardized data"| node_conversion_guide

click node_dashboard "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/app.R"
click node_general "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/general_summary_module.R"
click node_sepsis "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/sepsis_module.R"
click node_meningitis "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/meningitis_module.R"
click node_pneumonia "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/pneumonia_module.R"
click node_iais "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/iais_module.R"
click node_uti "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/uti_module.R"
click node_ssti "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/ssti_module.R"
click node_bji "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/bji_module.R"
click node_surgical "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/sp_module.R"
click node_report_templates "https://github.com/cnpi-adila/aware_qi_inpatient/tree/main/Markdown_Report"
click node_dummy_data "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/data/Global-PPS%20Template-Dummy%20Dataset.xlsx"
click node_qi_lookup "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/data/QIs-Lookup.csv"
click node_conversion_guide "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/04%20PPS%20Data%20Input%20Guide%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).xlsx"
click node_user_manual "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/01%20User%20Manual%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).pdf"
click node_graph_guide "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/02%20Graph%20Interpretations%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).pdf"
click node_stewardship_guide "https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/03%20Antimicrobial%20Stewarship%20Interpretations%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).pdf"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dashboard,node_users toneBlue
class node_general,node_sepsis,node_meningitis,node_pneumonia,node_iais,node_uti,node_ssti,node_bji,node_surgical toneAmber
class node_report_templates toneMint
class node_dummy_data,node_qi_lookup,node_conversion_guide,node_user_manual,node_graph_guide,node_stewardship_guide toneRose
```

## Components

### Dashboard experience

- [Shiny dashboard](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/app.R): `app.R`

### Indicator views

- [General summary](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/general_summary_module.R): `R/modules/general_summary_module.R`
- [Sepsis indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/sepsis_module.R): `R/modules/sepsis_module.R`
- [Meningitis indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/meningitis_module.R): `R/modules/meningitis_module.R`
- [Pneumonia indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/pneumonia_module.R): `R/modules/pneumonia_module.R`
- [Intra-abdominal indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/iais_module.R): `R/modules/iais_module.R`
- [Urinary indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/uti_module.R): `R/modules/uti_module.R`
- [Skin and soft-tissue indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/ssti_module.R): `R/modules/ssti_module.R`
- [Bone and joint indicators](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/bji_module.R): `R/modules/bji_module.R`
- [Surgical prophylaxis](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/R/modules/sp_module.R): `R/modules/sp_module.R`

### Feedback reports

- [Feedback report examples](https://github.com/cnpi-adila/aware_qi_inpatient/tree/main/Markdown_Report): `Markdown_Report`

### Data and guidance

- [Dummy surveillance data](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/data/Global-PPS%20Template-Dummy%20Dataset.xlsx): `data/Global-PPS Template-Dummy Dataset.xlsx`
- [QI lookup data](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/data/QIs-Lookup.csv): `data/QIs-Lookup.csv`
- [Data conversion guide](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/04%20PPS%20Data%20Input%20Guide%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).xlsx): `docs/04 PPS Data Input Guide for AWaRe QI Inpatient Dashboard (V.1.0).xlsx`
- [User manual](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/01%20User%20Manual%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).pdf): `docs/01 User Manual for AWaRe QI Inpatient Dashboard (V.1.0).pdf`
- [Graph interpretation](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/02%20Graph%20Interpretations%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).pdf): `docs/02 Graph Interpretations for AWaRe QI Inpatient Dashboard (V.1.0).pdf`
- [Stewardship interpretation](https://github.com/cnpi-adila/aware_qi_inpatient/blob/main/docs/03%20Antimicrobial%20Stewarship%20Interpretations%20for%20AWaRe%20QI%20Inpatient%20Dashboard%20(V.1.0).pdf): `docs/03 Antimicrobial Stewarship Interpretations for AWaRe QI Inpatient Dashboard (V.1.0).pdf`

### Other components

- **AMS users**

## Connections

- AMS users → Shiny dashboard: explore indicators (evidence: `README.md`)
- Shiny dashboard → Dummy surveillance data: uses example data (evidence: `README.md`)
- Shiny dashboard → Feedback report examples: supports report generation (evidence: `README.md`)
- Shiny dashboard → Data conversion guide: accepts standardized data (evidence: `README.md`)