Validate vaccine responses automatically

Configure Vaccination Status so that validator services can validate vaccine responses automatically with information from supported attachments.

Before you begin

Integrate with the validator service by doing the following:

• Obtain credentials for a validator service.
• Create a connection and credentials alias. For more information, see Create a Connection and Credential alias.

If your organization is using an integration that is already supported, such as the CommonTrust Network, then you need only to add your organization's credentials to the validator service record.

Role required: admin

Procedure

1. Configure the validator service.
   1. Navigate to Vaccination Status > Validator services.
   2. Select an existing validator service or, if you are creating a new one, click New.
      If you are selecting an integration that is already supported, such as the CommonTrust Network, you must enter your Connection alias and confirm the form is correct for your validator service.
   3. Fill in the fields on the form.

      Table 1. Validator service form

      Field	Action
      Name	The name of the validator service.
      Connection alias	The connection alias for your validator service. For more information on creating a connection alias, see Create a Connection and Credential alias.
      Validation subflow	The subflow used to confirm whether a submitted attachment is valid. A template flow is provided by default or you may create a flow and add it to this field. For more information on creating flows, see Create a flow. If you create your own subflow, it must have the same inputs and outputs as the template subflow.
      Initial validator state	The initial state the validator service starts in prior to the completion of the review, such as Ready. The recommended state is Ready unless there is a preprocessing step. Note: If the initial state is Preprocessing, then the redirect page must set the response record validator state to Ready so it works with the built-in validation flow.
      Redirect page	(Optional) A reference to a service portal page the user will be redirected to after they report their vaccination.
      Active	Option to activate the service.
      Domain	The domain required for the validator service, such as global.

   4. Click Submit.
2. Optional: Configure a vaccine code system used to read vaccine codes and validate submitted data.
   The vaccine code your system uses might be provided with Vaccination Status. Refer to your validator service's requirements for more information.
   1. Navigate to Vaccination Status > Vaccine code systems.
   2. Select New.
   3. Enter the name of the vaccine code system.
   4. Enter the URL for the vaccine code system.
   5. Select Submit.
3. Configure the vaccine response attachment type supported by the validator service.
   This attachment type users should use when they submit their vaccine responses.
   1. Navigate to Vaccination Status > Attachment types.
   2. Select New.
   3. Enter the name of the attachment type.
   4. Enter the name of the validator service.
   5. Enable the attachment type by selecting the Active check box.
   6. Set the domain to global.
   7. Select Submit.
4. Optional: Add common vaccine codes required by the vaccine code system and service.
   Common codes are provided with Vaccination Status. Refer to COVID-19 Vaccine Related Codes for additional common codes and the third-party service for codes their system supports.
   1. Vaccination Status > Vaccine codes.
   2. Select New.
   3. In the Code System field, add the corresponding system.
   4. In the Code field, enter the code used to identify information about the vaccine.
   5. Enter a description.
   6. Select Submit.
5. Activate the Auto-validate vaccine response flow.
   1. Navigate to Process Automation > Flow Designer.
   2. Search for the Auto-validate vaccine response flow.
   3. Select the flow.
   4. Select Activate.

Result

You have enabled automated vaccine response validation. Work notes in the vaccine response record are updated with information on whether the attachments, and therefore the response, are valid. You can use this information to manually review vaccine responses in the approval portal.

What to do next

To automate vaccine response reviews so that they are set to Approved if validation was successful or left in the state Not yet reviewed (a manual review is required), see Automate reviews of vaccine responses.