PostDICOM logo
PostDICOM logo

Using PostDICOM Cloud API

In this article, you will learn how to use PostDICOM Cloud API from your application or web interface.

If you want to use PostDICOM Cloud API, first of all you need two keys namely accountKey and apiKey. Please contact us and get yours. Details about these keys can be found below.

accountKey: This is the key assigned to your account by PostDICOM. It is unique and it is created when you register to PostDICOM and it does not change in time.

apiKey: This is the key assigned to a account which is authorized to use PostDICOM API functionality. It is adviced to change this key regularly.

What functions are supported by PostDICOM API?

You can get information about your users, institutions and studies. Moreover, you can upload DICOM files from your application of web interface. Functions and their usage are described below.

PostDICOM Cloud API Details

PostDICOM Cloud API javascript library can be downloaded from PostDicomCloudApi.js link. Add this address to "head" section of your HTML page. Example usage is as follows.

<script src="https://www.postdicom.com/cloud-api/PostDicomCloudApi.min.js" type="text/javascript"></script>

PostDICOM Cloud API Supported Functions

Initialization

To use PostDICOM Cloud API service, first call "postDicomCloudApi" method with your apiKey and accountKey. This will create an object. Sample usage is at below.

var myApi = new postDicomCloudApi(myApiKey, myAccountKey);

After object is created, call its "Initialize" method. This method checks your accountKey with apiKey and when finished calls the callback method. Results are in jSON format and they can be viewed in the callback method. Example usage is given below.

myApi.Initialize(function(result){
//result format is jSON.
//result contains "Success", "Message" and "Account" properties.
//If "Success" is true initailize completed. "Account" contains your account informations.
//If "Success" is false initialize failed. "Message" contains failed reason.
});

Create Folder

Using PostDICOM Cloud API, you can create folder in your account. userUuid and folderName parameters must be provided. result is returned in jSON format and include folder informations. Example usage is given below.

myApi.CreateFolder(userUuid(string), folderName(string), function(result){
//result format is jSON.
});

Searching for Studies

Using PostDICOM Cloud API, you can search studies in your account with different parameters. userUuid and institutionUuid parameters must be provided and other parameters are optional. You can search studies in the created folder with using folderUuid parameter. Search result is returned in jSON format. Example usage is given below.

myApi.GetPatientOrderWithDateRange(function(result){
//result format is jSON.
}, userUuid(string), institutionUuid(string), patientName(string), accessionNumber(string), patientId(string), otherPatientId(string), modalities(string array), startDate(date), endDate(date));

myApi.GetPatientOrderWithAllDates(function(result){
//result format is jSON.
}, userUuid(string), institutionUuid(string), patientName(string), accessionNumber(string), patientId(string), otherPatientId(string), modalities(string array));

myApi.GetPatientOrderFromFolder(function(result){
//result format is jSON.
}, userUuid(string), institutionUuid(string), folderUuid(string));

Obtaining an access link to view studies

You can create access links for your studies in your account. Method name and parameters are given below. userUuid parameter must be provided. Open the link in your application or through a web browser like Google Chrome, Mozilla Firefox, etc. For security reasons IP addresses of the link request and viewer must be the same.

myApi.GetViewUrlWithPatientId(userUuid(string), patientId(string), function(result){
//result format is jSON.
//result contains "Success", "Message", "ExpireDate", "Result".
//If "Success" is true access url created. "Result" contains access url.
//If "Success" is false create url failed. "Message" contains failed reason.
});

myApi.GetViewUrlWithAccessionNumber(userUuid(string), accessionNumber(string), function(result){
//result format is jSON.
//result contains "Success", "Message", "ExpireDate", "Result".
//If "Success" is true access url created. "Result" contains access url.
//If "Success" is false create url failed. "Message" contains failed reason.
});

myApi.GetViewUrlWithPatientOrderUuid(userUuid(string), patientOrderUuid(string), function(result){
//result format is jSON.
//result contains "Success", "Message", "ExpireDate", "Result".
//If "Success" is true access url created. "Result" contains access url.
//If "Success" is false create url failed. "Message" contains failed reason.
});

Uploading DICOM images

Using PostDICOM Cloud API, you can upload DICOM images from your application or web interface. userUuid and institutionUuid parameters must be provided. You can group uploaded images using the folderUuid parameter. During upload callback method will be invoked to provide upload progress and upload completed events. Only files in DICOM format can be uploaded.

myApi.UploadDicomFiles(userUuid(string), institutionUuid(string), selectedFiles(input file list), function(result){
//result format is jSON.
//result contains upload status and progress.
});

myApi.UploadDicomFilesIntoFolder(userUuid(string), institutionUuid(string), folderUuid(string), selectedFiles(input file list), function(result){
//result format is jSON.
//result contains upload status and progress.
});

About

PostDICOM is the next generation PACS (Picture Archiving and Communication System) which is built using Cloud technologies. It provides advanced tools and services to be used by healthcare professionals.

Quick Links

Address: PostDICOM
Kemp House, 152 - 160 City Road,
London, EC1V2NX

CONNECT WITH US

Contact Us

Send

mail icon

Need help?

Do you need help?
- OR -

The password must have at least 1 lowercase letter.


The password must have at least 1 uppercase letter.


The password must have at least 1 numeric character.


The password must contains at least 6 characters.


The password must contains no more than 16 characters.


- OR -

This browser is not supported by PostDICOM applications yet.


Please use one of the following browsers.


loading gif