OpenHealth Requirements

Overview

OpenHealth Requirements scans source files for structured requirement annotations and extracts them into a structured CSV file. It is available as both a Gradle plugin and a standalone CLI executable.

Features

• Extracts structured requirements from code comments
• Supports configurable comment prefixes (e.g., //, #, etc.)
• Works with any file type
• Outputs results as a CSV file
• Available as a Gradle plugin and CLI tool

Requirement Format

Requirements must follow a structured format within comments.

Example Requirement

fun exampleFunction() = println("Hello, world!")

// REQ-BEGIN: A_1234, A_5678
// | example_spec
// | This function prints a greeting.
fun greetUser() = println("Hello, User!")
// REQ-END: A_1234, A_5678

Breakdown:

Part	Meaning
REQ-BEGIN: A_1234, A_5678	Start of requirement annotations, listing requirement IDs
example_spec	Specification name
This function prints a greeting.	Description of how the code fulfills the requirement
REQ-END: A_1234, A_5678	End of requirement block

Using the Requirement Extractor

CLI Executable

Available Options:

java -jar cli.jar --base-path <base-path> --comment-prefix <prefix> --output <output.csv> <file-paths>...

Parameter	Description	Default
--base-path	Base path for file paths	/
--comment-prefix	Comment prefix (e.g., //, #)	//
--output	Output CSV file	requirements.csv
<file-paths>	File paths to scan	(required)

Example Usage

# Scan specific files with default settings
java -jar cli.jar /path/to/file1.kt /path/to/file2.kt

# Scan specific files for Python comments (`#`)
java -jar cli.jar --comment-prefix "#" --output requirements.csv /path/to/file1.py /path/to/file2.py

Gradle Plugin

Apply Plugin

Add the plugin to your build.gradle.kts:

plugins {
    id("de.gematik.openhealth.requirements") version "1.0.1"
}

Run Extraction

./gradlew extractRequirements

This generates a CSV file (requirements.csv) in the project root.

CSV Output Format

Requirement ID	Specification	Description	File Path	Start Line	End Line
A_1234	example_spec	This function prints a greeting.	/path/to/file.kt	5	8

Contributing

Feel free to submit pull requests or issues!

License

Copyright 2025 gematik GmbH

Apache License, Version 2.0

See the LICENSE for the specific language governing permissions and limitations under the License

Additional Notes and Disclaimer from gematik GmbH

1. Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.
2. Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   1. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
   2. The software is provided "as is" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.
   3. The software is the result of research and development activities, therefore not necessarily quality assured and without the character of a liable product. For this reason, gematik does not provide any support or other user assistance (unless otherwise stated in individual cases and without justification of a legal obligation). Furthermore, there is no claim to further development and adaptation of the results to a more current state of the art.
3. Gematik may remove published results temporarily or permanently from the place of publication at any time without prior notice or justification.
4. Please note: Parts of this code may have been generated using AI-supported technology. Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.