diff --git a/Usecases/UI-component-Desc.md b/Usecases/UI-component-Desc.md new file mode 100644 index 00000000..c987642d --- /dev/null +++ b/Usecases/UI-component-Desc.md @@ -0,0 +1,27 @@ +The UI microservices is split into 4 subservices
+#### 1.)Authentication
+- this service contains two actions: a login and register action
+- login: communicate with account information to validate credentials
+- register: communicate with account information to add new dredentials to account information
+#### 2.)Notification
+- this service generates and displays notifications when various tasks occur
+- some tasks include account info updates, updates to the triage record +#### 3.)TriageHandler
+- this service allows for triages to occur and triage records to be accessed.
+- communicates with the triage engine to perform triage
+- communicates with the triage record to get history + +#### 4.)ER Service
+- this service allows for checking the current ED load from the ERDataSource

+ +Connectors: +#### internal:
+- Triage services requires the user to be logged in (from authentication) + +#### External:
+- Authentication requires patient management to create patient credentials and validate patient credentials +- ERService requires ERDataSource from Health service management to determine load +- Notification services require patient management to determine changes in stored data to notify the patient about +- Triage services requires both patient management to access triage history and the triage engine from Health service management to perform a triage + + diff --git a/Usecases/UI_Deployment_description.md b/Usecases/UI_Deployment_description.md new file mode 100644 index 00000000..9011d5b1 --- /dev/null +++ b/Usecases/UI_Deployment_description.md @@ -0,0 +1,5 @@ +The first thing a client will see when accessing our service +will be the UI and how it is portrayed. This web server contains +a HTML website,a .css file for display styles, and a javascript file +to request tasks using fast API. Fast API is an efficient web framework for connecting the web server and the application server. +On the application server are three types of services: Authentication, Notification, and a Triage data gatherer. The Authentication service takes a username and password from the website, then communicates with the patient management microservice to determine the validity of the credentials. After Validity/Denial, the website will update accordingly. The notification service will generate a text message according to the current ask (such as a login success message) and display it on the webpage for a set period. The triage data gatherer communicates with the patient management microservice to obtain the data from the user's most recent triage and display it on the webpage. diff --git a/Usecases/UI_deployment.drawio b/Usecases/UI_deployment.drawio new file mode 100644 index 00000000..acaf5403 --- /dev/null +++ b/Usecases/UI_deployment.drawio @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +