spec-E-Rezept-ServiceRequest

Communication resources used to request a electronical prescription context. Resources to to be published on https://simplifier.net/erezept-servicerequest

Table of Contents

1. About The Project
   • Release Notes
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This Repo contains the fsh files to the later published spec-E-Rezept-ServiceRequest files on simplifier.net and a script to validate them.

Release Notes

See ReleaseNotes.md for all information regarding the (newest) releases.

Prerequisites

1. Clone this project to your local machine.
2. Run the install script once.
3. Work on teh FHIR Profiles build and validate them with the given script.

Installation

To install the necessary tools run

sudo ./install_fhir_tools.sh

This will install

• Java SDK 17 JRE
• Sushi from https://github.com/FHIR/sushi
• dotnet-sdk-3.1
• firely.terminal
• yq yaml-parser

After successfull installation run:

./validate.sh -is

See ../validation_results/ for results.

Usage

See Usage.md

Contributing

If you want to contribute, please check our CONTRIBUTING.md.

License

Copyright [yyyy] gematik GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.

Contact

Please address your ideas via PullRequest.

Usage

Installing FHIR tools on your local machine

NOTE: If you are using a 'box.fhir' Devbox you should have the neccessary dependencies already installed and this step can be skipped.

Otherwise, the following script installs all necessary tools for specifying fhir resources onto your local machine.

./scripts/install_fhir_tools.sh

(requires admin privileges)

Run Validation

Run script validate.sh to

1. Run sushi FHIR Files generator
2. Validate all files in the ./Resources folder
3. Get a html output file for each FHIR file in ../validation_results/

You can use following script options

Install dependencies from sushi-config.yaml

-i installs dependencies with firely.terminal from ./<foldername>/sushi-config.yaml file

./validate.sh -i

Sort resulting html files into severity folders

-s sorts resulting html files in folders by the severities of the findings. Categories are: error, warning, information and unknown

./validate.sh -s

Change default folder

-d foldername sets foldername for validation. Default is: ./Resources

validate.sh -d ./Testresources

Process single file

-f filename sets filename for single validation.

validate.sh -f ./Resources/fsh-generated/resources/myProfile.json

Work with specific version of Hapi Validator

-v version defines a version od the used Hapi Validator. If the specified version of the hapi validator is not present the default will be used. Validator-JARs will be downloaded to ~/.fhir/validators/.

validate.sh -v 5.6.70

Help

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