NLP Sandbox PHI Deidentifier API (1.2.0)

Download OpenAPI specification:Download

NLP Sandbox Team: team@nlpsandbox.io URL: https://nlpsandbox.io License: Apache 2.0

Introduction

This NLP tool takes as input a clinical note and returned a de-identified version of the note. This design of this API is a work in progress.

Examples

NLP Sandbox PHI Deidentifier Example

DeidentifiedNote

Operations about deidentified notes

Deidentify a clinical note

Returns the deidentified note

Request Body schema: application/json

required	object (Note) A clinical note
required	Array of objects (DeidentificationStep) A list of deidentification steps

Responses

Request samples

Payload

Content type

application/json

{"deidentificationSteps": [{"confidenceThreshold": 20,
"maskingCharConfig": {"maskingChar": "-"
},
"annotationTypes": ["text_date"
]
},
{"confidenceThreshold": 30,
"maskingCharConfig": {"maskingChar": "#"
},
"annotationTypes": ["text_person_name"
]
},
{"confidenceThreshold": 20,
"annotationTypeMaskConfig": { },
"annotationTypes": ["text_location"
]
}
],
"note": {"identifier": "awesome-note",
"text": "On 12/26/2020, Ms. Chloe Price met with Dr. Prescott in Seattle.",
"type": "loinc:LP29684-5",
"patientId": "awesome-patient"
}
}

Response samples

200
400
500

Content type

application/json

{"originalAnnotations": {"textDateAnnotations": [{"start": 42,
"length": 10,
"text": "10/26/2020",
"dateFormat": "MM/DD/YYYY",
"confidence": 95.5
}
],
"textPersonNameAnnotations": [{"start": 42,
"length": 11,
"text": "Chloe Price",
"confidence": 95.5
}
],
"textLocationAnnotations": [{"start": 42,
"length": 7,
"text": "Seattle",
"locationType": "city",
"confidence": 95.5
}
],
"textIdAnnotations": [{"start": 42,
"length": 11,
"text": "203-11-4535",
"idType": "ssn",
"confidence": 95.5
}
],
"textContactAnnotations": [{"start": 42,
"length": 11,
"text": "dave@uw.edu",
"contactType": "email",
"confidence": 95.5
}
]
},
"deidentifiedAnnotations": {"textDateAnnotations": [{"start": 42,
"length": 10,
"text": "10/26/2020",
"dateFormat": "MM/DD/YYYY",
"confidence": 95.5
}
],
"textPersonNameAnnotations": [{"start": 42,
"length": 11,
"text": "Chloe Price",
"confidence": 95.5
}
],
"textLocationAnnotations": [{"start": 42,
"length": 7,
"text": "Seattle",
"locationType": "city",
"confidence": 95.5
}
],
"textIdAnnotations": [{"start": 42,
"length": 11,
"text": "203-11-4535",
"idType": "ssn",
"confidence": 95.5
}
],
"textContactAnnotations": [{"start": 42,
"length": 11,
"text": "dave@uw.edu",
"contactType": "email",
"confidence": 95.5
}
]
},
"deidentifiedNote": {"identifier": "awesome-note",
"text": "On 12/26/2020, Ms. Chloe Price met with Dr. Prescott in Seattle.",
"type": "loinc:LP29684-5",
"patientId": "awesome-patient"
}
}

HealthCheck

Operations about health checks

Get health check information

Get information about the health of the service

Responses

Response samples

200
404
500

Content type

application/json

{"status": "pass"
}

Tool

Operations about this tool

Get tool information

Get information about the tool

Responses

Response samples

200
404
500

Content type

application/json

{"name": "awesome-nlp-tool",
"version": "1.0.6",
"license": "apache-2.0",
"repository": "github:awesome-org/awesome-nlp-tool",
"description": "An awesome NLP Tool that takes as input X and outputs Y.",
"author": "Awesome Team",
"authorEmail": "author@example.com",
"url": "https://example.com",
"type": "nlpsandbox:date-annotator",
"apiVersion": "1.2.0"
}

Get tool dependencies

Get the dependencies of this tool

Responses

Response samples

200
404
500

Content type

application/json

{"tools": [{"name": "awesome-nlp-tool",
"version": "1.0.6",
"license": "apache-2.0",
"repository": "github:awesome-org/awesome-nlp-tool",
"description": "An awesome NLP Tool that takes as input X and outputs Y.",
"author": "Awesome Team",
"authorEmail": "author@example.com",
"url": "https://example.com",
"type": "nlpsandbox:date-annotator",
"apiVersion": "1.2.0"
}
]
}