Skip to main content

FUME Community release notes

FUME Community is the open-source backend FUME engine. It serves the core transformation functionality through a RESTful API.

FUME Community GitHub.

v3.1.0​

Release date: Apr 26, 2026

Summary​

This release adds multi-server FHIR support to FUME Community. Mappings can now switch the active FHIR server within the current lexical scope by calling $useFhirServer(target?, config?), either against a named connection from connections.yml or an inline URL target.

Highlights​

  • Add $useFhirServer(target?, config?) for lexical-scope FHIR server switching inside mappings.
  • Add $fhirConnectionNames() to list the configured named FHIR connection names in expression code.
  • Support named alternate FHIR connections configured in connections.yml.
  • Support inline URL targets with optional authType, credentials, fhirVersion, and timeout overrides.
  • Keep terminology and conformance-oriented operations pinned to the default server so server switching only affects FHIR client operations.
  • Add pooled inline URL clients keyed by effective connection config.
  • Publish new docs for $useFhirServer, named FHIR connections, and the related runtime settings.

Breaking changes​

None known.

Ops / Deployment​

Existing single-server deployments do not need configuration changes. To use multi-server mappings, add named connections in connections.yml or call $useFhirServer() with an inline URL target. For reusable or secret-bearing connections, prefer named connections with environment variable substitution over inline credentials. Helm-based deployments can now render and mount named FHIR connections through the chart-managed Secret-backed connections.yml flow.

v3.0.6​

Release date: Mar 31, 2026

Summary​

This release fixes Swagger UI serving for packaged and bundled Community deployments, especially Node SEA builds. OpenAPI and Swagger docs can now remain available even when the application is shipped without the runtime filesystem layout expected by earlier versions.

Highlights​

  • Swagger UI assets are generated at build time and served from memory instead of from disk.
  • /api-docs routes continue to work in SEA and other bundled deployments where filesystem-based asset serving is not reliable.
  • Includes supporting dependency cleanup and a security-focused override alongside the docs fix.

Breaking changes​

None.

Ops / Deployment​

If you package FUME Community into a single executable or other bundled distribution, redeploy with this version to restore working OpenAPI and Swagger docs. Standard server deployments do not require configuration changes for this fix.

v3.0.5​

Release date: Mar 16, 2026

Summary​

This release fixes a regression affecting recursive contentReference type elements population (like Parameters.parameter.part) in v3.

Highlights​

  • Fixes incorrect contentReference element-name resolution that could leave Parameters.parameter.part silently unpopulated.
  • Includes a dependency graph refresh to keep the toolchain up-to-date.

Breaking changes​

None.

Ops / Deployment​

If your FLASH mappings may populate nested contentReference elements (like Parameters.parameter.part), this upgrade is recommended.

v3.0.4​

Release date: Mar 15, 2026

Summary​

This is a dependency-focused update with one concrete runtime resilience improvement: implicit FHIR package dependency resolution is more robust. The remaining changes are supporting toolchain refreshes aimed at overall stability.

Highlights​

  • Updates fhir-package-installer to improve resilience when resolving implicit package dependencies.
  • Refreshes related FHIR tooling dependencies to keep package exploration and snapshot generation current.

Breaking changes​

None.

Ops / Deployment​

If your deployments install FHIR packages, this release should reduce failures around implicit dependency resolution.

v3.0.3​

Release date: Mar 9, 2026

Summary​

This release is a targeted correctness fix for static JSON-backed mapping workflows. Valid edits to static JSON files now reload reliably without the stale-state behavior seen in previous v3 releases.

Highlights​

  • Fix stale static JSON reload behavior in the mapping provider.
  • Removes the old failure mode where a file could remain stale until it first passed through an invalid JSON state and then became valid again.

Breaking changes​

None.

Ops / Deployment​

None.

v3.0.2​

Release date: Mar 6, 2026

Summary​

This is a maintenance-heavy patch release, with an important internal refactor of the wat OpenAPI spec is served. The release also hardens the dependency surface and rolls in vulnerability fixes.

Highlights​

  • Build and test flows now regenerate the OpenAPI spec from the authored YAML source, reducing drift between source docs and /api-docs/swagger.json.
  • Dependency updates address reported npm vulnerabilities and refresh key package dependencies.
  • Supporting FHIR tooling dependencies moved forward together to keep snapshot and terminology flows current.

Breaking changes​

None.

Ops / Deployment​

Upgrade to this release to resolve all known vulnerabilities.

v3.0.1​

Release date: Feb 18, 2026

Summary​

This release adds first-class OpenAPI and Swagger documentation to FUME Community.

Highlights​

  • Community servers now expose an OpenAPI spec as part of the standard HTTP surface (/api-docs, /api-docs/swagger.json).

Breaking changes​

None.

Ops / Deployment​

Upgrade to this release if you want your FUME server to expose the OpenAPI spec HTTP routes.

v3.0.0​

Release date: Feb 17, 2026

Summary​

FUME Community v3.0.0 is a major release focused on correctness, diagnostics, and runtime scalability.

Most users running the standalone HTTP server will see the same core workflow (evaluate ad‑hoc mappings at POST /, or run saved mappings under /Mapping/*) — but with significantly improved conformance/validation behavior, more controllable diagnostics, and better production ergonomics.

If you embed FUME as a Node library, this release is a bigger change: the runtime is now explicitly modeled around FumeEngine (and FumeServer for HTTP) instead of singleton-style globals.

Key practical impact:

  • Output is more consistently FHIR‑conformant (automatic conformance like injected system/display and deeper validations).
  • Failures are easier to debug (position pointers + verbose evaluation report + tunable thresholds).
  • Running at scale is easier (caching/concurrency improvements and file‑based mappings).

Highlights​

  • Better correctness by default
    • Improved automatic conformance (injecting code system/display where appropriate).
    • Deeper structural + terminology validations, with evaluation policy thresholds you can tune.
  • Better diagnostics & debugging
    • verbose mode returns a full evaluation report (result + structured diagnostics + executionId).
    • More accurate position pointers in errors.
  • Operational scalability
    • Improved caching/concurrency behavior and an in‑memory compiled-expression LRU.
    • File-based mappings (*.fume) alongside FHIR-server-hosted mappings.
  • HTTP server ergonomics
    • Documented /health probe endpoint and built-in OpenAPI + Swagger UI.
    • Safer request metadata: $fumeHttpInvocation.headers is sanitized to reduce secret leakage.

Breaking changes​

This is a major version release.

For library users (Node embedding)​

  • The public programming model is now class-based:
    • Old: singleton helpers / global state (config, logger, transform, etc.)
    • New: create a FumeEngine and call engine.transform(...) (or transformVerbose(...)).
  • When embedding as a library, FUME intentionally does not read process.env / .env automatically; pass config explicitly.
  • Package/build outputs were modernized (including dual CJS/ESM exports). If you have custom bundling, validate imports.

For HTTP server users (integrations)​

  • If you had automation hitting recache via GET /recache, it now returns 405. Use POST /$recache.
  • POST /recache remains available but is deprecated (it emits a warning and will be removed in a future release).
  • If neither FHIR_SERVER_BASE nor MAPPINGS_FOLDER is configured, /Mapping/* endpoints are intentionally disabled and return 405 (ad‑hoc POST / remains available).

Ops / Deployment​

  • Review Community environment variables (many knobs moved from “implicit behavior” to explicit config):
    • FHIR package registry + caching: FHIR_PACKAGE_REGISTRY_URL, FHIR_PACKAGE_REGISTRY_TOKEN, FHIR_PACKAGE_CACHE_DIR.
    • File-based mappings + polling: MAPPINGS_FOLDER, MAPPINGS_FILE_EXTENSION, MAPPINGS_FILE_POLLING_INTERVAL_MS, MAPPINGS_SERVER_POLLING_INTERVAL_MS.
    • Request sizing: FUME_REQUEST_BODY_LIMIT.
    • Evaluation policy thresholds: FUME_EVAL_THROW_LEVEL, FUME_EVAL_LOG_LEVEL, FUME_EVAL_DIAG_COLLECT_LEVEL, FUME_EVAL_VALIDATION_LEVEL.
  • For production probing, prefer GET /health.
  • For debugging/triage, use ?verbose=true on evaluation endpoints. Note: verbose mode changes the response shape (it returns a report object containing result and diagnostics).
  • If you expose saved mappings as endpoints, be aware $fumeHttpInvocation.headers is sanitized (common secret-bearing headers are redacted).

v2.20.6​

Release date: Nov 10, 2025

Summary​

This release is a small dependency-focused update. It bumps Express to address a url.parse() deprecation warning in Node.js.

Highlights​

  • Bump express to avoid url.parse() warning.
  • Release housekeeping updates to lockfiles.

Breaking changes​

None known.

Ops / Deployment​

If you have custom Express middleware or integrations, validate behavior after the Express major-version upgrade.

v2.20.5​

Release date: Nov 9, 2025

Summary​

This release is a maintenance update around FHIR package installation and cache-path handling. It updates a couple of dependencies and improves resilience when package installation encounters errors.

Highlights​

  • Update fhir-package-installer and axios dependencies.
  • Improve cache-path comparisons by normalizing paths before comparison.
  • Handle dependency installation errors without interrupting the overall process.

Breaking changes​

None.

Ops / Deployment​

None.

v2.20.4​

Release date: Nov 2, 2025

Summary​

This release refreshes a large set of dependencies and improves how FHIR packages are installed, cached, and indexed. It also updates test infrastructure to better cover enterprise-like setups (custom registries/caches).

Highlights​

  • Refresh a wide set of runtime and dev dependencies (including updates to fhir-package-installer).
  • Improve FHIR package caching and index synchronization behavior.
  • Add/extend test coverage for custom registries and custom cache directories (including JFrog Artifactory scenarios).
  • Update environment variable examples to include FHIR_PACKAGE_CACHE_DIR (in the stateful/stateless env example files for this release line).

Breaking changes​

None.

Ops / Deployment​

  • If you use a custom on-disk FHIR package cache, review the FHIR_PACKAGE_CACHE_DIR guidance in the env examples.

v2.20.3​

Release date: Oct 29, 2025

Summary​

This release focuses on release automation rather than runtime behavior. It fixes the Docker publish workflow so published images are tagged with the correct version.

Highlights​

  • Fix Docker publish workflow to apply the correct version tag.
  • Keep runtime dependencies unchanged (release bookkeeping only).
  • Improve consistency between git tags and published Docker tags.

Breaking changes​

None.

Ops / Deployment​

If you deploy via Docker images, verify your automation expects the corrected tag format.

v2.19.1​

Release date: Aug 24, 2025

Summary​

Bug fix release focused on making package acquisition more robust: handles download/index problems more gracefully and avoids registry lookups by pinning a fixed package version.

Highlights​

  • Package download is handled gracefully on errors (8022858).
  • Empty/invalid package index files are tolerated (e86f1c6).
  • Uses a fixed fume package version to avoid registry lookups (0f37c13).
  • See the v2.19.1 GitHub release for the generated changelog.

Breaking changes​

None.

Ops / Deployment​

None.

v2.18.6​

Release date: Jul 20, 2025

Summary​

Bug fix release: increases request body size limits in the server constructor to better handle larger payloads.

Highlights​

Breaking changes​

None.

Ops / Deployment​

None.

v2.18.2​

Release date: Dec 25, 2024

Summary​

Fixes Issue #100: the $transpile operation now accepts a Content-Type header that includes a charset parameter (for example, application/vnd.outburn.fume; charset=utf-8).

Highlights​

  • Fixed $transpile rejecting Content-Type values with a charset parameter (Issue #100).

Breaking changes​

None.

Ops / Deployment​

None.

v2.17.1​

Release date: Dec 19, 2024

Latest

Bug Fixes

  • Support UTF-8 characters outside of the Latin range in $base64endoce, $base64decode
  • Use context value as first argument (if missing) in $startsWith() and $endsWith()

v2.17.0​

Release date: Dec 9, 2024

Features

  • Snapshot genrating function is now independent from server config & state, so it can be called as a standalone function without spawning the FUME server
  • Module now exports the FHIR Package Index, so it can be accessed externally

v2.16.2​

Release date: Dec 8, 2024

Bug Fixes

v2.16.1​

Release date: Dec 7, 2024

Improvements

  • Improved package indexing performance
  • Improved warmup time

Bug Fixes

v2.16.0​

Release date: Dec 6, 2024

Features

  • Upgrade NPM dependencies
  • Brand new FHIR package installer (replaces the FHIR Package Loader NPM module from HL7)
  • Global package index now resides in the current working folder, allowing for different FUME instances to have different packages loaded
  • The FUME Artifacts FHIR package is now installed automatically

Bug Fixes

  • Revert husky checking out all changes during in precommit (relevent for developers)

Reverts

  • EXCLUDE_FHIR_PACKAGES env parameter is cancelled (and ignored)

v2.15.5​

Release date: Dec 2, 2024

Bug Fixes

v2.15.4​

Release date: Dec 1, 2024

Bug Fixes

v2.15.3​

Release date: Dec 1, 2024

Bug Fixes

v2.15.2​

Release date: Nov 27, 2024

Bug Fixes

  • Correct element name for choice elements with a fixed value in the profile

v2.15.1​

Release date: Sep 22, 2024

Bug Fixes

  • Removed old "Parse to JSONATA" timing messages from log

v2.15.0​

Release date: Sep 8, 2024

Features

  • Added $wait(milliseconds) function
  • Docker deployment option

v2.14.0​

Release date: Aug 22, 2024

Features

  • Add line numbers to JSON representation of HL7v2 messages

v2.13.0​

Release date: Aug 22, 2024

Features

  • Support unknown HL7 v2 fields

v2.12.0​

Release date: Aug 17, 2024

Features

  • Allow external API middleware registration
  • Upgrade axios package to version 1.7.4 (security related patch)

v2.11.4​

Release date: Jul 17, 2024

Features

  • Include display element in $translateCoding() function’s results

v2.11.3​

Release date: Jul 15, 2024

Features

  • Better handling of namespaced XML inputs

v2.11.2​

Release date: Jul 15, 2024

Features

  • Upgrade NPM dependency packages

v2.11.1​

Release date: Jul 15, 2024

Bug Fixes

  • Support XML Content-Type in Mapping API endpoint

v2.11.0​

Release date: Jul 13, 2024

Features

  • Added support for XML inputs

v2.10.4​

Release date: Jul 2, 2024

Bug Fixes

  • Consistent handling for different profiling conventions on choice elements

v2.10.3​

Release date: Jun 29, 2024

Bug Fixes

  • Fixed false warnings about incomplete snapshot generation

v2.10.2​

Release date: Jun 28, 2024

Bug Fixes

  • Properly handle #contentReference as recursive BackboneElements

v2.10.1​

Release date: Jun 5, 2024

Bug Fixes

  • Gracefully handle not found StructureDefinition files

v2.10.0​

Release date: Jun 5, 2024

Features

  • Use storage to cache generated profile snapshots

v2.9.1​

Release date: Jun 4, 2024

Bug Fixes

  • Fixed issues with terminology validation

v2.9.0​

Release date: Jun 4, 2024

Features

  • Added CodeSystem and ValueSet processing functions
  • Validate required codes during FLASH transformation

v2.8.1​

Release date: Jun 1, 2024

Bug Fixes

  • Ignore rules with literally undefined values

v2.8.0​

Release date: Jun 1, 2024

Reverts

  • Revert some cardinality validation checks due to unhandled edge cases

v2.7.1​

Release date: May 31, 2024

Bug Fixes

  • Throw parsing error when a comment is left unclosed

v2.7.0​

Release date: May 30, 2024

Bug Fixes

  • Fix result finalization issues

v2.6.0​

Release date: May 30, 2024

Bug Fixes

  • Fix unwanted commenting of explicit URL’s in mappings

v2.5.0​

Release date: May 29, 2024

Features

  • New $transpile operation returns a mapping transpiled to JSONata

v2.4.0​

Release date: May 28, 2024

Features

  • Added support for single-line comments (//)

v2.3.0​

Release date: May 26, 2024

Features

  • Consider empty strings as empty values

v2.2.0​

Release date: May 26, 2024

Features

  • Major upgrade of NPM dependecies

v2.1.2​

Release date: Apr 17, 2024

Features

  • Support bundling into single executable by replacing .json file read mechanism

v2.1.1​

Release date: Apr 14, 2024

Bug Fixes

  • Fix incorrect logging of search result page size

v2.1.0​

Release date: Apr 14, 2024

Features

  • Added project contribution guide
  • Added new $capabilities() function

v2.0.12​

Release date: Mar 17, 2024

Features

  • Dev and Build configuration updates

v2.0.11​

Release date: Mar 13, 2024

Features

  • Internal function rewrite for performance improvement

v2.0.10​

Release date: Mar 6, 2024

Bug Fixes

  • Fixed issues with utilization of custom configurations

v2.0.9​

Release date: Mar 4, 2024

Features

  • Upgrade NPM dependency packages
  • Code refactoring

v2.0.8​

Release date: Mar 3, 2024

Features

  • Upgrade Node.js version to 20

Bug Fixes

  • Graceful handling of API requests for unfound mappings

v2.0.7​

Release date: Mar 3, 2024

Features

  • Dev and Build configuration updates

v2.0.6​

Release date: Mar 3, 2024

Bug Fixes

  • Fixed issues during application build

v2.0.5​

Release date: Mar 3, 2024

Features

  • Fixed bug with alias resource fetching
  • Add function getAliasResource to exported utils

v2.0.4​

Release date: Mar 3, 2024

Bug Fixes

  • Fixed bug with alias resource fetching

v2.0.3​

Release date: Mar 3, 2024

Bug Fixes

  • Cleanup of useless cached data

v2.0.2​

Release date: Mar 2, 2024

Bug Fixes

  • Fixed external API routes improperly registered

v2.0.1​

Release date: Feb 26, 2024

Bug Fixes

  • Fixed broken Mapping API route
  • Fixed logging issues

v2.0.0​

Release date: Feb 26, 2024

Features

  • Major code refactoring
  • Allow overriding logger with external logging function
  • Allow external RESTful API route registration
  • Allow external caching functions
  • Automatic loading of ConceptMap resources without prior registration
  • Allow external binding of functions
  • Brand new FHIR package loading mechanism
    • Recursively load entire dependency tree
    • Support exclusion of specific FHIR packages from machine FHIR cache
    • Improved package indexing and caching
  • More TypeScript coverage
  • Support FHIR server basic authorization
  • Expose internal utility functions for use by external modules
  • Allow overriding the FHIR client with an external one
  • Brand new profile snapshot generator
  • Load latest version of FHIR package when no version number is provided
  • Support setting a datatype profile using the slice syntax (element[profile])
  • Support the use of out-of-profile extensions using the slice syntax
  • Recursive loading of FHIR package dependency tree
  • Enforce minimum and maximum cardinalities
  • Automatic conversion of dateTime values when assigned into date elements
  • Improved error messages for profile validation exceptions
  • Support FHIR server basic authorization
  • Boost performance of element definition fetching
  • Dependency tree cleanup
  • Performance tuning & memory cleanup
  • Automatically set datatype of choice elements if profiled down to one type

Bug Fixes

  • Retry downloading FHIR packages on temporary unavailability of registry
  • Correct handling of complex extension structures
  • Fixed parsing of numeric values as strings
  • Removed internal leftover attributes from results
  • Prevent multiple datatype choices in polymorphic elements ([x])
  • Prevent stringification of arrays assigned into single elements
  • Fixed missing Boolean 'false' values in results
  • Fixed Bundle parsing error
  • Don’t crash if internet access is blocked when attempting to download packages
  • Fix object keys generated from array index numbers
  • Choice elements with fixed values having wrong element names and types

Reverts

  • Deprecated the $registerTable() function

v1.0.0​

Release date: Jun 4, 2023 (Initial release)

Features

  • Transformation invocation through RESTful API
  • Mapping retrieval from StructureMap resources stored on a FHIR server
  • FLASH mapping language interpreter
  • Supports JSON, CSV and HL7v2 input formats