Built-in Rules
FSH Lint comes with a comprehensive set of 25+ built-in rules organized into categories:
Rule Categories
Section titled “Rule Categories”Blocking Rules (4 rules)
Section titled “Blocking Rules (4 rules)”Rules that must pass before other rules can run. These validate critical requirements.
- Blocking Rules - Critical validation rules
Correctness (11 rules)
Section titled “Correctness (11 rules)”Rules that ensure FHIR specification compliance and prevent errors
Style (2 rules)
Section titled “Style (2 rules)”Rules that enforce consistent naming and formatting patterns
Suspicious (2 rules)
Section titled “Suspicious (2 rules)”Rules that detect potentially problematic patterns in FSH code
Documentation (4 rules)
Section titled “Documentation (4 rules)”Rules that ensure proper resource metadata and documentation
Rule Severity Levels
Section titled “Rule Severity Levels”- Error - Must be fixed; prevents compilation or causes runtime issues
- Warning - Should be fixed; best practice violation or potential issue
- Info - Informational; suggestions for improvement
- Hint - Optional; minor style suggestions
Configuring Rules
Section titled “Configuring Rules”See the Rule Configuration guide for details on:
- Enabling/disabling rules
- Changing rule severity
- Rule-specific options
- Creating custom rules
Rule Statistics
Section titled “Rule Statistics”Total built-in rules: 25
By severity:
- Error: Most critical rules
- Warning: Best practice violations
- Info: Documentation suggestions