# Configure Health Canada Gateway

Set up a Safety Health Canada Gateway profile and Transmission Profiles to support clinical trial and postmarket electronic submissions to Health Canada.


<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: 
With the 23R3 release, Veeva Safety <em>AS2 Connections</em> replace Safety Gateways. <em>AS2 Connections</em> provide significant technical improvements including Admin management of Internet Protocol (IP) lists, more concise outbound IP lists, and improved Certificate Management. Though Gateways are still supported, we recommend configuring your Vault to use an
<a href="/en/gr/01453/">Health Canada AS2 Connection</a>
instead of the Health Canada Gateway.</p>
    </div>
  </div>
</div>



## About Safety Health Canada Gateway Integration

Safety supports electronic submissions to Health Canada (HC) through AS2 (system-to-system) communication. Safety supports clinical trial and postmarket electronic submissions to Health Canada's Canada Vigilance Program (CVP).

Once the gateway and transmission profiles are configured, you can transmit ICSRs to Health Canada using the <a href="/en/gr/01288/#hc-e2b-r2">HC E2B (R2)</a> XML document format on a Submission.

## Prerequisites

Ensure your Vault has the following configuration before you configure electronic submissions to Health Canada:

* The Transmission Profile with the API Name `hc_cvp__v` should be named **HC MHPD**, with a Destination ID of "MHPDVAL". This Transmission Profile was originally named **HC CVP**, but the Transmission Profile must be renamed and the Destination ID updated as a result a second profile added in 22R1.
* To allow users to manually specify a value for the Message Type (M.1.1) E2B data element when preparing a Submission to Health Canada, add the **Message Type (HC)** (`message_type_hc__v`) field to the Submission layout.
* The Health Canada Agency must be in the Active state. Health Canada is a standard Agency provided with Safety. However, in certain Vaults, an Admin must [activate the Agency record][2].

### <a id="activate"></a>Activate the Health Canada Organization

Health Canada comes preconfigured in each Vault as a standard Organization. In certain Vaults, an admin must make the Agency active. Complete the following steps if Health Canada is inactive in your Vault:

1. Go to **Business Admin > Organizations**.
2. Open the **Health Canada** Agency record.
3. Select the **All Actions** menu.
4. Select **Change State to Active**.

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: The <strong>Change State to Active</strong> user action will only appear if it has been configured in your Vault. <a href="/en/gr/01433/#add-user-action-to-the-organization-lifecycle-inactive-state">Add User Action to the Organization Lifecycle Inactive State</a> provides instructions for this configuration.</p>
    </div>
  </div>
</div>



## Configure a Health Canada CVP AS2 Account

Before you can configure the Safety Gateway Profile, you must have an active Health Canada CVP AS2 account. When you configure your account, ensure that the AS2 URL exactly matches the Vault AS2 URL for your Vault.

### Public and Private Certificates

As part of the Health Canada registration process, you must obtain a public and private certificate pair and send the public certificate to Health Canada. If you need help generating these certificates, contact your Veeva Representative.

### Copy Your Vault AS2 URL 

1. Go to **Admin > Settings > Gateway Profiles**.
2. Open the **HC CVP** Gateway Profile.
3. Under **Vault AS2 URL**, select **Copy URL**.

## Configure Sender User

For Submissions to Health Canada, you must enter full contact details for the Sender User. This user's information will appear in generated forms and E2B files. The Sender User is assigned on Submission records in the **Sender (User)** field.

<a href="/en/gr/01274/">Managing Roles & Security in Safety</a> provides more information on setting up user contact details. 

An Admin can [configure the Health Canada Transmission Profile][1] to populate this field with a default Sender User on system generated transmissions based on the Transmission Profile.


## Configure the Safety Gateway Profile 

Vault comes provisioned with an inactive standard profile for the HC CVP. In order for users to send Submissions to the HC CVP, you must configure and activate the appropriate Gateway Profile by completing the following steps:

1. In the **Admin** area, go to the **Settings** tab.
2. In the left pane, select **Gateway Profiles**.
3. Open the **HC CVP** Gateway Profile and select **Edit**. The profile page is unlocked for editing.
4. Under **Details**, in the **Sponsor Email Address** field, enter the Vault user email address to be used as a contact in gateway transmissions.
5. Under **AS2 Profile Configuration**, complete the following fields:
    * **Vault AS2 URL**: This field is read-only. Verify that the DNS configured in the Health Canada account exactly matches the URL in this field.
    * **Sponsor Certificate**: Select **Choose**, and then open the private encryption certificate used to register with Health Canada. The private certificate is usually a PFX file.
    * **Sponsor Certificate Password**: Enter the password for the sponsor certificate.
    * **Sponsor ID**: Enter the sponsor ID registered with Health Canada.
    * **Health Authority Certificate**: Select **Choose**, and then open the public encryption certificate received from Health Canada during account setup. The public certificate is usually a P7B file.
    * **Health Authority ID**: Enter the appropriate Health Canada identification code.
    * **Health Authority URL**: Enter the destination Health Canada Gateway URL.
    * **Gateway User**: Select the Safety user whose name should appear in audit logs and gateway transactions.
6. Select **Save**.
7. To activate the profile, on the top-right corner, select **Set Active**.

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: The <strong>Gateway User Required</strong> checkbox is automatically populated by the system and is informational only.</p>
    </div>
  </div>
</div>



**Result** 

The HC CVP Gateway Profile is active and available to use to submit case reports to Health Canada. 

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: Because Health Canada does not allow testing with 3rd party vendors, their gateway has not been vendor tested with Safety. You must perform additional testing when setting up Health Canada electronic submissions.</p>
    </div>
  </div>
</div>



## Add a Submission Rule Set

Safety comes preconfigured with Health Canada as a Standard Organization. To define case criteria for submissions to the HC CVP Gateway, add a Submission Rule Set to the organization by completing the following steps:

1. Go to **Business Admin > Objects > Organizations**.
2. On the **Organizations** page, select **Health Canada**.
3. On the **Health Canada** page, select **Edit**.
4. Under **Details**, in the **Submission Rules** field, select a standard rule set from the dropdown.
5. Select **Save**.

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: <a href="/en/gr/01252/">Standard Reporting Rule Sets</a> provides more information about the available rule sets. If you require <em>Safety Rule Sets</em> beyond the standard ones supplied, your Admin can <a href="/en/gr/873466/">create and configure additional rule sets</a>.</p>
    </div>
  </div>
</div>



**Result**

Vault will now be able to auto-generate <strong>Submission</strong> records for ICSR submissions to Health Canada based on the rule set you selected.

## <a id="configure-the-health-canada-transmission-profile"></a>Configure Health Canada Transmission Profiles

Safety comes with standard, system-provided Transmission Profiles for Health Canada Submissions. You must configure these Transmission Profiles as part of the Health Canada gateway setup.

The following table lists the system-provided Health Canada Transmission Profiles:

<table>
    <thead>
        <tr>
            <th>Transmission Profile</th>
            <th>Usage</th> 
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>HC MHPD</td>
            <td>For submitting postmarket reports to the Health Canada's Marketed Health Products Directorate (MHPD).</td>
        </tr>
        <tr>
            <td>HC TPD</td>
            <td>For submitting clinical trial reports to the Health Canada's Therapeutic Products Directorate (TPD).</td>
        </tr>
    </tbody>
</table>

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: The <strong>HC MHPD</strong> Transmission Profile was originally named <strong>HC CVP</strong>, but the Transmission Profile was renamed and the Destination ID updated as a result of a second profile added in 22R1.</p>
    </div>
  </div>
</div>



<a href="/en/gr/01202/">Manage Transmission Profiles</a> provides instructions on setting up Transmission Profiles.

When setting up the Transmission Profiles, see the following guidance on setting the Origin and Destination IDs:

* **Origin ID**: Enter the Sponsor ID registered with Health Canada.
* **Destination ID**: Enter the Destination ID for the Health Canada gateway. You can specify one of the following IDs:

<table>
    <tr>
        <th>Transmission Profile</th>
        <th>Supported Destination IDs</th>
        <th>Description</th>
    </tr>
    <tr>
        <td rowspan="2">HC MHPD</td>
        <td><code>MHPD</code></td>
        <td>For postmarket reports being sent to the production gateway.</td>
     </tr>
    <tr>
        <td><code>MHPDVAL</code></td>
        <td>For postmarket reports being sent to the validation gateway.</td>
    </tr>
    <tr>
        <td rowspan="2">HC TPD</td>
        <td><code>TPD</code></td>
        <td>For clinical trial reports being sent to the production gateway.</td>
    </tr>
    <tr>
        <td><code>TPDVAL</code></td>
        <td>For clinical trial reports being sent to the validation gateway.</td>
    </tr>

</table>

Once you set up the Health Canada Transmission Profiles, the system uses the appropriate Transmission Profile to generate Submissions based on your Vault's <a href="/en/gr/01252/">reporting rules</a> for Health Canada.

[1]: #configure-the-health-canada-transmission-profile
[2]: #activate