VIDA Intelligence Portal
DICOMweb API
This document provides in-depth documentation for VIDA DICOMweb API and how to use this
API for uploading data to the VIDA Intelligence Portal.
STOW-RS API
1. Authentication
VIDA's DICOMweb API supports basic authentication with a Portal username and password.
Requestors can use the Portal username and password encoded with base64 and pass into
Authorization Header of each API call.
2. Get Projects
This API is used for returning all projects associated with a user along with projectId and
organizationId which will be used to create the API URL for the STOW-RS endpoint. Need to pass
in base64 encoded Portal username and password in header.
Request URL
https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/projects
3. STOW-RS – Dicom standard upload
The STOW-RS API is designed for uploading DICOM (Digital Imaging and Communications in
Medicine) files of medical studies. This API allows you to upload individual DICOM files for a
study, one after another. The API provides a straightforward way to upload files, and it returns
detailed information about the uploaded files upon successful completion.
To upload the dicom files using standard api, we need to upload the dicom files one by one, after
completion for the one file we should upload the other. The STOW-RS endpoint (URL) needs to
get created using projectId and organizationId fetched from API response received by using
“https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/projects". Also, need to pass in
Base64 encoded Portal username and password.
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Api Endpoint
https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies
1. Upload Api-POST Method
This API is used to upload dicom files, which gets content in binary value as parameter. The
uploaded status will be in “Upload in progress" till last file upload and wait for 1 hour and change
the status to “upload complete” and proceed with the flow.
• content: The binary content of the DICOM file you want to upload.
Request URL
https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies
Payload
{
content: binary file content
}
Response
{
"statusCode": 200,
"body": “{\
"fileName\": \”00300.DCM\”
"filePath\": \”public/vidawebsolution/01539-d99820cf-e143-4b62-ae54-
c6cf5c153594/1111-5af6b4cf-7a4f-4b2f-8868-ccc1650dd740-5af6b4cf-7a4f-4b2f-
8868-ccc1650dd740/b33156ad-545b-481d-8235-53eee73dcefb/8862ad0a-c4c0-
4990-ae44-14e4e9db0d81/00300.DCM\”, \”seriesId\”:\”1.2.840.10008.5.1.4.1.1.2\”,
\”studyId\”:\”1.3.12.2.1107.5.8.10.268525804207157.020210810143444015\\”,
\”patientId\”:\”AT01_314_Baseline_AIRFLOW3\”,\”status\”:\”success\”
}"
}
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
4. STOW-RS – Upload Zip File
The DICOM ZIP File Upload API provides a comprehensive solution for uploading ZIP files
containing DICOM images. This process involves chunking large files, initiating uploads, and
completing the upload process. The API supports handling ZIP files that exceed the allowed size
by dividing them into manageable chunks. The API endpoints provided below are utilized to
manage the entire process.
The STOW-RS endpoint (URL) needs to get created using projectId and organizationId
fetched from API response received by calling the “https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-c6cf5c153594/06dfd13c-b35d-47a1-842c-
a431cd62933e/projects“. Also, need to pass in Base64 encoded Portal username and password.
This api accepts zip chunks and once completed, merges all received chunks and convert back to
zip and proceeds with the flow.
Initiate Upload : https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies/intiateupload
Upload : https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies/upload
Complete Upload : https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies/completeupload
Api Endpoint
1. IntiateUpload Api-POST Method
This API is used to initiate the upload by creating an upload ID. The following parameters are
required:
• count: Number of chunks to upload.
• fileName: Name of the ZIP file.
• filesize: Size of the ZIP file.
• timeZone: Time zone of the upload.
Headers:
Authorization: Basic [Base64 Encoded Username:Password]
Request URL
https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies/intiateupload
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Payload
{
count: 4,
fileName: "sample-zip-file - Copy (2).zip”,
filesize: 380,
timeZone: “Asia/Calcutta”
}
Response
{
"statusCode": 200,
"body": "{\"uploadId\": \”2e53bab1-e184-4418-85d8-03927259c160\",\”subjectId\”:\”4d53bab1-e184-4418-
85d8-03927259c160\"}"
}
2.Upload Api –Post Method
This API is used to upload a chunk of the ZIP file in binary format. Parameters include:
• file: Binary content of the chunk.
• fileName: Name of the ZIP file.
• uploadId: ID generated from the InitiateUpload API.
• count: Total number of chunks.
• chunkCount: Current chunk number.
Headers:
Authorization: Basic [Base64 Encoded Username:Password]
Request URL
https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies/upload
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Payload
{
file: (binary),
fileName: “"sample-zip-file - Copy (2).zip",
uploadId: “2e53bab1-e184-4418-85d8-03927259c160”,
count: 4,
chunkCount:4
}
Response
{
"statusCode": 200,
"body": "{\
"count\": \"1\",
\"start\": \"1\",
\"series\": \"\",
\"studyId\": \"\",
\"patientId\": \" \”,
\"currentCount\": \”1 \”,
\"uploadStatus\": \" Completed\”,
\"totalCount\": \"1 \"
}"
3.CompleteUpload – Post Method
This API completes the upload process when passing the count and uploadID in JSON format.
Headers:
Authorization: Basic [Base64 Encoded Username:Password]
Request URL
url:-https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies/completeupload
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Payload
{
uploadId: “2e53bab1-e184-4418-85d8-03927259c160”,
count: 1
}
Response
{
"statusCode": 200,
"body": "{\
"completed\": \"public/vidawebsolution/01539-d99820cf-e143-4b62-ae54-
c6cf5c153594/1111-5af6b4cf-7a4f-4b2f-8868-ccc1650dd740-5af6b4cf-7a4f-4b2f-
8868-ccc1650dd740/b33156ad-545b-481d-8235-53eee73dcefb/8862ad0a-c4c0-
4990-ae44-14e4e9db0d81/00300.DCM\"
}"
}
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
5. STOW-RS – Upload DICOM file
This API is used for uploading DICOM files of a study. This API should be called to upload each file
of a single study, one after another. The STOW-RS endpoint (URL) needs to be created using
projectId and organizationId fetched from API response received by using
“https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/projects".. Also, need to pass in Base64
encoded Portal username and password.
Initiate Upload : https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies/intiateupload
Upload : https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies/upload
Complete Upload : https://znoxv2atk6.execute-api.us-east-
2.amazonaws.com/prod/<projectId>/<organizationId>/stowrs/studies/completeupload
1. IntiateUpload Api-POST Method
This API is used to initiate the upload by creating an upload ID. The following parameters are
required:
• count: Number of files to upload.
• fileName: Name of the dicom file.
• filesize: Size of the total file.
• timeZone: Time zone of the upload.
Headers:
Authorization: Basic [Base64 Encoded Username:Password]
Request URL
https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies/intiateupload
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Payload
{
count: 1,
fileName: "0018.dcm",
filesize: 560782,
timeZone:”Asia/Calcutta”
}
Response
{
"statusCode": 200,
"body": "{\"uploadId\": \”2e53bab1-e184-4418-85d8-
03927259c160\”,\”subjectId\”:\”4d53bab1-e184-4418-85d8-03927259c160\”}”
}
2.Upload Api –Post Method
In this Api, we should pass binary format, fileName, count, chuckCount and uploadId and we
should check the chunk count and uploadId
• file: Binary content of the chunk.
• fileName: Name of the DICOM file.
• uploadId: Generated uploadID.
• count: Total count of chunks.
• chunkCount: Current chunk count.
Headers:
Authorization: Basic [Base64 Encoded Username:Password]
Request URL
https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies/upload
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Payload
{
file: (binary),
fileName: “0020.dcm",
uploadId: “”,
count: 4,
chunkCount:4
Response
{
"statusCode": 200,
"body": "{\
"count\": \"3\",
\"start\": \"3\",
\"series\": \"1.2.840.10008.5.1.4.1.1.2\",
\"studyId\": \"1.3.12.2.1107.5.8.10.268525804207157.020210810143444015\",
\"patientId\": \"AT01_314_Baseline_AIRFLOW3\"
}"
}
3.CompleteUpload – Post Method
This API completes the upload process when passing the count and uploadID in JSON format.
Headers:
Authorization: Basic [Base64 Encoded Username:Password]
Request URL
url:-https://znoxv2atk6.execute-api.us-east-2.amazonaws.com/prod/d99820cf-e143-4b62-ae54-
c6cf5c153594/06dfd13c-b35d-47a1-842c-a431cd62933e/stowrs/studies/completeupload
Payload
{
uploadId: “”,
count: 4,
}
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
VIDA Intelligence Portal
Response
{
"statusCode": 200,
"body": "{\
"filePath\": \”public/vidawebsolution/01539-d99820cf-e143-4b62-ae54-
c6cf5c153594/1111-5af6b4cf-7a4f-4b2f-8868-ccc1650dd740-5af6b4cf-7a4f-4b2f-
8868-ccc1650dd740/b33156ad-545b-481d-8235-53eee73dcefb/8862ad0a-c4c0-
4990-ae44-14e4e9db0d81/00300.DCM\”, \”studyId\”:\”b33156ad-545b-481d-8235-
53eee73dcefb\”, \”subjectId\”:\”5af6b4cf-7a4f-4b2f-8868-ccc1650dd740\”
}"
}
2023 © VIDA Diagnostics, Inc. vidalung.ai US-30078 (1)
