FSH Lint

A Style and lint checker tool for validating FHIR Shorthand (FSH) files.

Quick Start

• 📦 Installation
• 🚀 Usage
• 📜 Rules
• 🤝 Contributing

Installation

Prebuilt binaries are available through GitHub Releases, or you can build from source if you have Go installed, with:

go install github.com/verily-src/fsh-lint@latest

Usage

The linter can be run from the command line. The basic usage is:

fsh-lint --paths path/to/YourFile.fsh

Automatic fixes are available for some rules as well, which can be applied with the --fix flag:

fsh-lint --paths path/to/YourFile.fsh --fix

Rules

Below is the complete list of rules by their rule-id grouped by their category.

Special Rules

• required-field-present
• profile-assignment-present

Code System Rules

• code-system-name-format
• code-system-name-matches-filename
• code-system-name-matches-id
• code-system-name-matches-title

Extension Rules

• binding-strength-present

Profile Rules

• binding-strength-present
• profile-name-matches-filename
• profile-name-matches-id
• profile-name-matches-title
• profile-parent-not-retired

Search Parameter Rules

• search-parameter-notice

Value Set Rules

• value-set-name-format
• value-set-name-matches-filename
• value-set-name-matches-id
• value-set-name-matches-title

Contributing

See CONTRIBUTING.md for more information.