ChipSoft HiX

Introduction

Easily and securely send appointment reminders, referrals, and other types of messages directly from HiX. Secure emailing is available from HiX version 6.1.

There are three different options for securely sending messages from HiX:

  1. Send all messages securely.
  2. Use Exchange on-premise to securely send specific types of messages (for example, appointment reminders).
  3. Use a mail server to securely send specific types of messages (for example, appointment reminders).
    This option also applies to Exchange Online (Office 365).
Info
To send secure emails from ChipSoft HiX, you need a business Zivver account in combination with the Zivver Mail Submission add-on. For Mail Submission, you need an Ultimate subscription and a contract that includes Mail Submission. To activate Mail Submission, please contact sales@zivver.com.

Configure mail submission in Zivver

To configure secure emailing in ChipSoft HiX, you use the Zivver Mail Submission functionality. You must be an administrator to configure this.

  1. Go to SMTP credentials.
  2. Click .
  3. Enter a description.
    For example, “HiX”.
  4. Click .
    A new screen opens showing a username and password. These credentials are displayed only once. Make sure to store them securely.
  5. Click .

You have now generated an SMTP username and SMTP password. You will use these SMTP credentials later in this guide to authenticate the connection to smtp.zivver.com. Depending on which of the three options you choose, you will use these credentials in HiX, Exchange on-premise, or a mail server.

Send all messages securely

Use this option to securely send all messages from HiX via Zivver. To do this, you set up an SMTP connection with Zivver in HiX. This is available from HiX version 6.1.

Tip
Check which email report definitions exist in HiX to ensure that all types of messages (for example, appointment reminders and messages to chain partners) can be sent securely. Are there email report definitions that should not be sent securely? If so, use Exchange on-premise or a mail server to securely send specific types of messages from HiX.
Note
In this section, we assume that HiX is configured to send emails. This means that CS-Routeer is configured for email, that email report definitions exist in CS-Overzichtsgenerator, and that routing fields are filled in within CS-Patiënt. If this is not the case, please contact ChipSoft or consult the CS-Routeer HiX manual to learn how to configure this.

Set up an SMTP connection in HiX

Follow the steps below to set up the SMTP connection between HiX and Zivver. To do this, you adjust the global settings in CS-Routeer.

Tip
Always test the steps below first in the acceptance environment before configuring them in the production environment.
  1. Open HiX.
  2. Go to CS-Routeer.
  3. Go to the global settings.
  4. Go to Routeertypes > Emailen.
  5. Verify that the Emailen actief option is enabled.
  6. Enter smtp.zivver.com in Emailhost.
  7. Enter the SMTP password from the chapter Mail submission instellen in Zivver in Mailserver password.
    Warning
    Do not enter the password of a Zivver account here.
  8. Enter the SMTP username from the chapter Mail submission instellen in Zivver in Mailserver user.
    Warning
    Do not enter the email address of a Zivver account here.
  9. Optional: enter the default email address of the sender in lowercase.

HiX is now configured to securely send messages via Zivver.

Warning

smtp.zivver.com only accepts the submitted message if:

  1. A Zivver account exists for the default sender. Verify this on the account page.
  2. This Zivver account is a member of the Zivver organization for which the SMTP credentials were generated.

Use Exchange on-premise to securely send specific types of messages

In this chapter, we explain how to set up an SMTP connection with Zivver in Exchange on-premise. We use a Mail Flow Rule to filter messages. This allows you to determine which types of messages are sent securely via Zivver, while regular email traffic is not routed through Zivver.

Tip
Use this option if you want to securely send specific types of messages (for example, only appointment reminders) from HiX. Do you want to securely send all messages from HiX? Then read Send all messages securely.
Note
In this chapter, we assume that an active SMTP connection exists between HiX and Microsoft Exchange on-premise. If this is not the case, please contact ChipSoft or consult the CS-Routeer HiX manual to learn how to configure this.

Create an accepted domain

The first step is to add a new accepted domain in Exchange. This is a fictitious domain that exists only within Exchange.

  1. Go to the Exchange Admin Center (EAC).
    For example, via https://<ServerFQDN>/ecp.
  2. Log in to the EAC as an administrator (admin).
  3. In the menu, go to Mail flow.
  4. Go to accepted domains.
  5. Click add to add a new domain.
  6. Enter a name, for example Zivver HiX.
  7. Enter zivver.org in Accepted domain.
  8. For This accepted domain is, select Authoritative.
  9. Click .

The fictitious accepted domain has now been created. In the next section, create a mail contact for this domain.

Create a mail contact

The second step is to create a mail contact. This mail contact uses the fictitious domain that was created in the previous section.

  1. Go to the Exchange Admin Center (EAC).
    For example, via https://<ServerFQDN>/ecp.
  2. Log in to the EAC as an administrator (admin).
  3. In the left-hand menu, select recipients.
  4. Select contacts.
  5. Click add.
  6. Select Mail contact.
  7. Enter Zivver Relay for Display name.
  8. Enter Zivver Relay for Name.
  9. Enter relay for Alias.
  10. Enter relay@zivver.org for External email address (the placeholder domain).
  11. Click .

The mail contact has now been created. Later in this chapter, we will route messages to this contact using a Mail Flow Rule.

Configure an Exchange Send Connector

The third step is to create an SMTP connection with smtp.zivver.com. To do this, you create a Send Connector.

Warning
These steps are written for Exchange on-premise and are not suitable for Exchange Online (Office 365). In Exchange Online, it is not possible to authenticate the connection to smtp.zivver.com using a username and password. As a workaround, you can add your organization’s domains to the Zivver allowlist.
  1. Go to the Exchange Admin Center (EAC).
    For example, via https://<ServerFQDN>/ecp.
  2. Log in to the EAC as an administrator (admin).
  3. In the left-hand menu, select Mail flow.
  4. Select Send connectors.
  5. Click add to add a new connector.
  6. Name the connector Zivver Send Connector.
  7. For Type, select Internet.
  8. Click .
  9. Select Route mail through these smart hosts.
  10. Click add.
  11. Enter smtp.zivver.com.
  12. Click .
    The smart host now appears in the list.
  13. Click .
  14. For Smart host authentication, select Basic authentication.
  15. Enable Offer basic authentication only after starting TLS.
  16. Enter the generated SMTP username from the chapter Mail submission instellen in Zivver in User name.
    Warning
    Do not enter the email address of a Zivver account here.
  17. Enter the generated SMTP password from the chapter Mail submission instellen in Zivver in Password.
    Warning
    Do not enter the password of a Zivver account here.
  18. Click .
  19. Click add.
  20. Enter SMTP for Type.
  21. Enter the placeholder domain zivver.org for FQDN.
  22. Enter 1 for Cost.
  23. Click .
  24. Click .
  25. Click add.
  26. Select a server and click .
  27. Click .
  28. Click .

The Send Connector is now configured to intercept all messages addressed to this fictitious domain. To actually submit the messages to smtp.zivver.com, one additional change is required. This cannot be done via EAC/ECP and must be performed using PowerShell. See Connect to Exchange servers using remote PowerShell for background information on the PowerShell cmdlets below.

  1. Start Windows PowerShell with administrator privileges.
  2. Run the following cmdlet to ensure that all loaded scripts use a valid certificate:
    Set-ExecutionPolicy RemoteSigned
  3. Run the following cmdlet to prompt for credentials:
    $UserCredential = Get-Credential
  4. Connect to Exchange on-premise and replace ServerFQDN with the correct server name:
    $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri http://"ServerFQDN"/PowerShell/ -Authentication Kerberos -Credential $UserCredential
  5. Import the Exchange cmdlets:
    Import-PSSession $Session -DisableNameChecking
  6. Retrieve an overview of the Send Connectors:
    Get-SendConnector
  7. Check the current port number of the Zivver Send Connector:
    Get-SendConnector "<Naam-Zivver-SendConnector>" | Select-Object port
  8. Change the port number of the Zivver Send Connector to 587:
    Set-SendConnector "<Naam-Zivver-SendConnector>" -port 587
  9. Verify that the port number has been updated:
    Get-SendConnector "<Naam-Zivver-SendConnector>" | Select-Object port
  10. Close the PowerShell session:
    Remove-PSSession $Session
Set-ExecutionPolicy RemoteSigned
$UserCredential = Get-Credential
$Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri http://"ServerFQDN"/PowerShell/ -Authentication Kerberos -Credential $UserCredential
Import-PSSession $Session -DisableNameChecking
Get-SendConnector
Get-SendConnector "<naam>" | Select-Object port
Set-SendConnector "<naam>" -port 587
Get-SendConnector "<naam>" | Select-Object port
Remove-PSSession $Session

The Send Connector is now ready. In the next section, create a Mail Flow Rule to route specific types of messages to the contact with this fictitious domain.

Configure a Mail Flow Rule

The fourth step is to create a rule that filters messages. The filtered messages are then routed to the mail contact with the fictitious domain.

Filter messages by subject

In the steps below, we use an example filter that checks the subject. If the subject of the message contains Afspraakbevestiging, the message will be sent securely.

  1. Go to the Exchange Admin Center (EAC).
    For example, via https://<ServerFQDN>/ecp.
  2. Log in to the EAC as an administrator (admin).
  3. In the left-hand menu, go to Mail flow.
  4. Go to Rules.
  5. Click the add button.
  6. Select Create a new rule....
  7. Name the rule Stuur HiX-afspraakbevestiging via Zivver.
  8. At the bottom, click More options....
  9. Under *Apply this rule if..., select The subject or body... and then subject matches these text patterns.
  10. Enter Afspraakbevestiging.
  11. Click add to add the value.
  12. Click .
  13. Click .
  14. Under And, select The recipient... and then is external/internal.
  15. Select the option Outside the organization.
  16. Click .
  17. Under *Do the following..., select Redirect the message to... and then these recipients.
  18. Select the mail contact with the fictitious domain created in Contactpersoon aanmaken.
  19. Click .
  20. Click .
  21. For Choose a mode for this rule, select Enforce.
  22. Enable the option Defer the message if rule processing doesn’t complete.
    Warning
    When this option is enabled, a message (regardless of whether it comes from HiX or Outlook) will only be sent after it has been checked against this rule. If Exchange temporarily fails to check messages, sending will be paused.
  23. Click .
  24. Check that the priority of the newly created rule is correct. Adjust if necessary to ensure that the different rules have the intended effect.
  25. Activate the rule.

The rule is now configured and active. All sent messages are checked and, depending on the subject, routed to the mail contact with the fictitious domain. The Send Connector intercepts all messages to this fictitious domain and then sends them via the SMTP connection to the Zivver SMTP server.

Use a mail server to securely send certain types of messages

This chapter explains how to set up an SMTP connection with Zivver on a mail server.

Tip
Use this option if you want to securely send only certain types of messages (e.g., appointment confirmations) from HiX. If you want to securely send all messages from HiX, see Use a mail server to securely send all messages.
Note
Does your organization use Exchange Online (Office 365)? Then you need a different mail server, because in Exchange Online it is not possible to authenticate the connection to smtp.zivver.com using a username and password.

Deploying an additional mail server alongside Exchange Online

With Exchange Online, you need an additional mail server to authenticate the SMTP connection to smtp.zivver.com using a username and password. This additional mail server filters messages from HiX, allowing you to determine which types of messages (e.g., appointment confirmations) are sent securely via Zivver, while regular message traffic is not sent through Zivver.

Messages from HiX then follow one of the routes below:

  1. HiX > Additional mail server > smtp.zivver.com > Recipient (secure message)
  2. HiX > Additional mail server > Exchange Online > Recipient (regular message)

To enable these routes, set up the following two SMTP connections on the additional mail server:

  1. An SMTP connection that sends certain types of messages (e.g., appointment confirmations) securely via smtp.zivver.com.
  2. An SMTP connection that sends all other messages via Exchange Online (Office 365).

In the following sections, we will show how to configure an additional mail server.

Setting up the SMTP connection

Use the following information to set up the SMTP connection with Zivver on your mail server:

Note
Refer to your mail server’s documentation to learn how to set up an SMTP connection.
  • SMTP server: smtp.zivver.com
  • SMTP port: 587
  • TLS: Yes, v1.2 with STARTTLS
  • SMTP authentication: Yes, using a username and password.
  • For username, enter the SMTP username from the chapter Mail submission instellen in Zivver.
    Warning
    Do not enter a Zivver account email address here.
  • For password, enter the SMTP password from the chapter Mail submission instellen in Zivver.
    Warning
    Do not enter a Zivver account password here.

Setting up the SMTP connection in hMailServer

In this chapter, we use hMailServer as the mail server. This is a free, open-source mail server for Microsoft Windows, which allows you to set up multiple SMTP connections and filters.

Follow the steps below to set up an SMTP connection with Zivver in hMailServer:

  1. Open hMailServer Administrator.
  2. Select the mail server.
  3. Click Connect.
  4. Enter the password.
  5. Click Settings.
  6. Click Protocols.
  7. Click SMTP.
  8. Click Routes.
  9. Click Add.
  10. Enter Zivver in Domain.
  11. Enter smtp.zivver.com in Target SMTP host.
  12. Enter 587 in TCP/IP port.
  13. For Connection security, select STARTTLS (Required).
  14. For When sender matches route, treat sender as, select A local email address.
  15. For When recipient matches route, treat recipient as, select A local email address.
  16. Go to the Delivery tab.
  17. Enable Server requires authentication.
  18. Enter the SMTP username from the chapter Mail submission instellen in Zivver under User name.
    Warning
    Do not enter a Zivver account email address here.
  19. Enter the SMTP password from the chapter Mail submission instellen in Zivver under Password.
    Warning
    Do not enter a Zivver account password here.
  20. Click Save.

The SMTP connection with Zivver is now set up. Repeat these steps to set up a second SMTP connection with your own mail server (e.g., Office 365).

Setting up a filter

In this section, we use hMailServer as the mail server. This is a free, open-source mail server for Microsoft Windows that allows you to set up multiple SMTP connections and filters.

Note
Not using hMailServer? Refer to your mail server’s documentation to learn how to filter messages.

The steps below use an example filter that checks the subject. If the subject of the message contains Afspraakbevestiging, the message will be sent securely.

  1. Open hMailServer Administrator.
  2. Select the mail server.
  3. Click Connect.
  4. Enter the password.
  5. Go to Rules.
  6. Click Add.
  7. Enter a name.
    For example: Send HiX appointment confirmation via Zivver.
  8. Enable Enabled.
  9. Under Criteria, click Add.
  10. Select the option Predefined field.
  11. Select Subject.
  12. For Search type, select Equals.
  13. Enter Afspraakbevestiging under Value.
  14. Click OK.
  15. Under Actions, click Add.
  16. Select the option Send using route.
  17. Select the option Zivver.
  18. Click OK.
  19. Click OK.

The filter is now set up and activated. All outgoing messages will now be checked and, depending on the subject, sent securely via Zivver.

Modifying an email report definition

Follow the steps below to make a HiX email report definition suitable for secure emailing:

Tip
Always test the steps below first in the acceptance environment before configuring them in the production environment.
Warning

smtp.zivver.com will only accept the message if:

  1. A Zivver account exists for the default sender.
    Check this on the account page.
  2. This Zivver account is a member of the Zivver organization for which the SMTP credentials were generated.
  1. Open HiX.
  2. Go to CS-Overzichtsgenerator.
  3. Open an existing email report definition.
  4. Ensure that Rapportage type has the option Emailen enabled.
  5. Enter the sender’s email address in lowercase.
  6. Enter a recipient. For example, the patient’s email address using the following expression: =[Context]Patient(Emailadres).
  7. Optional: see Bericht extra beveiligen met 2FA to secure the message further with an SMS code or access code.
  8. Optional: see Bericht automatisch intrekken na de vervaldatum to automatically retract the message after the expiration date for the recipient or both sender and recipient.
  9. Click OK.

Repeat the steps above for each email report definition you want to use for secure emailing.

Securing a message with 2FA

This functionality is optional. Secure the message with an SMS code or access code. The recipient can only read the message after entering the SMS code or access code. This ensures that only the intended recipient can access the message.

This can be done by providing the recipient’s mobile number, by setting the patient number as an access code, or by using a combination of SMS codes and patient numbers. Zivver uses this information to secure the message further. The mobile number and access code are not visible to the recipient, as these details are included as comments in the email report definition.

Securing with an SMS code

Include the patient’s mobile number in the message. Add the following code to the email report definition. The location of this code in the message does not matter.

Download expression to secure Zivver messages with SMS code

Securing with an access code

Include the patient number in the message as an access code. Add the following code to the email report definition. The location of this code in the message does not matter.

Download expression to secure Zivver messages with access code

Securing with an SMS code or access code

Include the patient’s mobile number in the message, or use the patient number as an access code if the mobile number is not available. Add the following code to the email report definition. The location of this code in the message does not matter.

Download expression to secure Zivver messages with SMS code or access code

Automatically retract message after expiration date

This functionality is optional. Set an expiration date after which the message can no longer be read by the recipient or by sender and recipient. This setting is not visible to the recipient, as these details are included as comments in the email report definition. See below how to configure this in an email report definition.

Message no longer readable by recipient after expiration date

In this example, the message is set to expire 30 days after sending and can no longer be read by the recipient. Add the following code to the email report definition. The location of this code in the message does not matter.

Download expression to make Zivver messages expire after 30 days for the recipient

Message no longer readable by sender and recipient after expiration date

In this example, the message is set to expire six months (178 days) after sending and can no longer be read by the sender and recipient. Add the following code to the email report definition. The location of this code in the message does not matter.

Download expression to make Zivver messages expire after 178 days for the sender and recipient