Skip to content

xInstallation Guide v1.0.0

Jump to bottom
Sunil Bhaskarla edited this page Dec 4, 2019 · 9 revisions

Installation Guide v1.0.0

System Requirements

Java 8 should be installed and accessible through your system shell environment or command prompt. The system should also meet requirements to run Apache Tomcat Server Version 9.0.26. The following system ports should be available and free to use:

FHIR Toolkit Ports

Port Used by
9705 Tomcat Shutdown port
9709 AJP
9743 TLS (reserved for future use)
9760 HTTP

XDS Toolkit Ports

Port Used by
5000-5015 PIF Listener port range
7297 Proxy Port
9770 HTTP
9773 TLS
9775 Tomcat Shutdown port
9779 AJP

Installation

Unzip the contents to a directory of your choice. The full path of the directory to which the ZIP file was extracted will be referred to as <installation-directory>.

<installation-directory>

In the references below, you will have to replace with the directory location of the folder where the ZIP file was extracted.

Terms

Term Description
CATALINA_HOME The Tomcat installation directory.
CATALINA_BASE The CATALINA_BASE environment variable specifies location of the root directory of the "active configuration" of Tomcat. See <installation-directory>/tomcat/RUNNING.txt for more details on CATALINA_BASE. Each type of Toolkit (FHIR, XDS) makes use of a dedicated CATALINA_BASE.
FHIR Toolkit NIST FHIR Toolkit is used for the IHE MHD profiles and FHIR testing.
XDS Toolkit NIST XDS Toolkit is used for the IHE XDS profiles.

Contents

The asbestos_complete1.0.0.zip file contains a Tomcat Application Server bundled with the following Java Web Applications:

  • FHIR Toolkit v1.0.0
  • XDS Toolkit v7.3.0
  • HL7 HAPI v3.7

The Default External Cache Location

The default ExternalCache location for all Toolkits is <installation-directory>/tomcat/Toolkits/ExternalCache

FHIR Toolkit Service Properties

All of the FHIR Toollkit backend process API related URLs (XDS Toolkit, HAPI FHIR) are configured in the following file: <installation-directory>/tomcat/Toolkits/FhirToolkit/conf/service.properties

Running FHIR Toolkit

Running FHIR Toolkit the easy way

We have installed two custom scripts in tomcat/bin. The scripts will start HAPI FHIR, XDS Toolkit, and FHIR Toolkit (in that order).

On *nix

Script
start.sh to start both the XDSToolkit base and the FhirToolkit base (in that order)
stop.sh to stop both

On Windows 10

Batch file
start.bat To start both the XDSToolkit base and the FhirToolkit base (in that order). Note: start.bat must be typed along with the .bat file extension.
stop.bat To stop both

To access FHIR Toolkit, open a Web browser to http://localhost:9760/

Optional: Running Only the FHIR Toolkit (without HAPI FHIR or XDS Toolkit)

HL7 HAPI FHIR

HAPI FHIR Website

https://hapifhir.io/

The version of the HAPI FHIR that was used to test FHIR Toolkit can be found here

HOW-TO

Replace FHIR Toolkit with another version

Replace XDS Toolkit with another version

Replace HAPI FHIR with another version

Changing the ExternalCache directory

The External Cache directory is specified by the -DEXTERNAL_CACHE Java System Property in the \tomcat\Toolkits\FhirToolkit\bin\setenv.bat (or setenv.sh). If an alternate External Cache location is desired, please update the -DEXTERNAL_CACHE Java System Property in the "setenv" batch file/script.

Changing FHIR Toolkit host name

The default host name used by the FhirToolkit is "localhost". This value is reflected in the FhirToolkit Capability Statement and also used by the backend API calls. If you wish to change the host name, please update the following:

  • Update the relevant part of the fhirToolkitBase property in <installation-directory>\tomcat\Toolkits\FhirToolkit\webapps\ROOT\serviceProperties.json
  • Update the relevant part of the fhirToolkitBase property in <installation-directory>\tomcat\Toolkits\FhirToolkit\webapps\asbestos\WEB-INF\classes\service.properties

Changing FHIR Toolkit port

The default port used by the FhirToolkit web application is 9760. This value is reflected in the FhirToolkit Capability Statement and also used by the backend API calls. If you wish to change the port, stop the Tomcat instance and please update the following:

  • Update the relevant part of the fhirToolkitBase property in <installation-directory>\tomcat\Toolkits\FhirToolkit\webapps\ROOT\serviceProperties.json
  • Update the relevant part of the fhirToolkitBase property in <installation-directory>\tomcat\Toolkits\FhirToolkit\webapps\asbestos\WEB-INF\classes\service.properties
  • Update the relevant part of the <installation-directory>\tomcat\Toolkits\FhirToolkit\conf\server.xml (Other Tomcat related ports such as 9705, 9709, 9743 are also configured in the same server.xml file.)

Restart Tomcat.

Configuration Files

File
serviceProperties.json Mainly used by the FHIR Toolkit Web Interface to communicate with the FHIR Toolkit backend API
service.properties FHIR Toolkit service properties
toolkit.properties XDS Toolkit properties
hapi.properties HAPI FHIR configuration properties

HL7(R), HEALTH LEVEL SEVEN(R), FHIR(R) and the FHIR Logo (R) are trademarks owned by Health Level Seven International, registered with the United States Patent and Trademark Office.

Sun, the Sun logo, Sun Microsystems, Solaris, HotJava, and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and certain other countries.

Clone this wiki locally