fhirsmith 0.18.2 → 1.0.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025-2026, Health Intersections Pty Ltd and the FHIRsmith contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -32,12 +32,19 @@ These are not being actively developed at present.
 ## Planned
 
 * R4/R6 interconverter
+* Full RESTful server implementation
+
+## Open Areas of Work 
+
+* How to handle expansions and validations of some kinds of invalid value sets 
+* more efficient CodeSystem implementations 
+* more work on internationalization of IPS documents and the IPS repository generally
 
 ## Summary Statement
 
 * Maintainers: Grahame Grieve, Italo Macêdo, Josh Mandel, Jose Costa Teixeira
 * Issues / Discussion: Use github issues
-* License: BSD-3
+* License: BSD-3-Clause (see [LICENSE](LICENSE))
 * Contribution Policy: Make PRs. PRs have to pass all the tests
 * Security Information: See [security.md](security.md)
 
@@ -51,23 +58,25 @@ in-build support for SSL, rate limiting etc. See [nginx.md](nginx.md) for how to
 
 ## Quick Start
 
-There are 4 executable programs:
+There are 5 executable programs:
 * the server (`node server`)
+* the cluster server (`node cluster`) - for high performance uses (see [cluster.md](cluster.md))
 * the terminology importer (`node --max-old-space-size=8192 tx/importers/tx-import XXX`) - see [Doco](tx/importers/readme.md)
 * the test cases (`npm test`)
 * the test cases generater (`node tx/tests/testcases-generator.js`)
 
-Unless you're developing, you only need the first two
+Unless you're developing, you only need the first three
 
 FHIRsmith is open source - see below, and you're welcome to use it for any kind of use. Note,
-though, that if you support FHIRsmith commercially as part of a managed service or product, you
-are required to be a Commercial Partner of HL7 - see (link to be provided).
+though, that if you support FHIRsmith commercially as part of a managed service or product, 
+and you seek support for your implementation from the project team, you are required to be a
+Commercial Partner of HL7 - consult [The FHIR Product Director](mailto:fhir-director@hl7.org).
 
 ### Quick Start
 
 * Install FHIRSmith (using docker, or an NPM release, or just get the code by git)
 * Figure out the data directory
-* Provide a configuration to tell the server what to run (see documentation below, or use a [prebuilt configuration]/configurations/readme.md)
+* Provide a configuration to tell the server what to run (see [CONFIGURATION.md](CONFIGURATION.md), or use a [prebuilt configuration](configurations/readme.md))
 * Run the server
 
 For further details of these steps, read on
@@ -116,115 +125,17 @@ npm install
 mkdir -p data data/logs
 
 # Copy example configuration
-cp config.example.json data/config.json
+cp config-template.json data/config.json
 
-# Edit configuration as needed
+# Edit configuration: every module is off until you set "enabled": true (comments are allowed)
 nano data/config.json
 ```
 
-Each Module has it's own entry in the config, as described by the module
-
-### Basic Configuration
-
-Create a `config.json` file in your data directory (use `config-template.json` as a starting point):
-
-```json
-{
-  "hostName" : "[descriptive name for the server]",
-  "server": {
-    "port": 3000,
-    "cors": {
-      "origin": "*",
-      "credentials": true
-    }
-  },
-  "modules": {
-    // per modules...
-  }
-}
-```
-
-### Logging Configuration
-
-Add a `logging` section to `config.json` to control log behaviour. All fields are optional and have sensible defaults:
-
-```json
-{
-  "logging": {
-    "level": "info",
-    "console": true,
-    "consoleErrors": false,
-    "maxFiles": 14,
-    "maxSize": "50m",
-    "flushInterval": 2000,
-    "flushSize": 200
-  }
-}
-```
-
-| Option | Default | Description |
-|---|---|---|
-| `level` | `"info"` | Minimum level to log: `error`, `warn`, `info`, `debug`, or `verbose` |
-| `console` | `true` | Write log lines to stdout/stderr. Disable when running as a systemd service where console output goes to the journal and is redundant |
-| `consoleErrors` | `false` | Whether `error` and `warn` levels appear on the console. When `false`, errors and warnings are written to the log file only |
-| `maxFiles` | `14` | Number of daily log files to retain before old ones are deleted |
-| `maxSize` | `0` (unlimited) | Maximum size per log file before rotation. Accepts human-readable strings: `"20m"`, `"1g"`, or a raw byte count |
-| `flushInterval` | `2000` | Milliseconds between buffered writes to disk. Increase to reduce I/O under heavy load |
-| `flushSize` | `200` | Number of buffered log lines that trigger an immediate flush regardless of the timer |
-
-Log files are written to the `logs/` subdirectory of the data directory as `server-YYYY-MM-DD.log`. A `server.log` symlink always points to the current day's file, so `tail -f data/logs/server.log` tracks the active log without needing to know the date.
-
-### Email and the Daily Report
-
-The server can email a short markdown report on itself once a day. It needs two things in
-`config.json`: an SMTP server to send through, and someone to send to:
-
-```json
-{
-  "email": {
-    "host": "smtp.example.org",
-    "port": 587,
-    "user": "fhirsmith",
-    "password": "...",
-    "from": "FHIRsmith <fhirsmith@example.org>"
-  },
-  "dailyReport": {
-    "to": ["ops@example.org"]
-  }
-}
-```
+### Configuration
 
-`user`/`password` are optional (an open relay); `secure` defaults to true for port 465 and
-to STARTTLS otherwise. Without an `email` block nothing is emailed, and without
-`dailyReport.to` there's no report (`dailyReport.enabled: false` turns it off explicitly).
-
-The report, titled "`{hostName}` daily report", goes out at midnight (the server's local
-time), or as soon as the server is up again if it was down at midnight. It has a paragraph
-on the server's stability since the last report - how much of the time it was up, restarts,
-the longest outage, and any upgrade (from the run history in the statistics database, so
-`stats.enabled: false` leaves the uptime unknown); a paragraph from each running module that
-has something to report (by default, none do); and a paragraph on the system - version,
-Node.js and OS, how long this run has been up, the log files and the free disk space they're
-drawing on, plus anything the npm audit check has found (packages with known vulnerabilities and
-what to do about them, or a newer FHIRsmith release). If any background task's last run failed, a
-final section lists them. When the last report was sent is kept in `daily-report.json` in the data
-directory.
-
-A module takes part by implementing `dailyReport({since, now})`, returning its paragraph as
-markdown (or a promise of it); an empty return means it has nothing to say that day. The
-request counts a module quotes come from `stats.countsSince(since, now)`, the per-operation
-counts in the statistics database for the period. The modules that report:
-
-| Module | Reports |
-|---|---|
-| Terminology server | how many of each operation were performed, over all its endpoints |
-| Terminology server registry | client requests answered by the API, servers registered, and any server that answered none of the registry's scans in the period |
-| Packages | packages served (tarball downloads) and new package versions found by the crawler |
-| XIG | pages served, and whether the database could be accessed (and whether the last download failed) |
-| Testing | pages served, test reports received, and the number held |
-| SMART Health Links | QR codes created (SMART Health Links and Verifiable Health Links), link accesses, and the documents stored to serve them |
-| IPS | pages served, IPS documents received, and the number stored |
-| Publisher | publication runs started, and how many finished successfully |
+The server reads `config.json` from the data directory. See [CONFIGURATION.md](CONFIGURATION.md)
+for the server settings (port, body size, logging, email and the daily report), the environment
+variables, and where each module's own settings are documented.
 
 ### Start the Server
 
@@ -237,9 +148,10 @@ npm start
 ```
 
 The server will be available at `http://localhost:{port}` using the port specified in the config.
-In the production servers listed above, the server always sits behind an NGINX server which manages
+In the production servers listed above, the server should always sit behind an NGINX server which manages
 SSL, security, rate limiting etc. See [nginx.md](nginx.md) for configuration advice, including
-running several servers behind one front door.
+running several servers behind one front door. To use more than one CPU core for terminology on
+one machine, see [cluster.md](cluster.md): a master and several tx workers, behind nginx.
 
 ## Testing
 
@@ -274,6 +186,9 @@ Or run it inline:
 FHIRSMITH_DATA_DIR=/var/lib/fhirsmith fhirsmith
 ```
 
+For cluster mode (a master and tx-workers - see [cluster.md](cluster.md)), run `fhirsmith-cluster`
+instead of `fhirsmith`.
+
 ### Changing the Node.js version
 
 Some of FHIRsmith's dependencies (the SQLite drivers) are native modules, built for the
@@ -309,14 +224,6 @@ Available tags:
 - `vX.Y.Z`: Specific version (e.g., `v1.0.0`)
 - `cibuild`: Latest build from the main branch
 
-### Environment Variables
-
-| Variable | Description | Default |
-|---|---|---|
-| `FHIRSMITH_DATA_DIR` | Path to the data directory | `./data` |
-| `PORT` | Server port (overrides config) | from config.json |
-| `NODE_ENV` | Node environment | `production` |
-
 ### Windows Installation
 
 You can install as a windows service using [windows-install.js](utilities/windows-install.js). You might need to
@@ -420,7 +327,7 @@ or do it via a PR
    ./release.sh X.Y.Z
 ```
 
-   `gr.sh` checks that the release is ready - on `main` and pushed, the three versions in
+   `release.sh` checks that the release is ready - on `main` and pushed, the three versions in
    `package.json` and `package-lock.json` match, `CHANGELOG.md` has a dated section with the
    conformance statement, and `test-cases-report.json` passed, is from this version and is
    newer than the last code change - then submits the report to
@@ -448,7 +355,7 @@ or do it via a PR
 
 ## License
 
-[BSD-3](https://opensource.org/license/bsd-3-clause)
+[BSD-3-Clause](LICENSE) - see also [opensource.org](https://opensource.org/license/bsd-3-clause)
 
 ## Contributing