d4l-data4life/hc-fhir-helper-sdk-kmp

Data4Life FHIR Helper SDK

Provides builder and extension to create and interact with FHIR objects

Explore the docs »

Report Bug · Request Feature

Table Of Contents

• About The Project
  • Features
  • Built With
• Getting Started
  • Requirements
  • Installation
  • Java
  • Android
• Roadmap
• Changelog
• Versioning
• Contributing
• Copyright and License

About The Project

This project provides helpers that allow usage of FHIR objects within D4L without knowledge about every detail and variation that is possible working with FHIR objects.

As of now there is no shared common implementation due to the missing FHIR multiplatform SDK. Therefore the sources are basically 1:1 in androidMain and jvmMain.

Features

• Builders to easily construct FHIR objects

• Kotlin Extensions that simplify FHIR object manipulation

Built With

• Kotlin Multiplatform

Getting Started

Requirements

• Java 11 | Limitations of Java language features and APIs | Desugaring

• Kotlin 1.7.10

• Android 6.0 (API 23) to Android 13.0 (API 33)

Installation

Add the following maven repository url to your root build.gradle.kts:

Please take a look over at Github aboout-github-packages#tokens on how to generate your private token for accessing the Github Package Registry. Add gpr.user = {your Github username} and gpr.key = {private github access token} to your gradle.properties

allprojects {
    repositories {
        ...
        maven {
            url = uri("https://maven.pkg.github.com/d4l-data4life/hc-fhir-helper-sdk-kmp")
            credentials {
                username = project.findProperty("gpr.user") as String? ?: System.getenv("PACKAGE_REGISTRY_USERNAME")
                password = project.findProperty("gpr.key") as String? ?: System.getenv("PACKAGE_REGISTRY_TOKEN")
            }
        }
    }
}

Your GitHub username and token needs to be stored in your global Gradle properties: ~/.gradle/gradle.properties

NOTICE

You need to have read access to this repository and generate a personal access token with repo, write:packages and read:packages scope.

gpr.user=github-username
gpr.key=github-token

Java

Add following dependencies to your app build.gradle.kts.

dependencies {
    implementation("care.data4life.hc-fhir-helper-sdk-kmp:fhir-helper-jvm:$version")
}

Android

Add following dependencies to your app build.gradle.kts.

dependencies {
    implementation("care.data4life.hc-fhir-helper-sdk-kmp:fhir-helper-android:$version")
}

Roadmap

This project is work in progress. We are working on adding more functionality, guidelines, documentation and other improvements.

Changelog

See changelog

Versioning

We use Semantic Versioning as a guideline for our versioning.

Releases use this format: {major}.{minor}.{patch}

• Breaking changes bump {major} and reset {minor} & {patch}

• Backward compatible changes bump {minor} and reset {patch}

• Bug fixes bump {patch}

Contributing

You want to help or share a proposal? You have a specific problem? Read the following:

• Code of conduct for details on our code of conduct.

• Contributing for details about how to report bugs and propose features.

• Developing for details about our development process and how to build and test the project.

Copyright and License

Copyright (c) 2022 D4L data4life gGmbH / All rights reserved. Please refer to our License for further details.