Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Summary

This page contains documentation for upload surgical pathology report REST API. Use HTTP POST method to call this API by passing a file as a path variable. In Surgical pathology report we upload report, deidentify report (if deidentifier is configured) and save report content in txt format. The file can be text or PDF format.

In case of PDF format

  • The API will extract the text content from the PDF.
  • Subsequently only a text format of the report is available (i.e. not PDF).
  • If you want to process the PDF to remove unwanted headers, footers, etc, you will need to write a custom plugin.

De-identify: By default there is no de-identification support. You can develop and plugin custom deidentifier based on the local needs.

Request Details

Use following url to upload surgical pathology report (SPR)

...

Parameter
Details
visitIdIdentifier of the visit.
fileReport file to upload


Result 

Response will contain file name of uploaded report.

 

Example

URL

http://<host>:<port>/openspecimen/rest/ng/visits/1/spr-file

MethodPOST
Content-Typeapplication/json
Requestfile : spr.pdf

Response

spr.txt

Error Cases 

...