Mass book vaccine appointments

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
  • Schedule appointments for multiple users at the same time instead of having users individually request appointments in the self-service portal.

    Before you begin

    Navigate to Vaccine Administration Management > Administration > Properties.

    Set the following property values in the System Property [sys_property] table.

    Table 1. System property table

    Property

    Description

    sn_vaccine_sm.vaccine.management.booking.max_distance

    The maximum distance, in miles, that is searched for an available vaccination location if there is no appointment slot available at the user’s preferred center.

    The default value is 50.

    sn_vaccine_sm.vaccine.management.booking.distance_unit

    The unit of measurement for the distance considered for vaccine appointment mass booking. The options are mi and km.

    The default value is mi.

    sn_vaccine_sm.vaccine.management.booking.max_locations

    The maximum number of alternate locations that are searched for a vaccination if there is no appointment slot available at the user’s preferred location. A higher value for this property increases the time that it takes to complete mass booking.

    The default value is 5.

    Role required: sn_vaccine_sm.admin and admin

    About this task

    Important:
    Mass booking does not currently support inventory-based scheduling.

    Procedure

    1. Create a temporary table.
      The table should either:
      • Extend sys_user.
        Note:
        For more information about extending tables, see Create a table.
      • The user field in the table should have a reference to the sys_user.
    2. Import the following health history data for each user into the temporary table.
      • User
      • Preferred vaccination center
      • Age group
      • Allergies to medications, food, a vaccine component, or latex (Yes/No)
      • Serious reaction or fainted or nearly fainted during or after vaccination (Yes/No)
      • Seizures or history of brain or nervous system problems (Yes/No)
      • Long-term health problem with heart disease, lung disease, asthma, kidney disease, metabolic disease, (for example, diabetes), anemia, or other blood disorder (Yes/No)
      Note:
      This data is required to book appointments for users. If users book the appointments in the self-service portal, the users provide this information at the time of booking. When a user with the admin role mass-books appointments for users, the data must be imported instead.
      For more information about importing data, see Import sets.
    3. Navigate to Vaccine Administration Management > Administration > Mass Booking Configurations and click New.
    4. Enter a name to describe the users included in the configuration.
    5. In the Program field, select the vaccination program to book appointments for.
    6. In the Table Name field, select the temporary table that you created.
    7. In the following fields, select the corresponding column from the temporary table to map the user data from the temporary table to the user's appointment.
      • Health history
      • Vaccine reaction
      • Age group
      • Preferred center
      • User
      • Long term health issues
      • Allergies
    8. In the Conditions field, add filter conditions to define which users to book appointments for.
    9. To complete the configuration, click Submit.
      • The configuration is saved but the appointments are not scheduled yet.
      • If a consumer or patient record does not exist for any user that has an appointment is booked, these records are created for the user.

    What to do next

    When you're ready to schedule the appointments, return to the configuration record and click Process Booking.
    Note:
    Whenever you process a booking, a new record gets created on the Mass Booking Jobs tab. Use this tab to view the progress of the scheduled appointments, for example, you can view the number of total appointments booked, appointments booked in a preferred center, the number of bookings failed for users, and so on.