OVERVIEW: XML Notifications

XrayVision (versions 3.10 build 19 and above) has the added ability to notify a web server through HTTP POST using XML when the following database changes/events occur:

• Create new image or save image
• Delete image
• Move image to another patient
• Create patient
• Delete patient
• Modify patient
• Modify image
• Import image to patient

The feature is useful for integrating XrayVision with a third-party web application that relies on querying a cached database. Select Tools > Options from the main menu and access the 'Notifications' tab to enable the feature.

The XML message sent to the web server can then be processed to update a database. Provided below are some sample notifications.

Note: The following escape characters will be utilized in any XML Notification sent by the software:

" - "
' - '
< - &lt;
> - &gt;
& - &amp;

Sample Notifications

• New Image or Image Save (Note: More “file_change” notifications may be sent than shown below.):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_change</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoStamp</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoStamp</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_110059.AutoStamp</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
<source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_change</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoXVTAG</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoStamp</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_110059.AutoXVTAG</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_change</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.Auto</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.Auto</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_110059.Auto</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

• Delete Image:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_delete</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoStamp</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoStamp</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_110059.AutoStamp</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_delete</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoXVTAG</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.AutoXVTAG</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_110059.AutoXVTAG</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_delete</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.Auto</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_110059.Auto</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_110059.Auto</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

• Move Image to Another Patient (Note: More “file_change” notifications may be sent than shown below.):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_delete</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_111847.AutoStamp</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_111847.AutoStamp</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_111847.AutoStamp</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_delete</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_111847.AutoXVTAG</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_111847.AutoXVTAG</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_111847.AutoXVTAG</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_delete</action>
   <patient>
      <first_name>John</first_name>
      <last_name>Doe</last_name>
      <chart_id>XVA100000</chart_id>
      <ssn>111-22-3333</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_111847.Auto</filename_full>
      <filename_relative>.\Patients\DOEJOHN_111223333_XVA100000\DigX_01032012_111847.Auto</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJOHN_111223333_XVA100000</filename_path>
      <filename_filename>DigX_01032012_111847.Auto</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_change</action>
   <patient>
      <first_name>Jane</first_name>
      <last_name>Doe</last_name>
      <chart_id>16</chart_id>
      <ssn/>
      <gender/>
      <dob/>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJANE_16\DigX_01032012_111847.Auto</filename_full>
      <filename_relative>.\Patients\DOEJANE_16\DigX_01032012_111847.Auto</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJANE_16</filename_path>
      <filename_filename>DigX_01032012_111847.Auto</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_change</action>
   <patient>
      <first_name>Jane</first_name>
      <last_name>Doe</last_name>
      <chart_id>16</chart_id>
      <ssn/>
      <gender/>
     <dob/>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJANE_16\DigX_01032012_111847.AutoStamp</filename_full>
      <filename_relative>.\Patients\DOEJANE_16\DigX_01032012_111847.AutoStamp</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJANE_16</filename_path>
      <filename_filename>DigX_01032012_111847.AutoStamp</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>file_change</action>
   <patient>
      <first_name>Jane</first_name>
      <last_name>Doe</last_name>
      <chart_id>16</chart_id>
      <ssn/>
      <gender/>
      <dob/>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\DOEJANE_16\DigX_01032012_111847.AutoXVTAG</filename_full>
      <filename_relative>.\Patients\DOEJANE_16\DigX_01032012_111847.AutoXVTAG</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\DOEJANE_16</filename_path>
      <filename_filename>DigX_01032012_111847.AutoXVTAG</filename_filename>
   </file>
   <image_information>
      <teeth>1, 2, 3, A, B, C</teeth>
      <size>100000 bytes</size>
      <taken_date>2010/05/01 13:30</taken_date>
      <type>Digital X-ray</type>
      <subtype>Periapical</subtype>
   </image_information>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

• Create Patient (Note: More “patient_file_change” notifications may be sent than shown below.):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>patient_file_change</action>
   <patient>
      <first_name>x</first_name>
      <last_name>x</last_name>
      <chart_id>17</chart_id>
      <ssn>x</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\XX_X_17\PatientDef.XVAPD</filename_full>
      <filename_relative>.\Patients\XX_X_17\PatientDef.XVAPD</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\XX_X_17</filename_path>
      <filename_filename>PatientDef.XVAPD</filename_filename>
   </file>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>patient_file_change</action>
   <patient>
      <first_name>x</first_name>
      <last_name>x</last_name>
      <chart_id>17</chart_id>
      <ssn>x</ssn>
      <gender>M</gender>
      <dob>1/1/1970</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\XX_X_17\PatientEIDef.XVAEI</filename_full>
     <filename_relative>.\Patients\XX_X_17\PatientEIDef.XVAEI</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\XX_X_17</filename_path>
      <filename_filename>PatientEIDef.XVAEI</filename_filename>
   </file>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

• Delete Patient (Note: When a patient is deleted no individual messages are sent for the deleted images.):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>patient_delete</action>
   <patient>
      <first_name>x</first_name>
      <last_name>x</last_name>
      <chart_id>17</chart_id>
      <ssn>x</ssn>
      <gender/>
      <dob/>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\XX_X_17</filename_full>
     <filename_relative>.\Patients\XX_X_17</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients</filename_path>
      <filename_filename>XX_X_17</filename_filename>
   </file>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

• Modify Patient (Note: More “patient_file_change” notifications may be sent than shown below.):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>directory_rename</action>
   <old_patient>
      <first_name>FirstTest</first_name>
      <last_name>LastTest</last_name>
      <chart_id>55555</chart_id>
      <ssn>55555</ssn>
   </old_patient>
   <patient>
      <first_name>FirstTest2</first_name>
      <last_name>LastTest2</last_name>
      <chart_id>55555</chart_id>
      <ssn>55555</ssn>
      <gender/>
      <dob/>
   </patient>
   <directory>
      <directory_old_name>C:\MyInstallLocation\Patients\LASTTESTFIRSTTEST_55555_55555</directory_old_name>
      <directory_old_name_relative>.\Patients\LASTTESTFIRSTTEST_55555_55555</directory_old_name_relative>
      <directory_new_name>C:\MyInstallLocation\Patients\LASTTEST2FIRSTTEST_55555_55555</directory_new_name>
      <directory_new_name_relative>.\Patients\LASTTEST2FIRSTTEST_55555_55555</directory_new_name_relative>
   </directory>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--XV Notification-->
<?XVNotification 1.0?>
<action>
   <action>patient_file_change</action>
   <patient>
      <first_name>FirstTest2</first_name>
      <last_name>LastTest2</last_name>
      <chart_id>55555</chart_id>
     <ssn>55555</ssn>
      <gender>F</gender>
      <dob>1/1/1971</dob>
   </patient>
   <file>
      <filename_full>C:\MyInstallLocation\Patients\LASTTEST2FIRSTTEST_55555_55555\PatientDef.XVAPD</filename_full>
      <filename_relative>.\Patients\LASTTEST2FIRSTTEST_55555_55555\PatientDef.XVAPD</filename_relative>
      <filename_path>C:\MyInstallLocation\Patients\LASTTEST2FIRSTTEST_55555_55555</filename_path>
      <filename_filename>PatientDef.XVAPD</filename_filename>
   </file>
   <source>
      <computer_name>MYCOMPUTERNAME</computer_name>
      <client_name>MYCOMPUTERNAME</client_name>
      <user_name>userfirst.userlast</user_name>
      <computer_ip>192.168.0.1</computer_ip>
      <clinic_id>your_clinic_id</clinic_id>
   </source>
</action>