-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocuments.html
More file actions
207 lines (198 loc) · 15.8 KB
/
Copy pathdocuments.html
File metadata and controls
207 lines (198 loc) · 15.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Documents — guides & references (PDF) | MessageFoundry</title>
<meta name="description" content="MessageFoundry guides and references as downloadable PDFs — orientation, install, deploy, operations, security and compliance — plus the Standards.">
<link rel="canonical" href="https://messagefoundry.org/documents.html">
<link rel="icon" href="/assets/img/favicon.svg" type="image/svg+xml">
<meta name="theme-color" content="#0b1220">
<meta property="og:type" content="website">
<meta property="og:site_name" content="MessageFoundry">
<meta property="og:title" content="Documents — MessageFoundry">
<meta property="og:description" content="Guides and references as downloadable PDFs — orientation, deploy, operate, security, and compliance.">
<meta property="og:url" content="https://messagefoundry.org/documents.html">
<meta property="og:image" content="https://messagefoundry.org/assets/img/og.png">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<meta property="og:image:type" content="image/png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://messagefoundry.org/assets/img/og.png">
<link rel="stylesheet" href="/assets/css/styles.css">
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "SoftwareApplication",
"@id": "https://messagefoundry.org/#software",
"name": "MessageFoundry",
"applicationCategory": "Healthcare interface engine",
"applicationSubCategory": "HL7 interface engine",
"operatingSystem": "Windows, Linux, macOS",
"url": "https://messagefoundry.org/",
"downloadUrl": "https://pypi.org/project/messagefoundry/",
"license": "https://www.gnu.org/licenses/agpl-3.0.html",
"isAccessibleForFree": true,
"offers": { "@type": "Offer", "price": "0", "priceCurrency": "USD" },
"publisher": { "@id": "https://messagefoundry.org/#org" }
}
</script>
</head>
<body>
<a class="skip-link" href="#main">Skip to content</a>
<div class="eabar" role="region" aria-label="Project status">
<div class="container">
<p><strong>Early Access · beta.</strong> We're building toward 1.0 — and we want people involved now, while it can still be shaped. <a href="/status.html">Where the project stands →</a></p>
</div>
</div>
<header class="site-header">
<div class="container header-inner">
<a class="brand" href="/" aria-label="MessageFoundry home">
<img class="brand-mark" src="/assets/img/logo.svg" alt="" width="28" height="28">
<span class="brand-name">Message<span class="brand-accent">Foundry</span><span class="brand-tm">™</span></span>
</a>
<button class="nav-toggle" aria-expanded="false" aria-controls="site-nav" aria-label="Toggle navigation"><span></span><span></span><span></span></button>
<nav class="site-nav" id="site-nav">
<div class="nav-group">
<button type="button" class="nav-group__btn" aria-expanded="false" aria-haspopup="true" aria-controls="nav-product">Product</button>
<div class="nav-group__menu" id="nav-product">
<a href="/overview.html">Overview</a>
<a href="/features.html">Features</a>
<a href="/features-table.html">Feature list</a>
<a href="/architecture.html">Architecture</a>
<a href="/reliability.html">Reliability (CI)</a>
<a href="/tools.html">Tools</a>
<a href="/editor.html">Editor</a>
<a href="/console.html">Console</a>
<a href="/ai.html">AI assist</a>
</div>
</div>
<a href="/security.html">Security</a>
<a href="/comparison.html">Comparison</a>
<div class="nav-group">
<button type="button" class="nav-group__btn" aria-expanded="false" aria-haspopup="true" aria-controls="nav-getstarted">Get started</button>
<div class="nav-group__menu" id="nav-getstarted">
<a href="/getting-started.html">Quickstart</a>
<a href="/guides/">Guides</a>
<a href="/documents.html" class="active" aria-current="page">Documents</a>
</div>
</div>
<div class="nav-group">
<button type="button" class="nav-group__btn" aria-expanded="false" aria-haspopup="true" aria-controls="nav-company">About Us</button>
<div class="nav-group__menu" id="nav-company">
<a href="/about.html">About</a>
<a href="/status.html">Project status</a>
<a href="/licensing.html">Licensing</a>
<a href="/contact.html">Contact</a>
<a href="/sponsor.html">Sponsor</a>
</div>
</div>
<a class="btn btn-ghost" href="/pypi.html">PyPI<svg width="15" height="15" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M12 3l8 4.5l0 9l-8 4.5l-8 -4.5l0 -9l8 -4.5"/><path d="M12 12l8 -4.5"/><path d="M12 12l0 9"/><path d="M12 12l-8 -4.5"/><path d="M16 5.25l-8 4.5"/></svg></a>
<a class="btn btn-ghost" href="https://github.com/MEFORORG/MessageFoundry" target="_blank" rel="noopener">GitHub ↗</a>
</nav>
</div>
</header>
<main id="main">
<section class="section section--dark section--tight">
<div class="container center">
<span class="eyebrow">Documentation</span>
<h1 style="max-width:22ch;margin-inline:auto">Guides & references</h1>
<p class="lead">Everything as downloadable PDFs — orientation, install & deploy, operations, security, and compliance. The full source also lives in the <a href="https://github.com/MEFORORG/MessageFoundry">repository</a>.</p>
</div>
</section>
<section class="section">
<div class="container" style="max-width:860px">
<div class="table-wrap" style="margin-top:6px">
<table class="cmp feat">
<thead><tr><th scope="col">Document</th><th scope="col">What's in it</th></tr></thead>
<tbody>
<tr class="grp"><th colspan="2" scope="colgroup">Start here</th></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-User-Guide.pdf" target="_blank" rel="noopener">User guide</a> <span class="pdf-tag">PDF</span></th><td>Task-oriented walkthrough — from a clean machine to authoring Connections, Routers, and Handlers, then operating and monitoring the engine.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Mental-Model.pdf" target="_blank" rel="noopener">Mental model</a> <span class="pdf-tag">PDF</span></th><td>The big-picture orientation: the four building blocks, how a message flows, and the invariants that keep nothing lost.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Install-Guide.pdf" target="_blank" rel="noopener">Installation guide</a> <span class="pdf-tag">PDF</span></th><td>Install the pinned engine and stand up your own private config repo — one repo driving Test, Production, and more.</td></tr>
<tr class="grp"><th colspan="2" scope="colgroup">Install & deploy</th></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Deployment-Guide.pdf" target="_blank" rel="noopener">Deployment & network exposure</a> <span class="pdf-tag">PDF</span></th><td>How every channel binds, whether it carries TLS, and how it's authenticated before you expose it off loopback.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Configuration.pdf" target="_blank" rel="noopener">Configuration & settings</a> <span class="pdf-tag">PDF</span></th><td>Every setting the engine reads — the config file and environment overrides, and what each option controls.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-System-Requirements.pdf" target="_blank" rel="noopener">System requirements & sizing</a> <span class="pdf-tag">PDF</span></th><td>Hardware, OS, runtime, database, and volume-based sizing guidance for running the engine.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Windows-Service.pdf" target="_blank" rel="noopener">Windows service</a> <span class="pdf-tag">PDF</span></th><td>Run the engine as a long-lived Windows service with NSSM: boot-start, crash-restart, graceful drain, hardening.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Remote-Console-Customer-Guide.pdf" target="_blank" rel="noopener">Remote console — customer setup</a> <span class="pdf-tag">PDF</span></th><td>An IT-admin guide to running the console from staff PCs: give the engine a TLS certificate, open it to the network securely, and connect each console — with optional mutual TLS.</td></tr>
<tr class="grp"><th colspan="2" scope="colgroup">Adopt & operate</th></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-HA-Reference-Architecture.pdf" target="_blank" rel="noopener">HA reference architecture</a> <span class="pdf-tag">PDF</span></th><td>Active/passive HA via an app-level leader lease in the shared SQL store — no WSFC or AD — plus an operator VIP.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Clustering.pdf" target="_blank" rel="noopener">Clustering (active-passive HA)</a> <span class="pdf-tag">PDF</span></th><td>Running MessageFoundry as an active-passive cluster — leader election, failover behavior, and operating the pair.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Adoption-Guide.pdf" target="_blank" rel="noopener">Adoption & rollout guide</a> <span class="pdf-tag">PDF</span></th><td>A practical playbook from first install to full production, with staged go/no-go gates.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Migration-Guide.pdf" target="_blank" rel="noopener">Migrating from a legacy engine (Corepoint, Rhapsody, Mirth, etc.)</a> <span class="pdf-tag">PDF</span></th><td>A vendor-fair playbook for moving interfaces to MessageFoundry: inventory, map, validate, cut over with rollback.</td></tr>
<tr class="grp"><th colspan="2" scope="colgroup">Concepts & reference</th></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Architecture.pdf" target="_blank" rel="noopener">Architecture overview</a> <span class="pdf-tag">PDF</span></th><td>A modular, contract-bounded engine with a durable store-as-queue pipeline so no message is lost.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Throughput-and-Capacity.pdf" target="_blank" rel="noopener">Throughput & capacity</a> <span class="pdf-tag">PDF</span></th><td>What we measured to establish 40 million message events a day, what was <em>not</em> saturated at that ceiling, and how to size against your own partners' acknowledgement times.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-HL7-Validation.pdf" target="_blank" rel="noopener">HL7 validation</a> <span class="pdf-tag">PDF</span></th><td>Three composable tiers — tolerant peek, strict structural, and cross-field business consistency.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-CI-Quality.pdf" target="_blank" rel="noopener">Automated testing & quality</a> <span class="pdf-tag">PDF</span></th><td>How thousands of automated tests run on every change to keep the engine reliable.</td></tr>
<tr class="grp" id="security"><th colspan="2" scope="colgroup">Security & compliance</th></tr>
<tr><th scope="row"><a href="/assets/MessageFoundry-Secure-Development-Standards.pdf" target="_blank" rel="noopener">Secure Development Standards</a> <span class="pdf-tag">PDF</span></th><td>The foundation — the full NIST SSDF / 800-115 / 800-66 mapping and the OWASP ASVS 5.0 Level 3 self-assessment across all 345 requirements.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Security-Overview.pdf" target="_blank" rel="noopener">Security overview</a> <span class="pdf-tag">PDF</span></th><td>Secure-by-default controls, a secure SDLC, the per-interface threat model, and the ASVS L3 self-assessment.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-Users-and-Security.pdf" target="_blank" rel="noopener">Users & security</a> <span class="pdf-tag">PDF</span></th><td>How every operator is authenticated and authorized — local accounts, MFA, Active Directory, RBAC, and audit.</td></tr>
<tr><th scope="row"><a href="/assets/docs/MessageFoundry-ASVS-HIPAA-Penalty.pdf" target="_blank" rel="noopener">App security & HIPAA penalties</a> <span class="pdf-tag">PDF</span></th><td>How application-security verification (OWASP ASVS) shapes HIPAA breach-penalty tier exposure.</td></tr>
</tbody>
</table>
</div>
</div>
</section>
</main>
<footer class="site-footer">
<div class="container">
<div class="footer-grid">
<div class="footer-brand">
<a class="brand" href="/" aria-label="MessageFoundry home">
<img class="brand-mark" src="/assets/img/logo.svg" alt="" width="28" height="28">
<span class="brand-name">Message<span class="brand-accent">Foundry</span><span class="brand-tm">™</span></span>
</a>
<p class="footer-tagline"><b>More</b> Than an HL7 Interface Engine</p>
<p>Open-source healthcare interface engine — secure by default, built to recognized standards, connecting a wide range of protocols and message types.</p>
<div class="badge-row" style="margin-top:16px">
<span class="badge">Open source</span>
<span class="badge">No lock-in</span>
<span class="badge">Self-hosted</span>
</div>
</div>
<div class="footer-col">
<h4>Product</h4>
<a href="/overview.html">Overview</a>
<a href="/features.html">Features</a>
<a href="/architecture.html">Architecture</a>
<a href="/reliability.html">Reliability</a>
<a href="/dicom.html">DICOM</a>
<a href="/security.html">Security & PHI</a>
<a href="/documents.html">Documents</a>
</div>
<div class="footer-col">
<h4>Tools</h4>
<a href="/tools.html">Tools</a>
<a href="/editor.html">Editor</a>
<a href="/console.html">Console</a>
<a href="/ai.html">AI assist</a>
</div>
<div class="footer-col">
<h4>Get started</h4>
<a href="/getting-started.html">Quickstart</a>
<a href="/guides/">Guides</a>
<a href="/comparison.html">Comparison</a>
</div>
<div class="footer-col">
<h4>Project</h4>
<a href="/status.html">Project status</a>
<a href="https://github.com/MEFORORG/MessageFoundry" target="_blank" rel="noopener">GitHub</a>
<a href="https://github.com/MEFORORG/MessageFoundry/issues" target="_blank" rel="noopener">Issues</a>
<a href="/contact.html">Contact</a>
<a href="/licensing.html">License</a>
<a href="/about.html">About</a>
<a href="/sponsor.html">Sponsor</a>
</div>
</div>
<div class="footer-bottom">
<span>© 2026 MEFOR-ORG, a non-profit — this website and its content, all rights reserved. The MessageFoundry engine is separately open source, licensed under AGPL-3.0-or-later.</span>
<span>MessageFoundry and the MessageFoundry word mark are trademarks of MEFOR-ORG. Mirth Connect, Cloverleaf, Rhapsody, Corepoint, and Ensemble are trademarks of their respective owners; MessageFoundry is independent and unaffiliated.</span>
</div>
</div>
</footer>
<script src="/assets/js/nav.js" defer></script>
</body>
</html>