Detectors /   DETECTOR
Generate Code Validate Data   Nightfall Console

Protected Health Information

This is a DLP detector that you can easily use or extend upon in the Nightfall platform.

Description Detects protected health information (PHI). HIPAA defines PHI as data that uniquely identifies an individual plus a diagnostic indicator such as medication, diagnosis, and procedure.
Detector type AI Model (Entity Detection)
Category Health
Region Global
Tags health pii hipaa
Enum (for using this detector via the API)
PROTECTED_HEALTH_INFORMATION

Used in These Detection Rules

Used in These Policies


Use Detector via API

Read API Reference

curl --request POST \
     --url https://api.nightfall.ai/v3/scan \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer  REPLACE-WITH-YOUR-KEY' \
     --header 'Content-Type: application/json' \
     --data '
{
     "policy": {
          "detectionRules": [
               {
                    "detectors": [
                         {
                              "minNumFindings": 1,
                              "minConfidence": "LIKELY",
                              "displayName": "Protected Health Information",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "PROTECTED_HEALTH_INFORMATION"
                         }                    ],
                    "name": "My Inline Detection Rule",
                    "logicalOp": "ANY"
               }
          ]
     },
     "payload": [
          "INSERT 1+ PAYLOAD(S)",
          "INSERT 1+ PAYLOAD(S)"
     ]
}
'

          import requests
          import json

          api_key = "REPLACE-WITH-YOUR-KEY"
          url = "https://api.nightfall.ai/v3/scan"

          headers = {
              "Accept": "application/json",
              "Authorization": f"Bearer {api_key}",
              "Content-Type": "application/json"
          }

          payload = {
              "policy": {
                  "detectionRules": [
                      {
                          "detectors": [
                              {
                                  "minNumFindings": 1,
                                  "minConfidence": "LIKELY",
                                  "displayName": "Protected Health Information",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "PROTECTED_HEALTH_INFORMATION"
                              }
                          ],
                          "name": "My Inline Detection Rule",
                          "logicalOp": "ANY"
                      }
                  ]
              },
              "payload": [
                  "INSERT 1+ PAYLOAD(S)",
                  "INSERT 1+ PAYLOAD(S)"
              ]
          }

          response = requests.post(url, headers=headers, data=json.dumps(payload))
          print(response.status_code)
          print(response.json())
          

Protected Health Information Validator

Input any text to validate or test. The default minimum confidence is set to "Possible".