Skip to content

gematik/spec-TemplateForSimplifierProjects

Repository files navigation


About

This template standardizes the development of fhir resources with .fsh resources. It should reduce time for setup and ease the development process.

The following features are provided:

  • Best practices for modeling fsh files see /Resources/input/fsh folder.
  • Scripted creation and validation of fsh files and the generated fhir resources using a Hapi validator. See usage page.
  • Sorting of validation results by severity in subfolders.
  • Validation of committed fsh files via github-action with different validators (hapi, simplifier).

Installation

Here you can find the installation instructions

Setup

You can browse through the best practice files for some examples. Before you start specifying your own artifacts you have to

  • configure sushi-config.yaml with the dependencies that your project needs. These will be placed in the ~/.fhir/packages directory
  • Set the current year in the LICENSE file (bottom of the page) AND the Readme_template.md

Remove template files

Before you can start working within your project you need to delete the best-practise files. Feel free to review them before deletion. You can either run setup.sh

chmod u+x ./scripts/setup.sh && ./scripts/setup.sh

or you can execute these steps manually:

Finally you will need to

  • Create or re-use the OSPO conform README which can be found in this repository PROJECT_README.md too.
  • populate the new/renamed README.md with information for your repository.

Usage

Information about using the preconfigured devontainer including sushi, hapi validator and the codfsh-Extension can be found in usage page.

Help

If you find issues with this template project, please leave an issue or create a Pull Request via the template repository.