Philter’s API provides access to Philter’s ability to detect and remove PHI and PII and to monitor Philter’s status. The available methods are available via Philter’s REST interface.
curl examples shown on this page are written assuming Philter has been enabled for SSL. If launched from the AWS or Windows Azure marketplaces or DockerHub, SSL will automatically be enabled. See the Configuration for more information on SSL.
Filtering PHI and PII in Text
This API endpoint receives text and removes PHI from the text based on Philter’s enabled and configured filters. If not provided, the context defaults to
none, and if not provided, the filter profile name defaults to
The response will consist of the plain-text filtered text.
The response will have a header called
x-document-id that contains the Philter-assigned document ID of the submitted text. This document ID will be required if you wish to retrieve the locations of identified PHI/PII in the text at a later time. If you are not using the Filtered Replacements Store and are not interested in retrieving the locations of the identified PHI/PII you can discard the value of this header.
Retrieving PHI/PII Replacement Values
This API endpoint receives the filtered text and their replacements. This endpoint allows you to maintain a history of what information was filtered and anonymized for each document. Note that the store must be enabled for this functionality to be available. Refer to Philter’s Configuration for details on how to enable the store.
The response will be a list of JSON objects that describe the filtered text.
Getting Philter’s Status
This API endpoint returns the status of Philter which will either be
HTTP 200 OK or
HTTP 503 Service Unavailable. This endpoint is well suited for use by an external application or service to monitor the status of Philter, such as for health checks when deployed behind an AWS EC2 load balancer.
Note that Philter will return
HTTP 503 Service Unavailable during initialization. Initial health checks during Philter’s initialization should be delayed by at least 2 minutes to allow adequate time for Philter to initialize.
||Philter is initializing or unhealth.||
||Philter is healthy.||