Public Repository

Last pushed: a year ago
Short Description
This API segments patient's sensitive health information using the patient consent.
Full Description

Supported Source Code Tags and Current Dockerfile Link

1.16.0 (latest), 1.13.0

Current Dockerfile

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

What is Document Segmentation Service API?

The Document Segmentation Service (DSS) API is responsible for the segmentation of the patient's sensitive health information using the patient consent. Segmentation invloves the following phase:

Document Validation: DSS uses Document-Validator to verify that the document is a valid CCD document.

Fact Model Extraction: DSS extracts the fact model using the consent policy.

Value Set Lookup: For every code and code system in the fact model, it uses Value Set Service to lookup the value set categories which is store in the fact model.

BRMS (Business Rules Management Service) Execution: DSS uses the rule execution service to execute the clinical fact.

Redaction: DSS uses the patient consent and the concept code to redact the document.

Tagging: DSS tag the docment based on the business rules specified in Guvnor.

Clean Up: DSS remove custom element that were added to the document for tracing.

Segmented Document Validation: DSS validate the segmented document before returning it.

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

How to use this image

Start a DSS instance

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

docker run --name dss -d bhits/dss: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/dss:latest --spring.datasource.password=strongpassword

Environment Variables

When you start the DSS image, you can edit the configuration of the DSS 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 dss -e JAR_FILE="dss-latest.jar" -v "/path/on/dockerhost/dss-latest.jar:/dss-latest.jar" -d bhits/dss:latest


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

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


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

docker run --name dss -e DEFAULT_PROGRAM_ARGS=",ssl,docker" -d bhits/dss: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/dss-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