Before You Start
Make sure you have the following:
- Case name - will appear in the Case Details section of the summary and also in the DigitalOwl portal
- Business Line ID - The ID of the Business Line you wish to upload the case too. See here for further details: How to retrieve the Business Line ID
- Medical Documents - All the documents that need to be uploaded to be consolidated into one case.
Uploading a case requires three different requests to our API
Step 1 - Creating a Case
The case object is where you’d upload the medical documents and download the summary output
POST /cases
Body Fields
| Name | Description | Type | REQUIRED |
|---|---|---|---|
| name | The title you want on the case | String | ✔️ |
| businessLineId | The Business Line ID of the case | String | ✔️ |
Important - The response will include a caseId field that will be required for later use.
Step 2 - Uploading Documents
POST /documents
Request Body
The request body should include the binary data of the document.
Headers
| Name | Description | Type | REQUIRED |
|---|---|---|---|
| Content-Length | Document size in bytes | Number | ✔️ |
| Content-Type | Document Mime-Type | String | ✔️ |
| x-case-id | Case Id to upload the documents to | String | ✔️ |
| x-file-name | Document file name | String | ✔️ |
Supported Mime-Type
- application/pdf
- image/jpeg
- image/png
- image/tiff
Step 3 - Start Processing the Case
POST /cases/{caseId}/process
After all the documents have been uploaded successfully, you will need to send an additional request to start the case processing. You will need to call this endpoint within 24 hours of creating the case, after the 24 hours, the case will expired.
Params
| Name | Description | Type | REQUIRED |
|---|---|---|---|
| caseId | Case Id of the case to process | String | ✔️ |
Step 4 - Get Case Status
GET /cases/{caseId}
The result body will have a property named externalStatus, when the externalStatus value is completed, the summary is ready and you can proceed to the next step
Params
| Name | Description | Type | REQUIRED |
|---|---|---|---|
| caseId | Case Id | String | ✔️ |
Step 5 - Download Case Summary
GET /cases/{caseId}/summary
This request will download the case summary.
Params
| Name | Description | Type | REQUIRED |
|---|---|---|---|
| caseId | Case Id | String | ✔️ |