Skip to content

Commit cf6985a

Browse files
marycrawfordmarycrawford
and
marycrawford
authored
Add ReportVision Product Walthrough Video and Azure Infra Architecture (#521)
* remove old video and include rv full product walthrough video * update with azure diagram and demo video * Update README.md demo link * Update README.md revised disgram * Remove table of contents reference after video * Fix Notices Section * Add Return Table of Contents Reference to Infra Arch Section * update ops/terraform README and resolve conflicts * Update README.md's architectural design * save updated architectural design to images-and-media folder * Update ops/terraform/README.md with revised Architecture diagram * update images-and-media with revised architecture diagram * update images-and-media with revised architecture * Remove Extra Text Box in Architecture for ops/terraform * Remove extra text box from architecture in main README * Update README.md * Update ops/terraform README.md --------- Co-authored-by: marycrawford <[email protected]>
1 parent b2cebd3 commit cf6985a

File tree

5 files changed

+40
-31
lines changed

5 files changed

+40
-31
lines changed

README.md

+35-30
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,21 @@
44
- [The Solution](#the-solution)
55
- [Future Considerations](#future-considerations)
66

7-
[2. Notices](#2-notices)
8-
- [2.1 Privacy Standard Notice](#21-privacy-standard-notice)
9-
- [2.2 Records Management Standard Notice](#22-records-management-standard-notice)
10-
- [2.3 Domestic Copyright Protection Notice](#23-domestic-copyright-protection-notice)
11-
- [2.4 Public Domain Standard Notice](#24-public-domain-standard-notice)
12-
- [2.5 Open Source Notice](#25-open-source-notice)
13-
- [2.6 License Standard Notice](#26-license-standard-notice)
14-
- [2.7 Github Notice](#27-github-notice)
15-
- [2.8 Contributing Standard Notice](#28-contributing-standard-notice)
7+
[2. Infrastructure Architecture](#2-infrastructure-architecture)
168

17-
[3. General Disclaimer](#3-general-disclaimer)
9+
[3. Notices](#3-notices)
10+
- [3.1 Privacy Standard Notice](#31-privacy-standard-notice)
11+
- [3.2 Records Management Standard Notice](#32-records-management-standard-notice)
12+
- [3.3 Domestic Copyright Protection Notice](#33-domestic-copyright-protection-notice)
13+
- [3.4 Public Domain Standard Notice](#34-public-domain-standard-notice)
14+
- [3.5 Open Source Notice](#35-open-source-notice)
15+
- [3.6 License Standard Notice](#36-license-standard-notice)
16+
- [3.7 Github Notice](#37-github-notice)
17+
- [3.8 Contributing Standard Notice](#38-contributing-standard-notice)
1818

19-
[4. Other Related Documents](#4-other-related-documents)
19+
[4. General Disclaimer](#4-general-disclaimer)
20+
21+
[5. Other Related Documents](#5-other-related-documents)
2022

2123

2224
# 1. Overview
@@ -38,31 +40,34 @@ With ReportVision, public health departments can move from cumbersome, error-pro
3840

3941
This application offers a robust framework for public health departments and personnel to efficiently extract relevant data from lab reports utilizing an advanced Optical Character Recognition (OCR) model. This OCR technology significantly enhances both the speed and accuracy of data extraction, taking your data processing capabilities to the next level.
4042

41-
Check out the following videos to see how the updated OCR model works in action, and and witness firsthand how ReportVision enhances both the speed and accuracy of data extraction!
43+
Check out the following video which demos the ReportVision application including how the updated OCR model works in action, and witness firsthand how ReportVision enhances both the speed and accuracy of data extraction!
4244

43-
<div align="center">
44-
<video width="500" height="280" controls>
45-
<source src="/images-and-media/reportvision-demo.mp4" type="video/mp4">
46-
Video Extracting Data From Lab Reports.
47-
</video>
48-
</div align="center">
45+
https://github.com/user-attachments/assets/5b707ec2-5d11-436b-a270-98000ef21e8f
4946

5047
## Future Considerations
5148

5249
The current version of the application is optimized only for PDF-based lab reports. However, as demand from public health departments and personnel continues to grow, we see significant potential to expand support for additional file formats in future updates.
5350

5451
+ [Return to Table of Contents](#table-of-contents).
5552

56-
# 2. Notices
53+
# 2. Infrastructure Architecture
54+
55+
The following provides a High-Level Architectural Design of the ReportVision Azure Architecture, with OCR powered by Tesseract to enhance efficiency, user experience, and throughput.
56+
57+
<img width="998" alt="rv-azure-architecture-diagram" src="https://github.com/user-attachments/assets/5c73c2e7-4b38-4527-8df0-ec5beb1eaf5e" />
58+
59+
+ [Return to Table of Contents](#table-of-contents).
60+
61+
# 3 Notices
5762

58-
## 2.1 Privacy Standard Notice
63+
## 3.1 Privacy Standard Notice
5964
This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the [Disclaimer](DISCLAIMER.md) and [Code of Conduct](code-of-conduct.md).
6065

6166
For more information about CDC's privacy policy, please visit [http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).
6267

6368
+ [Return to Table of Contents](#table-of-contents).
6469

65-
## 2.2 Records Management Standard Notice
70+
## 3.2 Records Management Standard Notice
6671

6772
This repository is not a source of government records, but is a copy to increase
6873
collaboration and collaborative potential. All government records will be
@@ -71,13 +76,13 @@ published through the [CDC web site](http://www.cdc.gov).
7176
+ [Return to Table of Contents](#table-of-contents).
7277

7378

74-
## 2.3 Domestic Copyright Protection Notice
79+
## 3.3 Domestic Copyright Protection Notice
7580

7681
This repository is a work of the United States Government and is not subject to domestic copyright protection under 17 U.S.C. § 105. If published in the public domain within the United States, copyright and related rights worldwide will be waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
7782

7883
+ [Return to Table of Contents](#table-of-contents).
7984

80-
## 2.4 Public Domain Standard Notice
85+
## 3.4 Public Domain Standard Notice
8186
This repository constitutes a work of the United States Government and is not
8287
subject to domestic copyright protection under 17 USC § 105. This repository is in
8388
the public domain within the United States, and copyright and related rights in
@@ -88,13 +93,13 @@ copyright interest.
8893

8994
+ [Return to Table of Contents](#table-of-contents).
9095

91-
## 2.5 Open Source Notice
96+
## 3.5 Open Source Notice
9297

9398
This repository is open source and follows [open practices](docs/open_practices.md). Contributors are expected to adhere to the organization's [rules of behavior](docs/rules_of_behavior.md).
9499

95100
+ [Return to Table of Contents](#table-of-contents).
96101

97-
## 2.6 License Standard Notice
102+
## 3.6 License Standard Notice
98103

99104
The code in this repository is licensed under the Apache License 2.0 (ASL v2), or any later version at your discretion.
100105

@@ -106,14 +111,14 @@ Additionally, any code forked from this open-source project will retain its orig
106111

107112
+ [Return to Table of Contents](#table-of-contents).
108113

109-
## 2.7 Github Notice
114+
## 3.7 Github Notice
110115

111116
GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise. If you are new to GitHub, we recommend starting with this
112117
[basic tutorial](https://help.github.com/articles/set-up-git) to familiarize yourself with version control and collaboration.
113118

114119
+ [Return to Table of Contents](#table-of-contents).
115120

116-
## 2.8 Contributing Standard Notice
121+
## 3.8 Contributing Standard Notice
117122

118123
While we encourage continuous development of this repository's codebase, there is currently no designated department overseeing its management. If you'd like to contribute, you have two options:
119124

@@ -127,18 +132,18 @@ CDC including this GitHub page may be subject to applicable federal law, includi
127132

128133
+ [Return to Table of Contents](#table-of-contents).
129134

130-
# 3. General Disclaimer
135+
# 4. General Disclaimer
131136

132137
This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/cdc/?CDC_AAref_Val=https://www.cdc.gov/about/organization/mission.htm).
133138

134139
+ [Return to Table of Contents](#table-of-contents).
135140

136-
# 4. Other Related Documents
141+
# 5. Other Related Documents
137142

138143
* [Open Practices](docs/open_practices.md)
139144
* [Rules of Behavior](docs/rules_of_behavior.md)
140145
* [Disclaimer](docs/DISCLAIMER.md)
141146
* [Contribution Notice](docs/CONTRIBUTING.md)
142147
* [Code of Conduct](docs/code-of-conduct.md)
143148
* [Review Guidelines](docs/REVIEW_GUIDELINES.md)
144-
* [Review SLAS](docs/REVIEW_SLAS.md)
149+
* [Review SLAS](docs/REVIEW_SLAS.md)
-63 MB
Binary file not shown.
Loading
9.94 MB
Binary file not shown.

ops/terraform/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Currently, our infrastructure is built specifically for Azure, with a traditional cloud architecture hosting our frontend code from blob storage and our OCR-API, Middleware-API running in App Service's. The frontend, OCR-API, Middleware-API, and the Postgres Database are behind a Virtual Network and load balanced by an App Gateway.
44

5+
This diagram provides a high-level overview of our Azure architectural design.
6+
7+
<img width="998" alt="rv-azure-architecture-diagram" src="https://github.com/user-attachments/assets/5c73c2e7-4b38-4527-8df0-ec5beb1eaf5e" />
8+
59
## List of Azure Services being used
610

711
- Resource Groups
@@ -90,4 +94,4 @@ once Purge Protection has been Enabled it's not possible to disable it
9094
```
9195
This is a valid and expected error because we do not want to purge the secret for the database. We implemented this change right before our contract ended and ran out of time to fix it(We started looking into possibly making it a warning instead of an error).
9296
93-
All the updating changes should still apply even with this error but it definitely is blocking Github Actions from working properly for this process to be fully automated.
97+
All the updating changes should still apply even with this error but it definitely is blocking Github Actions from working properly for this process to be fully automated.

0 commit comments

Comments
 (0)