SonicDICOM PACS. Integration Manual June, JIUN Corporation. All rights reserved.

Transcription

1 SonicDICOM PACS Integration Manual 19 June, JIUN Corporation. All rights reserved.

2 Contents Integration Manual... 3 Version history Login Login by another Method Get the One-Time Password Encrypt ID and Password Login by using the encrypted character string Search Available Keys and Operators in Worklist Available Keys and Operators in Viewer

3 Integration Manual DICOM Viewer of SonicDICOM PACS can be integrated with third-party other software (EMR, HIS/RIS etc.). Adding parameters to URL, and then open a Web browser, you can login with any ID. You can also display Study list and images which match the search criteria. Version history Version Date Description 1.0 February 16, 2016 The first edition issued. 2.0 June 19, Login by another method was added. Some changes on configuration of documents and contents. 3

4 1. Login You can simply login to SonicDICOM PACS DICOM Viewer by starting up Web browser from other software and adding the following parameters to URL hash. Worklist: Viewer: After executing a login process, parameters of ID and Password will be removed automatically from URL hash. Also, ID and Password information will not be remained on a history of Web browser. 4

5 2. Login by another Method A login method of previous term is very simple and easy to use, but in some cases, users need to login by more secure method. The following description shows a login method by using encryption method. 2.1 Get the One-Time Password Please issue POST request for the following URL from other software, and please get the one-time password. SonicDICOM PACS will create the secret key and the public key when the one-time password is generated, and SonicDICOM PACS will respond public key as the one-time password. URL: /viewer/api/otp/ 2.2 Encrypt ID and Password Please encrypt ID and Password by RSA method on other software side using the one-time password that is got from SonicDICOM PACS. Example for before encrypting character string: id=admin&password=password Example for after encrypting character string: encryptedstring 2.3 Login by using the encrypted character string Please change the parameter of URL hash as the following, and please execute a login. Example of URL: /viewer/list.html#code=encryptedstring Once SonicDICOM PACS receives such a request, it will decrypt the encrypted character string by using the secret key which is created when the one-time password is generated. And then it will execute a login process inside of software. If it succeeded a login, it responds HTTP code 200, and if it failed, it responds 401. The one-time password will be deleted automatically if it is used once or if it spends a certain time after its generation. 5

6 3. Search Adding parameters such as the followings to URL hash, you can easily get a result which matches search criteria. Worklist: Viewer: You can easily execute a search from other software by adding any parameters to URL hash after ID and Password. NOTE Please change "localhost" in URL to a PC's IP address which SonicDICOM PACS is working. If you already specified a port number which Web server of SonicDICOM PACS uses, please add a port number after IP address like as " :8080" Please insert "&" between each parameter. Please make sure to do an escape process for parameter values (symbols except for alphanumeric). If you already logged in to SonicDICOM PACS with your decided ID, your ID and Password can be omitted. 6

7 4. Available Keys and Operators in Worklist In Worklist (list.html), the following keys can be used as search criteria. You need to do an escape process for parameter values (symbols except for alphanumeric characters). Also, if you use more than one parameter, please insert "&" between each parameter. Item Key Example Study Instance UID studyinstanceuid studyinstanceuid=1%2e2%2e392%2e200224%2e2%2e3000%2 E8001 (studyinstanceuid= ) Series Instance UID seriesinstanceuid seriesinstanceuid=1%2e2%2e392%2e200224%2e3%2e3000% 2E8002 (seriesinstanceuid= ) SOP Instance UID sopinstanceuid sopinstanceuid=1%2e2%2e392%2e200224%2e3%2e3000%2e 8003 (sopinstanceuid= ) Patient ID patientid patientid=12345 (patientid=12345) Patient Name patientname patientname=john (patientname=john) Patient Comments patientcomments patientcomments=something (patientcomments=something) Patient Birth Date patientbirthdate patientbirthdate=1990%2f04%2f01 (patientbirthdate=1990/04/01) Patient Sex patientsex patientsex=m (patientsex=m) Study Description studydescription studydescription=something (studydescription=something) Study ID studyid studyid= (studyid=123456) Study Date studydate studydate=2014%2f01%2f23 (studydate=2014/01/23) Study Time studytime studytime=10%3a56%3a20 (studytime=10:56:20) Accession Number accessionnumber accessionnumber= (accessionnumber= ) Series Number seriesnumber seriesnumber=1 (seriesnumber=1) Series Date seriesdate seriesdate=2014%2f01%2f23 (seriesdate=2014/01/23) Series Time seriestime seriestime=10%3a56%3a20 (seriestime=10:56:20) Series Description seriesdescription seriesdescription=something (seriesdescription=something) Modality modality modality=mr (modality=mr) Bodypart Examined bodypartexamined bodypartexamined=knee (bodypartexamined=knee) 7

8 In Worklist (list.html), you can use the following operators. You need to do an escape process for operators except for the first "=". Item Operator Escaped Equal = or === = 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 Exception OR search is available by specifying the item of Modality as follows. modality=cr&modality=ct Range search is available by specifying the item of StudyDate as follows. studydate=%3d~2013/11/25~2016/08/31 Special values can be specified for the item of StudyDate as follows. studydate=today studydate=yesterday studydate=pastweek 8

9 5. Available Keys and Operators in Viewer In Viewer (view.html), the following keys can be used as search criteria. You need to do an escape process for parameter values (symbols except for alphanumeric characters). Also, if you use more than one parameter, please insert "&" between each parameter. Item Key Example Study Instance UID studyinstanceuid studyinstanceuid=1%2e2%2e392%2e200224%2e2%2e3000%2e 8001 (studyinstanceuid= ) Series Instance UID seriesinstanceuid seriesinstanceuid=1%2e2%2e392%2e200224%2e3%2e3000%2e 8002 (seriesinstanceuid= ) SOP Instance UID sopinstanceuid sopinstanceuid=1%2e2%2e392%2e200224%2e3%2e3000%2e8 003 (sopinstanceuid= ) Patient ID patientid patientid=12345 Accession Number accessionnumber accessionnumber= In Viewer (view.html), you can use the following operators. Item Operator Equal = 9