openehr-rm-4j

This repository contains the source code for Maven packages with Java interface declarations for the classes defined by the corresponding specifications of the openEHR Reference Model (RM) component.

Dependencies

• Clients of this package need to use Java version 8 or later
• For the build of this package the current LTS version of Java should be used

Usage

The "openehr-rm-4j" packages are published to GitHub Packages. So, even though they are publicly available, projects that want to apply those packages need a GitHub access token with the "read:packages" scope. How to create such an access token is described here: docs.github.com.

Maven

For projects that use Maven as build management tool, the personal GitHub access token and "openehr-rm-4j" GitHub package repository should be added to the global Maven settings.

~/.m2/settings.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <activeProfiles>
    <activeProfile>github</activeProfile>
  </activeProfiles>
  <profiles>
    <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
        </repository>
        <repository>
          <id>github</id>
          <url>https://maven.pkg.github.com/openehr4j/openehr-rm-4j</url>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
    </profile>
  </profiles>
  <servers>
    <server>
      <id>github</id>
      <username>USERNAME</username>
      <password>TOKEN</password>
    </server>
  </servers>
</settings>

Then the dependencies to the "openehr-rm-4j" packages can be declared inside the Project Object Model.

/path/to/project/pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <properties>
        <openehr.rm.version>1.1.0-alpha-19</openehr.rm.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-common</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-data-structures</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-data-types</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-demographic</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-ehr</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-ehr-extract</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-integration</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
        <dependency>
            <groupId>io.github.openehr4j.java-api</groupId>
            <artifactId>openehr-rm-support</artifactId>
            <version>${openehr.rm.version}</version>
        </dependency>
    </dependencies>

</project>

Also see

• Working with the Apache Maven registry | docs.github.com

Gradle

For projects that use Gradle as build management tool, the personal GitHub username and access token should be added to the global Gradle properties.

~/.gradle/gradle.properties

gpr.user=USERNAME
gpr.key=TOKEN

After the registration of the GitHub Maven repository, the dependency on the required package can be declared as for any other Maven package.

/path/to/project/build.gradle

repositories {
    maven {
        url = uri('https://maven.pkg.github.com/openehr4j/openehr-rm-4j')
        credentials {
            username = project.findProperty('gpr.user')
            password = project.findProperty('gpr.key')
        }
    }
}

ext['openehrRmVersion'] = '1.1.0-alpha-19'

dependencies {
    implementation "io.github.openehr4j.rm:common-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:data-structures-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:data-types-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:demographic-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:ehr-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:ehr-extract-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:integration-api:${openehrRmVersion}"
    implementation "io.github.openehr4j.rm:support-api:${openehrRmVersion}"
}

Also see

• Working with the Gradle registry | docs.github.com

Version number scheme

The "openehr-rm-4j" package version number consists of two parts: (1) the version number of the corresponding openEHR component and (2) a package-specific suffix. Those two parts are separated by the first hyphen.

The suffix has four different types:

1. alpha: releases for development tests
2. beta: release candidates for system tests
3. RELEASE: official Package for corresponding openEHR component version
4. RELEASE-patch: if necessary, bug fixes for the released package

Except for the RELEASE which is terminal, each type is followed by another hyphen and then an integer number that gets incremented with every new release.

Development

Publish to Maven Local

For testing purposes, the packages of this project can be published to Maven Local.

./gradlew publishToMavenLocal
find ~/.m2/repository/com/experimental-software

By adding mavenLocal() to the repository declaration in the build.gradle file of the implementing app, the locally built package can be used without it being accessible on the Internet.

repositories {
    mavenLocal()
    mavenCentral()
    maven {
        url = uri('https://maven.pkg.github.com/openehr4j/openehr-rm-4j')
        credentials {
            username = project.findProperty('gpr.user')
            password = project.findProperty('gpr.key')
        }
    }
}

Maintenance

Publish to GitHub Packages

The packages are automatically published to GitHub Packages after the creation of a new GitHub release.

Update Gradle Wrapper

sdk list java
./gradlew wrapper --gradle-version $VERSION

Legal notice

openEHR is a trademark of openEHR International.

The openEHR specifications themselves are distributed under the Attribution-NoDerivs 3.0 Unported (CC BY-ND 3.0) license. This project transpiles them to the Java programming language, under the assumption that it is allowed usage according to the "Principles" section in their Intellectual Property notice: openehr.org.

This project is not affiliated with and not endorsed by openEHR International.

References

• https://specifications.openehr.org/releases/RM/latest
• https://github.com/openEHR/specifications-RM