- Artur Kruszewski
LinkedIn
- Wojciech Kasa
- Piotr Filipowicz
- Sebastian Dąbkowski
LinkedInWelcome to the architectural story of MonitorMe - the O'Reilly Winter 2024 Architectural Kata. Our team took the 1st place. The winning presentation is here: https://www.youtube.com/watch?v=td_AVU1QORk
StayHealthy, Inc. is a large and highly successful medical software company located in San Francisco, California, US. They currently have 2 popular cloud-based SAAS products: MonitorThem and MyMedicalData. MonitorThem a comprehensive data analytics platform that is used for hospital trend and performance analytics-alert response times, patient health problem analytics, patient recovery analysis, and so on. MyMedicalData is a comprehensive cloud-based patient medical records system used by doctors, nurses, and other health professionals to record and track a patient's health records with guaranteed partitioning between patient records. StayHealthy, Inc. is now expanding into the medical monitoring market and is in need of a new medical patient monitoring system for hospitals that monitors a patient's vital signs using proprietary medical monitoring devices built by StayHealthy, Inc.
MonitorMe is an advanced medical patient monitoring system created by StayHealthy, Inc. As the healthcare industry continues to evolve, the demand for sophisticated monitoring solutions becomes increasingly important. MonitorMe meets this demand by providing a comprehensive platform that continuously monitors patients' vital signs, analyzes data for potential issues, and notifies medical professionals when necessary. This architectural narrative offers a detailed exploration of MonitorMe's system architecture, emphasizing its main components, data flow, communication methods, and adherence to non-functional requirements. By understanding MonitorMe's architecture, stakeholders and the development team can gain insight into how the system functions, its alignment with business objectives, and its potential to improve patient care in healthcare environments. Let's explore the architectural complexities of MonitorMe to reveal its innovative design and capabilities.
Upon receiving the requirements from the stakeholders, our team proceeded to analyze and distill the information provided. This involved a thorough examination and refinement process to extract the essential elements and key details. By conducting this requirements distillation, we aimed to ensure a clear understanding of the project scope and objectives, enabling us to proceed with the development process effectively and efficiently. We came up with the business overview and distilled requirements. Frankly speaking, all these requirements can be covered by the four main data flows:
- Collecting data from sensors and visualizing them on the nurse's station.
- Alerting the medical staff on both mobile devices and the nurse's station when anomalies are detected based on defined and easily extendable rules.
- Browsing the patient's vital signs (maximum 24 hours).
- Sending the snapshot to MyMedicalData.
We conducted Event Storming technique to identify main components for the MonitorMe system. This collaborative workshop helped us visualize system workflows, identify domain events, and determine the interactions between components. Through this process, we identified the necessary components and their relationships, informing the design and implementation of the system. Here are the results:
The Business Requirements and Event Storming results have led us to delve deeper into the project and identify crucial architectural characteristics that are highly important for the Monitor Me system.
Choosing the right architectural characteristics is a critical process that lays the foundation for designing an effective architecture and defining efficient data flow within a system. By carefully considering these characteristics, one can determine the most suitable software and hardware components to effectively fulfill the system requirements. This ensures not only the proper functioning of the system but also its scalability, maintainability, and overall performance. Based on the requirements and our expertise, the following top three characteristics have been identified:
Having identified the top three driving characteristics, we can simply choose the architecture style that best fits our business case ADR-012
By utilizing the C4 approach, specifically focusing on the Context (C1) and Container (C2) views, we can effectively visualize the overall structure and key dependencies within the MonitorMe system.
The Context view allows us to understand the high-level relationships and interactions between the system and its external components or systems. All architectural decisions are documented as the Architecture Decision Records (ADRs).
The whole description of the Context view can be found here.
Meanwhile, the Container view provides a detailed breakdown of the internal components and how they are organized within containers such as services, databases, and user interfaces. This approach enables us to gain a comprehensive understanding of the system architecture, facilitating effective communication and decision-making throughout the development process.
The picture below show the final Container (C2) view.
The whole description of the Context view can be found here.
There were identified four main system use cases:
- Monitoring patients by nurse stations
- Alerting when anomalies detected
- Taking a snapshot from the nurse station
- Reviewing historical data from the nurse station
The final deployment diagram looks like the diagram below. If you want to see details, go to the Deployment section.
| Function | Goal | Characteristic to test | Result |
|---|---|---|---|
| Infrastructure validation | The goal is to check whether business goal to achieve an average response time of 1 second or less for displaying vital signs. |
Performance | Success |
| Guarantee to receive alert | Medical professionals receive alert push notifications of a potential problem based on raw data analysis to a StayHeathy mobile app on their smart phone as well as the consolidated monitoring screen in each nurses station. |
Availability | Success |
| Fail-over | If any of vital sign device (or software) fails, MonitorMe must still function for other vital sign monitoring (monitor, record, analyze, and alert). | Availability, Fault Tolerance | Success |
| Functionality | Description |
|---|---|
| Authentication and Authorization | The whole authentication and authorization should be considered, however it is a known issue that could be solved on both ways: - as a part of MonitorMe system - as the SSO of the current solution in hospital |
| Push notifications to the mobile phone | Push notifications are a standard solution for delivering real-time alerts to users' devices. However, their implementation falls outside the scope of the current architecture proposal, which focuses on defining system components. Integrating push notification functionality will be addressed separately. |
| VPN to the external systems | To decide in further steps whether establishing VPN for access to the MedicalData is worth considering for enhanced security and privacy. On this stage, it doesn't play significant role and this decision can be taken later. |
| The hardware | Computers, servers, display screens should follow the newest commercial standards and parameters. |
| Patient registration | The next iteration should show how to register patients, assign sensors to them and map Patients to the MyMedicalData |
| Integration with MonitorThem | The integration with MonitorThem is not specified by stakeholders. The next step should clarify the point of integration, but it shouldn't change the architecture at all |
Team Topologies is an approach to organizational design and team structures that optimizes software delivery and organizational effectiveness. It provides principles and patterns for designing teams based on software architecture and organizational goals. For a detailed description, refer to the Team Topologies Overview file.
