Introducing SUSHI, the world's first compiler for FHIR Shorthand!
This initial release is intended mainly for the development team in order to test that the basic process works as intended. It is limited in features and lacks basic documentation. Basic documentation, as well as at least one more feature, will be added in the coming days.
Current supported features:
- Defining profiles and extensions
- Parents are limited to FHIR resources and profiles defined as part of FHIR
- Cardinality constraints
- Flags (
MS,SU,?!) - Value Set bindings
- Only (e.g. type) constraints (limited to FHIR resources and profiles defined as part of FHIR)
To install SUSHI, first install Node.js, then run:
npm install -g fsh-sushi
After installing fsh-sushi, the sushi command should be in your path:
$ sushi --help
Usage: sushi <path-to-fsh-defs> [options]
Options:
-o, --out <out> the path to the output folder (default: "out")
-h, --help output usage information
sushi should be run against a FSH Tank folder containing a package.json config file and .fsh files:
$ sushi sushi-0.1.0-fsh-examples
info: Exported 4 profile(s) and 1 extension(s).
An example FSH Tank zip is attached to this release below. It is for demonstration purposes only and needs to be unzipped before running sushi against it. Note that the example FSH files may use features of FHIR Shorthand that are not supported in this release of SUSHI.