Configure Azure Form Recognizer integration for automatic vaccine response reviews
As a Vaccination Status admin, configure Vaccination Status to work with Azure Form Recognizer service and automate vaccine response approvals.
Before you begin
To integrate with the Azure Form Recognizer service, you should do the following:
- Use Azure Form Recognizer and obtain connection credentials
- Train a machine-learning model if you are using your organization's own model for validation purposes
Role required: sn_imt_vaccine.admin
About this task
When you add your credentials to connect to the Azure Form Recognizer service, you may choose to use a ServiceNow -trained model or a model created by your organization.
- For more information on Azure Form Recognizer service, see Azure Form Recognizer documentation.
- For more information on the Azure Form Recognizer API used by default, see Form Recognizer 2021-09-30-preview.
Procedure
Enable the Allow validation engine approvals to update Vaccine Review Outcome records property to automate the approvals of vaccine responses.
Navigate to All > Vaccination Status > Properties.
Locate the Allow validation engine approvals to update Vaccine Review Outcome records property and select Yes.
Configure the Azure Recognizer service confidence threshold property used to validate Centers for Disease Control and Prevention (CDC) Vaccination Cards.
The value in this step is the confidence level required by the service to determine that a submitted CDC Vaccination Card matches the user.
Navigate to All > Vaccination Status > Properties.
Navigate to the Azure Form Recognizer confidence threshold, a decimal value between 0 and 1 [sn_imt_vaccine.azure_form_recognizer_confidence_threshold] property.
Enter a decimal value to represent the confidence threshold required for a vaccine response to match.
Select Save.
Add your connection credentials and trained model to the Azure Form Recognizer validator service.
| Trained model | Steps |
|---|---|
| ServiceNow model |
Note: Contact ServiceNow Customer Service and Support or your account management team for "Vaccination Status – Azure Integration setup support". ServiceNow Customer Service and Support and your account management team can complete the steps required to add the trained model with you. Model copy authorizations only last for an hour. |
| Customer-trained model |
|
Activate the Auto-validate vaccine response flow.
Navigate to All > Process Automation > Flow Designer.
Search for the Auto-validate vaccine response flow.
Select the flow.
Select Activate.
Result
When users add CDC Vaccination Card attachments to their vaccine responses and set the attachment type to CDC Vaccination Card, the following occurs:
- The card is read by the Azure Form Recognizer service and trained machine-learning (ML) model
- A confidence score is generated
- The confidence score is compared to the configured threshold
- The validation engine sets the Vaccine Review Outcomes based on whether the first and last names matched
Parent Topic:Automating vaccine response reviews with the Azure Form Recognizer service