Skip to main content

PHI Analysis

The PHI Analysis activity uses the Amazon Comprehend Medical API to invoke the PHI Analysis specific Amazon Comprehend API methods.

After executing the function, the activity outputs action specific field values (if applicable) and the status of the request (success/failure information) in a ResponseStatus object (ResponseStatus) that you can use in subsequent activities (e.g., conditional logic).

How it works​

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Amazon Comprehend Scope activity to your project.
  3. Add the PHI Analysis activity inside the Amazon Comprehend Scope activity.
  4. Click the Configure button inside the PHI Analysis activity (this opens the Object Wizard).
  5. Select the Method you want to invoke and enter values for the fields returned in the Object Wizard.
  6. Create and enter a ResponseStatus variable for the Output property.

In the Body of the Activity​

To enter your PHI Analysis property values, you must use the Object Wizard by clicking the Configure button.

Properties​

Common​

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output​

  • ResponseStatus - The status of the request (success/failure information). This field supports only ResponseStatus variables (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.