Skip to content

xInstallation Guide v2.x.x

Jump to bottom
Sunil Bhaskarla edited this page Sep 25, 2021 · 5 revisions

The newer version of the Installation Guide v2.2.x can be found here: https://github.com/usnistgov/asbestos/wiki/Installation-Guide-v2.2.x

Overview

The toolkit download is a zip file named asbestos.version.zip. It contains a full installation of Tomcat pre-loaded with the toolkit components. The components are

  • FHIR Toolkit (proxy, test engine, and UI)

  • XDS Toolkit (needed for testing MHD XDSonFHIR option)

  • HAPI FHIR server

While there is one Tomcat Home there are several Tomcat Bases (independent instances of Tomcat). The overall contents look like:

asbestos/
   tomcat/
      bin/
          start.sh            Starts entire tool
          start.bat
          stop.sh             Shuts down entire tool
          stop.bat
      Toolkits/
          ExternalCache/      External Cache shared between XDS Toolkit and FHIR Toolkit
                              All internal tools auto-configure to use it
          FhirToolkit/
              conf/
                  service.properties   Controlling properties file for server
              webapps/
                  asbestos    FHIR Toolkit WAR
                  ROOT/
                      serviceProperties.json   Secondary properties file for UI
          XdsToolkit/
              webapps/
                   fhir/      HAPI server
                   xdstools/  XDS Toolkit

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. At least one of these environment variables is needed to run this program: JAVA_HOME or JRE_HOME. 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

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 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.x.y * XDS Toolkit v7.3.+ * HL7 HAPI v3.7

Of these elements, XDS Toolkit is optional. It is only used to support the XDSonFHIR environment. In the future its installation will be optional.

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>. In the references below, you will have to replace <installation-directory> with the directory location of the folder where the ZIP file was extracted.

Starting FHIR Toolkit

Starting 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

Launching FHIR Toolkit UI

To launch the UI for FHIR Toolkit, open a Web browser to http://localhost:9760/

Advanced installation options

In the above default configuration, FHIR Toolkit, HAPI, XDS Toolkit and the user’s browser are all running on one machine and all references between system components are through localhost. FHIR Toolkit can be installed and configured with all the Tomcat services in different instances of Tomcat on different machines and the UI running through a real hostname.

There are currently two sources for configuration information: the HOW-TO section below and https://github.com/usnistgov/asbestos/wiki/Configuration. These will be combined in the future.

HL7 HAPI FHIR

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

The Default External Cache Location

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

HL7®, HEALTH LEVEL SEVEN®, FHIR® and the FHIR Logo ® 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