ScreenIT Platform - Documentation Index

Welcome to the ScreenIT Platform Documentation

This documentation provides comprehensive architectural and technical information about the ScreenIT digital health platform for architects, developers, and technical stakeholders who need to understand the platform's architecture, design, and engineering practices.

Last Updated: October 22, 2025

---

Quick Start - Where to Begin

New to ScreenIT? Start Here

→ ONBOARDING_GUIDE.md - Architecture onboarding entry point

This guide provides:

• Platform overview and executive summary
• Glossary of ScreenIT-specific terminology
• Technology stack summary
• Repository structure overview
• Documentation reading paths for different assessment goals

Estimated Reading Time: 20-30 minutes

---

Phase 1 Documentation

These documents provide comprehensive architecture reference for all technical stakeholders:

Core Architecture Documentation

Document	Purpose	Audience	Estimated Time
ONBOARDING_GUIDE.md	Entry point, glossary, navigation guide	All technical stakeholders	20-30 min
architecture/C4_DIAGRAMS.md	C4 Model architectural visualization	Architects	30-45 min
architecture/DEPLOYMENT_TOPOLOGY.md	AWS infrastructure overview	DevOps/Infrastructure	20-30 min

Vendor Architecture Documentation

Document	Purpose	Audience	Estimated Time
vendor-architecture/honeycomb-backend.md	Backend monorepo architecture	Backend developers	20-30 min
vendor-architecture/admin-portal.md	Admin portal frontend architecture	Frontend developers	10-15 min
vendor-architecture/clinician-portal.md	Clinician portal frontend architecture	Frontend developers	10-15 min
vendor-architecture/patient-portal.md	Patient portal frontend architecture	Frontend developers	10-15 min

Total Quick Assessment Time: ~2-3 hours (read all Phase 1 docs)

---

Existing Comprehensive Documentation

These comprehensive documents provide deep technical detail on all aspects of the ScreenIT platform:

Architecture Documentation

Document	Focus Area	Lines	Key Topics
architecture/SCREENIT_MASTER_ARCHITECTURE.md	Complete system overview	666	3-tier architecture, 8 microservices, 3-database split, multi-tenant security
architecture/SCREENIT_HONEYCOMB_BACKEND_ARCHITECTURE.md	Backend microservices deep dive	680	NestJS patterns, GraphQL Code-First, service responsibilities
architecture/SCREENIT_PORTAL_INTEGRATION_ARCHITECTURE.md	Frontend architecture patterns	530	React Admin framework, Mantine UI, multi-endpoint routing
architecture/SCREENIT_DATABASE_ARCHITECTURE.md	Database design and schemas	1324	PostgreSQL schemas, MongoDB schemas, multi-tenant isolation
architecture/SCREENIT_SYSTEM_FLOW_DIAGRAMS.md	Visual workflow diagrams	945	End-to-end process flows, data flows
architecture/SCREENIT_SYSTEM_FLOW_DIAGRAMS_A4_OPTIMIZED.md	Print-optimized flow diagrams	660	A4-formatted diagrams

API & Data Documentation

Document	Focus Area	Key Topics
api/SCREENIT_API_INTEGRATION_ARCHITECTURE.md	API architecture	GraphQL APIs, endpoints, integration patterns
api/SCREENIT_API_REFERENCE.md	API reference	GraphQL schemas, query examples
api/SCREENIT_DATABASE_SCHEMA_REFERENCE.md	Database schema reference	Complete entity definitions, relationships

Security Documentation

Document	Focus Area	Key Topics
security/SCREENIT_SECURITY_ARCHITECTURE.md	Security architecture	Multi-tenant isolation, Firebase multi-app, encryption
security/SCREENIT_SECURITY_IMPLEMENTATION_GUIDE.md	Security implementation	Code patterns, authentication flows, authorization

Operations Documentation

Document	Focus Area	Key Topics
operations/SCREENIT_DEPLOYMENT_OPERATIONS_ARCHITECTURE.md	Deployment & operations	CI/CD, Serverless Framework, environment management
operations/SCREENIT_PERFORMANCE_SCALABILITY_ARCHITECTURE.md	Performance & scalability	Caching strategies, database optimization, auto-scaling
operations/SCREENIT_OPERATIONAL_GUIDE.md	Operational procedures	Monitoring, incident response, DR procedures

Workflow Documentation

Document	Focus Area	Key Topics
workflows/SCREENIT_CLINICAL_WORKFLOWS.md	Clinical workflows	Patient onboarding, assessment administration, results review
workflows/SCREENIT_END_TO_END_PROCESSES.md	Complete user journeys	End-to-end process flows for all user types

Domain-Specific Documentation

Document	Focus Area	Key Topics
BUNDLE_SCREENING_ARCHITECTURE.md	Clinical data model	SCAT6/SCOAT6 bundle architecture, screening data structures

Navigation & Reference

Document	Focus Area	Key Topics
navigation/SCREENIT_LLM_NAVIGATION_GUIDE.md	LLM-optimized navigation	Documentation structure for AI assistants
navigation/SCREENIT_TOPIC_CROSS_REFERENCE.md	Cross-reference index	Topic index across all docs

Bug Tracking

Document	Focus Area
bugs/MFA_AUTO_LOGOUT_BUG.md	Known issues

---

Documentation Reading Paths

Choose a reading path based on your assessment goal:

System Architecture Assessment

Goal: Understand overall system design, technology choices, architectural patterns

1. Start: ONBOARDING_GUIDE.md
2. Visual: architecture/C4_DIAGRAMS.md
3. Comprehensive: architecture/SCREENIT_MASTER_ARCHITECTURE.md
4. Backend: architecture/SCREENIT_HONEYCOMB_BACKEND_ARCHITECTURE.md
5. Frontend: architecture/SCREENIT_PORTAL_INTEGRATION_ARCHITECTURE.md
6. Database: architecture/SCREENIT_DATABASE_ARCHITECTURE.md

Total Time: ~4-5 hours

---

Code Quality Assessment

Goal: Evaluate code organization, patterns, best practices

1. Start: ONBOARDING_GUIDE.md
2. Backend: vendor-architecture/honeycomb-backend.md → Explore ybh-honeycomb/apps/*/src/
3. Admin Portal: vendor-architecture/admin-portal.md → Explore ybh-admin-portal/src/
4. Clinician Portal: vendor-architecture/clinician-portal.md → Explore ybh-clinician-portal/src/
5. Patient Portal: vendor-architecture/patient-portal.md → Explore ybh-patient-portal/src/
6. Code Review: Review GraphQL resolvers, TypeORM entities, React components

Total Time: ~5-6 hours

---

Security Assessment

Goal: Evaluate security architecture, data protection, compliance

1. Start: ONBOARDING_GUIDE.md
2. Security Architecture: security/SCREENIT_SECURITY_ARCHITECTURE.md
3. Security Implementation: security/SCREENIT_SECURITY_IMPLEMENTATION_GUIDE.md
4. Database Security: architecture/SCREENIT_DATABASE_ARCHITECTURE.md (focus on encryption, multi-tenancy)
5. API Security: api/SCREENIT_API_INTEGRATION_ARCHITECTURE.md
6. Code Review: Review GraphQL resolvers for organization-scoped queries, Firebase auth integration

Total Time: ~4-5 hours

---

Infrastructure Assessment

Goal: Understand AWS deployment, scalability, operations

1. Start: ONBOARDING_GUIDE.md
2. Infrastructure: architecture/DEPLOYMENT_TOPOLOGY.md
3. Deployment & Ops: operations/SCREENIT_DEPLOYMENT_OPERATIONS_ARCHITECTURE.md
4. Performance: operations/SCREENIT_PERFORMANCE_SCALABILITY_ARCHITECTURE.md
5. CloudFormation: Review ybh-honeycomb/honeycomb infrastructure cloudformation template - *.yaml
6. CI/CD: Review bitbucket-pipelines.yml in each repository

Total Time: ~3-4 hours

---

Clinical Workflow Assessment

Goal: Understand clinical workflows, SCAT6/SCOAT6 implementation

1. Start: ONBOARDING_GUIDE.md
2. Clinical Workflows: workflows/SCREENIT_CLINICAL_WORKFLOWS.md
3. End-to-End Processes: workflows/SCREENIT_END_TO_END_PROCESSES.md
4. Bundle Architecture: BUNDLE_SCREENING_ARCHITECTURE.md
5. System Flows: architecture/SCREENIT_SYSTEM_FLOW_DIAGRAMS.md
6. Code Review: Review screening workflows in clinician and patient portals

Total Time: ~4-5 hours

---

Technology Stack Quick Reference

Frontend Technologies

• React 18.2.0 - UI framework
• TypeScript - Type safety
• Mantine 7.16.1 - UI component library
• React Admin 5.4.0 - Admin interface framework
• Apollo Client 3.11.10 - GraphQL client
• Vite 5.4.11 - Build tool
• Jotai 2.11.0 - Atomic state management
• TailwindCSS 3.4.15 - Utility-first CSS
• Firebase 11.0.2 - Authentication

Backend Technologies

• NestJS 10.x - Enterprise Node.js framework
• TypeScript - Type safety
• GraphQL - API pattern (Code-First)
• TypeORM 0.3.x - PostgreSQL ORM
• Mongoose 7.x - MongoDB ODM
• NX - Monorepo tool
• Serverless Framework 3.x - AWS Lambda deployment
• Jest - Testing framework

Infrastructure Technologies

• AWS Lambda - Serverless compute
• PostgreSQL (RDS) 14+ - Relational database (2 instances)
• MongoDB (DocumentDB) 6.x - NoSQL database
• Redis (ElastiCache) 7.x - Distributed cache
• AWS SQS - Message queues (12 queues)
• AWS S3 - Object storage
• AWS KMS - Encryption
• Firebase Auth - User authentication (3 apps)
• Bitbucket Pipelines - CI/CD
• CloudFormation - Infrastructure as Code

---

ScreenIT at a Glance

Platform Overview

ScreenIT is a comprehensive digital health SaaS platform specializing in neurological screening and concussion assessment.

Key Metrics:

• 3 Frontend Portals: Admin, Clinician, Patient
• 8 Backend Microservices: NestJS + GraphQL
• 3 Databases: PostgreSQL × 2, MongoDB
• 4 Deployment Environments: dev, stage, prodau (Australia), produk (UK)
• Serverless: 100% AWS Lambda compute
• Multi-Tenant: Organization-level data isolation

Repository Structure

mpf/  (Miroma Project Factory root)
├── docs/                      # All architecture documentation
├── ybh-honeycomb/            # Backend monorepo (8 microservices)
├── ybh-admin-portal/         # Admin Portal (React)
├── ybh-clinician-portal/     # Clinician Portal (React)
└── ybh-patient-portal/       # Patient Portal (React)

---

Documentation Maintenance

Document Ownership

Documentation is maintained by the ScreenIT development team and updated with each major platform change.

Version History

• October 22, 2025: Updated documentation positioning for general architecture understanding
• October 21, 2025: Phase 1 documentation created (ONBOARDING_GUIDE, C4_DIAGRAMS, DEPLOYMENT_TOPOLOGY, repository ARCHITECTURE.md files)
• August 1, 2025: Existing comprehensive documentation (SCREENIT_MASTER_ARCHITECTURE, etc.)

How to Update Documentation

1. Architecture Changes: Update relevant ARCHITECTURE.md files and C4_DIAGRAMS.md
2. New Features: Update SCREENIT_MASTER_ARCHITECTURE.md and relevant workflow docs
3. Infrastructure Changes: Update DEPLOYMENT_TOPOLOGY.md and CloudFormation templates
4. Security Changes: Update SCREENIT_SECURITY_ARCHITECTURE.md

---

Additional Resources

Code Repositories

• Honeycomb Backend: ybh-honeycomb/ (NX monorepo)
• Admin Portal: ybh-admin-portal/ (React SPA)
• Clinician Portal: ybh-clinician-portal/ (React SPA)
• Patient Portal: ybh-patient-portal/ (React SPA)

CloudFormation Templates

• Dev Environment: ybh-honeycomb/honeycomb infrastructure cloudformation template - full architecture - dev.yaml
• Prod Environment: ybh-honeycomb/honeycomb infrastructure cloudformation template - full architecture - prod.yaml
• Partial Infrastructure: ybh-honeycomb/honeycomb infrastructure cloudformation template - partial architecture.yaml

CI/CD Pipelines

• Honeycomb: ybh-honeycomb/bitbucket-pipelines.yml
• Admin Portal: ybh-admin-portal/bitbucket-pipelines.yml
• Clinician Portal: ybh-clinician-portal/bitbucket-pipelines.yml
• Patient Portal: ybh-patient-portal/bitbucket-pipelines.yml

---

Contact & Support

For questions about this documentation or the ScreenIT platform:

• Architecture Questions: Refer to SCREENIT_MASTER_ARCHITECTURE.md or repository ARCHITECTURE.md files
• Technical Support: Contact ScreenIT technical team

---

Quick Assessment Checklist

For 2-Hour Quick Assessment:

• Read ONBOARDING_GUIDE.md
• Review C4_DIAGRAMS.md
• Skim SCREENIT_MASTER_ARCHITECTURE.md
• Browse one repository ARCHITECTURE.md
• Explore codebase

For 1-Day Comprehensive Assessment:

• Complete Quick Assessment (2 hours)
• Read all repository ARCHITECTURE.md files (1 hour)
• Review DEPLOYMENT_TOPOLOGY.md and CloudFormation templates (1 hour)
• Review SCREENIT_DATABASE_ARCHITECTURE.md (1 hour)
• Review SCREENIT_SECURITY_ARCHITECTURE.md (1 hour)
• Explore codebase in depth (2+ hours)

---

Last Updated: October 21, 2025 Documentation Version: 1.0 (Phase 1 Complete)

Ready to begin? Start with ONBOARDING_GUIDE.md →