Run Firely Terminal, and optionally the Java Validator too, as GitHub Actions on your FHIR GitHub repository. Validate conformance resource and examples against the FHIR specification and your custom business rules on every commit and pull request.

Example setup can be found on this project:

• Copy the contents of or download this example main.yml setup file.
• Add the contents to a main.yml file in your GitHub repository in the .github/workflows folder.
• You should now see the pipeline on your Actions tab and it should run on every push or pull request to the main or master branch. This can be configured in the yml file.

You can add a badge to your repository with the current pipeline status:

• Go to the Actions tab on your repository
• Select the Firely Validation pipeline
• Select the three dots and click 'Create status badge'
• Paste this code in the beginning of your README.md file.

The Firely Terminal Pipeline allows to validate all FHIR conformnce resources and corresponding examples. The pipeline expects the following content to be present in the repository:

• package.json containing all dependencies of the project (required, root-level of the project)
• project.yaml containing canonical claims (optional, root-level of the project)
• A folder containing all terminology resources (optional, path can be configured. See PATH_TO_CONFORMANCE_RESOURCES)
• A folder containing all StructureDefinitions (optional, path can be configured. See PATH_TO_CONFORMANCE_RESOURCES)
• A folder containing all examples (optional, path can be configured. See PATH_TO_EXAMPLES)

You can specify the following options using the "with" syntax in your GitHub Actions yml configuration:

• PATH_TO_CONFORMANCE_RESOURCES:
  • description: 'Relative paths of the folder(s) containing FHIR Conformance resources (StructureDefinition, ValueSet, CodeSystem).'
  • required: true
• PATH_TO_EXAMPLES:
  • description: 'Relative paths of the folder(s) containing examples for the FHIR Conformance resources defined by the project'
  • required: false
• PATH_TO_QUALITY_CONTROL_RULES:
  • description: 'Relative path pointing to Quality Control rules. Path MUST not include the .rules.yaml part of the file. Runs minimal.rules.yaml by default.'
  • required: false
• DOTNET_VALIDATION_ENABLED:
  • description: 'Boolean flag to run the .NET validator to validate conformance resources and examples'
  • required: false
  • default: true
• JAVA_VALIDATION_ENABLED:
  • description: 'Boolean flag to run the offical HL7 Java validator to validate conformance resources and examples'
  • required: false
  • default: false
• EXPECTED_FAILS:
  • description: Specify which steps in your validation workflow are expected to fail due to possible bugs in the validator(s). Allowed values: 'VALIDATION_CONFORMANCE_JAVA', 'VALIDATION_CONFORMANCE_DOTNET', 'VALIDATION_EXAMPLES_JAVA', 'VALIDATION_EXAMPLES_DOTNET'
  • required: false
• OUTPUT_FORMAT:
  • description: Specify the format of the validation output: Allowed values: 'RAW', 'SUMMARY' (produces a markdown compatible overview of all validation issues)
  • required: false
• JAVA_VALIDATION_OPTIONS:
  • description: 'Custom options passed to the Java validator. See https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator'
  • required: false
• SIMPLIFIER_USERNAME:
  • description: 'Simplifier email address (not username), needed for running Quality Control checks. Please use GitHub Secrets for this variable.'
  • required: true
• SIMPLIFIER_PASSWORD:
  • description: 'Simplifier password, needed for running Quality Control checks. Please use GitHub Secrets for this variable.'
  • required: true
• SUSHI_ENABLED:
  • description: 'Boolean flag to run fsh-sushi on the current repository to generated conformance resources based on FHIR shorthand'
  • required: false
  • default: false
• SUSHI_OPTIONS:
  • description: 'Custom options passed to SUSHI. See https://www.npmjs.com/package/fsh-sushi'
  • required: false
• FIRELY_TERMINAL_VERSION:
  • description: 'Version of Firely Terminal used for .NET-based validation'
  • default: '3.3.2'
  • required: true
• JAVA_VALIDATOR_VERSION:
  • description: 'Version of org.hl7.fhir.core library used for Java-based validation'
  • default: '6.4.4'
  • required: true
• SUSHI_VERSION:
  • description: 'Version of SUSHI used for compiling the FSH files'
  • default: '3.12.2'
  • required: true

• Feature: Upgrade Firely Terminal to v3.3.2
• Feature: Upgrade Java validator to v6.4.4
• Feature: Upgrade SUHSI to v3.12.2

• Feature: Upgrade Firely Terminal to v3.2.0
• Feature: Upgrade Java validator to v6.3.32
• Feature: Upgrade SUHSI to v3.12.0

• Feature: Upgrade Java validator to v6.3.14
• Feature: Upgrade SUHSI to v3.11.0

• Feature: Upgrade Firely Terminal to v3.1.0
• Feature: Upgrade Java validator to v6.3.1
• Feature: Upgrade SUHSI to v3.8.0

• Feature: Upgrade Java validator to v5.6.98
• Feature: Remove 1 by 1 validation with .NET validator in favor for Simplifier Quality Control

• Fix: Always execute fhir restore if SUSHI is enabled
• Fix: Run SUSHI before validation
• Fix: Only install Firely Terminal if it's not already installed
• Feature: Add FIRELY_TERMINAL_VERSION, JAVA_VALIDATOR_VERSION, SUSHI_VERSION as options
• Feature: Upgrade Firely Terminal to v3.0.0
• Feature: Upgrade Java validator to v5.6.65
• Feature: Upgrade SUHSI to v2.7.0

• Feature: Upgrade SUSHI to v2.5.0

• Fix: Only load XML and JSON files in Java validator
• Fix: Check fhirVersion in package.json and execute fhir spec
• Feature: Upgrade Java validator to v5.6.39

• Feature: Upgrade Firely.Terminal to v2.5.0-beta-7
• Feature: Upgrade Java validator to v5.6.27
• Feature: Upgrade SUSHI to v2.2.6

• Feature: Upgrade Firely.Terminal to v2.5.0-beta-4

• Feature: Add SUSHI_ENABLED and SUSHI_OPTIONS options
• Feature: Add option to push resource without subfolders
• Feature: Update to Firely.Terminal v2.5.0-beta-2
• Feature: Update Java validator to v5.6.0

• Feature: Upgrade Java validator to version 5.4.6

• Feature: Enable Quality Control if DOTNET_VALIDATION_ENABLED is enabled. A Simplifier Login is required to use this feature. See SIMPLIFIER_USERNAME and SIMPLIFIER_PASSWORD option.
• Feature: Upgrade Java validator to version 5.4.5

• Feature: Upgrade Java validator to version 5.3.11

• Feature: Upgrade Java validator to version 5.3.9

• PATH_TO_EXAMPLES is currently not supported in combination with DOTNET_VALIDATION_ENABLED. The .NET part will currently ignore examples.
• All folders in PATH_TO_CONFORMANCE_RESOURCES are currently validated individually in the Java validator. Each folders therefore is validated in it's own context with no access to the other folders