Difference between revisions of "The Lookup Table Modification API"

From MircWiki
Jump to: navigation, search
(Created page with "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 Lo...")
(No difference)

Revision as of 13:01, 25 June 2015

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:

/lookup?id=...&key=...&value

where:

  • id is the id attribute of the DicomAnonymizer stage whose lookup table is to be modified
  • key is the key of the lookup table entry to be created or modified
  • value 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:

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

adds the ptid/567 entry to the table and assigns it the value 777.

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.