Enable Narrative Templates for Report Types and Studies

Learn how to update your Vault’s configuration to enable custom narrative templates based on Organization, Report Type, Study Type, Study, and Localization.

About the Feature

Narrative Templates for Report Types and Studies, introduced in 22R2, enables Veeva Safety to apply custom narrative templates based on Case details. Using custom narrative templates saves case processing time by generating a narrative document with only case-specific details.

Upon Case promotion, Vault applies the template that shares the most criteria with the Case based on the following fields:

  • Case Type (E2B or manual)
  • Organization
  • Report Type
  • Study Type
  • Study (Blinded or Unblinded)
  • Localization

To learn more about narrative template types, see Configure Narrative Templates: Custom Narrative Templates.

25R3 Update: Manage Blind Protection for Case Narratives

With the 25R3 release, you can turn off blind protection for generated narratives. See Manage Blind Protection to configure your Vault for the updated feature.

Add Study Type and Localization to the Case Information Field Layout

Add the Study Type (study_type__v) and Localization (localization__v) document fields to the Case Information Field Layout.

  1. Go to Admin > Configuration > Document Fields.
  2. Open the field for editing.
  3. Under Options, select “Case Information” from the Display Section field.

Add Narrative Template Type to Transmission Profile Layouts

Custom narrative templates can be enabled on AS2 Gateway, System Gateway, and Connection Transmission Profile types. If the Narrative Template Type field does not appear on either Transmission Profile record, update the Layout.

  1. Go to Configuration > Objects > Transmission Profile > Layouts.
  2. Make the following updates to one or more layouts, as required:
    • System Gateway
    • AS2 Gateway
    • Connection Profile
  3. In the “Inbound Settings” section, select Add, and then select Narrative Template Type from the drop-down list.
  4. To rearrange fields, drag and drop.
  5. Select Save.

Update Existing Transmission Profiles to Use Custom Narrative Templates

To use custom narrative templates in existing Transmission Profiles, select the Override Narrative Template option.

  1. Go to Business Admin > Transmission Profile.
  2. Select an existing AS2 Gateway or System Gateway Transmission Profile type, or select Create to Create a Transmission Profile.
  3. In the “Inbound Settings” section, select the Narrative Template Type drop-down list, and then select Override Template.
  4. Select Save.

Add the Re-render Case Narrative Action

  1. Add the “Re-render Case Narrative” (rerender_case_narrative__v) action to the Case object.
  2. Add “Re-render Case Narrative” as an entry action to the following Case lifecycle states:
    • Data Entry
    • Medical Review
    • QC
    • Unblinded
  3. Add “Re-render Case Narrative” as a user action to the following Case lifecycle states:
    • Data Entry
    • Medical Review
    • Revision
    • Triage

Grant Permissions

Ensure your permissions sets are granted the appropriate level of access to objects and fields according to your organization’s process.

To manage permissions for the Re-render Case Narrative action, go to Admin > Users & Groups > Permission Sets > [Permission Set] > Objects > Case > Object Action Permissions.

Recommended standard permission sets for access to this feature include the following:

  • Case Intake Actions
  • Case Entry Actions
  • Case Review Actions

The available levels of access are View and Execute.

Add the Re-render Localized Narrative Action

  1. Add the “Re-render Localized Case Narrative” (rerender_localized_case_narrative__v) action to the Localized Case object.
  2. Add “Re-render Localized Case Narrative” as an entry action to the following Localized Case lifecycle state:
    • Translation Review
  3. Add “Re-render Case Narrative” as a user action to the following Localized Case lifecycle states:
    • Translation Entry
    • Active

Grant Permissions

Ensure your permissions sets are granted the appropriate level of access to objects and fields according to your organization’s process.

To manage permissions for the Re-render Localized Case Narrative action, go to Admin > Users & Groups > Permission Sets > [Permission Set] > Objects > Localized Case > Object Action Permissions.

Recommended standard permission sets for access to this feature include the following:

  • Case Intake Actions
  • Case Entry Actions
  • Case Review Actions
  • Case Translation Actions

The available levels of access are View and Execute.

Update the Narrative Template Document Type Dependency

  1. Go to Admin > Configuration > Field Dependencies.
  2. Edit the Template › Narrative (Template) condition to match the following image:

Narrative Template Field Dependency

Manage Blind Protection

You can control blind protection for narrative documents with the Turn off Blind Protection on Narrative setting. When enabled, Vault populates the Blind Protection field value of generated narrative documents with Off. This document field value determines the following:

  • Off: Any information in the narrative document may be displayed in the Narrative Preview field.
  • On: The Narrative Preview field does not display any sensitive information and unauthorized users cannot view the narrative document.

When Vault generates a narrative for a follow-up Case, the new narrative document inherits the Blind Protection value from the narrative of the previous Case version unless the follow-up Case was unblinded during processing. In this scenario, Vault always sets the Blind Protection field to On. If you enable this setting, you must update templates with merge fields or tokens that return blinded information so that the Blinding Type returns in the same merge field or token. If the initial narrative document contains merge fields for narrative templates, Vault regenerates tokens to update values.