About FHIRFLARE IG Toolkit

A comprehensive toolkit designed for developers and implementers working with FHIR® Implementation Guides (IGs).

Overview

The FHIRFLARE IG Toolkit is a web application built to simplify the lifecycle of managing, processing, validating, and deploying FHIR Implementation Guides. It provides a central, user-friendly interface to handle common tasks associated with FHIR IGs, streamlining workflows and improving productivity.

Whether you're downloading the latest IG versions, checking compliance, converting resources to FHIR Shorthand (FSH), or pushing guides to a test server, this toolkit aims to be an essential companion.

Core Features

  • IG Package Management: Import FHIR IG packages directly from the registry using various version formats (e.g., `1.1.0-preview`, `current`), with flexible dependency handling (Recursive, Patch Canonical, Tree Shaking). View, process, unload, or delete downloaded packages, with detection of duplicate dependencies.
  • IG Processing & Viewing: Extract and display key information from processed IGs, including defined profiles, referenced resource types, must-support elements, and examples. Visualize profile relationships like `compliesWithProfile` and `imposeProfile`.
  • FHIR Validation: Validate individual FHIR resources or entire Bundles against the profiles defined within a selected IG. Provides detailed error and warning feedback. (Note: Validation accuracy is still under development, especially for complex constraints).
  • FHIR Server Interaction:
    • Push processed IGs (including dependencies) to a target FHIR server with real-time console feedback.
    • Explore FHIR server capabilities and interact with resources using the "FHIR API Explorer" (GET/POST/PUT/DELETE) and "FHIR UI Operations" pages, supporting both the local HAPI server (in Standalone mode) and external servers.
  • FHIR Shorthand (FSH) Conversion: Convert FHIR JSON or XML resources to FSH using the integrated GoFSH tool. Offers advanced options like context package selection, various output styles, FHIR version selection, dependency loading, alias file usage, and round-trip validation ("Fishing Trip") with SUSHI. Includes a loading indicator during conversion.
  • API Support: Provides basic API endpoints for programmatic import and push operations.

Technology

The toolkit leverages a combination of technologies:

  • Backend: Python with the Flask web framework and SQLAlchemy for database interaction (SQLite).
  • Frontend: HTML, Bootstrap 5 for styling, and JavaScript for interactivity and dynamic content loading. Uses Lottie-Web for animations.
  • FHIR Tooling: Integrates GoFSH and SUSHI (via Node.js) for FSH conversion and validation. Utilizes the HAPI FHIR server (in Standalone mode) for robust FHIR validation and operations.
  • Deployment: Runs within a Docker container managed by Docker Compose and Supervisor, ensuring a consistent environment.

Get Involved

This is an open-source project. Contributions, feedback, and bug reports are welcome!