Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gematik/spec-templateforsimplifierprojects
Template for creating gematik FHIR profiles
https://github.com/gematik/spec-templateforsimplifierprojects
fhir fsh miscellaneous template
Last synced: 12 days ago
JSON representation
Template for creating gematik FHIR profiles
- Host: GitHub
- URL: https://github.com/gematik/spec-templateforsimplifierprojects
- Owner: gematik
- Created: 2022-08-29T08:25:39.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T09:05:18.000Z (8 months ago)
- Last Synced: 2024-04-17T05:15:57.932Z (7 months ago)
- Topics: fhir, fsh, miscellaneous, template
- Language: GLSL
- Homepage:
- Size: 20.3 MB
- Stars: 4
- Watchers: 13
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 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](./Resources/input/fsh).
* Scripted creation and validation of fsh files and the generated fhir resources using a Hapi validator. See [usage page](./USAGE.md).
* 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](INSTALL.md)
# Setup
You can browse through the [best practice files](./Resources/input/fsh) for some examples. Before you start specifying your own artifacts you have to
* configure [sushi-config.yaml](./Resources/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](./scripts/setup.sh)
```bash
chmod u+x ./scripts/setup.sh && ./scripts/setup.sh
```
or you can execute these steps manually:
* delete all files in [./Resources/input/fsh](./Resources/input/fsh)
* delete all files in [./Resources/fsh-generated/resources](./Resources/fsh-generated/resources)
* delete [downloaded_validation_script.sh](./scripts/downloaded_validation_script.sh)
* delete [install_fhir_tools.sh](./scripts/install_fhir_tools.sh) when you have already installed the FHIR Tools by using this script. Otherwise do not delete now.
* delete [this readme file](./README.md) and rename Readme_template.md with README.md
Finally you will need to
* Create or re-use the OSPO conform README which can be found in this repository [PROJECT_README.md](/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](./USAGE.md).
# Help
If you find issues with this template project, please leave an issue or create a Pull Request via the [template repository](https://github.com/gematik/spec-TemplateForSimplifierProjects).