-
Notifications
You must be signed in to change notification settings - Fork 4
xInstallation Guide v1.0.0
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
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:
Port | Used by |
---|---|
9705 | Tomcat Shutdown port |
9709 | AJP |
9743 | TLS (reserved for future use) |
9760 | HTTP |
Port | Used by |
---|---|
5000-5015 | PIF Listener port range |
7297 | Proxy Port |
9770 | HTTP |
9773 | TLS |
9775 | Tomcat Shutdown port |
9779 | AJP |
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. |
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.
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 with the directory location of the folder where the ZIP file was extracted.
We have installed two custom scripts in tomcat/bin
. The scripts will start HAPI FHIR, XDS Toolkit, and FHIR Toolkit (in that order).
Script | |
---|---|
start.sh |
to start both the XDSToolkit base and the FhirToolkit base (in that order) |
stop.sh |
to stop both |
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 launch the UI for FHIR Toolkit, open a Web browser to http://localhost:9760/
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.
- https://github.com/usnistgov/asbestos/releases/download/0.1/fhir.zip
- The
fhir.zip
file can be extracted to<installation-directory>/tomcat/Toolkits/XdsToolkit/webapps
- You may need to update the FHIR Toolkit service.properties file to reflect the FHIR Base URL that is in use.
The default ExternalCache location for all Toolkits is <installation-directory>/tomcat/Toolkits/ExternalCache
The External Cache directory is specified by the -DEXTERNAL_CACHE Java System Property in the <installation-directory>/tomcat/Toolkits/FhirToolkit/bin/setenv.sh
(or setenv.bat
). If an alternate External Cache location is desired, please update the -DEXTERNAL_CACHE
Java System Property in the "setenv" batch file/script.
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/conf/service.properties
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/conf/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 sameserver.xml
file.)
Restart Tomcat.
File | Description |
---|---|
serviceProperties.json | Mainly used by the FHIR Toolkit Web Interface to communicate with the FHIR Toolkit backend API |
service.properties | FHIR Toolkit service properties. All of the FHIR Toolkit backend process API related URLs (XDS Toolkit, HAPI FHIR) are configured in the following file: <installation-directory>/tomcat/Toolkits/FhirToolkit/conf/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.