RePORT AI Portal
0.22.0

For Researchers & Data Managers

  • User Guide
    • Start Here
    • What’s Included
    • Contents
      • Overview
        • What It Does
        • Who It Helps
        • Typical Workflow
        • Privacy in Plain Language
        • When to Use It
        • Next Step
      • Installation
        • Requirements
        • Install
        • Start the Web UI
        • Optional Developer Setup
        • Prepare for First Run
      • Quick Start
        • Before You Start
        • 1. Place Study Files
        • 2. Choose a Model Provider
        • 3. Load the Study
        • 4. Start Chat
        • Use Existing Study
        • Common Problems
        • Next Steps
      • Configuration
        • Minimum Settings
        • Recommended Default
        • Study Folder
        • PHI-Related Settings
        • PHI Key
        • Where to Put More Detail
        • Next Step
      • Data Pipeline
        • What “Load Study” Means
        • Input Folder
        • Output Folder
        • Running the Pipeline
        • Using an Existing Study
        • PDFs
        • Audit Files
        • Troubleshooting
      • Glossary
        • Developer Terms
      • Frequently Asked Questions
        • What is RePORT AI Portal?
        • Who is it for?
        • What can I ask it?
        • What files do I need?
        • Do I need an API key?
        • How do I install it?
        • How do I run it?
        • Can I use an existing processed study?
        • Does the assistant read raw files?
        • What if my PDFs may contain PHI?
        • Can I skip PDFs?
        • Where do I check what happened during a run?
        • What if I find raw PHI in output?
        • Can it handle large datasets?
        • Is there a GUI?
        • Where are developer details?
    • Where Details Live

For IRB & Auditors

  • IRB/Auditor Profile
    • Review Path
    • What This System Does
    • What This Profile Covers
    • What This Profile Does Not Cover
    • Contents
      • PHI Handling
        • Purpose
        • What Is Handled
        • Where PHI Can Exist
        • How PHI Is Protected
        • Why These Controls Exist
        • Jurisdiction Alignment
        • Primary Authority Links
      • Conformance Evidence
        • Reviewer Evidence Package
        • Open Operator Items
      • Attestations
        • PHI-Free PDF Attestation
        • Limited Dataset Attestation

For Developers & Maintainers

  • Developer Guide
    • Start by Role
    • Contents
      • Architecture
        • System Overview
        • The Five-Tier Zone Model
        • Core Components
        • Pipeline Modules
        • Supporting Services
        • Data Flow
        • Security Boundaries
        • Design Principles
        • See Also
      • PHI Architecture
        • The Four Tiers (plus audit and one out-of-zone tier)
        • The Eight-Action Scrub Catalog (Step 1.6)
        • The Agent-Boundary Three-Gate Stack
        • The PDF Orchestrator’s Redact-Then-Call Posture
        • The Integrity Chain
        • Log Hygiene
        • KeyStore
        • Subprocess Sandbox
        • Module Map
        • IRB Benchmark Cross-Reference
        • When You Touch This Code
        • See Also
      • Architecture Decisions (ADRs)
        • ADR-001 — Single-study, local-first runtime
        • ADR-002 — HMAC-SHA256 pseudonymization with sidecar key (no vault)
        • ADR-003 — SANT per-subject date jitter over HIPAA year-only
        • ADR-004 — Rule+allowlist over Microsoft Presidio
        • ADR-005 — tmpfs staging as an operator opt-in (not default)
        • ADR-006 — External-API PDF extraction refused by default
        • ADR-007 — Four-tier architecture (RED / AMBER / GREEN / GREEN-PROTECT)
        • ADR-008 — Agent boundary PHI + k-anon gate as defence-in-depth
        • ADR-009 — Counts-only audit reports (never raw values)
        • ADR-010 — Subprocess + rlimits sandbox for run_python_analysis
        • ADR-011 — KeyStore (in-memory API-key registry)
        • ADR-012 — Two-way PDF orchestrator (pdfplumber + redacted-text LLM merge)
        • ADR-013 — Single reviewed snapshot baseline
        • ADR-014 — Parallel extraction phase (3-worker ThreadPoolExecutor)
        • ADR-015 — l-diversity (l=2) on row-returning tools
      • References
        • Primary Regulations
        • Standards & Frameworks
        • Techniques
        • Benchmarks & Comparative Studies
        • Tools & Libraries Cited in Decisions
        • Reading Order for a New Contributor
      • Tech Stack
        • Runtime — language and tooling
        • Runtime — pipeline
        • Runtime — agent
        • Runtime — security
        • Runtime — observability
        • Development
        • Custom type stubs
        • Pinning policy
      • Dataset Extraction
        • Overview
        • Data Flow
        • Source
        • Output
        • JSONL Record Schema
        • Zone Enforcement
        • CLI Usage
        • Downstream Handoff
        • Key Files
      • PDF Extraction
        • Two co-existing extraction paths
        • Dispatch
        • Orchestrator path (the default)
        • Capability gate details
        • Legacy raw-PDF API path
        • Output schema (per-form)
        • CLI usage
        • Key files
        • Testing
        • Downstream usage
        • Licensing
      • Operations
        • Prerequisites
        • Pipeline Run
        • Artifact Rebuild
        • Cleanup
        • Security Verification
        • Quality Checks
        • Debug and Troubleshooting
        • Known Limitations
        • AI Assistant
        • Trio-Bundle Snapshot Maintenance
      • Production Readiness
        • Scope
        • Release Gate
        • Deployment Boundary
        • Security Headers
        • Monitoring
        • Backups and Restore
        • Secret and Key Rotation
        • Incident Response
        • Operational Non-Negotiables
        • External References
      • Sandbox: Subprocess-Isolated Code Execution
        • Threat Model
        • Architecture
        • The macOS Asymmetry
        • Configurable Knobs
        • Code Persistence and Replication
        • Tests
        • Future Work
        • When You Touch This Code
      • Versioning
        • Version Source of Truth
        • Automatic Version Bumping
        • Manual Bumping
        • Version Validation
        • Checking the Current Version
      • API Reference
        • Core Modules
        • Extraction Modules
        • Security Modules
        • Utility Modules
        • Extraction Modules (continued)
        • AI Assistant Modules
        • Telemetry
        • Extraction Modules (continued)
        • Utility Modules (continued)
        • Sandbox Subprocess
        • Extraction I/O Helpers
        • Indices and Tables
      • Project Status
        • Implemented
        • Verification
        • IRB Conformance
        • Known Follow-Ups
      • Production Backlog
        • Supply Chain
        • Runtime Resilience
        • Security Headers
        • Observability
        • Data Retention
        • Deployment Packaging
      • Documentation Style
        • Style Basis
        • Documentation Boundary
        • Profile-first Rule
        • User-facing Page Pattern
        • Developer-facing Page Pattern
        • IRB-facing Page Pattern
        • Language Rules
        • Freshness Checks
        • Change Checklist
      • Contributing
        • Branch And PR Workflow
        • Attribution
        • Local Setup
        • Before Opening A PR
        • Coding Rules
        • Documentation Rules
        • Adding A PHI Rule
        • Adding An Agent Tool
        • Adding Provider Support
        • Review Focus
      • Testing
        • Active Commands
        • Current Test Layout
        • What Each Gate Proves
        • PHI-Critical Coverage
        • Writing Tests
        • CI Behavior
      • Agent Instructions (for AI Coding Assistants)
        • Orientation
        • Quick reference
        • Architecture (two-world)
        • Tech stack
        • Critical conventions
        • Web UI architecture
        • Key files
        • Documentation
    • Working Rules

Project Updates

  • Release Notes
    • Unreleased
      • Added
      • Changed
      • Fixed
    • Release Note Rules
RePORT AI Portal
  • Search

© Copyright 2025–2026, Solomon S Joseph.

Built with Sphinx using a theme provided by Read the Docs.