Appendix A: API parameters - Appendix A: API parameters - PACSgear - PACS Scan Mobile - PACSgear/PACS-Scan-Mobile/4.0/PACS-Scan-Mobile-User-Help/Appendix-A-API-parameters - 4.0 - 4.0

You can use the following API calls to launch PACS Scan Mobile by using the base URL <cmdname>PACSScanMobile://</cmdname> from Mobile Safari or another browser application.

You can pass parameters to the app by using the app launch name, PACSScan-Mobile:// and appending ?key=value. You can append additional parameters by adding an ampersand (&) and another key/value pair.

Example

PACSScanMobile://?firstname=test&mrn=1234

Parameters

Parameter Key Value Patient Name patientName String, in the format, Lastname^FirstName^MiddleName First Name firstName String Last Name lastName String Middle Name middleName String MRN mrn String Date of Birth dob String formatted with DICOM style date. For example, 19770526. Sex sex String. Acceptable values are m, f, male, female. It is not case sensitive. Accession Number acc String Study Description studyDesc String Server IP or Name serverIP String. Do not include http, https or www. You can append the port number to the end preceded with a colon. Server SLL Flag isSSL String. t for true, and everything else is false. It is not case sensitive. Return URL returnURL String, callback URL. It can be an iOS app URL scheme or a web address. Department Department String Query enable AllowQuery TRUE or FALSE Auto lookup enable AutoQuery TRUE or FALSE Username Username String Password Password String Operator Operator String Domain Domain String. Assigns the user to the appropriate domain for authentication. Its value is the defined domain value in PACSgear Enterprise, such as Local. This parameter is only needed if the user launching PACS Scan Mobile is not a member of the default domain user group defined in PACSgear Enterprise. args Args String scroll scroll TRUE or FALSE