23R1 Template Revisions

Learn about system template changes in Vault Safety 23R1.

Last Updated

Note Beginning with 23R3 content and for all subsequent releases, Vault Release Notes is the official site for Vault Safety release notes.

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 23R1 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 23R1 New Features page outlines which features require configuration upgrades, and provides links to enablement instructions for each feature.

Update Localizations Records

Previously, all Localization Types were set to “Local”, except the Global record. As many customers do not require Localization, multiple Localization Types have been updated. You can update this setup based on the process requirements.

Go to Business Admin > Objects > Localization. Ensure the Localization Scope and Localization Type match the recommended setup:

all-localizations-cleanup
Recommended Setup for Localization Records

Update Case Review Workflows for Study and Non-Study Cases

This update simplifies Vault administration. There are no functional changes. Follow the sections below to create separate Case Review workflows for Study and Non-Study Cases:

Once complete, update entry actions for the Case Lifecycle Medical Review state.

Create the Case Review (Post-Market) Workflow

  1. Go to Admin > Configuration > Workflows.
  2. Hover over the Case Review workflow and select the menu-button menu > Copy.
    A Copy Object Workflow window appears
  3. Update the Label to “Case Review (post-market)” and then select Copy.
  4. In the Case Review (post-market) workflow, perform the following updates to obtain the modified workflow as shown:
    Case Review (post-market) Workflow: Remove Rules in Serous and Unexpected? Step
    Case Review (post-market) Workflow
    1. Go to the Serious and Unexpected? decision step and remove the following rules:
      remove-rules-serious-unexpected-case-review-post-market
      Case Review (post-market) Workflow: Remove Rules in Serous and Unexpected? Step
    2. Delete the following steps by hovering over them and selecting the menu-button menu > Delete:
      • Study? decision
      • Study Blinded? decision
      • Case Unblinded? decision
      • Open Arm? decision
      • Unblind? decision
      • Medical Review (Blinded) task
      • Medical Review (Not Blinded) task
      • Medical Review (Not Blinded) task
      • Set Expedited = No update record field step
      • Start Unblinding state change

      Note You must remove these steps in the provided order as some steps are dependent on others.

    3. Select the Start step and update the Next Steps to Medical Review.
  5. Select Make configuration active.

Create the Case Review (Study) Workflow

  1. Go to the Case Review workflow.
  2. Update the Label to “Case Review (study)”.
  3. Perform the following updates on the existing Case Review workflow to obtain the modified workflow as shown:
    case-review-study-workflow
    Case Review (study) Workflow
    1. Hover over the Study? decision. Select the menu-button menu > Delete.
    2. Select Start and update the Next Steps to Study Blinded?
    3. Select the Serious and Unexpected? decision. Remove the following rules:
      remove-rules-serious-unexpected-case-review-study
      Case Review (study) Workflow: Remove Rules in Serous and Unexpected? Step
    4. Hover over the Medical Review task. Select the menu-button menu > Delete.
    5. Hover over the Set Expected = Yes update record field step. Select the menu-button menu > Delete.
  4. Select Make configuration active.

Update Entry Actions for the Case Lifecycle Medical Review State

This configuration ensures that Cases cannot go to Medical Review with major validation failures.

  1. Go to Admin > Configuration > Object Lifecycles > Case Lifecycle > Medical Review state.
  2. Update the Entry Actions as shown:
    case-lifecycle-medical-review-entry-actions
    Case Lifecycle Medical Review Entry Actions
  3. Save the page.

Remove the Narrative Document Lifecycle State Change from the Case Triage State

Perform the following steps to remove the narrative document lifecycle state change entry action from the Case lifecycle Triage state:

  1. Go to Admin > Configuration > Object Lifecycles > Case Lifecycle.
  2. Select the Triage (triage_state__v) state.
  3. Remove the following entry action:
    remove-case-narrative-lc-entry-action-case-triage
    Remove Narrative Document Lifecycle State Change Entry Action on Case Triage State
  4. Save the page.

Remove Inactive Inbox Item Page Layout

Follow the steps below to remove an inactive Inbox Item page layout:

  1. Go to Admin > Configuration > Objects > Inbox Item > Page Layouts.
  2. Hover over the Hide Organization (Manual Creation) (hide_organization_manual_creation__c) page layout and select the menu-button menu > Delete.

Update Case Lifecycle Entry Actions and Narrative Lifecycle Entry Criteria

This configuration enhances the overall Case processing experience. It is important to consider your specific business needs.

Perform the steps in the sections below to update the Case and Narrative lifecycles, respectively:

Update Entry Actions for the Case Lifecycle QC State

  1. Go to Admin > Configuration > Object Lifecycles > Case Lifecycle > QC State.
  2. Update the entry actions as shown:
    entry-actions-case-lifecycle-qc
    Case Lifecycle QC State Entry Actions
  3. Save the page.

Add Entry Criteria for the Narrative Document Lifecycle Review State

  1. Go to Admin > Configuration > Document Lifecycles > Narrative Lifecycle > States > Review (review__v).
  2. In the Review state, go to the Entry Criteria tab.
  3. Add the following entry criteria as shown:
    entry-criteria-narrative-lifecycle-review
    Narrative Lifecycle Review State Entry Criteria
  4. Save the page.

Remove Highlighted Term Layout Rule

This configuration removes the Highlighted Term (highlighted_term__c) layout rule on the Case Adverse Event object so that the Highlighted Term is always visible.

  1. Go to Admin > Configuration > Objects > Case Adverse Event > Page Layouts > Case Adverse Event Detail Page Layout > Layout Rules.
  2. Hover over the Highlighted Term (highlighted_term__c) layout rule and select the menu-button menu > Delete.

Upload an Updated Summary ADR from Postmarketing Sources Template

Due to an Excel limitation, the header of the PBRER Summary ADR from Postmarketing Sources is cut off. Follow the steps below to upload an updated template file with the full header:

  1. Go to Vault Safety Help Configure Aggregate Report Templates: Standard Table Templates and download the following file:
    safety-help-pbrer-summary-adr-postmarketing-sources-download
    Vault Safety Help PBRER Summary ADR from Postmarketing Sources Download
  2. Go to Business Admin > Templates > Documents & Binder Templates.
  3. Go to Template > Aggregate Summary Tabulation > Summary ADR from Postmarketing Sources.
  4. Select Summary ADR from Postmarketing Sources to edit.
  5. Select Upload File and find the file you want to upload.
  6. Save the page.

Add the Last Modified Date to the Aggregate Report Page Layout

The Last Modified Date can be useful for troubleshooting issues with aggregate reports. Perform the following steps to add the Last Modified Date to the Aggregate Report page layout:

  1. Go to Admin > Configuration > Objects > Aggregate Report > Page Layouts > Aggregate Report Detail Page Layout.
  2. In the Documents section, select Edit Columns.
  3. Add the Last Modified Date column.
  4. Save the page.

Update Filter Aliases in SMQ/CMQ Reports

Four (4) system reports were unable to display variable filter criteria in the output. This configuration updates the filter alias values for these reports as shown by the table below:

REPORT FILTER OLD FILTER ALIAS REPLACEMENT FILTER ALIAS
Sample SMQ/CMQ Search by Product using Root Query Case > Organization Organization Organization equals {#####}
Case > Product Primary Suspect Product Primary Suspect Product equals {#####}
MedDRA Query > Root Query Root-Level SMQ/CMQ Root-Level SMQ/CMQ equals {#####}
MedDRA Criteria > Scope Query Scope Query Scope in {#####}
Sample SMQ/CMQ Search by Product across Multiple Queries Case > Organization Organization Organization equals {#####}
Case > Product Primary Suspect Product Primary Suspect Product equals {#####}
MedDRA Criteria > MedDRA Query SMQ/CMQs SMQ/CMQs in {#####}
MedDRA Criteria > Scope Query Scope Query Scope in {#####}
Sample SMQ/CMQ Search by Study using Root Query Case > Organization Organization Organization equals {#####}
Case > Study Study Study equals {#####}
MedDRA Query > Root Query Root-Level SMQ/CMQ Root-Level SMQ/CMQ equals {#####}
MedDRA Criteria > Scope Query Scope Query Scope in {#####}
Sample SMQ/CMQ Search by Study across Multiple Queries Case > Organization Organization Organization equals {#####}
Case > Study Study Study equals {#####}
MedDRA Criteria > MedDRA Query SMQ/CMQs SMQ/CMQs in {#####}
MedDRA Criteria > Scope Query Scope Query Scope in {#####}
  1. On the user side of Vault, go to Analytics > Reports.
  2. Select one of the above reports.
    A Select Report Values window appears.
  3. Complete the information in the window:
    • Organization: Select the Organization for the report.
    • Study: Select the Study for the report.
    • Root-Level SMQ/CMQ: Select a root query.
    • Query Scope: Select whether the scope is Broad or Narrow.
  4. Select the edit-icon icon.
  5. Perform the Filter Alias updates as described in the table above.
  6. Select Run.
  7. Save the page.
  8. Repeat steps 2-5 for the remaining reports.

Update Case Triage and Data Entry Workflows

This configuration supports customers who do not need both a Case Triage and Case Entry workflow. This configuration also ensures all Cases (both E2B and non-E2B) go through the data entry workflow.

Update the Case Lifecycle

Perform the following steps to update the Case lifecycle Data Entry state (case_entry_state__v) Label as well as the Triage state (triage_state__v):

  • Label
  • Entry Actions
  • User Actions
  1. Go to Admin > Configuration > Objects Lifecycles > Case Lifecycle > Triage (triage_state__v) state.
  2. Update the State Label to “Data Entry (Initial)”.
  3. Update the Data Entry (Initial) entry actions as shown:
    entry-actions-case-lifecycle-data-entry-initial
    Case Lifecycle Data Entry (Initial) State Entry Actions
  4. Update the Data Entry (Initial) user actions as shown:
    user-actions-case-lifecycle-data-entry-initial
    Case Lifecycle Data Entry (Initial) State User Action
  5. Go to the Data Entry (case_entry_state__v) state and update the Label to “Data Entry (Reopened)”.
  6. Save the page.

Deprecate or Delete the Case Triage Workflow

Perform the following steps to deprecate the Case Triage workflow:

  1. Go to Admin > Configuration > Workflows > Case Triage (case_triage__c).
  2. Update the Label to “(Deprecated) Case Triage”.
  3. Save the page.
  4. Select Make configuration active.

To completely delete the Case Triage workflow:

  1. Go to Configuration > Workflows.
  2. Hover over the Case Triage (case_triage__c) workflow and select the menu-button menu > Delete.

Update the Case Entry Workflow

Perform the following steps to modify the existing Case Entry workflow as shown:

case-entry-workflow-updated
Case Entry Workflow
  1. Go to Admin > Configuration > Workflows > Case Entry.
  2. Remove the following steps:
    • E2B? decision
    • DME and Non-Serious? decision
    • Seriousness Required task
  3. Select Start and update the Next Steps to Case Entry.
  4. Select Start QC and update the Label to “State Change: QC”.
  5. Select Case Entry and update the Next Steps to State Change: QC.
  6. Select Requires Medical Review and update the Rules as shown below:
    requires-medical-review-decision-case-entry-wf
    Case Entry Workflow Requires Medical Review Decision Rules
  7. Select Make configuration active.

Remove the Malfunction Only Field from the Case Page Layout

This configuration is for the Remedial Actions and Malfunction for Combination Products feature. Perform the following steps to remove the Malfunction Only (malfuncion_only__v) field from the Case page layout, since Device Report Type is used to indicate malfunction on device-type Case Products:

  1. Go to Admin > Configuration > Objects > Case > Page Layouts > Case Page Layout.
  2. In the Device Details section, remove the Malfunction Only field.
  3. Save the page.

Create the All Transmissions Tab

This configuration allows distribution managers to manage all outbound Submissions more easily.

Perform the following steps to create the All Transmissions (all_transmissions__c) tab:

  1. Go to Admin > Configuration > Tabs.
  2. Create a new tab as shown below:
    all-transmissions-tab
    All Transmissions Tab
  3. Save the page.
  4. Select Reorder and move the All Transmissions tab after the Localized Cases tab.
  5. Save the page.

Activate PADER and PSUR Tabs

This change allows new customers to generate PADER and PSUR tabulations without having to enable the feature.

Perform the following steps to activate the PADER and PSUR tabs:

  1. Go to Admin > Configuration > Tabs.
  2. Go to Aggregate Reports > PADER.
  3. Update the Status to Active.
  4. Repeat step 3 for Aggregate Reports > PSUR.

Update Transmission Lifecycle Entry Actions

This configuration ensures a correction workflow will automatically start for Transmissions that enter the MDN Failure state.

Perform the following steps to update the entry actions for the Transmission lifecycle:

  1. Go to Admin > Configuration > Object Lifecycles > Transmission Lifecycle.
  2. Select the MDN Failure state.
  3. Update the entry actions as shown:
    transmission-lc-mdn-failure-entry-actions
    Transmission Lifecycle MDN Failure State Entry Actions
  4. Select the MDN Received state.
  5. Update the user actions as shown:
    transmission-lc-mdn-received-user-actions
    Transmission Lifecycle MDN Received User Actions
  6. Remove the Send a notification entry action for the following Transmission lifecycle states:
    • MDN Received
    • E2B ACK Accepted
    • E2B ACK Warning
  7. Save the page.

Update Case Serious Field Formula

This configuration ensures that the Serious field is accurately calculated by considering the multiple ways a Case can be tagged as serious.

  1. Go to Admin > Configuration > Objects > Case > Fields > Serious.
  2. Edit the Formula Expression to 
    Or(Not(IsBlank(case_tags__v)),Not(IsBlank(watchlist_tags__v)))
  3. Save the page.

Inactivate the Study Cases Rule

The Study and Study Registration sections do not appear on Cases if there are no studies in the Library. You do not need to maintain business partner studies, however, if a Case contains the primary Product on a Partner Distribution List, users are still unable to see the entire Study section, which impacts ICSR reporting to agencies.

Perform the following steps to inactivate the Study Cases Rule, which hides the Study and Study Registration sections:

  1. Go to Admin > Configuration > Objects > Cases > Page Layouts > Case Page Layout > Layout Rules.
  2. Select the Study Cases Rule.
  3. Edit the Status field to Inactive.
  4. Save the page.

Replace Medical History Text App Control

Perform the following steps to replace the Medical History Text app control, which combines the current Medical History Text app control field with the Medical History Text (reason omitted) field:

  1. Go to Admin > Configuration > Objects > Case > Page Layouts > Case Page Layout.
  2. In the Patient section, add the new Medical History Text app control field.
    The Add Medical History Text window appears.
  3. Select Done in the window.
  4. Remove the old Medical History Text field from the Patient section as shown:
    replace-old-medical-history-text-field
    Remove Old Medical History Text Field
  5. Save the page.

Make Auto-Calculated Fields Read-Only

This configuration makes some auto-calculated fields read-only on the Case Entry Actions permission set.

  1. Go to Admin > Users & Groups > Permission Sets > Case Entry Actions > Objects.
  2. Select Case.
  3. Clear the Edit checkbox for the following fields:
    • Expected (status)
    • Expectedness
    • Listedness (Core)
    • Listedness (status)
    • Seriousness
  4. Save the page.

Make the Study Type Required for Studies

This configuration makes the Study Type (study_type__v) field required on the Study object.

  1. Go to Admin > Configuration > Objects > Study > Fields.
  2. Select the Study Type (study_type__v) field.
  3. In the Options section, select the User must always enter a value (required) checkbox.
  4. Save the page.

Move the Create Follow-Up Case User Action to Approved State

This configuration allows the user to create a Follow-up Case when the Case is in Approved state, as opposed to Medical Review state. Perform the following steps to update the Case lifecycle:

  1. Go to Admin > Configuration > Object Lifecycles > Case Lifecycle.
  2. Select the Medical Review state and go to the user actions.
  3. Remove the Create Follow Up Case user action.
  4. Go to the Approved state.
  5. Add the Create Follow Up Case user action as shown:
    case-lifecycle-approved-create-fu-case-user-action
    Case Lifecycle Approved State Add Create Follow Up Case User Action
  6. Save the page.

Add Entry Criteria on the Medical Review State for Validation Failures

This configuration prevents Cases with validation failures from entering the Medical Review state. Performing the following steps to update the Case lifecycle:

  1. Go to Admin > Configuration > Object Lifecycles > Case Lifecycle.
  2. Select the Medical Review state.
  3. Add the entry criteria as shown:
    case-lifecycle-mr-validation-status-entry-criteria
    Case Lifecycle Medical Review State Add Validation Status Entry Criteria
  4. Save the page.

Correct the IMDRF Codes in the Device Code Object

Four (4) IMDRF codes in the Device Code (device_code__v) object were previously incorrect, which led to code exclusions for FDA E2B(R2) files. This configuration makes the necessary corrections for the following IMDRF codes:

IMDRF CODE LEVEL CORRECT CODE
Increase in Suction 1 A14
Difficult or Delayed Separation 2 A1503
Premature Separation 2 A1503
Separation Failure 2 A1503
  1. Go to Business Admin > Objects > Device Codes.
  2. Use the table above to update the respective device codes.
    • For level 1 updates, update the Level 1 - IMDRF Code field.
    • For level 2 updates, update the Level 2 - IMDRF Code field.
  3. Save the page.

Update Controlled Vocabularies

This configuration aligns the label on controlled vocabulary records with the most common values requested in implementation.

Perform the following steps to relabel the EU Method of Assessment controlled vocabulary and create new controlled vocabulary records:

  1. Go to Business Admin > Objects > Controlled Vocabularies.
  2. Select EU Method of Assessment.
  3. Update the Name field to “Global Introspection”.
  4. In the Controlled Vocabularies object, select Create.
  5. Use the table below to create the new records:
    Type Name E2B Code Assessment Result CAUSALITY ESTABLISHED API Name
    Action Taken Drug Temporarily Discontinued/Interrupted 1 N/A N/A drug_temporarily_discontinued__c
    Study Type Investigator-Initiated Study 1 N/A N/A investigator_initiated_ study__c
    Case Assessment Result Related 1 Related Yes related__c
    Case Assessment Result Probably Related 1 Probable / Likely Yes probable__c
    Case Assessment Result Possibly Related 1 Possible Yes possible__c
    Case Assessment Result Unlikely Related 2 Unlikely No unlikely__c
    Case Assessment Result Not Related 2 Not Related No not_related__c
    Case Assessment Result Not applicable 2 Unassessable / Unclassifiable No not_applicable__c
  6. Save the page.

Make Expectedness Required on Datasheet Criteria

This configuration ensures that datasheets are set up more reliably.

Perform the following steps to make Expectedness required on the Datasheet Criteria object type:

  1. Go to Admin > Configuration > Objects > MedDRA Criteria > Object Types.
  2. Select the Datasheet Criteria (datasheet_criteria__v) table heading.
  3. Select Expectedness.
  4. Select the User must always enter a value (required) checkbox.
  5. Save the page.

Add Administrators Role to Custom Rules on Localization Objects

This configuration allows Business Admins to make changes to localized library objects.

The steps below describe how to add the Administrators group as Editor on custom sharing rules for the following objects:

  • Localized Organization
  • Localized Product
  • Localized Study
  • Localized Study Arm
  • Localized Substance
  1. Go to Admin > Configuration > Objects > [Object].
  2. In the Details tab, ensure Enable Custom Sharing Rules is selected.
  3. In the Sharing Rules tab > Custom Sharing Rules section, select Create.
  4. Use the following table to enter the Label information for the respective object:
    Object Label Name
    Localized Organization All Localized Organizations all_localized_organizations__c
    Localized Product All Localized Products all_localized_products__c
    Localized Study All Localized Studies all_localized_studies__c
    Localized Study Arm All Localized Study Arms all_localized_study_arms__c
    Localized Substance All Localized Substances all_localized_substances__c
  5. Save the page.
    After saving the page, the Roles section appears.
  6. In the Roles section, select Add.
    An Add Manual Assignment window appears.
  7. Complete the following information:
    • Role: Editor
    • Users and Groups: Administrators
  8. Save the page.

Configure PMDA Multi-Submission with Localized Case

Configuration updates have been made to the 23R1 template to support submitting multiple PMDA Submissions from a single Case.

These configuration changes are documented in Enable PMDA Multi-Submission with Localized Case.