Skip to main content

Creating a Healthcare Interoperability (Foundation) Namespace and Production Using the Installer Wizard

The Installer Wizard allows you to create a Foundation namespace and production that contains all of the mappings and libraries needed for health care interoperability. If you need to modify a Foundation namespace, for example to modify the routine database, you can use the Namespaces page (System Administration > Configuration > System Configuration > Namespaces) after you have created and activated your Foundation namespace in the Installer Wizard.

In order to create a secure and portable configuration for your Health Connect Foundation namespace and production, use the Installer Wizard to:

  1. Set the Network Host Name

  2. Set up Secure Communication

  3. Create your Foundation namespace and production

Note:

When you select the Start All button on pages accessed through the Health menu, only Foundation productions are started. If you open a different production in a Foundation namespace, that production will not be started.

The business host Ens.Activity.Operation.Local that is automatically added to a Foundation production is used for activity monitoring, and can be removed if you do not need this functionality.

Accessing the Installer Wizard

  1. Log in to the Management Portal for your instance as a user with the %HS_Administrator role.

  2. Click Health in the menu on the left.

  3. Click the Installer Wizard link in the banner at the top of the page.

Setting the Network Host Name the Installer Wizard

HealthShare Health Connect uses the Network_Host_Name during configuration to generate URLs that address the various system components on a particular instance. The Network_Host_Name defaults to the machine’s host name if you do not explicitly set it in the Network Host Name page in the Installer Wizard.

Important:

Always set the Network_Host_Name before you begin configuring Health Connect.

Because the URLs based on the Network_Host_Name become embedded in your productions, InterSystems strongly recommends that you use a hostname that is resolved by your DNS as the value for Network_Host_Name rather than a machine IP address or a fully-qualified domain name that might be longer than the maximum of 50 characters. Using a DNS hostname provides the flexibility to redirect resources at the network level, making it much easier to later clone a system for testing, move a system to a new server, or restore a backup on another machine.

In a mirrored Health Connect installation, the Network_Host_Name should be set to the mirror VIP (or DNS entry for the mirror VIP).

To set the Network_Host_Name:

  1. Follow the instructions to access the Installer Wizard.

  2. Click Configure Network Host Name.

  3. In the Network Host Name field, replace the machine’s host name with a host name resolved by your DNS that refers to the machine. For a mirrored system, use the DNS entry of the mirror VIP. The maximum length for this string is 50 characters.

  4. Click Save.

Setting Up Secure Communication for a Foundation Production

Live Health Connect systems should always use secure communication.

Note:

If you set up secure communication before you create a Foundation namespace and production, then your Foundation production will automatically use the secure communication settings when you activate it.

Follow the instructions below to securely configure your Foundation namespace and production:

  1. If you have not already done so, set the Network Host Name.

  2. Configure your web server(s) to enable SSL/TLS. See the documentation for the web server you are using. Make a note of each SSL/TLS hostname and port.

  3. Create an InterSystems IRIS SSL/TLS Configuration for your Health Connect instance:

    Follow the instructions in “Create or Edit a TLS Configuration” in the TLS Guide to create an SSL/TLS Configuration. Note the Configuration Name.

    When you create or edit endpoints in the service registry, you can specify which SSL/TLS configuration to use. You can also specify the SSL/TLS Configuration directly in each production web client in the SSLConfig property.

  4. Configure secure communication in the Installer Wizard:

    1. Follow the instructions to access the Installer Wizard.

    2. Click Configure Secure Communication.

    3. The Server HostName field displays the value you entered in the Configure Network Host Name dialog. This is typically a “short name” that is resolved by your DNS rather than a fully-qualified domain name.

    4. In the Secure Port field, enter the SSL port number for your secure web server.

    5. Optionally enter a Web Server Prefix. If you are configuring a single web server to serve multiple HealthShare instances, enter the instance name to which you want to connect in the Web Server Prefix field, just as you would enter it in the CSP Server Instance field if you were defining a remote server connection.

    6. Confirm that the value in the Secure Root Endpoint field is correct.

    7. Select the These Settings are Active checkbox.

      Important:

      If you do not select These Settings are Active, then your secure communication settings will not be used when you create your Foundation namespace and production in the Installer Wizard.

    8. Select an SSL/TLS Configuration from the dropdown. Selecting an SSL/TLS Configuration allows the Installer Wizard to correctly construct your service registry entries to use secure communication.

    9. Click Save.

Creating a Foundation Namespace and Production in the Installer Wizard

Important:

Before you create a Foundation namespace and production for a live system, set up secure communication, so that your Foundation production automatically uses secure communication settings. Failure to do so may result in security vulnerabilities.

To install and activate a Foundation production using the Installer Wizard:

  1. Follow the instructions to access the Installer Wizard.

  2. Click Configure Foundation.

  3. For Local Name, enter the name that will identify the Foundation production. This name will become the namespace that contains the class definitions for the production. The maximum length for this string is 50 characters. The local name is referred to below as <LOCAL_NAME>.

  4. The Network Name is the network-wide, unique name for the Foundation production. It defaults to Network_Host_Name:<LOCAL_NAME>.

    Note:

    Network_Host_Name defaults to the machine’s host name if you do not explicitly set it in the Configure Network Host Name option in the Installer Wizard. Network_Host_Name should always be set in the Installer Wizard before you begin configuring your instance.

    A DNS entry is a better choice of Network_Host_Name, as it provides more flexibility. In a mirror, it is important that Network_Host_Name be set to the VIP (or DNS entry) of your mirror before you use the Installer Wizard to configure your productions.

  5. For Description, enter an optional short description.

  6. If the system is a mirror member and you want to mirror the database, select Mirror Database. For additional information about mirroring with Health Connect, see the considerations for health care products described in Managing Mirroring.

    Note:

    On versions prior to 2022.1, in order to mirror a foundation namespace, request an ad hoc patch for HSHC-3009 from the WRC, and follow the ad hoc instructions provided.

  7. For Production, enter the package and class name that you will use for this production in the form Package.Class. The default is <LOCAL_NAME>PKG.FoundationProduction. For example, “HSFOUNDATIONPKG.FoundationProduction”. Adding PKG to <LOCAL_NAME> makes it easy to differentiate between namespace and code package names, and prevents naming collisions.

  8. For Template, choose Generic Production.

  9. The default location for the production database, IRIS.DAT, is installDir/mgr/localName. To specify a location for the database other than the default, enter the alternate location in the Alternate Database Location field. If you specify an absolute location, then that location will be created if it does not exist. Your database will be in alternateDatabaseLocation/localName. If you specify a relative location then the database will be created in installDir/mgr/hslib/alternateDatabaseLocation/localName.

  10. Click Save. This production is now displayed in the list of configurations.

  11. In the row for the production you just created, click Activate. A window pops up, asking if you want to proceed. It is at this step that your Foundation production is created.

  12. Click Start to start the activation process.

    Note:

    If you close the dialog box before it displays a message that indicates completion, you will not see any error messages that may occur in the creation of your production.

    The result of the activation process is a new namespace that contains a Foundation production and other related classes. If you used the default values, the namespace for this production will be <LOCAL_NAME>, and the production name will be <LOCAL_NAME>PKG.FoundationProduction. So, for example, if you enter HSFOUNDATION in the Local Name field, you will create an HSFOUNDATION namespace that contains a FoundationProduction in the HSFOUNDATIONPKG package.

FeedbackOpens in a new tab