Specifications of Integration

Specifications of Integration

This document is also available in PDF format, please download.

1. Introduction

SonicDICOM can be integrated with third-party other softwares (ERM, HIS/RIS etc.). Results will be filtered using the URL parameters from the other software, and studies matching the criteria (e.g., Patient ID, etc.) will be displayed. This operation can be run from both the Worklist page (list.html) and the Viewer page (view.html).

1.1 Version history

VersionDateDescription
1.02016/02/16First version

2. How to Display

  1. Launch your web browser from the other software, set the parameters for the SonicDICOM URL, and then access it.
  2. Studies matching the filter criteria will be displayed.

2.1 EXAMPLE

Worklist Page:
http://192.168.100.1/viewer/list.html#id=admin&password=password&patientid=%3D%3D123

In this example, you log in automatically with the default SonicDICOM account (ID: admin, Password: password), and the studies for Patient ID 123 are displayed on the Worklist page.

Viewer Page:
http://192.168.100.1/viewer/view.html#id=admin&password=password&patientid=123

In this example, you log in automatically with the default SonicDICOM account (ID: admin, Password: password), and the studies for Patient ID 123 are displayed on the Viewer page.

2.2 Required Parameters

The three parameters below are required for integrating.

idThe login ID for SonicDICOM
EXAMPLE: id=admin
passwordThe account password for SonicDICOM
EXAMPLE: password=password
filter criteriaThe filter criteria
EXAMPLE: patientid=%3D%3D123

*For the “192.168.10.100.1” section, enter the IP address of the PC on which SonicDICOM is installed.
*For the “admin” and “password” sections, enter your account’s log in information for SonicDICOM.
*Enter “&” between each set of parameters.
*For parameter values (Non-alphanumeric symbols), always use escapes. The “%3D%3D” in the example is the escaped equivalent of “==”.

3. Worklist page

On the Worklist page (list.html), you can set the following entries as filter criteria.

3.1 Parameters

ItemParameterExample
Study Instance UIDstudyinstanceuidstudyinstanceuid=%3D%3D1%2E2%2E392%2E200224%2E2%2E3000%2E8001
(studyinstanceuid===1.2.392.200224.2.3000.8001)
Series Instance UIDseriesinstanceuidseriesinstanceuid=%3D%3D1%2E2%2E392%2E200224%2E3%2E3000%2E8002
(seriesinstanceuid===1.2.392.200224.3.3000.8002)
SOP Instance UIDsopinstanceuidsopinstanceuid=%3D%3D1%2E2%2E392%2E200224%2E3%2E3000%2E8003
(sopinstanceuid===1.2.392.200224.3.3000.8003)
Patient IDpatientidpatientid=%3D%3D12345
(patientid===12345)
Patient Namepatientnamepatientname=%3D%3Djohn
(patientname===john)
Patient Commentspatientcommentspatientcomments=%3D%3Dsomething
(patientcomments===something)
Patient Birth Datepatientbirthdatepatientbirthdate=%3D%3D1990%2F04%2F01
(patientbirthdate===1990/04/01)
Patient Sexpatientsexpatientsex=%3D%3Dm
(patientsex===m)
Study Descriptionstudydescriptionstudydescription=%3D%3Dsomething
(studydescription===something)
Study IDstudyidstudyid=%3D%3D123456
(studyid===123456)
Study Datestudydatestudydate=%3D%3D2014%2F01%2F23
(studydate===2014/01/23)
Study Timestudytimestudytime=%3D%3D10%3A56%3A20
(studytime===10:56:20)
Accession Numberaccessionnumberaccessionnumber=%3D%3D20140123001
(accessionnumber===20140123001)
Series Numberseriesnumberseriesnumber=%3D%3D1
(seriesnumber===1)
Series Dateseriesdateseriesdate=%3D%3D2014%2F01%2F23
(seriesdate===2014/01/23)
Series Timeseriestimeseriestime=%3D%3D10%3A56%3A20
(seriestime===10:56:20)
Series Descriptionseriesdescriptionseriesdescription=%3D%3Dsomething
(seriesdescription===something)
Modalitymodalitymodality=%3D%3Dmr
(modality===mr)
Bodypart Examinedbodypartexaminedbodypartexamined=%3D%3Dknee
(bodypartexamined===knee)

3.2 Operators

On the Workist page (list.html), you can use the following operators.

ItemOperatorEscaped
Equal= or
===
=
=%3D%3D
Not Equal=!==%21%3D
Greater Than=>>=%3E%3E
Greater Than Or Equal=>==%3E%3D
Less Than=<<=%3C%3C
Less Than Or Equal=<==%3C%3D
Contains=**=%2A%2A

4. Viewer page

On the Viewer page (view.html), you can set the following entries as filter criteria.

4.1 Parameters

ItemParameterExample
Study Instance UIDstudyinstanceuidstudyinstanceuid=1%2E2%2E392%2E200224%2E2%2E3000%2E8001
(studyinstanceuid=1.2.392.200224.2.3000.8001)
Series Instance UIDseriesinstanceuidseriesinstanceuid=1%2E2%2E392%2E200224%2E3%2E3000%2E8002
(seriesinstanceuid=1.2.392.200224.3.3000.8002)
SOP Instance UIDsopinstanceuidsopinstanceuid=1%2E2%2E392%2E200224%2E3%2E3000%2E8003
(sopinstanceuid=1.2.392.200224.3.3000.8003)
Patient IDpatientidpatientid=12345
Accession Numberaccessionnumberaccessionnumber=20140123001

4.2 Operators

On the Viewer page (view.html), you can use the following operators.

ItemOperatorEscaped
Equal==