HealthShare Health Connect Cloud Reference Information

In the Deployment Details section of the Overview page for your deployment, you can view the details of your deployment, including:

• Deployment size

• Creation date

• Deployment ID

• Cloud provider and region

• High Availability State

• Underlying InterSystems IRIS platform

The Interoperability Details section of the Overview page displays the File System Interoperability directory name to be used by Interoperability Productions Opens in a new tab that need to store files on the file system. If you have a High Availability configuration, files in this directory are copied automatically from the primary mirror member to the backup mirror member.

This section also displays the CIDR Block for the private network used for this deployment, as well as the Virtual IP Address of the deployment. This CIDR block defines the range of IP addresses used for the internal Health Connect Cloud components. The Virtual IP address is a static address within the CIDR block that you use to communicate with this Health Connect Cloud deployment. If you have a High Availability configuration, this Virtual IP address will continue to work no matter which mirror member is the primary member.

The External IP is displayed only if you have enabled external connections on the Firewall page.

If you have a High Availability configuration, the High Availability section of the Overview page displays whether or not your mirror is healthy, shows you the current state of each mirror member, and identifies which mirror member is the primary member and which mirror member is the backup member.

To create a user :

1. On the Connect Users page for your deployment, click Create User.

2. On the Create User dialog, type a Username and Email, and click Create.

   The user now appears in the list of Connect Users. However the user must create a permanent password to be able to log in to the Health Connect Cloud Management Portal or the Message Bank Management Portal, as described in the following steps.

3. Have the user check their email account for a temporary password.

4. Have the user click the Password Management Page link, and log in with the username and temporary password.

5. When prompted to change their password, the user should type a permanent password, confirm the password, and click Send.

   The user is redirected to the Health Connect Cloud Management Portal.

6. Make sure the user can log in to the Health Connect Cloud Management Portal with their username and permanent password.

After creating a user, you need to specify which interoperability productions the user is allowed to access.

To grant interoperability production access to a user:

1. In Connect Users list, in the row for that user, click Edit Productions in the Actions column.

2. On the Access to Productions dialog, select the Namespaces (productions) to which the user should have access.

3. Click Apply.

   This list of productions is now displayed in the Productions column in the row for the user.

If you later add a production and want to allow users to access the production, return to the Connect Users page and use this same procedure to assign access to the new production.

If you ever need to reset a user’s password:

1. Click the Password Management Page link.

2. If you see a dialog asking you to sign in with a specific username, click Sign In As a Different User? Otherwise, skip this step.

3. When asked to sign in with a username and password, click Forgot Your Password?

4. Type the user’s username, and click Reset My Password.

   A reset code will be sent to the user’s email address.

5. Have the user enter the reset code and select a new password. Then click Change Password.

To remove a user’s Health Connect Cloud Management Portal (and Message Bank Management Portal) access, in Connect Users list, click the Delete User icon in the Actions column for that user.

When you create an interoperability production, the Cloud Services Portal also creates a namespaceOpens in a new tab for the production, which includes a database for the code and data for that production. After creating a production, you can configure and manageOpens in a new tab it using the Management Portal.

A Health Connect Cloud deployment also includes a namespace called REPO, which can be used to store code that is shared between all of your productions. If you need to create custom code and make it automatically available to all productions, add the code to the HCC packageOpens in a new tab in the REPO namespace. In InterSystems terminology, the code in the REPO namespace is mapped to each production namespaceOpens in a new tab by means of a concept known as a %ALL namespace. Custom code is not necessarily required to develop a production. For more information on developing productions, see the Health Connect documentation setOpens in a new tab.

If your Health Connect Cloud deployment was created with the High Availability configuration, the databases for your interoperability productions (as well as the REPO database) are automatically mirrored to the backup server.

If your Health Connect Cloud deployment was created with a Message Bank, all of the messages processed by each production, as well as any event log entries, are stored in the Default Message Bank. For details on creating additional Message Banks, see Create a Message Bank.

To create a production:

1. On the Productions page, under Create Interoperability Production, type the desired name of your production.

2. Click Create Production.

After you create a production, it shows up in the Productions list at the top of the page with a Production State of Stopped. When the creation process is finished, the Production State changes to Running. The Production Started column shows the time the production was started, in GMT. You may need to click Refresh to update the status.

To manage the production in the Management Portal, click Manage in the row for that production. You will need to log in as a user that you or a team member has created (and granted production access to) on the Connect Users page.

To delete an interoperability production:

1. On the Productions page, click the Delete Production icon in the Actions column for that production.

2. In the Delete Production dialog box, type Permanently Delete, and click Delete.

The production is removed from the Productions list at the top of the page.

To create a new SSL/TLS Configuration:

1. On the SSL/TLS Configurations page, under Create SSL/TLS Configuration, type the desired name of your SSL/TLS Configuration.

   Only alphanumeric characters are allowed. No spaces or special characters.

2. Type an optional Description.

3. If desired, check Enabled to enable the configuration after creating it.

   You can enable or disable it later by editing the configuration.

4. Choose a Type for the configuration.

   Client means that this configuration is used when Health Connect Cloud initiates a connection to another system, for example, in an outbound TCP adapter in a production’s business operation.

   Server means that this configuration used when another systems initiates a connection to Health Connect Cloud, for example, in an inbound TCP adapter in a production’s business service.

5. Choose the desired Certificate Verification for this configuration.

   If this is a Client configuration:

   • None means that the server does not need to provide a certificate and the client performs no verification.

   • Required means that the server must provide a certificate and the client verifies the certificate with the Certificate Authority that issued the certificate.

   If this is a Server configuration:

   • None means that the client neither requires or requests a certificate.

   • Request means that the client may or may not provide a certificate and the server verifies the certificate only if provided.

   • Required means that the client must provide a certificate and the server verifies the certificate with the Certificate Authority that issued the certificate.

6. Upload the file containing the trusted Certificate Authority certificate(s).

7. Upload the file containing configuration certificate.

8. Upload the file containing associated private key.

9. Select the Private Key Type.

10. Type the Private Key Password.

11. Select the Minimum Protocol Version supported by this configuration.

12. Select the Maximum Protocol Version supported by this configuration.

13. If desired, edit the Enabled Cipherlist.

    The default set of cipher suites is:

    • ALL — Includes all cipher suites except the eNULL ciphers

    • !aNULL — Excludes ciphers that do not offer authentication

    • !eNULL — Excludes ciphers that do not offer encryption

    • !EXP — Excludes export-approved algorithms (both 40- and 56-bit)

    • !SSLv2 — Excludes SSL v2.0 cipher suites

14. For Server configurations only, select the size of Diffie-Hellman key (if using).

15. For Server configurations only, optionally enable and configure OSCP Stapling.

    OCSP (Online Certificate Status Protocol) is an internet protocol that checks the validity status of a certificate in real-time.

16. Click Create Configuration.

For more information on the fields on this page, see About ConfigurationsOpens in a new tab.

After you create a configuration, it shows up in the SSL/TLS Configurations list at the top of the page.

To edit an SSL/TLS Configuration:

1. On the SSL/TLS Configurations page, click the Edit Configuration icon in the Actions column for that SSL/TLS Configuration.

2. In the dialog box, edit any of the fields, and click Submit.

See Create an SSL/TLS Configuration for information on each field.

To delete an SSL/TLS Configuration:

1. On the SSL/TLS Configurations page, click the Delete Configuration icon in the Actions column for that SSL/TLS Configuration.

2. In the Delete Configuration dialog box, type Permanently Delete, and click Delete.

The configuration is removed from the SSL/TLS Configurations list at the top of the page.

If you want to receive a notification when an SSL certificate is about to expire, you can configure a business service in a production to do this for you. See Configure a Production to Send SSL Certificate Expiration Alerts for more information.

To create a new SQL Gateway configuration:

1. On the SQL Gateways page, under Create SQL Gateway Configuration, type the Configuration Name of your SQL Gateway configuration.

   Only alphanumeric characters are allowed. No spaces or special characters.

2. Choose a Driver to use for the connection.

3. In the Server box, type the URL of the server to use for this connection.

4. In the Port box, type the port number to connect to on the server.

5. In the Database box, type the name of the external database.

6. In the User box, type the username to use to connect to the external database.

7. In the Password box, type the password to use to connect to the external database.

8. Click Create Configuration.

After you create a configuration, it shows up in the SQL Gateway Configurations list at the top of the page.

To test a SQL Gateway configuration:

On the SQL Gateways page, click the Test Configuration icon in the Actions column for that configuration.

You should see the message “Successfully connected to remote server.”

If you see the message “There was an issue testing configuration. Please double check configuration parameters.” then edit the SQL Gateway configuration and try again.

To edit a SQL Gateway configuration:

1. On the SQL Gateways page, click the Edit Configuration icon in the Actions column for that configuration.

2. In the dialog box, edit any of the fields, and click Save.

See Create a SQL Gateway Configuration for information on each field.

To delete a SQL Gateway configuration:

1. On the SQL Gateways page, click the Delete Configuration icon in the Actions column for that configuration.

2. In the Delete Configuration dialog box, type Permanently Delete, and click Delete.

The configuration is removed from the SQL Gateway Configurations list at the top of the page.

Before creating a private firewall rule, you must create a InterSystems Network ConnectOpens in a new tab deployment to create a VPN hub and then connect a VPN gateway device (or Direct Connection) and your Health Connect Cloud deployment.

To add a private firewall rule to Health Connect Cloud:

1. On the Firewall page, in the Private Rules section, click Create Rule.

2. In the Add Firewall Rule dialog box:

   1. In the Type box, select Custom.

   2. In the Protocol box, select either TCP or UDP, depending the type of traffic to allow using this rule.

   3. In the Port Range box, type the port number(s) or range(s) to use for this rule.

      Use port 443 to allow a user to log into the Health Connect Cloud Management Portal or a port in the range 1025 through 65535 for other connections. Use a hyphen to specify a contiguous range of port numbers (for example, 1040-1050). Use commas to separate multiple non-contiguous port numbers (for example, 1040, 1050, 1060). When using commas, do not specify more than 50 port numbers at a time.

   4. In the CIDR Block box, type the CIDR block that defines the source IP addresses allowed using this rule.

      Public CIDR blocks are not permitted in private firewall rules.

   5. In the Description box, type the purpose of this rule.

   6. Click Add.

To delete a private firewall rule, click the Delete Configuration icon in the Actions column for that rule.

Before creating the first external firewall rule, you must enable external connections:

1. On the Firewall page, in the External Rules section, slide the Enable External Connections slider to the right.

   You are redirected to the list of deployments while the Health Connect Cloud deployment is updated. This may take a few minutes.

2. When the status for your deployment changes from UPDATING back to COMPLETE, click the card and navigate back to the Firewall page.

To add an external firewall rule to Health Connect Cloud:

1. On the Firewall page, in the External Rules section, click Create Rule.

2. In the Add Firewall Rule dialog box:

   1. In the Type box, select Custom.

   2. In the Protocol box, select either TCP or UDP, depending the type of traffic to allow using this rule.

   3. In the Port Range box, type the port number(s) or range(s) to use for this rule.

      Use port 443 to allow a user to log into the Health Connect Cloud Management Portal or a port in the range 1025 through 65535 for other connections. Use a hyphen to specify a contiguous range of port numbers (for example, 1040-1050). Use commas to separate multiple non-contiguous port numbers (for example, 1040, 1050, 1060). When using commas, do not specify more than 50 port numbers at a time.

   4. In the CIDR Block box, type the CIDR block that defines the source IP addresses allowed using this rule.

      Private CIDR blocks are not permitted in external firewall rules.

   5. In the Description box, type the purpose of this rule.

   6. Click Add.

To delete an external firewall rule, click the Delete Configuration icon in the Actions column for that rule.

If you are no longer using any external firewall rules, slide the Enable External Connections slider to the left to disable all external connections to Health Connect Cloud. Any existing external rules are hidden on the Firewall page, but they are not deleted and will be displayed again if you re-enable external connections. Note that the external IP address of the Health Connect Cloud deployment may change when external connections are re-enabled.

To enable DNS forwarding:

1. On the DNS Forwarding page, move the slider to the right to Enable the feature.

2. Wait 5 minutes to make sure that the feature is fully enabled in the background. You will not see any visual indication that this is complete.

   Important:

   If you don’t wait until the feature is fully enabled, any mappings you attempt to create will fail.

To add a mapping:

1. On the DNS Forwarding page, click New.

2. On the Add Mapping dialog, in the DNS Servers box, type the IP addresses of one or more DNS servers.

   To add multiple DNS servers, press the Enter key after each IP address.

3. In the Domains box, type one or more domain names.

   To add multiple domains, press the Enter key after each domain name.

4. On the Add Mapping dialog, click Save.

   Press the Enter key after entering the last domain name to enable the Save button.

5. On the DNS Forwarding page, click New to add additional mappings, if needed.

6. On the DNS Forwarding page, click Save Changes to save all of your new mappings.

   Note:

   If you navigate to another page without saving your new mappings, they will be lost.

7. After saving your changes, wait 5 minutes for the new mappings to be fully processed before making any other changes.

To delete a mapping:

1. On the DNS Forwarding page, in the row for the mapping you want to delete, click the Delete Configuration icon in the Actions column.

2. Delete any other mappings, if needed.

3. Click Save Changes to save all of your deletions.

   Note:

   If you navigate to another page without saving your deletions, they will be lost.

4. After saving your changes, wait 5 minutes for the deletions to be fully processed before making any other changes.

If your Health Connect Cloud deployment was created with the Message Bank option, all messages and other data processed by the connected productions are stored in the default Message Bank. This Message Bank has a namespaceOpens in a new tab of BANK.

To create a new Message Bank:

1. On the Message Banks page, under Create Message Bank, type the desired name of your Message Bank.

2. Click Create Message Bank.

After you create a production, it shows up in the Message Banks list at the top of the page with a Production State of Stopped. When the creation process is finished, the Production State changes to Running. The Production Started column shows the time the production was started, in GMT. You may need to click Refresh to update the status.

To manage the Message Bank in the Management Portal, click Manage in the row for that Message Bank. If you are not already logged in to the Management Portal, you will need to log in with a username and password that you or a team member has created on the Connect Users page

For more details on Message Banks, see Configuring the Enterprise Message BankOpens in a new tab.

To delete a message bank:

1. On the Message Banks page, click the Delete Message Bank icon in the Actions column for that Message Bank.

2. In the Delete Message Bank dialog box, type Permanently Delete, and click Delete.

The Message Bank is removed from the Message Banks list at the top of the page.

The Network Connectivity Test section of the Network page allows you to test connectivity from this deployment to a particular server and port. The server could be an external server or an on-premise server accessed over your company’s VPN.

To perform a connectivity test:

1. In the Network Connectivity Test section of the Network page, in the IP or Hostname box, type the IP address (such as 203.0.113.0) or hostname (such as example.com) of the server to which you want to connect.

2. In the Port box, type the port number to which you want to connect on that server.

   You can specify one of the following ports: 21, 22, 53, 443, 465, 587, or a port in the range 1024-65535.

3. Click Test Connection.

   You will see either a success or failure message.

The VPC Flow Logs section of the Network page allows you to monitor the traffic coming in and out of this deployment. This allows you to confirm that your network configuration is correct, debug network issues, monitor traffic patterns, or identify unauthorized access attempts.

To view flow log entries:

1. In the VPC Flow Logs section of the Network page, optionally filter the log by entering one or more of the following fields:

   • Actions — Choose ACCEPT to see only traffic that was permitted to flow from the source to the destination or REJECT to see only traffic that was blocked from reaching its intended destination.

   • Host IP — Type the IP address of either the source or destination.

   • Host Port — Type the port of either the source or destination.

2. Enter the Start Time and End Time of the period of time you want to examine.

   The default window is the most recent 10 minutes. The maximum window is 30 minutes in duration.

3. Click Find.

   Flow log entries matching the entered criteria are displayed.

4. Optionally, click Load More to load more log entries.

   This button only appears if more log entries remain to be loaded.