Software Design Document

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 7

Software Design Document (SDD)

Revision History
Date Version Description Authot

10/04/2023 V1.0.0 Initial SDD for PACS System Mahmoud Youssef

Table of Contents
1. Introduction..............................................................................................................................................1
2. Overall Description...................................................................................................................................2
3. System Features and Requirements..........................................................................................................3
4. System Architecture and Design...............................................................................................................4
5. Data Design..............................................................................................................................................6
6. User Interface Design...............................................................................................................................7
7. Security Design.........................................................................................................................................7
8. Implementation Considerations................................................................................................................7
9. Quality Assurance.....................................................................................................................................8
10. Appendices...........................................................................................................................................8

This SDD provides a blueprint for the development, deployment, and maintenance of the .NET-
based PACS integrated with an OHIF viewer. It must be reviewed, refined, and approved by all
project stakeholders before implementation begins.

1. Introduction
1.1 Purpose
The purpose of this document is to provide a detailed overview of our
on-premises .NET-based Picture Archiving and Communication System (PACS) software, along
with a React-based off the shelf viewer Open Health Imaging Foundation (OHIF) after modifying
UI to match our own. The PACS will handle storage, retrieval, management, and display of
medical images acquired from various modalities using DICOM protocol.
1.2 Scope
The PACS will operate on the customer's Windows server, receiving studies from on-site
modalities, storing images on the server's file system, and referencing these studies via file
paths in a Microsoft SQL Server database. A Web Access to DICOM Objects (WADO) server will
communicate these paths to the OHIF viewer's worklist, enabling physicians to access and
view the studies.
1.3 Definitions, Acronyms, and Abbreviations
- PACS: Picture Archiving and Communication System
- OHIF: Open Health Imaging Foundation
- DICOM: Digital Imaging and Communications in Medicine
- WADO: Web Access to DICOM Persistent Objects
- SDD: Software Design Document
- AE Title: Application Entity Title
- IP: Internet Protocol
- MSSQL: Microsoft SQL Server

1.4 References
- DICOM Standard Specifications
- OHIF Viewer Documentation
- .NET Framework Documentation
- Microsoft SQL Server Documentation

2. Overall Description
2.1 System Architecture
The PACS is structured as a multi-tier application comprising the following layers:
- Presentation Layer: React-based OHIF viewer for displaying medical images.
- Application Layer: .NET-based backend for business logic and DICOM
communication.
- Data Layer: File system for image storage and MSSQL for metadata management.
- Network Layer: DICOM, WADO, and HTTP/HTTPS protocols for system
communication.
2.2 System Features
- DICOM modality worklist management.
- Secure communication using DICOM TLS.
- Persistent storage of medical images.
- Efficient retrieval of images via the WADO server.
- High-resolution image viewing through the OHIF viewer.

2.3 User Classes and Characteristics


- Radiologists: Primary users who view and analyze medical images.
- Technicians: Operate the imaging modalities and PACS software.
- IT Support Staff: Install, configure, and maintain the PACS system.

2.4 Operating Environment


- Server: Windows Server with .NET runtime.
- Client: Any device with a web browser that supports modern JavaScript (React).

3. System Features and Requirements


3.1 Functional Requirements
3.1.1 Modality Communication
- FR1: The system shall receive DICOM images from modalities using the DICOM protocol.
3.1.2 Image Storage
- FR2: The system shall store DICOM images in the server's file system.
- FR3: The system shall record the file paths of the stored images in the MSSQL
database.
3.1.3 WADO Server
- FR4: The WADO server shall retrieve study paths from the database.
- FR5: The WADO server shall transmit study information to the OHIF viewer.

3.1.4 OHIF Viewer Integration


- FR6: The OHIF viewer shall display medical images retrieved via the WADO server.
3.2 Non-Functional Requirements
3.2.1 Performance
- NFR1: The system shall handle concurrent requests from multiple modalities.
- NFR2: The image retrieval and display process shall not exceed 5 seconds under typical
load.
3.2.2 Security
- NFR3: The system shall comply with HIPAA and other relevant regulations for data security.
- NFR4: All DICOM transfers shall utilize secure transport mechanisms.

3.2.3 Reliability
- NFR5: The system shall have an uptime of 99.9%, not including scheduled
maintenance.
3.2.4 Scalability
- NFR6: The system shall be scalable to accommodate an increasing number of images
and modalities.
3.2.5 Maintainability
- NFR7: The system shall support easy updates and maintenance without
significant downtime.

4. System Architecture and Design


4.1 High-Level Architecture

4.2 Detailed System Design


4.2.1 PACS Backend
- Written in C# (.NET).
- Manages DICOM communication (reception, parsing, and storing).
- Interacts with the MSSQL database to store and retrieve study metadata.

4.2.2 MSSQL Database


- Stores study metadata, including file paths.
- Optimized schema for quick lookups.

4.2.3 File System


- Hierarchical storage structure for organizing DICOM images.
- Backup and recovery strategies in place.
4.2.4 WADO Server

- Implemented as a .NET service.


- Handles HTTP/HTTPS requests for image data.

4.2.5 OHIF Viewer


- React-based front-end.
- Communicates with the WADO server via RESTful APIs.
- Implements viewing features such as zoom, pan, and windowing.

5. Data Design
5.1 Database Design

5.2 Data Dictionary


- Studies Table: Contains records for each study with references to series.
- Series Table: Contains records for each series with references to images.
- Images Table: Contains file path references and metadata for each image.

6. User Interface Design


6.1 OHIF Viewer UI
- Study list and worklist interface.
- Image viewing area with toolbars for image manipulation.

7. Security Design
7.1 Security Measures
- Authentication and authorization mechanisms.
- Encryption for data at rest and in transit.
- Regular security audits and updates.

8. Implementation Considerations
8.1 Platform Dependencies
- Windows Server for hosting the PACS and database.
- .NET runtime for the PACS backend.
- Web browser for the OHIF viewer.

8.2 Use of Open Source


- The OHIF viewer is an open-source project.
- Other open-source libraries may be used for DICOM handling and UI components.
9. Quality Assurance
9.1 Testing Strategy
- Unit testing for individual components.
- Integration testing for end-to-end workflows.
- Load testing to validate performance under stress.

9.2 Acceptance Criteria


- Compliance with DICOM standards.
- Adherence to security regulations.
- Positive feedback from user acceptance testing.

10. Appendices
10.1 Appendix A: Glossary
- See section 1.3.
10.2 Appendix B: References
- See section 1.4.
10.3 Appendix C: To-Be-Determined List
- Final deployment configuration details.
- Specific security protocols and cipher suites to be used.
- Detailed backup and disaster recovery procedures.

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy