The complete the interoperability layer setup the following three components are needed. XDS-Mediator is only needed if you plan to use XDS. These may reside on separate or the same machine.
OS: Ubuntu 14.04 x64
OpenHIM-core
Installation Notes
- Follow this guide.
- Since the startup script uses upstart, you start the service by giving the command:
sudo start openhim-core
Configuration
- Download default.json and put it in /etc/openhim-core
- Edit the upstart file at /etc/init/openhim-core.conf and add the parameter --conf=/etc/openhim-core/default.json
- Make any config changes to the file /etc/openhim-core/default.json
- We did not make any changes in our testing environment.
OpenHIM-Mediator-XDS
Installation Notes
- Download the release from this page.
- Extract to /opt/openhim-mediator-xds
- Download this init script to control the mediator using the service command and place it in /etc/init.d.
- Make sure to make the script executable. chmod +x openhim-mediator-xds
- You will need to make some adjustments to cmd and user at the top of the file based on the version and user you create below.
- Create a user to run the mediator.
- e.g. # adduser openhim
Configuration
- Download mediator.properties and place it in the openhim-mediator-xds directory.
- Edit mediator.properties to point to each component needed for XDS messages.
OpenHIM-console
Installation Notes
- You will need a web server installed, we will use apache2.
- Download and extract openhim-console to your web root. Default is /var/www/html
Configuration
- Edit config/default.json.
- The host parameter should point to where openhim-core is installed.
- Make sure to use a FQDN or ip address for the host.
- Read this if you have any issues.
Connecting with other components
Check out this getting started guide for more information on channels in OpenHIM. The OpenHIM mainly acts as a proxy for accessing
Client Registry (PIX/PDQ)
- Create a new channel and point it at the client registry's PIX/PDQ adapter. Below are the options we have in our test environment. Feel free to change these, but remember to reference those changes in your PoC or scripts.
- Basic Info
- Channel Name: PIX/PDQ
- URL Pattern: /pixpdq
- TCP Host: 0.0.0.0
- TCP Port: 8989
- Status: Enabled
- Access Control
- Allowed roles and clients: ohie (you will need to assign this role to one of your clients in the client tab)
- Content Matching
- Match Content Type: No Matching
- Routes
- Add New Route
- Route Name: CR
- Primary: True
- Type: MLLP
- Secured: Not Secured (recommended for testing only)
- Host: cr.example.com
- Port: 2100
- Click green checkbox
- Add New Route
- Save Changes
- Basic Info
Interlinked Registry (CSD)
- Create a new channel and point it at the ILR's CSD adapter.
- Basic Info
- Channel Name: CSD
- URL Pattern: ^/CSD($|/.*)
- Channel Type: HTTP
- Status: Enabled
- Basic Info