No description
Find a file
Daniel 1a491d7367
Some checks failed
Forgejo Docker Build / Root app tests (push) Successful in 50s
Forgejo Docker Build / Build Docker image (push) Successful in 7s
Forgejo Docker Build / End-to-end (browser) (push) Failing after 8s
feat: a deck up to sixty slides is generated, reviewed and modified
Twenty was the review ceiling while the form allowed thirty, so a 21-30 slide
deck was written, stored and then silently never reviewed — and modifying one
above twenty was shown only its first twenty pages while the prompt claimed
one image per slide. The three numbers are the schema's own limit now, so a
deck that can be asked for can also be stored, reviewed and edited: the form's
max, both generation clamps and MAX_SLIDES are all 60.

Measured at that size before this change: 45 pages cost 28,796 prompt tokens
and 2.2s to review, a 46-page deck with a fault on page 24 was found and
re-laid correctly, and a 44-slide deck used ~5,900 output tokens of the
16,000 ceiling.
2026-09-16 17:21:03 +02:00
.forgejo/workflows feat: the API describes itself, at /api/openapi.json 2026-09-13 00:52:55 +02:00
.github ci: fix the failing job, split deploy out, and drop the Android build 2026-09-12 23:30:52 +02:00
android
assets feat: deck cards fit their content, callouts use the theme's ink, questions can carry a film, formats end with references 2026-09-14 15:35:10 +02:00
docs feat: the password door is gone; One Sign In is the only way in 2026-09-15 04:14:04 +02:00
e2e test(e2e): the landing specs tie the job to the click, not to a poll count 2026-09-16 04:05:12 +02:00
migrations feat: a resource is generated as a job, and DeepSeek writes it without thinking 2026-09-16 03:53:57 +02:00
monitoring
public feat: a deck up to sixty slides is generated, reviewed and modified 2026-09-16 17:21:03 +02:00
scripts test(e2e): the browser suite follows generation into its job, and can log in again 2026-09-16 04:02:10 +02:00
src feat: a deck up to sixty slides is generated, reviewed and modified 2026-09-16 17:21:03 +02:00
test feat: a deck up to sixty slides is generated, reviewed and modified 2026-09-16 17:21:03 +02:00
.dockerignore
.env.example feat: the assistant reopens the chat you were in, and DeepSeek answers without thinking when told to 2026-09-14 15:24:48 +02:00
.gitignore
.gitmessage
.node-pg-migraterc.json
admin-cli.js feat: the password door is gone; One Sign In is the only way in 2026-09-15 04:14:04 +02:00
CONTRIBUTING.md ci: fix the failing job, split deploy out, and drop the Android build 2026-09-12 23:30:52 +02:00
docker-compose.e2e.yml test: e2e runs against its own throwaway database, not production's 2026-09-13 00:49:25 +02:00
docker-compose.local.yml
docker-compose.monitoring.yml
docker-compose.yml chore: the app reaches the gateway by container name, not the public host 2026-09-16 03:53:53 +02:00
docker-entrypoint.sh test: e2e runs against its own throwaway database, not production's 2026-09-13 00:49:25 +02:00
Dockerfile
grafana-dashboard.json
package-lock.json
package.json
README.md feat: the password door is gone; One Sign In is the only way in 2026-09-15 04:14:04 +02:00
server.js refactor: sign-in codes and registration invitations leave; the SSO has both 2026-09-13 06:11:00 +02:00
TODO.md ci: fix the failing job, split deploy out, and drop the Android build 2026-09-12 23:30:52 +02:00

Ped-AI

Ped-AI is a pediatric clinical documentation, education, and bedside decision-support app. This fork has moved well beyond the original scribe app: it now combines encounter documentation, clinical workflows, private teaching material, admin controls, MCP-backed clinical assistant integration, Redis-backed operational state, and hardened deployment defaults.

The app runs as an authenticated Express/Postgres service with a browser frontend and optional integrations for LiteLLM, AWS, OpenAI-compatible APIs, Nextcloud WebDAV, S3-compatible storage, OpenBao, Redis, OIDC, TOTP, and Cloudflare Turnstile.

Current Scope

Clinical Documentation

  • Live encounter capture with structured pediatric HPI generation.
  • Dictation cleanup for narrative notes.
  • SOAP, sick visit, well visit, hospital course, chart review, precharting, and ED encounter workflows.
  • Parent-facing education handouts generated from clinician notes, with diagnosis, medication, emergency-care guidance, and preferred-language support.
  • Pediatric developmental milestone tooling.
  • Templates, physician memory, and per-tab model overrides.
  • Server-side speech-to-text routing through configured providers.

Bedside Tools

  • Pediatric calculators and emergency dosing helpers.
  • PE guide and clinical reference content.
  • Vaccines, catch-up schedules, growth/vitals, bilirubin, BSA, GCS, equipment, and resuscitation helpers.
  • Mobile-friendly PWA layout for bedside use.
  • Per-user phone extension and pager directory with soft-delete, search, ZIP export, and JSON/ZIP import for handoff between users.

My Resources

  • Private teaching material any signed-in user can generate for themselves — nobody else sees it.
  • Presentations are designed as slide decks (comparisons, tables, callouts, figures beside text), not written as markdown for a parser to guess at.
  • Grounded in the indexed clinical library, and optionally PubMed and the web, each admin-enabled.
  • Optional illustrations, several per resource, placed through the deck.
  • Revise in place, and download as PowerPoint, Word or PDF. See docs/my-resources.md.

Clinical Assistant

  • Optional MCP-backed clinical assistant integration.
  • Prompt suggestions backed by Redis operational cache.
  • No clinical answer response caching.
  • Designed to retrieve from indexed clinical material while keeping provider selection explicit.

Admin And Security

  • One Sign In (OIDC, Authentik) is the only way in. There is no password sign-in, no registration and no password reset in the app; accounts, invitations and roles (from groups) are managed at the provider.
  • Role-based access from the provider's groups, audit trail, and optional Turnstile on the routes that still take free text.
  • Admin panel for users, settings, prompts, models, and logs.
  • Audit, API, access, and client-error logs with redaction hardening.
  • OpenBao secret loading support at container startup.
  • S3-compatible document storage support.

Removed Browser STT

Browser Whisper has been removed from the runtime. The app should not ship browser Whisper workers, browser-local Whisper model downloads, Transformers.js browser STT, or Browser Whisper setup docs.

Speech-to-text is handled server-side through configured providers such as Google/Gemini, AWS Transcribe, LiteLLM, or OpenAI Whisper. Browser-native Web Speech remains gated behind an explicit user setting when present in the browser — it is off unless a user turns it on, because Chrome and Edge send that audio to Google.

Quick Start

cp .env.example .env
./scripts/build-image.sh
docker compose up -d --no-build

The default compose exposes the app on 127.0.0.1:3552 and starts:

  • pediatric-ai-scribe for the Node app.
  • pedscribe-db for Postgres with pgvector.
  • ped-ai-redis for operational Redis state.

Health check:

curl -fsS http://127.0.0.1:3552/api/health

Prometheus metrics are exposed at GET /metrics with the ped_ai_ metric prefix.

Accounts, roles and invitations are managed in authentik (One Sign In); the app has no registration.

Core Environment

Set real values in .env before production use.

APP_URL=https://your-domain.example
JWT_SECRET=<64-char-random-secret>
DB_PASSWORD=<strong-database-password>

AI_PROVIDER=litellm
LITELLM_API_BASE=https://your-litellm.example/v1
LITELLM_API_KEY=<key>

TRANSCRIBE_PROVIDER=litellm
LITELLM_STT_MODEL=whisper-1

REDIS_URL=redis://ped-ai-redis:6379

Supported text AI providers are LiteLLM, OpenRouter, AWS Bedrock, and Azure OpenAI. Speech-to-text and text-to-speech both route through LiteLLM, so the upstream speech vendor is a gateway configuration choice rather than an app one; browser-native Web Speech stays off unless a user opts in.

Admin CLI

docker exec pediatric-ai-scribe node admin-cli.js list-users
docker exec pediatric-ai-scribe node admin-cli.js create-admin admin@example.com password123 "Dr. Admin"
docker exec pediatric-ai-scribe node admin-cli.js make-admin user@example.com
docker exec pediatric-ai-scribe node admin-cli.js stats

Maintenance

The app checks Postgres collation drift on startup and can reindex text indexes after image or OS-library changes.

docker exec pediatric-ai-scribe npm run maint:check
docker exec pediatric-ai-scribe npm run maint:reindex

Run the reindex command after major Postgres image changes, restoring a dump from another distro, or seeing lookup behavior that suggests collation/index drift.

Testing

Run the Node test suite:

npm test

Run syntax checks for touched files when doing focused backend work:

node --check server.js
node --check src/routes/transcribe.js

Run the Playwright smoke suite against the e2e compose stack:

docker compose -f docker-compose.yml -f docker-compose.e2e.yml up -d pediatric-scribe-e2e
npm run e2e

Deployment Notes

  • Put the app behind HTTPS before clinical use.
  • Use only AI/STT/TTS providers covered by your BAA and data-processing requirements.
  • Configure OIDC/SSO and 2FA for production users.
  • Keep JWT_SECRET, database credentials, provider keys, S3 keys, SMTP credentials, and OpenBao tokens out of git.
  • Treat logs as sensitive operational data even with redaction enabled.
  • Use the Caddy/reverse-proxy layer to expose only intended public routes.

Documentation

Primary references:

  • docs/architecture.md — system map, repository layout, request pipeline, and service boundaries.
  • docs/developer-guide.md — day-to-day code-change workflow, route and module reference.
  • docs/module-conventions.md — CommonJS, ESM, globals, and rendering rules.
  • docs/features-explained.md — what each feature is, in plain terms.
  • docs/api-reference.md — API routes.
  • docs/configuration.md — environment variables and live app_settings.
  • docs/database.md — every table, its columns, and what is encrypted.
  • docs/migrations.md — how schema changes are made and applied.
  • docs/authentication.md — SSO-only sign-in, OIDC, sessions, rate limits.
  • docs/ai-providers.md — provider selection, prompts, injection hardening.
  • docs/clinical-assistant.md — MCP-backed assistant behavior and safety rules.
  • docs/retrieval-tuning.md — how much corpus each feature retrieves, and what it costs.
  • docs/global-prompt-administration.md — prompt overrides and the conversation budget.
  • docs/speech.md — STT, TTS, recording, and audio backups.
  • docs/my-resources.md — private teaching material, the slide renderer, and search sources.
  • docs/deployment.md — production deployment.
  • docs/scaling.md — scaling priorities and readiness work.
  • docs/openid-setup.md — OIDC provider setup.
  • docs/ops-docs-ped-ai-and-milvus.md — operational notes for the retrieval stack.
  • docs/improvements.md — the running list of what to improve next.
  • docs/logic/README.md — the deeper code walkthrough.

Some deep docs/logic/ files still describe historical implementation details. Prefer runtime code and tests when documentation conflicts with current behavior.

Clinical Safety

Ped-AI is documentation and education support software. It does not replace clinical judgment, local policy, medication verification, or attending review. Validate generated notes, calculations, and recommendations before use in patient care.