FHIRFLARE IG Toolkit – Quick Start Guide (Lite Mode)
Hosted at: https://flare.fhirlab.net
Audience: Medical personnel with basic understanding of FHIR and Implementation Guides (IGs)
1. Accessing the Toolkit
- Open your browser and go to: https://flare.fhirlab.net
- No installation required — Lite Mode runs entirely in the browser.
- All validation and conversion operations are performed client-side or via lightweight server calls.
2. Selecting and Importing IGs from the FHIR Registry
Steps
- Navigate to Search and Import IGs.
- Enter the IG name (e.g.,
hl7.fhir.au.base
) and select the desired version. - Click Import.
- The IG and its dependencies will be cached locally for validation use.
IGs are sourced from the official FHIR registry and Simplifier.net.
3. Uploading a Local IG
Steps
- Package your Implementation Guide as a
.tgz
file. - Go to Manage IGs.
- Click Upload Local IG and select your
.tgz
file. - The toolkit will extract and register the IG for use in validation.
Useful for testing custom or unpublished IGs.
4. Validating FHIR Resources
Steps
- Go to the Validation section.
- Upload your FHIR resource file (JSON or XML).
- Select the IG to validate against (imported or uploaded).
- Click Validate.
- Review the validation report showing errors, warnings, and info messages.
Lite Mode uses local StructureDefinitions only. Terminology validation (e.g., ValueSet bindings) may be limited.
5. Converting FHIR Resources to FSH
Steps
- Navigate to the FSH Converter section.
- Upload one or more FHIR resource files.
- Configure conversion options:
- Output style (flat or grouped)
- Include metadata
- Use alias file
- Click Convert.
- Download the generated
.fsh
files.
Powered by the integrated GoFSH engine for accurate FSH generation.