Category

The category designates a broad PHI category.

The identify_phi and redact_phi endpoints, as well as the Analyze - Web App, now include labels that are broken down by:

  • PHI Type (phi_type) - the PHI identifier assigned to the text.
  • Category (category) - the broader PHI category assigned to the text.
"annotations": [
    {
      "labels": {
        "phi_type": {
          "label": "[PATIENT]",
          "score": 1.0
        },
        "category": {
          "label": "[PERSON]"
        }
      },
      "text": "John Doe",
      "span": {
        "start": 9,
        "end": 17
      }
    },

List of Categories

The following categories are possible:

CONTACT
DATE
DEMOGRAPHICS
IDENTIFIER
INSTITUTION
LOCATION
ORGANIZATION
PERSON
WEBADDRESS

Mappings

Current mappings between each category and its included PHI types are as follows:

CategoryPHI Type
CONTACTEMAIL, FAX, PHONE, USERNAME
DATEDATE
DEMOGRAPHICSAGE, PROFESSION
IDENTIFIERBIOID, DEVICE, HEALTHPLAN, IDNUM, MEDICAL RECORD
INSTITUTIONORGANIZATION
LOCATIONCITY, COUNTRY, STATE, STREET, ZIP, LOCATION-OTHER
ORGANIZATIONORGANIZATION
PERSONDOCTOR, PATIENT
WEBADDRESSURL