Enable Pregnancy and Parent-Child Case Data Collection

Learn how to upgrade your vault configuration to enable pregnancy and parent-child case data collection.

Last Updated

Note Beginning with 24R1 in April 2024 and for all subsequent releases, Vault Safety General Release Help content is moving to a new site. Test the new site using Limited Release content.

About the Feature

Vault Safety added support to collect information about pregnancy cases and outcomes in 21R1. This page provides instructions to upgrade your vault configuration to enable this data capture.

For information on using Pregnancy Cases for data entry once this feature has been enabled, see Add a Pregnancy Case.

Note Vaults originally deployed from the 21R1 Vault Safety template include all of the configuration required for this feature already, with the exception of the following:

Update Case Page Layout

  1. Go to Configuration > Objects.
  2. Open the Case (case_version__v) object.
  3. Go to the Page Layouts tab.
  4. Open the Case Page Layout.
  5. Add the Pregnancy Case field to the Details section. See the suggested layout in the following image:
    Pregnancy Case Added to Case Details Section
    Pregnancy Case Added to Case Details Section
  6. Add a Pregnancy Information section with pregnancy fields. See the following image for the suggested layout and fields:
    Case Page Layout Pregnancy Section
    Case Page Layout Pregnancy Section

    Note The Pregnancy Conception Date and Pregnancy Due Date fields are moved out of the Patient section to the Pregnancy Information section.

  7. Add the following page layout rule to hide pregnancy information:
    Setting Value
    Label Enter a Label, such as "Not Pregnancy Case/Pregnant at Exposure"
    Name The system automatically populates this field based on the Label
    Status Active
    Hide the following Page Layout Items
    • Type: Sections
    • Values: Pregnancy Information
    IF this Layout Rule Expression is TRUE pregnancy_case__v != true && pregnant_at_vaccination__v != true
    Layout Rule to Hide Pregnancy Section on Case
    Layout Rule to Hide Pregnancy Section on Case

If your vault receives Imported Cases from an external system that collects pregnancy information, add pregnancy-related to the Imported Case (imported_case__v) object type.

Add Fields to Object Type

  1. Go to Configuration > Objects.
  2. Open the Case (case_version__v) object.
  3. Open the Object Types tab.
  4. Open the Actions (Gear-Button) menu, and select Edit Object Type Fields.
  5. Under the Imported Case (imported_case__v) object type, ensure the following fields are selected:
    • Pregnancy Case
    • Gestation
    • Last Menstrual Date
    • Pregnancy Conception Date
    • Pregnancy Due Date
    • Number of Fetuses
    • Gravida/Gravidity
    • Para/Parity
    • Pregnancy Outcome
    • Delivery Method
    • Date of Pregnancy Outcome
    • Sponsor Pregnancy Awareness
  6. Select Save.

Update Imported Case Page Layout

  1. Go to Configuration > Objects.
  2. Open the Case (case_version__v) object.
  3. Go to the Page Layouts tab.
  4. Open the Imported Case Page Layout.
  5. Add the Pregnancy Case field to the Details section. See the suggested layout in the following image:
    Pregnancy Case Added to Imported Case Details Section
    Pregnancy Case Added to Imported Case Details Section
  6. Add a Pregnancy Information section with pregnancy fields. See the following image for the suggested layout and fields:
    Case Page Layout Pregnancy Section
    Case Page Layout Pregnancy Section

    Note The Pregnancy Conception Date and Pregnancy Due Date fields are moved out of the Patient section to the Pregnancy Information section.

  7. Add the following page layout rule to hide pregnancy information:
    Setting Value
    Label Enter a Label, such as "Not Pregnancy Case/Pregnant at Exposure"
    Name The system automatically populates this field based on the Label
    Status Active
    Hide the following Page Layout Items
    • Type: Sections
    • Values: Pregnancy Information
    IF this Layout Rule Expression is TRUE pregnancy_case__v != true && pregnant_at_vaccination__v != true
    Layout Rule to Hide Pregnancy Section on Case
    Layout Rule to Hide Pregnancy Section on Case

Post-21R1: Case and Imported Case Object Configuration Changes

The following configuration changes must be made in all vaults deployed in 21R1 and earlier.

  1. In Configuration > Objects > Case > Fields, update the label for the Pregnancy Case (pregnancy_case__v) field to "Pregnancy"
  2. Go to the Page Layouts tab, and open the following page layouts for editing:
    • Case Page Layout
    • Imported Case Page Layout
    The following steps should be completed on both page layouts.
  3. (Recommended) Rearrange the following fields on the page layout:
    • Move Last Menstrual Period below Gender
    • Move Pregnancy below Last Menstrual Period
    • Move Pregnant at Exposure below Pregnancy
    • Move Gestation below Pregnancy Due Date
  4. Add a Related Object section for Child Information Cases:
    1. In the Related Object field, select the second Case in the list
    2. In the Section Label field, enter Child Information
    3. In the Section Name field, enter child_information
    4. In the Criteria VQL field, enter: object_type__vr.api_name__v = 'child_information__v'
    5. Select Apply on Create
      Adding Child Information Related Object Section
      Adding Child Information Related Object Section
    6. Include the following columns in the Child Information section:
      • Patient Initials
      • Date of Birth
      • Lifecycle State
  5. Change the Menstrual page layout rule:
    1. Go to the Layout Rules tab.
    2. Open the Menstrual layout rule for editing.
    3. Change the Hide the following Page Layout Items settings to match the following:
      • Controls: Last Menstrual Period, Pregnant at Exposure, Gestation
      • Fields: Pregnancy Case
    4. Save the layout rule.
      Menstrual Page Layout Rule
      Menstrual Page Layout Rule
  6. Change the Not Pregnancy Case/Pregnant at Exposure page layout rule:
    1. Go to the Layout Rules tab.
    2. Open the Not Pregnancy Case/Pregnant at Exposure layout rule for editing.
    3. Change the Hide the following Page Layout Items settings to match the following:
      • Sections: Pregnancy Information, Child Information
    4. Save the layout rule.
      Not Pregnancy Case/Pregnant at Exposure Layout Rule
      Not Pregnancy Case/Pregnant at Exposure Layout Rule

Configure Child Information Case Object Type

Add fields to the object type, and then add a page layout for Child Information Cases.

Add Fields to Object Type

  1. Go to Configuration > Objects.
  2. Open the Case (case_version__v) object.
  3. Open the Object Types > Fields tab.
  4. Open the Actions (Gear-Button) menu, and select Edit Object Type Fields.
  5. Under the Child Information (child_information__v) object type, ensure the following fields are selected:
    • Height
    • Weight
  6. Select Save.

Add Child Information Case Page Layout

  1. In Configuration > Objects > Case, open the Page Layouts tab.
  2. Create a page layout for the Child Information Object Type.
  3. Update the Details section to the following fields:
    • Organization
    • Parent Information
    • Patient Initials / ID
    • Patient Name Prefix
    • Patient First Name
    • Patient Middle Name
    • Patient Last Name
    • Date of Birth
    • Age at Onset
    • Gender
    • Height
    • Weight
    • Hospital MRN
    • GP MRN
  4. (Optional) Make the Organization field required.
    The Organization is required to create Child Information and Child Information Test Results with appropriate Sharing Settings. Vault Platform Help provides instructions for setting up required object type fields.
  5. Edit the following field control labels on the page layout. Optionally, also update the field help text accordingly:
    Field New Label
    Patient Initials / ID Child Initials
    Patient Prefix Child Name Prefix
    Patient First Name Child First Name
    Patient Middle Name Child Middle Name
    Patient Last Name Child Last Name
    Age at Onset Child Age
  6. Add a Case Test Results related object section.

Result

The following image shows the Child Information Page Layout after configuration:

Child Information Case Page Layout
Child Information Case Page Layout

Configure Parent Information Case Object Type

Add study-related fields to the Parent Information (parental_case__v) object type. Then, update the Parent Information page layout to support entering the related Study on pregnancy cases.

Add Fields to the Parent Information Object Type

  1. Go to Configuration > Objects.
  2. Open the Case (case_version__v) object.
  3. Open the Object Types tab.
  4. Open the Actions (Gear-Button) menu, and select Edit Object Type Fields.
  5. Under the Parent Information (parental_case__v) object type, select the following fields:
    • Study Name
    • Study Name (Continued)
    • Study Name (reason omitted)
    • Study Number
    • Study Number (reason omitted)
    • Study Site
    Adding Study Fields to Parent Case
    Adding Study Fields to Parent Case
  6. Select Save.

Update the Parental Case Page Layout

Update the Parental Case Detail Page Layout (parental_case_detail_page_layout__c) to add fields and add a page layout rule.

Add Fields to the Layout

  1. In Configuration > Objects > Case, open the Page Layouts tab.
  2. Open the Parental Case Detail Page Layout (parental_case_detail_page_layout__c).
  3. Add the Pregnancy field to the Parent section.
  4. (Optional) Add Pregnancy Information and Pregnancy Outcome detail sections to organize the pregnancy-related fields.
  5. Add the following pregnancy-related fields to the page layout:
    • Add the following fields to the Pregnancy Information section, if added:
      • Last Menstrual Period
      • Pregnancy Conception Date
      • Pregnancy Due Date
      • Gestation
      • Para/Parity
      • Gravida/Gravidity
      • Number of Fetuses
      • Sponsor pregnancy awareness
    • Add the following fields to the Pregnancy Outcome, if added:
      • Date of Pregnancy Outcome
      • Pregnancy Outcome
      • Delivery Method
  6. Ensure the MedDRA Version field is on the page layout.
    This field is required to auto-code the Child Test Results.
  7. Add the following study-related field controls to the page layout. We recommend adding these controls to the Parent section:
    • Study
    • Study Site
  8. (Optional) Consider moving the Gestation field from the Parent detail section to the Pregnancy Information section.

    Note If you move this field to the Pregnancy Information section, it may be hidden according to the page layout rule described in the following section.

  9. Edit the following field control labels on the page layout. Optionally, also update the field help text accordingly:
    Field New Label
    Patient Initials / ID Parent Initials
    Patient Prefix Parent Name Prefix
    Patient First Name Parent First Name
    Patient Middle Name Parent Middle Name
    Patient Last Name Parent Last Name
    Age at Onset Age of Parent
  10. (Optional) Rename the Children Cases related object section to Children Cases/Information.
  11. Save the page layout.

Result

The following image shows the Parental Case Detail Page Layout after configuration:

Parental Case Detail Page Layout
Parental Case Detail Page Layout

Add Page Layout Rules

  1. On the Parental Case Detail Page Layout (parental_case_detail_page_layout__c), go to Layout Rules.
  2. Add the following layout rule to hide pregnancy-related sections if not tracking pregnancy or if the parent is not pregnant at exposure:
    Setting Value
    Label Enter your preferred Label
    Name The system automatically populates this field based on the Label
    Status Active
    Hide the following Page Layout Items
    • Type: Sections
    • Values: Pregnancy Information, Pregnancy Outcome
    IF this Layout Rule Expression is TRUE pregnancy_case__v != true && pregnant_at_vaccination__v != true
    Hide Pregnancy Sections if NOT Pregnancy Case or Pregnant at Exposure Layout Rule
    Hide Pregnancy Sections if NOT Pregnancy Case or Pregnant at Exposure Layout Rule
  3. Add the following rule to hide study-related fields if it is not a pregnancy case:
    Setting Value
    Label Enter your preferred Label
    Name The system automatically populates this field based on the Label
    Status Active
    Hide the following Page Layout Items
    • Type: Fields
    • Values: Study, Study Site
    IF this Layout Rule Expression is TRUE pregnancy_case__v != true
    Hide Study Fields if NOT Pregnancy Case Layout Rule
    Hide Study Fields if NOT Pregnancy Case Layout Rule
  4. Update the existing Menstrual (menstrual__c) layout rule to hide additional fields if the gender is not female:
    Setting Value
    Label Menstrual
    Name menstrual__c
    Status Active
    Hide the following Page Layout Items
    • Type: Fields
    • Values: Last Menstrual (normalized), Last Menstrual, Pregnant at Exposure, Pregnant at Exposure (Reason Omitted), Last Menstrual (reason omitted)
    IF this Layout Rule Expression is TRUE gender_value__vr.name__v != "Female"
    Updated Last Menstrual Layout Rule
    Updated Last Menstrual Layout Rule

Post-21R1: Parent Information Case Configuration Changes

We recommend that you make the following configuration changes in all vaults deployed in 21R1 and earlier.

  1. Go to Configuration > Objects > Case.
  2. Go to the Page Layouts tab, and open the Parental Case Detail Page Layout.
  3. Rearrange the following fields on the page layout:
    • Move Last Menstrual Period below Gender
    • Move Pregnancy below Last Menstrual Period
    • Move Pregnant at Exposure below Pregnancy

Permissions and Security Updates

Update permission sets as described in the following sections, per your organization’s requirements.

Grant Permissions to the Child Information Object Type

For users that require access to the Child Information Case object type, ensure to update permission sets.

Note Permissions to the Child Information Case object type must be configured in all vaults created in 21R1 and earlier.

  1. Go to Users & Groups > Permission Sets and open the appropriate permission set, such as Case Entry Actions.
  2. Open the Objects tab.
  3. Select Case.
  4. On the Case permissions page, under Object Permissions, grant Read, Create, and Edit permissions to the Child Information object type, as required.

Grant Permissions to Edit Pregnancy Fields

You must grant users permissions to allow them to read and edit the new pregnancy fields

  1. Go to Users & Groups > Permission Sets and open the appropriate permission set, such as Case Entry Actions.
  2. Open the Objects tab.
  3. Select Case.
  4. On the Case permissions page, under Object Field Permissions, grant Read and Edit permissions to the following fields (as required):
    • Gestation
    • Last Menstrual
    • Pregnancy Conception Date
    • Pregnancy Due Date
    • Pregnancy Case
    • Sponsor Pregnancy Awareness
    • Date of Pregnancy Outcome
    • Pregnancy Outcome
    • Delivery Method
    • Number of Fetuses
    • Para/Parity
    • Gravida/Gravidity

Additional Resources

Support for collecting pregnancy information on Inbox Items was also added to Vault Safety in 23R1. This feature allows intake users to track pregnancy exposure before Case promotion, facilitating data entry during Case processing.

See Enable Pregnancy Case Intake to enable this feature and About Pregnancy Case Intake for more information.

Feedback?