22R2 Safety Template Revisions

Vault Safety template revisions include changes to Vault configuration for general usability improvements. Template revisions are not automatically rolled out to existing customers.

New Vaults created in 22R2 or later will have the following settings by default. Vaults created in an earlier release can optionally be updated to match these changes. The sections on this page provide the instructions to enable these changes.

This page does not cover how to update your template to support new features. The What’s New in 22R2 page outlines which features require configuration upgrades, and provides links to enablement instructions for each feature.

Configure Standard and Custom Tabs for Safety Suite Manifest Update

Configuration updates have been made to the 22R2 template for manifestation support. These configuration changes are documented in Enable Safety Suite Manifest Update and Tabs.

Update Create Document Action for Literature Documents

Perform the following steps to include literature documents in outbound E2B transmissions for a Case by default, if applicable:

  1. In the Admin area, go to Configuration > Document Lifecycles > Case Source Lifecycle.
  2. In the Event Actions tab, select Create Action.
  3. Create an event action using the following image:

    Literature Documents Create Document Action for Retransmit Field

Rename the Expectedness Section for Case Assessments

Since the “Expectedness (Local Datasheets)” section in Case Assessments will now include Core Datasheets as well, follow the steps below to rename the section:

  1. Go to Configuration > Objects > Case Assessment.
  2. In the Page Layouts tab, go to the Case Assessment Detail Page Layout.
  3. Update the “Expectedness (Local Datasheets)” section with the following information:
    • Section Label: Expectedness
    • Section Name: expectedness__c

Create an Inbox Item - Reject Workflow

The following configuration was added to allow customers to provide a reason when rejecting an Inbox Item:

  1. Go to Configuration > Workflows.
  2. Create an Object Workflow.
  3. Complete the Create Workflow Details section with the following information and save the page:
    • Label: Inbox Item - Reject
    • Name: inbox_item_reject__c
    • Lifecycle: Inbox Item Lifecycle
  4. Update the Start step with the following information:
    • Next Steps: Create Step > Task: Reject
  5. Complete the Task: Reject step using the following information and images:
    • Next Steps: Create Step > SC
    • Task Label: Reject
    • Assign Task To: Workflow Owner
    • Instructions: Please provide a reason for rejecting Inbox Item ${Object.name__v}.
    • Task Requirement: Required

    • Due Date: Workflow Start Date > + 1 Days
      Create Reject Task Step for Inbox Item - Reject Workflow (1)

    • Prompts:
      • Verdict Label: Reject Inbox Item
      • Prompt for Comments: Comments
      • Reasons Label: Rejection Reason
      • Reason Values:
        • Non-company product
        • Missing Patient Information
        • Missing Reporter Information
        • No Adverse Event
        • Other - Provide Comment
      • Verdict Label: Back to New
        Create Reject Task Step for Inbox Item - Reject Workflow (2)

  6. Complete the SC (state change) workflow step using the following image:
    Create SC (State Change) Action Step for Inbox Item - Reject Workflow

  7. Ensure your workflow matches the following image and then select Make configuration active:
    Inbox Item - Reject Workflow

  8. To add the workflow action, go to Configuration > Object Lifecycles > Inbox Item Lifecycle > New state.
  9. Replace the Change state to Rejected user action using the image below:
    Add Inbox Item - Reject User Action on Inbox Item Lifecycle

Create a Protected Renditions Profile for CIOMS and FDA 3500A

The following configuration was added to support the generation of protected viewable renditions for CIOMS and FDA 3500A. This ensures that downloaded CIOMS I and 3500A renditions cannot be edited.

Part 1: Create a New Rendition Profile

  1. Go to Configuration > Rendition Profiles.
  2. Create a new Rendition Profile using the following image:
    Rendition Profile with Protection

Part 2: Add Event Action to Case Generated Document Lifecycle

  1. Go to Configuration > Document Lifecycles > Case Generated Document Lifecycle.
  2. In the Event Actions tab, select Create Document.
  3. Create an Event Action using the following image:
    Create Document Set Rendition Profile Event Action

Part 3: Add the Protected Rendition Profile Shared Field to the Case > ICSR Document Type

  1. Go to Configuration > Document Fields.
  2. Go to the Case > Individual Case Safety Reports (ICSR) document type.
  3. Select Add > Existing Shared Field > Rendition Profile (rendition_profile__v).

Create a Case Number Lookup Field for Inbox Items

Perform the following steps to add a Case Number lookup field for Inbox Items so that all Inbox Items for a given Case appear on the Case Number. This allows users to see all the Inbox Items that went into all versions of a Case.

Part 1: Create the Case Number Lookup Field for Inbox Items

  1. Go to Configuration > Objects > Inbox Item.
  2. In the Fields tab, create a field using the following image:
    Create Case Number Lookup Field for Inbox Items

Part 2: Remove the Case Number Field from the Inbox Item Page Layout

  1. In the Page Layouts tab, go to Inbox Item Detail Page Layout.
  2. In the Organization and Region section, remove Case Number.

Part 3: Update the Case Number Page Layout

  1. Go to Objects > Case Number > Case Number Detail Page Layout.

  2. Add a Related Object Section using the following image:
    Add Related Inbox Item Object Section to Case Number

  3. Move the Inbox Item section between the Case Versions and the Workflow Timeline sections.
  4. Edit the Inbox Item section columns to include:
    • Name
    • Lifecycle State
    • Case
    • Priority
    • New Info Date
    • Source Document

Create a Case Test Result Icon

The following configuration was added to promptly determine whether a Case Test Result is outside the normal high or normal low range using an icon:

Part 1: Create a Formula Field for the Case Test Result Object

  1. Go to Configuration > Objects > Case Test Result.
  2. In the Fields tab, create a new field using the following information:
    • Step 1: Formula
    • Label: I
    • Name: icon__c
    • Status: Active
    • Select Display in default lists and hovercards
    • Return Type: Icon
    • Set Default Value:
      If(And(Or(isBlank(normal_low_value__v),isBlank(result_value__v),
      result_value__v>value(normal_low_value__v)),Or(isBlank(normal_high_value__v),
      isBlank(result_value__v),result_value__v<value(normal_high_value__v))),
      null,icon("exclamation-triangle", "#ff0000", "Out of normal range"))
      • Select Show in Header

Part 2: Add the Formula Field to the Case Page Layout

  1. Go to Configuration > Objects > Case > Case Page Layout.
  2. In the Test Results section, add the I column between the Result (Unit) and Normal High Value columns.
    Formula Column on Case Test Results Section

Create a Case Nullification Workflow for the Case Lifecycle

The following configuration was added to make nullifying a Case more accessible to users. Perform the steps below to create a Case nullification workflow and add a Case nullification entry action.

Part 1: Create the Nullify Case Workflow

  1. Go to Configuration > Workflows.
  2. Create an Object Workflow.
  3. Complete the Create Workflow Details section with the following information and save the page:
    • Label: Nullify Case
    • Name: nullify_case__c
    • Lifecycle: Case Lifecycle
  4. Edit the Start step with the following information:
    • Next Steps: Create Step > Case Nullification
    • Start Options:
      Nullify Case Start Step: Start Options

  5. Edit the Case Nullification workflow step:
    Nullify Case Case Nullification Step (1)
    Nullify Case Case Nullification Step (2)

  6. Edit the Change State: Nullified step:
    Nullify Case Change State: Nullified Step

  7. Ensure your workflow matches the following image and then select Make configuration active:
    Nullify Case Workflow

Part 2: Update the Case Lifecycle Entry Actions, User Actions, and Permissions

  1. Go to Configuration > Object Lifecycles > Case Lifecycle.
  2. Select the Nullifying state.

  3. Update the Entry Actions using the following image:
    Nullify Case Entry Action

  4. In the Data Entry state, add the following User Action using the image below:
    Add Void Case User Action to Data Entry State

  5. Repeat step 4 for the following states:
    • Medical Review
    • QC
    • Revision
    • Triage
    • Unblinded
  6. Edit the Case Lifecycle > Roles.
  7. Remove Read permission for the Nullified and Voided states for the following Case Roles:
    • Data Entry
    • Intake
    • Medical Coder
    • Medical Reviewer
    • QC
    • Safety Writer
    • Translator

Part 3: Update the Case Voiding Workflow

  1. Go to Configuration > Workflows > Case Voiding.

  2. Ensure the Start step matches the following image:
    Update Case Voiding: Start Step

  3. Ensure the Reason for Voiding step matches the following image:
    Update Case Voiding Workflow: Reason for Voiding Step (1)
    Update Case Voiding Workflow: Reason for Voiding Step (2)

  4. Complete the Decision: Void? step using the following image:
    Case Voiding Workflow: Decision: Void? Step

  5. Complete the SC: Voided step using the following image:
    Case Voiding Workflow: SC: Voided Step

  6. Complete the SC: Triage step using the following image:
    Case Voiding Workflow: SC: Triage Step

  7. Ensure your workflow matches the following image and then select Make configuration active:
    Case Voiding Workflow Updated

Update the Transmission Page Layout for Submission Records

Support for the Health Canada Transmission Profiles and Message Types feature was added to Vault Safety in 22R1. For this release, the Message Type (HC) (message_type_hc__v) field could be added to the Submission page layout by an administrator to allow users to specify the Message Type when preparing a Submission to Health Canada.

The following template configuration was added to include this field on the Submission page layout by default for Vaults created in 22R2 or later. A layout rule was also created to display the field only for the Health Canada destination:

  1. Go to Configuration > Objects > Transmission.
  2. In the Page Layouts tab, go to the Submission Detail Page Layout.
  3. Add the Message Type (HC) (message_type_hc__v) field to the Details section.
  4. Create a Layout Rule for this page layout using the following information:
    • Label: ​​Hide HC Fields
    • Name: hide_hc_fields__c
    • Status: Active
    • Type > Values: Fields > Message Type (HC)
    • IF his Layout Rule Expression is TRUE:
      destination__vr.name__v != 'Health Canada'