Amy-Term

Not signed in Sign in

Documentation

Everything needed to run, operate, federate, and validate your Amy-Term deployment.

Start here

Install, start the stack, and verify core endpoints.

Getting started ~10 minutes

Operational how-to: imports, authoring, federation, and troubleshooting.

How-to Core reference

API Docs (Swagger)

Full OpenAPI for all routes. Use for client integration and testing.

Reference /docs

Operational readiness

Versioned release notes

Change log per version with upgrade notes and compatibility.

Ops Release history

Production Readiness Statement

One-pager: architecture, controls, monitoring, and go-live checklist.

Go-live Executive summary

Federation

Capture curated artefacts and distribute to regional nodes.

Admin /federation

Federation trust model

Keys, signing policy, rotation, and verification requirements.

Security Integrity-first

Backup and recovery

Postgres backup / restore

Runbooks: backups, restore testing, retention, and disaster recovery.

Security baseline

Hardening guidance: TLS, secrets, RBAC, logs, and monitoring.

Reference Baseline

Health endpoints

Liveness checks and operational validation of dependencies.

Diagnostics /health/live

Validate core endpoints

$ curl -s http://localhost:8000/health/live
$ curl -s http://localhost:8000/health/ready
$ curl -s http://localhost:8000/metadata # FHIR capability statement (if enabled)

Security and compliance

Controller/processor roles, data categories, retention, and rights.

Compliance Public-facing

Template for deployments and audits.

Template GDPR Art. 35

Security baseline

Hardening guidance: TLS, secrets, RBAC, logs, and monitoring.

Reference Baseline

Developer shortcuts

These links are often used during integration work.

OpenAPI docs

$ start http://localhost:8000/docs
$ start http://localhost:8000/redoc

FHIR capability & terminology

$ curl -s http://localhost:8000/metadata
$ curl -s "http://localhost:8000/CodeSystem?_count=10"
$ curl -s "http://localhost:8000/ValueSet?_count=10"