Schema: Identify_phi

Understanding the JSON schema for the identify_phi endpoint.

JSON Response

Skip to key:value pairs.

{
  "input_text": "Patient: John Doe\nAddress: 112 First Ave, New York, NY\nPhone: 555-555-1212\nAdmission date: December 13, 2022\nDiagnosis: UTI\nPhysician: Dr. Jane Smith\nNPI: 1234567890\nPhysician number: 555-555-9876\nClinical note:\nMr. Doe is a 75-year-old male with a history of urinary tract infections.\nHe presented to the Pearson clinic today with symptoms of dysuria and frequency.\nA urine culture was performed by Dr. Jones and showed significant growth of Escherichia coli.\nThe patient was started on a course of oral antibiotics and will follow up with\nthe clinic in one week for a repeat urine culture.\nIf no improvement, patient will be referred to St. Joseph Hospital.",
  "annotations": [
    {
      "labels": {
        "phi_type": {
          "label": "[PATIENT]",
          "score": 1.0
        },
        "category": {
          "label": "[PERSON]"
        }
      },
      "text": "John Doe",
      "span": {
        "start": 9,
        "end": 17
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[STREET]",
          "score": 0.998
        },
        "category": {
          "label": "[LOCATION]"
        }
      },
      "text": "112 First Ave",
      "span": {
        "start": 27,
        "end": 40
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[CITY]",
          "score": 0.94
        },
        "category": {
          "label": "[LOCATION]"
        }
      },
      "text": "New York",
      "span": {
        "start": 42,
        "end": 50
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[STATE]",
          "score": 0.999
        },
        "category": {
          "label": "[LOCATION]"
        }
      },
      "text": "NY",
      "span": {
        "start": 52,
        "end": 54
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[PHONE]",
          "score": 0.983
        },
        "category": {
          "label": "[CONTACT]"
        }
      },
      "text": "555-555-1212",
      "span": {
        "start": 62,
        "end": 74
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[DATE]",
          "score": 1.0
        },
        "category": {
          "label": "[DATE]"
        }
      },
      "text": "December 13, 2022",
      "span": {
        "start": 91,
        "end": 108
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[DOCTOR]",
          "score": 0.999
        },
        "category": {
          "label": "[PERSON]"
        }
      },
      "text": "Jane Smith",
      "span": {
        "start": 139,
        "end": 149
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[MEDICALRECORD]",
          "score": 0.829
        },
        "category": {
          "label": "[IDENTIFIER]"
        }
      },
      "text": "1234567890",
      "span": {
        "start": 155,
        "end": 165
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[PHONE]",
          "score": 0.843
        },
        "category": {
          "label": "[CONTACT]"
        }
      },
      "text": "555-555-9876",
      "span": {
        "start": 184,
        "end": 196
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[PATIENT]",
          "score": 1.0
        },
        "category": {
          "label": "[PERSON]"
        }
      },
      "text": "Doe",
      "span": {
        "start": 216,
        "end": 219
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[AGE]",
          "score": 0.999
        },
        "category": {
          "label": "[DEMOGRAPHICS]"
        }
      },
      "text": "75",
      "span": {
        "start": 225,
        "end": 227
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[HOSPITAL]",
          "score": 0.996
        },
        "category": {
          "label": "[INSTITUTION]"
        }
      },
      "text": "Pearson clinic",
      "span": {
        "start": 306,
        "end": 320
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[DOCTOR]",
          "score": 0.999
        },
        "category": {
          "label": "[PERSON]"
        }
      },
      "text": "Jones",
      "span": {
        "start": 404,
        "end": 409
      }
    },
    {
      "labels": {
        "phi_type": {
          "label": "[HOSPITAL]",
          "score": 0.999
        },
        "category": {
          "label": "[INSTITUTION]"
        }
      },
      "text": "St. Joseph Hospital",
      "span": {
        "start": 639,
        "end": 658
      }
    }
  ]
}

Key:Value Pairs

KeyValue
annotationsContains an array of healthcare concepts identified in the text.
categoryThe broader PHI category assigned to the healthcare text.
endUsed with start under span. The precise ending index of the healthcare text in either the input_text (identify_phi) or output_text (redact_phi).
labelAn entity that has been recognized by the model for the specified text. The type of the label is determined by the parent key.
labelsThe named entities found in the annotated text span.
input_textThe original text sent to the API for analysis.
phi_typeThe PHI identifier assigned to the healthcare text.
scoreThe confidence our API’s model has in selecting the appropriate label for the PHI; 1.0 signifies full confidence from the model for the specified label.
spanContains the start and end for each piece of healthcare text.
startUsed with end under span. The precise starting index of the healthcare text in either the input_text (identify_phi) or output_text (redact_phi).
textA piece of text from the request that is recognized as healthcare information.