Repository navigation
docs: the design of record for the server on PostgreSQL and the operator console - #56
Merged
Merged
Conversation
…tor console docs/architecture.md records the server (the process and its configuration, the PostgreSQL cross-reference store with its history and transaction boundaries, the matching in three tiers with the steward in the middle, the PIXm, PDQm and PMIR faces, the HL7 v2 listener, pseudonyms, authorization and audit), the two images released at SLSA Build Level 3, the CI lanes FerroPIX lacked, and the operator console: its information architecture, every screen with its states, the wireframes at 1440 and 390 px, and the FerroUI component inventory with the seven gaps to file on FerroUI. CLAUDE.md, the book and the memory name the console, the store and the two images as planned, by milestone.
rubentalstra
enabled auto-merge
October 21, 2026 10:33
This was referenced Oct 21, 2026
A timeline: events along a rail with actor, kind, time and a body that opens
FerroHEALTH/FerroUI#139
Closed
Closed
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed and why
The owner decided on 2026-10-21 that FerroPIX is a standalone server with its cross-reference in PostgreSQL, ships two OCI images (the server and an operator console on FerroUI, the fifth console of the family), releases both at SLSA Build Level 3 through reusable workflows, files every FerroUI gap on FerroUI, and takes identifier lookups by
POST(#52). The repository had no design of record for the server or the console.docs/architecture.md, new, in the family's architecture-document style. Every decision names a vendored section (PIXm 3.1.0, PDQm 3.2.0, PMIR 1.6.0, BALP 1.1.4, FHIR R4) or says "no specification governs this: our own design". Sections: the problem and the pins; the shape (two images, theihe-itiserver features); the process and the configuration tree (TOML,FERROPIX__overrides,_filesecrets,deny_unknown_fields); the PostgreSQL store (identifier domains with one Source each, source records with write-once versions, persons, a temporal link table, candidates with scores and evidence, reversible merges, pseudonymisation domains, the steward action trail, subscriptions), its migrations, transaction boundaries and locks; the matching in three tiers (deterministic on authoritative identifiers, Fellegi-Sunter on demographics with per-field evidence, human review between the thresholds, automatic probabilistic linking off by default); the FHIR face (ITI-83 byGETandPOST, ITI-104, ITI-78, ITI-119, ITI-93, ITI-94, with a status table per case and one policy for merged and removed identifiers); the HL7 v2 listener on FerroBRIDGE's parser, cited by transaction until the TF-2 texts are vendored; pseudonyms, the BSN and the pseudo-BSN; authorization throughferrohealth-smart, BALP throughihe-atna, the health family, a request log that never records a query string or a body, and the FerroPULSE usage report; the two images, the compose quickstart, the Helm chart after FerroEHR's, and the SLSA Build Level 3 release lanes; the five CI lanes FerroPIX lacks beside FerroFED; the console (information architecture, every workflow with its screen, states, keyboard path and phone reflow, the operator API it reads, the quality bar, ASCII wireframes at 1440 and 390 px, the FerroUI component inventory per screen, and seven gaps with their API shapes: record compare, score breakdown, timeline, masked identifier with audited reveal, keyboard shortcut legend, work-list, and the FerroPIX brand theme); the workspace layout; the build order by milestone; the decision register.CLAUDE.md: the owner's decisions in the scope, a section pointing at the design of record, the milestones v0.0.3 to v0.0.5 as the build order,docs/architecture.mdin the repo map, and the FerroUI sibling line names the decided console in place of "should FerroPIX ever get a console".docs-claims.shholds.ferroui-lockstep.mdrecords the console as decided; the index follows.CHANGELOG.md: an[Unreleased]entry.Guards run locally on the branch:
writing-style.sh(the changed files and the published prose),docs-claims.sh,ihe-citations.sh(234 citations, every one in the vendored text),versions.shandsite-links.sh, all green.Closes #55
Licensing of contributions
Checklist
CHANGELOG.mdhas an[Unreleased]entry.website/book/srcis updated for every user-visible change.