openspecimen/rest/ng/visits/{visitId}/spr-file/{file}
Use this resource to upload surgical pathology report (SPR) for visit. Use
| 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. In Surgical pathology report we upload report, deidentify report (if deidentifier is configured) and save report content in txt format.
URL :
Use following url
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 local needs.
Request Details
Use the following URL to upload surgical pathology report (SPR)
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file/{file}
Result :
Response will contain file
Parameter | Details |
|---|---|
| id | Identifier of the visit. |
| file | Report file to upload |
Result
The response will contain the file name of the uploaded report.
Example
...
| URL |
|
| Method | POSTRequest |
| Content-Type | applicationmultipart/jsonform-data |
| json | {}
|
| Request | file: spr.pdf |
Response | spr.txt |
Error
...
Cases
codeCode | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical Pathology Report (SPR) has been uploaded successfully |
| 400 | All requests | Invalid parameters |
| 401 | All requests | Authorization failed, User doesn’t have Authoritydoes not have sufficient rights to perform this operation |
| 404 | All requests | Visit not found, Visit with given identifier specified in the requested operation does not exist in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operationsServer Error. Report this error to the system administrator |