Schema: Redact_phi
Understanding the JSON schema for the
redact_phi
endpoint.JSON Response
{
"output_text": "Patient: [PATIENT]\nAddress: [STREET], [CITY], [STATE]\nPhone: [PHONE]\nAdmission date: [DATE]\nDiagnosis: UTI\nPhysician: Dr. [DOCTOR]\nNPI: [MEDICALRECORD]\nPhysician number: [PHONE]\nClinical note:\nMr. [PATIENT] is a [AGE]-year-old male with a history of urinary tract infections.\nHe presented to the [HOSPITAL] today with symptoms of dysuria and frequency.\nA urine culture was performed by Dr. [DOCTOR] 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 [HOSPITAL].",
"annotations": [
{
"labels": {
"phi_type": {
"label": "[PATIENT]",
"score": 1.0
},
"category": {
"label": "[PERSON]"
}
},
"text": "[PATIENT]",
"span": {
"start": 9,
"end": 18
}
},
{
"labels": {
"phi_type": {
"label": "[STREET]",
"score": 0.998
},
"category": {
"label": "[LOCATION]"
}
},
"text": "[STREET]",
"span": {
"start": 28,
"end": 36
}
},
{
"labels": {
"phi_type": {
"label": "[CITY]",
"score": 0.94
},
"category": {
"label": "[LOCATION]"
}
},
"text": "[CITY]",
"span": {
"start": 38,
"end": 44
}
},
{
"labels": {
"phi_type": {
"label": "[STATE]",
"score": 0.999
},
"category": {
"label": "[LOCATION]"
}
},
"text": "[STATE]",
"span": {
"start": 46,
"end": 53
}
},
{
"labels": {
"phi_type": {
"label": "[PHONE]",
"score": 0.983
},
"category": {
"label": "[CONTACT]"
}
},
"text": "[PHONE]",
"span": {
"start": 61,
"end": 68
}
},
{
"labels": {
"phi_type": {
"label": "[DATE]",
"score": 1.0
},
"category": {
"label": "[DATE]"
}
},
"text": "[DATE]",
"span": {
"start": 85,
"end": 91
}
},
{
"labels": {
"phi_type": {
"label": "[DOCTOR]",
"score": 0.999
},
"category": {
"label": "[PERSON]"
}
},
"text": "[DOCTOR]",
"span": {
"start": 122,
"end": 130
}
},
{
"labels": {
"phi_type": {
"label": "[MEDICALRECORD]",
"score": 0.829
},
"category": {
"label": "[IDENTIFIER]"
}
},
"text": "[MEDICALRECORD]",
"span": {
"start": 136,
"end": 151
}
},
{
"labels": {
"phi_type": {
"label": "[PHONE]",
"score": 0.843
},
"category": {
"label": "[CONTACT]"
}
},
"text": "[PHONE]",
"span": {
"start": 170,
"end": 177
}
},
{
"labels": {
"phi_type": {
"label": "[PATIENT]",
"score": 1.0
},
"category": {
"label": "[PERSON]"
}
},
"text": "[PATIENT]",
"span": {
"start": 197,
"end": 206
}
},
{
"labels": {
"phi_type": {
"label": "[AGE]",
"score": 0.999
},
"category": {
"label": "[DEMOGRAPHICS]"
}
},
"text": "[AGE]",
"span": {
"start": 212,
"end": 217
}
},
{
"labels": {
"phi_type": {
"label": "[HOSPITAL]",
"score": 0.996
},
"category": {
"label": "[INSTITUTION]"
}
},
"text": "[HOSPITAL]",
"span": {
"start": 296,
"end": 306
}
},
{
"labels": {
"phi_type": {
"label": "[DOCTOR]",
"score": 0.999
},
"category": {
"label": "[PERSON]"
}
},
"text": "[DOCTOR]",
"span": {
"start": 390,
"end": 398
}
},
{
"labels": {
"phi_type": {
"label": "[HOSPITAL]",
"score": 0.999
},
"category": {
"label": "[INSTITUTION]"
}
},
"text": "[HOSPITAL]",
"span": {
"start": 628,
"end": 638
}
}
]
}
Key:Value Pairs
Key | Value |
---|---|
annotations | Contains an array of healthcare concepts identified in the text. |
category | The broader PHI category assigned to the healthcare text. |
end | Used with start under span . The precise ending index of the healthcare text in either the input_text (identify_phi ) or output_text (redact_phi ). |
label | An entity that has been recognized by the model for the specified text. The type of the label is determined by the parent key. |
labels | The named entities found in the annotated text span. |
output_text | The redacted version of the original text that was sent to the API for analysis. |
phi_type | The PHI identifier assigned to the healthcare text. |
score | The 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. |
span | Contains the start and end for each piece of healthcare text. |
start | Used with end under span . The precise starting index of the healthcare text in either the input_text (identify_phi ) or output_text (redact_phi ). |
text | A piece of text from the request that is recognized as healthcare information. |
Feedback
Was this page helpful?
Great! If you ever have questions or want to provide feedback, send us an email.
Bummer. We hate when we miss the mark. If you have suggestions for improvements or other general comments, send us an email.