Versions Compared

Key

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

openspecimen/rest/ng/visits/{visitId}/spr-file/{file}

Use this resource to upload  surgical pathology report (SPR) for visit. Use HTTP POST method to call this API by passing 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. 

URL : 

Use 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 name of uploaded report.

 

Example:

 

URL

http://<host>:<port>/openspecimen/rest/ng/visits/1/spr-file/{fileName:spr.pdf}

MethodPOST
Requestapplication/json
json

{}

 

Response

spr.txt

 

Error Cases :

...

code

...

Applies to

...

Status Message

...

Introduction:

Surgical pathology reports (SPRs) contain vital information based on the surgeon's pathological observations about the patient and biospecimens. In OpenSpecimen v2.0, SPRs are uploaded at the visit level.

From the user interface, one can upload PDFs and/or text files to upload SPRs. Alternatively one can use the APIs to integrate with your pathology systems (e.g. Cerner).

This page explains how to use the APIs to upload SPRs to OpenSpecimen.

Below is the list of available REST API's.

Child pages (Children Display)
sortcreation