OpenHealth provides open-source software components for TI-related development. This repository offers reusable modules for smartcard access, cryptography, and efficient interoperability between Rust and other platforms.

The project is in active, early-stage development; APIs and modules may change without prior notice.

• core-modules/: Rust crates for ASN.1 handling, cryptography and healthcard functionality.
• core-modules-kotlin/: Kotlin/JVM bindings and examples that integrate the Rust modules into JVM-based applications.
• core-modules-swift/: Swift/iOS interoperability artifacts (UniFFI + xcframework).
• docs/: Additional documentation, interoperability notes and project specific guides.

We aim to support a broad set of operating systems and architectures, including:

Published artifacts are available on Maven Central. Use the latest published version.

Kotlin Multiplatform (common dependency):

kotlin {
    sourceSets {
        val commonMain by getting {
            dependencies {
                implementation("de.gematik.openhealth:healthcard:<version>")
            }
        }
    }
}

Android:

repositories { mavenCentral() }

dependencies {
    implementation("de.gematik.openhealth:healthcard-android:<version>")
}

JVM:

repositories { mavenCentral() }

dependencies {
    implementation("de.gematik.openhealth:healthcard-jvm:<version>")
}

1. In Xcode, add a package dependency with the repository URL: https://github.com/gematik/OpenHealth-Core.
2. Set the Dependency Rule to Exact Version and pick the desired release tag.
3. Add the OpenHealthHealthcard product to your target.

Notes:

• The Swift package references the xcframework at core-modules-swift/healthcard/OpenHealthHealthcardFFI.xcframework inside the selected tag. If that file is missing for a given release, build it locally (see core-modules-swift/healthcard/README.md) or use the release asset.

If you want to contribute, please refer to the Contribution Guidelines for information about workflows, code style and testing expectations.

See docs/README.md.

Copyright 2025 gematik GmbH

Apache License, Version 2.0

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

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.