COMSATS University Islamabad (CUI)

Software Design Description

(SDS DOCUMENT)

for

MediChaos

Version 1.0

By
Abdur Rehman CIIT/SP22-BCS-005/ISB
Muhammad Adil Feroze CIIT/SP22-BCS-006/ISB
Hassan Ali CIIT/SP22-BCS-032/ISB

Supervisor
XYZ

Co-Supervisor (if any)

XYZ
Bachelor of Science in Computer Science (2022-2026)
Software Design Description for MediChaos Page 1

Table Of Contents
1. Introduction..............................................................................................................................3
1.1 System Introduction......................................................................................................................3
1.2 Background of the System............................................................................................................3
1.3 Objectives of the System..............................................................................................................3
1.4 Significance of the System...........................................................................................................4
2. Design Methodology and Software Process Model...............................................................4
2.1 Design Methodology....................................................................................................................4
2.2 Software Process Model: Agile Development Model..................................................................5
2.3 Justification for the Agile Model..................................................................................................5
2.3.1 Why Not Waterfall?.................................................................................................................5
2.3.2 Why Not Prototyping or Spiral?...............................................................................................5
2.4 Conclusion....................................................................................................................................6
3. System Overview......................................................................................................................6
3.1 Product Perspective......................................................................................................................6
3.2 Product Scope...............................................................................................................................7
3.3 Product Functionality...................................................................................................................7
3.4 Users and Characteristics..............................................................................................................8
3.5 Operating Environment................................................................................................................9
4. Design Models.........................................................................................................................10
4.1 Composite Viewpoint.................................................................................................................10
4.2 Logical Viewpoint......................................................................................................................11
4.3 Information Viewpoint...............................................................................................................12
4.4 Interaction Viewpoint.................................................................................................................13
Admin Sequence Diagram......................................................................................................................13
Doctor Sequence Diagram......................................................................................................................14
Patient Sequence Diagram......................................................................................................................15
4.5 State Dynamics Viewpoint.........................................................................................................16
Admin State Diagram..............................................................................................................................16
Doctor State Diagram..............................................................................................................................17
Patient State Diagram..............................................................................................................................18
4.6 Algorithm Viewpoint..................................................................................................................19
Software Design Description for MediChaos Page 2
Software Design Description for MediChaos Page 3

1. Introduction
1.1 System Introduction
The software project, MediChaos - Organizing healthcare, optimizing outcomes, is an ambitious
endeavor that combines advanced technologies to address critical challenges in the healthcare
sector. Our primary goal is to create an intelligent system that leverages web-based platforms,
machine learning models, and efficient data management to enhance patient care, streamline
operations, and improve overall healthcare experiences.

MediChaos aims to empower patients by providing easy access to medical information, enabling
convenient appointment scheduling, and offering predictive health insights through integrated
machine learning models. It acts as a comprehensive tool for doctors to manage patient data,
streamline communication, and utilize diagnostic aids. By seamlessly integrating robust algorithms,
secure databases, and user-friendly interfaces, MediChaos promises to revolutionize how healthcare
is delivered and managed.

1.2 Background of the System

In the field of healthcare management, existing software solutions like “HealthEase” have paved the
way for efficient systems. HealthEase combines patient management with appointment scheduling,
finding applications in clinics, hospitals, and private practices. However, our project, MediChaos,
stands out in several ways:

- Advanced Disease Prediction: MediChaos goes beyond basic management, using machine
learning models to predict health issues such as heart disease, diabetes, and Parkinson's disease.

- Patient-Centric Interaction: Unlike HealthEase, MediChaos emphasizes user interaction,

providing personalized healthcare experiences and facilitating better decision-making.

- Adaptability: MediChaos dynamically adapts to different healthcare contexts, making it versatile

for various medical environments.

- Seamless Data Management: Integrating robust algorithms and secure databases, MediChaos
ensures real-time responsiveness and data security.

In short, MediChaos aims to revolutionize patient care, streamline operations, and enhance overall
healthcare experiences.

1.3 Objectives of the System

 Enhance Accessibility: MediChaos aims to provide patients with easy access to medical
information, appointment scheduling, and health predictions, empowering them to manage
their healthcare confidently.
 Improve Patient Care: By utilizing machine learning models for disease prediction,
MediChaos enhances diagnostic accuracy and provides personalized healthcare
recommendations.
Software Design Description for MediChaos Page 4

 Streamline Operations: MediChaos optimizes hospital operations by efficiently managing

doctor availability, patient appointments, and administrative tasks.
 Foster Patient-Doctor Interaction: MediChaos enhances communication between patients
and doctors, facilitating better medical guidance and timely healthcare interventions.
 Customization and Adaptability: Users can customize MediChaos’s functionalities,
integrate specific healthcare protocols, and adapt the system to various medical contexts.
 Seamless Data Management: MediChaos seamlessly integrates robust algorithms and
secure databases, ensuring real-time responsiveness and efficient data handling.latency.

1.4 Significance of the System

MediChaos’s significance lies in its innovative integration of advanced web-based platforms and
machine learning models to enhance patient care, operational efficiency, and data management. It
stands out as a comprehensive tool for patients to manage their healthcare, a reliable system for
doctors to utilize predictive health insights, and an efficient platform for administrators to
streamline hospital operations. Its adaptability and seamless data integration make it a valuable
asset across various healthcare contexts, promising to improve the quality of care and operational
efficiency in medical facilities.

2. Design Methodology and Software Process Model

2.1 Design Methodology

MediChaos is a complex system with multiple interacting modules (e.g., Patient Management,
Doctor Management, Administrative Management, Machine Learning Integration). Object-
Oriented Programming (OOP) is the ideal choice because:

1. Modularity and Reusability:

o Each module (e.g., Patient, Doctor, Admin, Health Prediction Models) can be
represented as a separate class with encapsulated attributes (e.g., patient records, doctor
schedules) and behaviors (e.g., book appointment, predict disease).
o Promotes code reuse, especially for similar functionalities like user authentication across
modules.
2. Ease of Maintenance and Scalability:
o OOP's modularity makes it easier to maintain and extend the system (e.g., adding a new
prediction model or expanding user roles).
o Changes to a specific class/module won't impact others due to encapsulation.
3. Data Abstraction:
o Allows hiding internal implementation details from end-users (e.g., complex ML
prediction processes) while providing user-friendly interfaces.
4. Inheritance and Polymorphism:
o Facilitates code efficiency and extensibility. For example:
 A User base class can provide shared attributes (e.g., name, email) and methods
(e.g., login, logout) for Patient, Doctor, and Admin subclasses.
Software Design Description for MediChaos Page 5

Polymorphism allows overriding functionalities (e.g., different appointment


handling for doctors and patients).
5. Real-World Alignment:
o OOP naturally maps to real-world healthcare concepts, such as patients, doctors, and
appointments as objects.

2.2 Software Process Model: Agile Development Model

The Agile model is the best fit for MediChaos due to the following reasons:

1. Dynamic and Evolving Requirements:

o Healthcare systems often undergo changes in compliance standards and feature
requirements.
o Agile allows frequent iterations and adaptability to evolving needs (e.g., adding new
prediction models or integrating with external hospital systems).
2. Incremental and Modular Delivery:
o MediChaos can be developed and deployed in smaller increments (e.g., Patient
Management module first, then Doctor Management).
o Each sprint delivers a fully functional and testable module.
3. Collaboration and Feedback:
o Frequent interactions with stakeholders (e.g., doctors, patients, admins) enable the
incorporation of real-world feedback into the system's development.
4. Focus on Quality:
o Agile emphasizes continuous testing and validation, ensuring the system is secure and
functional at each stage.
5. Scalability and Risk Management:
o Early delivery of core functionalities reduces risks and provides opportunities for
performance testing and optimization.
o Modules like machine learning predictions can be continuously trained and fine-tuned
during iterations.

2.3 Justification for the Agile Model

2.3.1 Why Not Waterfall?

 Waterfall is linear and rigid, requiring all requirements to be finalized upfront. MediChaos
is a new system, and user needs or ML models may evolve during development, making
Agile more suitable.

2.3.2 Why Not Prototyping or Spiral?

 Prototyping is effective for systems with ambiguous requirements but lacks a structured
approach to deployment and scalability.
 The Spiral model, while iterative, is more suited to high-risk projects with less defined
goals and a heavier focus on risk management.
Software Design Description for MediChaos Page 6

2.4 Conclusion

By following OOP as the design methodology and the Agile Development Model as the process,
MediChaos ensures:

 A modular, maintainable, and scalable design.

 Rapid delivery of critical features with continuous improvement.
 Adaptability to healthcare industry requirements and end-user feedback.

3. System Overview
3.1 Product Perspective
MediChaos is an innovative system that combines advanced web-based platforms, machine learning
models, and efficient data management to transform healthcare management. It operates in various
healthcare environments, including hospitals, clinics, and private practices. The project is entirely
new, designed from scratch to address the need for comprehensive healthcare management,
predictive health insights, and seamless patient-doctor interaction.

For better understanding, we made a block diagram:

Figure 1: Block Diagram

Software Design Description for MediChaos Page 7

3.2 Product Scope

MediChaos is a web-based healthcare management system designed to streamline operations,
enhance patient care, and provide predictive health insights. The system interacts with various
modules such as patient panels, doctor panels, and admin dashboards to facilitate efficient
healthcare management. It leverages machine learning algorithms to process patient data, enabling
real-time disease prediction and personalized healthcare recommendations.

3.3 Product Functionality

 Patient Management:
- Allows patients to securely access and manage their healthcare information, including
medical records and lab results.
- Enables patients to schedule, reschedule, or cancel appointments with doctors through a user-
friendly interface.
- Utilizes integrated machine learning models to provide patients with predictive insights for
conditions such as heart disease, diabetes, and Parkinson’s disease.

 Doctor Management:
- Allows doctors to manage their profiles, view patient records, update availability, and
schedule appointments.
- Provides diagnostic support through machine learning models, assisting in early detection and
personalized treatment plans.
- Facilitates communication with patients, allowing for efficient and timely medical advice and
follow-ups.

 Administrative Management:
- Offers a centralized dashboard for administrators to monitor and manage all system activities,
including patient and doctor data.
- Ensures data security and privacy, complying with healthcare regulations and standards.
- Allows for the addition and management of hospital departments, staff, equipment, ongoing
operations, and appointments.

 Health Prediction Models:

- Integrates advanced machine learning models for predicting heart disease, diabetes, and
Parkinson’s disease based on patient data.
- Provides real-time health predictions and insights, aiding in early diagnosis and preventive
care.
- Displays predictive analytics in an easily understandable format for both doctors and patients.

 User Interface:
- Provides an intuitive, web-based interface for patients, doctors, and administrators to interact
with the system.
- Displays real-time updates, notifications, and alerts to ensure timely information flow.
- Facilitates easy navigation and access to various functionalities and features of the system.

 Communication Module:
- Enables secure communication between patients and doctors through messaging and video
consultation features.
- Supports timely medical guidance, follow-ups, and patient queries.
- Integrates with email and SMS systems for notifications and reminders.
Software Design Description for MediChaos Page 8

 Integration with External Systems:

- Communicates with external healthcare systems and devices through APIs.
- Facilitates seamless integration with existing hospital management systems and electronic
health records (EHR) systems.

3.4 Users and Characteristics

Primary Users:

1. Hospital Management System:

o Characteristics:
 Experienced professionals responsible for managing hospital operations and
resources.
 Proficient in healthcare administration, including patient data management and
regulatory compliance.
 Familiar with technology tools for optimizing hospital efficiency and patient care.
 May have varying levels of technical expertise depending on their specific roles and
responsibilities.
o Pertinent Characteristics:
 Focus on user-friendly interface design for efficient management of patient records,
appointments, and hospital resources.
 Integration with existing hospital management systems and protocols to ensure
seamless operation and data integrity.
 Prioritize system reliability and uptime to support critical hospital functions and
patient care.

2. Medical Staff (Doctors, Nurses, Technicians):

o Characteristics:
 Healthcare professionals responsible for providing medical care and treatment to
patients.
 Well-trained in medical procedures, patient care, and medical technology usage.
 Require access to patient records, diagnostic tools, and communication channels for
effective care coordination.
 May have varying levels of technical expertise depending on their specialties and
experience.
o Pertinent Characteristics:
 Ensure user-friendly interfaces tailored to specific medical workflows and
responsibilities, allowing for efficient patient care delivery.
 Integration with medical devices and diagnostic tools to streamline data collection
and analysis, enhancing diagnostic accuracy and treatment outcomes.
 Support for secure communication channels and collaboration features to facilitate
interdisciplinary care coordination and decision-making.

Secondary Users:

1. Patients:
o Characteristics:
 Individuals seeking medical treatment, care, or consultation from healthcare
providers.
 Have varying levels of medical knowledge and technology literacy.
 Require access to personal health information, appointment scheduling, and
communication with healthcare providers.
Software Design Description for MediChaos Page 9

 Value user-friendly interfaces and convenient access to healthcare services.

o Pertinent Characteristics:
 Provide intuitive and accessible interfaces for managing appointments, accessing
medical records, and communicating with healthcare providers.
 Integration with patient education resources and wellness tools to empower patients
in managing their health and well-being.
 Support for personalized health recommendations and reminders to promote
proactive healthcare management.

2. Support Staff (IT Personnel, Help Desk):

o Characteristics:
 Technical professionals responsible for supporting and maintaining the MediChaos
system.
 Have expertise in IT infrastructure, software troubleshooting, and customer support.
 Require access to system logs, diagnostic tools, and knowledge base resources for
effective issue resolution.
 Value responsiveness, accuracy, and effective communication with users.
o Pertinent Characteristics:
 Provide comprehensive training and documentation for support staff to effectively
troubleshoot and resolve user issues.
 Integration with IT service management tools and ticketing systems to streamline
support ticket handling and resolution.
 Regular system updates and maintenance to ensure optimal performance and
reliability.

3.5 Operating Environment

1. Web Browser Compatibility:
- MediChaos, being a web-based application, should be compatible with popular web
browsers such as Google Chrome, Mozilla Firefox, Safari, and Microsoft Edge.

2. Operating System Compatibility:

- As a web application, MediChaos is platform-independent and can run on various
operating systems including Windows, macOS, and Linux.

3. Software Components:
- MERN Stack: Built using the MERN (MongoDB, Express.js, React, Node.js) stack,
ensuring compatibility with the latest stable versions of each component.
- Machine Learning Integration: Machine learning models used to predict different
diseases of user and recommend doctors accordingly.
- Database Compatibility: Utilizes MongoDB as the backend database, compatible
with the selected version of MongoDB.
- Node.js Runtime: Runs on Node.js runtime environment, compatible with the
chosen version of Node.js for server-side operations.

4. Network Environment:
- MediChaos operates over the internet and requires a stable internet connection for
users to access the application.
- Compatibility with various network environments including wired, wireless, and
mobile data connections (3G, 4G) ensures accessibility from different locations and
devices.
Software Design Description for MediChaos Page 10

5. Interoperability:
- Interacts effectively with different devices and platforms, providing a consistent user
experience across various devices and screen sizes.
- Ensures compatibility with web standards and protocols for seamless integration
with other web services and APIs.

4. Design Models
4.1 Composite Viewpoint

Figure 2: Package Diagram

Software Design Description for MediChaos Page 11

4.2 Logical Viewpoint

Figure 3: Class Diagram

Software Design Description for MediChaos Page 12

4.3 Information Viewpoint

Figure 4: Entity-relation Diagram

Software Design Description for MediChaos Page 13

4.4 Interaction Viewpoint

Admin Sequence Diagram

Software Design Description for MediChaos Page 14

Figure 5: Admin Sequence Diagram

Software Design Description for MediChaos Page 15
Software Design Description for MediChaos Page 16

Doctor Sequence Diagram

Figure 6: Doctor Sequence Diagram

Software Design Description for MediChaos Page 17

Patient Sequence Diagram

Figure 7: Patient Sequence Diagram

Software Design Description for MediChaos Page 18

4.5 State Dynamics Viewpoint

Admin State Diagram

Figure 8: Admin State Diagram

Software Design Description for MediChaos Page 19

Doctor State Diagram

Figure 9: Doctor State Diagram

Patient State Diagram

Software Design Description for MediChaos Page 20

Figure 10: Patient State Diagram

4.6 Algorithm Viewpoint

1. Start the software.
Software Design Description for MediChaos Page 21

2. Initialize variables, data structures, and necessary services (database connection, server,
etc.).
3. Authenticate user:
 If the user is not authenticated:
 Display login screen.
 Read user credentials.
 Validate credentials.
 If credentials are valid, proceed to the next step.
 Else, display error message and return to the login screen.
4. Display the main menu to the user.
5. Repeat the following steps until the software is closed:
1. Read the user's choice from the input.
2. If the user's choice is 1:
 Display account management options (e.g., view profile, edit profile, change password).
 Read and process user inputs for account management.
3. Else if the user's choice is 2:
 Display patient management options (e.g., add patient, view patient records, update patient
records).
 Read and process user inputs for patient management.
4. Else if the user's choice is 3:
 Display AI model management options (e.g., run diagnostic model, view model results,
update models).
 Read and process user inputs for AI model management.
5. Else if the user's choice is 4:
 Display appointment scheduling options (e.g., schedule new appointment, view
appointments, update appointments).
 Read and process user inputs for appointment scheduling.
6. Else if the user's choice is 5:
 Display billing and payment options (e.g., view invoices, process payments, generate
reports).
 Read and process user inputs for billing and payment.
7. Else if the user's choice is 6:
 Display system administration options (e.g., user management, data backup, system
settings).
 Read and process user inputs for system administration.
8. Else:
 Display an error message for an invalid choice.
6. End the software:
 Perform necessary cleanup operations (e.g., close database connections, save user session
data).
 Log the user out.
 Display a shutdown message.