This repository contains the FHIR Questionnaires supported by NAV.
To preview a questionnaire run (you need to have sushi installed: npm install -g fsh-sushi):
sushi .
Then open the preview/index,html file with a browser, and select the generated json file of the questionnaire located at: fsh-generated/resources
The Questionnaires are developed using FSH (Tutorial).
Each Questionnaire is located in a folder within the input/fsh folder. Typical content of a Questionnaire folder:
input/fsh/NAV-06-03-04/
├── CHANGELOG.md # Maintained by the release process
├── package.json # Configure package name, version is managed by the release process
└── questionnaire.fsh # Source code for the Questionnaire
To build the FHIR resources just run the following at the root of the project:
npm install -g fsh-sushi
sushi .
The release process is managed by release-please. The release workflow relies on the following convention:
- Workflow name, Questionnaire id (
Instancefield in the .fsh file) and Questionnaire's folder name in theinput/fshfolder must match.
Commits following the Conventional Commit messages and affecting the Questionnaire folder, will trigger the creation of a PR. While open, this PR will keep track of additional commits satisfying the aforementioned mentioned rules and update the Changelog and version (see for more details).
Upon merge of this PR a Github Release will be created containing the json resource for the Questionnaire, as well as a npm package will be published containing the same resource. The version in the Questionnaire resource will be inferred from the package.json file.
To create a new Questionnaire just create a folder in the input/fsh folder. Here create a package.json and a .fsh file describing your Questionnaire. Make sure you also create a workflow file for the release process.
NOTE: Make sure you follow the convention mentioned in the Release management section.