Public Repository

Last pushed: 10 months ago
Short Description
The Patient User API is responsible for managing the patient user account.
Full Description

Supported Source Code Tags and Current Dockerfile Link

0.16.0 (latest), 0.15.0, 0.12.0

Current Dockerfile

For more information about this image, the source code, and its history, please see the GitHub repository.

What is Patient User API?

The Patient User API is responsible for managing the patient user creation process, including user creation and activation, user scope management, email token generation, and extracting existing user profile from the Patient Health Record API (PHR) in the Consent2Share (C2S) application.

For more information and related downloads for Consent2Share, please visit Consent2Share.

How to use this image

Start a Patient User instance

Be sure to familiarize yourself with the repository's file before starting the instance.

docker run --name patient-user -d bhits/patient-user:latest <additional program arguments>

NOTE: In order for this API to fully function as a microservice in the Consent2Share application, it is required to setup the dependency microservices and the support level infrastructure. Please refer to the Consent2Share Deployment Guide in the corresponding Consent2Share release (see Consent2Share Releases Page) for instructions to setup the Consent2Share infrastructure.


The Spring profiles application-default and docker are activated by default when building images.

This API can run with the default configuration which is from three places: bootstrap.yml, application.yml, and the data which the Configuration Server reads from the Configuration Data Git Repository. Both bootstrap.yml and application.yml files are located in the class path of the running application.

We recommend overriding the configuration as needed in the Configuration Data Git Repository, which is used by the Configuration Server.

Also, Spring Boot supports other ways to override the default configuration to configure the API for a certain deployment environment.

The following is an example to override the default database password:

docker run -d bhits/patient-user:latest --spring.datasource.password=strongpassword

Environment Variables

When you start the Patient User image, you can edit the configuration of the Patient User instance by passing one or more environment variables on the command line.


This environment variable is used to setup which jar file will run. you need mount the jar file to the root of container.

docker run --name patient-user -e JAR_FILE="patient-user-latest.jar" -v "/path/on/dockerhost/patient-user-latest.jar:/patient-user-latest.jar" -d bhits/patient-user:latest


This environment variable is used to setup JVM argument, such as memory configuration.

docker run --name patient-user -e "JAVA_OPTS=-Xms512m -Xmx700m -Xss1m" -d bhits/patient-user:latest


This environment variable is used to setup an application argument. The default value is ", docker".

docker run --name patient-user -e DEFAULT_PROGRAM_ARGS=",ssl,docker" -d bhits/patient-user:latest

Supported Docker versions

This image is officially supported on Docker version 1.12.1.

Support for older versions (down to 1.6) is provided on a best-effort basis.

Please see the Docker installation documentation for details on how to upgrade your Docker daemon.


View license information for the software contained in this image.

User Feedback


Documentation for this image is stored in the bhits/patient-user-api GitHub repository. Be sure to familiarize yourself with the repository's file before attempting a pull request.


If you have any problems with or questions about this image, please contact us through a GitHub issue.

Docker Pull Command