...
...
...
...
...
...
| Table of Contents |
|---|
Summary
This page contains documentation for upload surgical pathology report REST API. Use the HTTP POST method to call this API by passing a file as a path variable. The file can be text or 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 the following url URL to upload surgical pathology report (SPR)
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file
Parameter | Details |
|---|---|
| visitIdid | Identifier of the visit. |
| file | Report file to upload |
...
Result
Response The response will contain the file name of the uploaded report.
Example
| URL | |
| Method | POST |
| Content-Type | applicationmultipart/jsonform-data |
| Request | file: spr.pdf |
Response | spr.txt |
Error
...
Cases
Code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical Pathology Report (SPR) has been uploaded successfully |
| 400 | All requests | Invalid parameters |
| 401 | All requests | User does not have sufficient rights to perform this operation |
| 404 | All requests | Visit specified in the requested operation does not existsexist |
| 500 | All requests | Internal Server Error. Report this error to the system administrator |