View source for The Lookup Table Modification API

This article describes how to update the DICOM Anonymizer lookup table through an external program. The intended audience of this article is software developers. See [[The CTP Lookup Table Editor]] for a description of the lookup table structure.

An external program can add or modify a single entry in the lookup table for a DicomAnonymizer stage by accessing the CTP LookupServlet with this URL path:

:<b><tt>/lookup?id=...&key=...&value</tt></b>

where:
* <b><tt>id</tt></b> is the <b><tt>id</tt></b> attribute of the DicomAnonymizer stage whose lookup table is to be modified
* <b><tt>key</tt></b> is the key of the lookup table entry to be created or modified
* <b><tt>value</tt></b> is the value to be assigned to the key

To be effective, the key must include both the KeyType and the PHI value. For example:

:<b><tt>http://192.168.0.4:8080/lookup?id=TEST&key=ptid/567&value=777</tt></b>

adds the <b><tt>ptid/567</tt></b> entry to the table and assigns it the value <b><tt>777</tt></b>.

The LookupServlet supports this API through both the HTTP GET and PUT methods. GET is supported only to make initial testing easy. Developers are encouraged to implement using the PUT method as the GET support will be removed in the near future.