Admins can configure Vaults to automatically generate and send email questionnaires to Case Reporters for follow-up information.
About Scheduled Follow-Up Emails
This page provides instructions on how you can configure your Vault to generate and send questionnaires to Case Reporters for follow-up information. Follow-up questionnaires are used when there is missing information on the Inbox Item, resulting in an invalid Case. For instructions on how to use this feature once configured, see Send a Follow-Up Email Questionnaire to a Case Reporter.
Vault’s controlled document management capabilities include setting up questionnaires. To customize when a questionnaire is sent, configure Follow-Up Rules or leverage Watchlists to monitor Adverse Events of Special Interest (AESI).
If a Case matches with a questionnaire template for a Follow-Up Rule or Watchlist and the reporter provides their email and consent to be contacted, then Vault performs the following actions:
- Generates a Correspondence Transmission record to log events regarding the email
- Emails the questionnaire to the reporter’s designated email address
Note: For information on how to set up online questionnaires for Follow-up Case information, see Set Up Follow-Up Online Questionnaires. You can only configure one (1) method of generating questionnaires configured in your Vault.
Prerequisites
Consider the following requirements before you can configure follow-up questionnaires:
- Before you can access this feature, you must enable Scheduled Follow-Up Questionnaire Emails.
- In addition to setting up layouts and security, you must perform the 22R3 configuration to remove constraints on the Transmission object.
- Before you can add questionnaire templates for Watchlists and Adverse Events of Special Interest (AESI), you must have already configured the Watchlist.
In addition, if you enable Extend Definition of Suspect to Drug Not Administered, questionnaires are generated for Case Products with a Drug Role of Suspect, Interacting, or Drug Not Administered. Otherwise, questionnaires are generated only for the Suspect and Interacting Drug Roles.
Important Terms
Before you start configuring follow-up questionnaires, it’s important to understand the following terms:
- Reporter: The person reporting the adverse event. This may be a medical professional or the patient themselves. Reporter information is stored using a Case Contact record.
- Email Consent: The reporter has explicitly provided consent to be contacted about this Inbox Item or Case by email.
- Questionnaire: A predefined document with questions and requests for information to be sent to a reporter or health professional.
- Watchlist: A specific set of MedDRA terms of special interest for a specific product. This is sometimes referred to as Adverse Events of Special Interest (AESI).
Best Practices & Recommendations
- Specify base global templates as much as possible.
- Specify only the Country and Language template document fields when required. This makes maintenance easier.
- Try to use templates at the watchlist-level instead of the MedDRA Criteria level where possible.
- You can have multiple watchlists under the same watchlist tag for easier management.
Create the Questionnaire Template Document
You must create a source questionnaire and add it as a controlled document template. Vault uses the questionnaire template to generate specific questionnaires for each Case. The resulting document is added as an attachment on the Correspondence record. To learn more about controlled document templates, see Creating & Managing Controlled Document Templates.
You can create the questionnaire source file using any document type. However, we recommend that you use a DOCX file format, which allows you to configure merge field tokens in the file.
Merge field tokens are replaced by field values from the relevant Case when Vault generates a Case questionnaire. To learn more about using merge fields, see Using Merge Fields for Microsoft Word & Excel.
Add Reply-To Contact Emails
Add Person records to configure the email addresses for reply-to contacts on questionnaire emails. A reply-to contact must be selected when configuring questionnaire templates. The email does not have to be associated with a Vault user.
- Go to Business Admin > Objects > Persons.
- Select Create.
- In the Create Person window, select the type of person, and then Continue. You can add any type of Person record to store the email address.
- On the Create Person page, specify the fields, and then select Save.
Result
The Person record is added and can be selected as the reply-to email address in automated questionnaire emails.
Case Follow-Up Rules
Set up case Follow-Up Rules to add questionnaires for a given product. When this feature is enabled, basic Follow-Up Rules are added to your Vault. You can customize these default Follow-Up Rules to specify the number of attempts to reach out to the reporter and how long to wait between each attempt.
Follow-Up Rule questionnaire templates use the Template > Correspondence (Template) > Questionnaire (Template) document type.
To set up questionnaires specific to certain adverse events of special interest, set up a Watchlist or MedDRA Term questionnaire template.
Customize a Case Follow-Up Rule
- Go to Business Admin > Objects > Follow-Up Rules.
- Open the Follow-Up Rule that you want to customize.
- Select Edit, and modify these fields as required.
- Select Save.
Note: For custom Follow-Up Rules, the API Name must match the Follow-up Type. For example, a Custom Follow-Up rule named ‘Custom Clinical Study Rule’ with a custom Follow-Up Type ‘Custom Clinical Study’ (custom_clinical_study__c
) would use the API name custom_clinical_study__c
.
After You Finish
Add one or more questionnaire template documents.
Add Follow-Up Rule Questionnaire Templates
We recommend adding Follow-Up Rule questionnaires from the Follow-Up Rule record to automatically populate the Follow-Up Rule field and filter the document type field. However, you can also add templates from the Library tab.
- On the new Follow-Up Rule record, expand Template Documents.
- Select Add.
- Perform one of the following sequences:
- To use an existing template, select the document, and then select Close.
- To add a new template, complete the following steps:
- Select Create.
- On the Upload Files (Step 1) page, upload the file and classify the document as Template > Correspondence (Template) > Questionnaire (Template), and then select Next.
- On the Upload Files (Step 2) page, specify the General Document Fields and Questionnaire Settings Fields, and then select Save. Once you save the document, you are directed back to the Follow-Up Rule record.
- Go to the template document in the Library. Select the document name link under Template Documents to find the document quickly.
- Move the document to a steady state, such as Approved. The method to move the document to a steady state depends on how your Admin has configured your Vault. We recommend configuring a document workflow for approval. The document must be in a steady state to be used as a controlled template.
Result
The template document is added to the Follow-Up Rule. Add as many template documents as you require. Vault uses the Follow-Up Type along with the Questionnaire Settings to determine when to send email questionnaires. See Questionnaire Matching Logic to understand how Cases are matched to templates.
Watchlist and AESI Questionnaires
You can add questionnaire templates at the Watchlist level and at the MedDRA Term level. If you add a questionnaire template for the entire Watchlist, and also add a questionnaire template for certain MedDRA Terms, the MedDRA Term template supersedes the Watchlist template for those terms only.
Note: When a MedDRA Term supersedes a Watchlist, only the questionnaire for that MedDRA Term is sent for Cases and Inbox Items with that MedDRA Term. The core questionnaire for the Watchlist is not sent.
Watchlist questionnaire templates use the Template > Correspondence (Template) > AESI Questionnaire (Template) document type.
Note: Watchlists and AESI Questionnaires are not supported for Inbox Items.
Add Questionnaire Templates for a Watchlist or MedDRA Term
We recommend adding the questionnaire from the Watchlist or MedDRA Term record to automatically populate certain fields. However, you can also add templates from the Library tab.
- Go to Business Admin > Objects > Watchlists.
- Open the Watchlist for which you want to schedule automated email follow-ups.
- Perform one of the following sequences, depending on where you want to add the template:
- To add a template for the entire Watchlist:
- On the Watchlist record, expand Templates.
- Select Add. The Watchlist layout must be configured to show the Templates section. If your Admin has not configured this section in your Vault, add the document from the Library tab.
- To add a template for a specific MedDRA Term:
- Expand MedDRA Terms, and then open the term for which you want to add the questionnaire template.
- On the MedDRA Criteria record, expand Template Documents.
- Select Add. The MedDRA Term layout must be configured to show the Template Documents section. If your Admin has not configured this section in your Vault, add the document from the Library tab.
- To add a template for the entire Watchlist:
- Perform one of the following sequences:
- To use an existing template, select the document, and then select Close.
- To add a new template, complete the following steps:
- Select Create.
- On the Upload Files (Step 1) page, upload the file and classify the document as Template > Correspondence (Template) > AESI Questionnaire (Template), and then select Next.
- On the Upload Files (Step 2) page, specify the General Document Fields and Questionnaire Settings Fields, and then select Save. Once you save the document, you are directed back to the Follow-Up Rule record.
- Go to the template document in the Library. Select the document name link under Template Documents to find the document quickly.
- Move the document to a steady state, such as Approved. The method to move the document to a steady state depends on how your Admin has configured your Vault. We recommend configuring a document workflow for approval. The document must be in a steady state to be used as a controlled template.
Result
The template document is added to the Watchlist or MedDRA Criteria. Add as many template documents as you require. Vault uses the Watchlist or MedDRA Criteria along with the Questionnaire Settings to determine when to send email questionnaires. See Questionnaire Matching Logic to understand how Cases are matched to templates.
Questionnaire Template Document Fields
The following sections describe the fields that appear on questionnaire document templates.
General Document Fields
The following table describes the General fields. These fields appear on the Questionnaire (Template) document.
Field | Description |
---|---|
Organization | (Required) Select the Organization to which this Follow-Up Rule applies. The Inbox Item or Case Organization field must match the Organization that you select in this field. |
Name | (Required) Enter a name for this document. The name determines how Vault displays and refers to the document in the user interface. |
Title | Enter a secondary identifier for the document. |
Template Document Type | (Required) Select Questionnaire. |
Questionnaire Settings Fields
The following tables describe the Questionnaire Settings fields and the use cases for each questionnaire type. These fields appear on the Questionnaire (Template) document.
Fields for Follow-Up Rule Questionnaire Templates Only
Field | Description |
---|---|
Follow-Up Rule | (Required) The Follow-Up Rule referencing this template. Vault automatically populates this field when you add the template to a Follow-Up Rule. The Inbox Item or Case Follow-Up Type field must match the Follow-Up Rule set in this field. |
Products | Select the Products to which this questionnaire applies. You can enter multiple values. The questionnaire will be sent to reporters of cases involving any of these products. The Inbox Item or Case must match the Product that you select in this field, according to the following conditions:
If you do not select a Product, Vault populates this field using approved questionnaire templates that match the Country or Language specified on this questionnaire template. Questionnaire templates with blank Product, Country, and Language fields are considered a match. |
Fields for AESI Questionnaire Templates Only
Field | Description |
---|---|
Watchlist | The Watchlist referencing this template. Vault automatically populates this field when you add the template to a Watchlist. The Case Watchlist Tags field must contain the tag for the Watchlist set in this field. |
MedDRA Terms | The specific MedDRA Terms to which this questionnaire applies. When you add the template under a MedDRA term in a Watchlist, Vault populates this field automatically. Cases must contain a Case Adverse Event with a coded MedDRA term that matches the MedDRA Term set in this field. |
Fields for All Questionnaire Templates
Field | Description |
---|---|
Countries | To make this questionnaire specific to certain countries, select the countries to which this questionnaire applies. The Inbox Item or Case must match a Country that you select in this field, according to the following conditions:
If each of the above fields are blank, Vault only matches questionnaires with an empty Country field. |
Language | To make this questionnaire specific to certain languages, select the languages to which this questionnaire applies. The Inbox Item or Case must match a Language that you select in this field, according to the following conditions:
If each of the above fields are blank, Vault only matches questionnaires with the Country field either left blank or set to English. |
Reply-To | (Required) Select the contact whose email should be populated in the Reply-To field on the email sent to the reporter. The available options depend on the Reply-To records set up. |
How Vault Determines When to Send a Questionnaire
The following flowchart illustrates what Vault looks at to determine whether to generate the Correspondence record and email questionnaire for a given Case:
The following list provides more information on each of the actions and decisions in the above flowchart:
- Once per day, at approximately midnight EST, to determine which Cases to consider sending a questionnaire for, Vault searches for Inbox Items and Cases with the Send Follow-Up checkbox selected.
- Vault verifies that the Inbox Item or Case matches either a Follow-Up Rule, Watchlist tag, or MedDRA Term for which a questionnaire document template is configured.
- Vault queries the Product, Language, and Country information from the Inbox Item or Case.
- Vault verifies whether the Inbox Item or Case matches the criteria configured in the Questionnaire Settings section on a template document for the given Follow-Up Rule or Watchlist. If the Case matches multiple template documents, Vault generates multiple questionnaires.
- If the Inbox Item or Case matches a questionnaire template, Vault verifies that the reporter provided their consent to be contacted for more information to use the appropriate Correspondence Transmission Method:
- If the Inbox Item or Case contains the reporter’s email address and consent, then Vault generates and sends an automatic Email Correspondence.
- If the Inbox Item or Case is missing either the reporter’s email or their consent, Vault looks for the most recently created non-primary Reporter, if available.
- If the Inbox Item or Case is missing either the non-primary Reporter’s email address or consent, Vault generates a Manual Correspondence.
Example: Follow-Up Rule Cholecap Questionnaire
The following diagram shows an example questionnaire for a postmarket product, Cholecap, and an example Case that would trigger this questionnaire being sent to the reporter:
Questionnaire Matching Logic
The following sections describe how Vault determines matches between Inbox Items or Cases and the Questionnaire Settings for each template type.
Field Calculation
The following list describes how Vault calculates the Product, Language, and Country when evaluating an Inbox Item or Case:
Product
- Inbox Item — All Case Products or Company Products on the Inbox Item.
- Case — All Case Products where the Drug Role is Suspect, Interacting, or Drug Not Administered.
Country
- Inbox Item — The Reporter Country field on the Primary Case Contact. If the Reporter Country field is blank, then Vault looks at the Event Country field on the primary Case Adverse Event.
- Case — The Reporter Country field on the primary Case Contact. If the Reporter Country field is blank, then Vault looks at the Event Country field on the primary Case Adverse Event.
Language
- Inbox Item — The Reporter Language field on the primary Case Contact, if both the email address and consent are provided for this primary Reporter. If the email and consent for the primary Reporter are not provided, Vault uses the language in which the Event (Reported) field was coded for the primary Adverse Event. If this information is not available, Vault defaults to English.
- Case — The Reporter Language field on the primary Case Contact. If the Reporter Language field is blank, then Vault looks at the language in which the Event (Reported) field was coded on the primary Case Adverse Event. If this information is not available, Vault defaults to English.
Note: In addition to the criteria mentioned below, for Vault to generate a questionnaire, the Inbox Item or Case must always match with the Organization specified on the questionnaire template.
Follow-Up Rule Questionnaire Matching
For Follow-Up Rules, Vault evaluates each suspect or interacting Case Product for a matching questionnaire template using the following logic:
Priority Order | Case Questionnaire Matching | System Action |
---|---|---|
Level 1 |
Product Country Language |
Generates a questionnaire for each template that matches on all of these fields. |
Level 2 |
Product Country Language |
If either of the following conditions is true, then Vault only considers templates with an empty Country field.
Vault generates a questionnaire if there is a template matching on Product and Language with a blank Country field. |
Level 3 |
Product Country Language |
If the following conditions are true, then Vault only considers templates with a Language field empty or set to English.
Vault generates a questionnaire if there is a template matching on Product and Country with a blank or English Language field. |
Level 4 |
Product Country Language |
Vault generates a questionnaire for each template that only matches on Product when both of the following conditions are met:
If neither of the above conditions are met, Vault does not generate a questionnaire. |
Product Country Language |
Questionnaire not generated. |
Watchlist and MedDRA Term Questionnaire Matching
For Watchlist questionnaires, Vault evaluates each Case Adverse Event with a MedDRA term of special interest for a matching questionnaire template.
Vault uses the same Country and Language matching as the Follow-Up Rule matching, with the additional considerations:
- MedDRA Term Questionnaire — If there is a MedDRA Term questionnaire matching the term coded on the Case Adverse Event, then only the specific MedDRA Term template is used to create the questionnaire.
- Watchlist Questionnaire — If there is no matching MedDRA Term questionnaire, but there is a Watchlist template matching the term coded on the Case Adverse Event, then the Watchlist template is used to create the questionnaire.
- Neither — If the event coded on the Case Adverse Event does not match either a Watchlist or MedDRA Term template, then no Watchlist questionnaire is sent.