MedITEX API manual

From MedITEX - Wiki

(Difference between revisions)
Jump to: navigation, search
Line 711: Line 711:
 
<td>Subtype (Integer)</td>
 
<td>Subtype (Integer)</td>
 
<td>Default -&gt; 12.</td>
 
<td>Default -&gt; 12.</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 +
<p>The following file type - sub type combinations are possible:</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>File type</strong></td>
 +
<td><strong>Sub type</strong></td>
 +
<td><strong>Designation</strong></td>
 +
</tr>
 +
<tr>
 +
<td>3</td>
 +
<td>9</td>
 +
<td>Long-term medication</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>1</td>
 +
<td>Previous diseases</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>4</td>
 +
<td>Semen analysis<br /></td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>5</td>
 +
<td>Hormones</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>22</td>
 +
<td>Microbiology</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>23</td>
 +
<td>Genetics</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>24</td>
 +
<td>Endocrinology</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>25</td>
 +
<td>Serology</td>
 +
</tr>
 +
<tr>
 +
<td>8</td>
 +
<td>26</td>
 +
<td>Clinical chemistry</td>
 +
</tr>
 +
<tr>
 +
<td>9</td>
 +
<td>6</td>
 +
<td>DIR Medical history</td>
 +
</tr>
 +
<tr>
 +
<td>9</td>
 +
<td>7</td>
 +
<td>CAVE</td>
 +
</tr>
 +
<tr>
 +
<td>9</td>
 +
<td>8</td>
 +
<td>DIR Medical history</td>
 +
</tr>
 +
<tr>
 +
<td>9</td>
 +
<td>10</td>
 +
<td>Finding</td>
 +
</tr>
 +
<tr>
 +
<td>9</td>
 +
<td>21</td>
 +
<td>Note</td>
 +
</tr>
 +
<tr>
 +
<td>10</td>
 +
<td>12</td>
 +
<td>Document general</td>
 +
</tr>
 +
<tr>
 +
<td>10</td>
 +
<td>20</td>
 +
<td>Cryo Gyn</td>
 +
</tr>
 +
<tr>
 +
<td>10</td>
 +
<td>30</td>
 +
<td>Cryo Andro</td>
 +
</tr>
 +
<tr>
 +
<td>10</td>
 +
<td>33</td>
 +
<td>Medical history questionnaire</td>
 +
</tr>
 +
<tr>
 +
<td>10</td>
 +
<td>100</td>
 +
<td><strong class="b3"> </strong>Administration of documents</td>
 +
</tr>
 +
<tr>
 +
<td>10</td>
 +
<td>101</td>
 +
<td>Egg cell pictures form MedITEX IVF</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>3</td>
 +
<td>fallopian status</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>11</td>
 +
<td>Andro findings</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>13</td>
 +
<td>Gyn findings</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>14</td>
 +
<td>Uterus/Ovaries</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>15</td>
 +
<td>Ultrasound</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>16</td>
 +
<td>Hysteroscopy</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>17</td>
 +
<td>Laparscopy/HSSG</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>18</td>
 +
<td>Abrasio</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>19</td>
 +
<td>Laparotomy</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>27</td>
 +
<td>PCT/Mucus</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>28</td>
 +
<td>Transvaginale endoscopy</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>31</td>
 +
<td>Hepatitis</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>32</td>
 +
<td>Examinations</td>
 +
</tr>
 +
<tr>
 +
<td>11</td>
 +
<td>102</td>
 +
<td>DICOM</td>
 
</tr>
 
</tr>
 
</tbody>
 
</tbody>

Revision as of 11:29, 31 July 2013

<tbody> </tbody>
<img src="/images/Api1.png" alt="" width="765" height="196" />

Obtained using the mexAPI.dll it is possible to get reports out of MedITEX IVF by calling the functions which are included in the DLL. It is also conceivable to control program functions in MedITEX IVF out of another program.

 

Contents

ExportCSVData

This function enables the export of files and reports out of MedITEX IVF with LDT. File format is CSV.

<tbody> </tbody>

function ExportCSVData (AUser, APassword:  PAnsiChar; AExportID: PAnsiChar; APathAndFile: PAnsiChar; AFilter: PAnsiChar = nil): Integer; stdcall;            

Parameters:
AUser, APassword (PAnsiChar) A specific user in MedITEX IVF which can be used in external programs.
AExportID (PAnsiChar) This is the ID of your report.
APathAndFile (PAnsiChar)
 Path where the file should be saved.                                                               
AFilter (PAnsiChar, optional)

Filter condition for the export.

Example: Patient_ID = 1000 and dt_gewinnung > '01.01.2010'

Return type: The type of the return value is integer. The function returns 1 on success or -1 on failure.

Example:

 

OpenPatientCryoOverview

This function offers the opportunity to call up the cryo storage in MedITEX IVF using the DLL.

The parameters user, password (PAnsiChar) and patientID (PAnsiChar) should be passed to the function.

After each call of the function, if MedITEX is running, the cryo storage of the respective patient will open.

<tbody> </tbody>

function OpenPatientCryoOverview (AUser, APassword: PAnsiChar; APatientID: PAnsiChar): Integer; stdcall;
Parameters:
AUser, APassword (PAnsiChar)    
A specific user in MedITEX IVF which can be used in external programs.                          
APatientID (PAnsiChar) This is the ID of your patient.

Return type: The type of the return value is integer. The function returns 1 on success or -1 on failure.

Example:

 

OpenPatientOverview

With this function it is possible to open the patient overview window in MedITEX IVF using the DLL.

The parameters user, password (PAnsiChar) and PatientenID (PAnsiChar) has to be passed to the function. After calling the function the patient overview window opens, if MedITEX IVF is running.

<tbody> </tbody>

function OpenPatientOverview (AUser, APassword: PAnsiChar; APatientID: PAnsiChar): Integer; stdcall; 
Parameters:
AUser, APassword (PAnsiChar)   
A specific user in MedITEX IVF which can be used in external programs.                         
APatientID (PAnsiChar) This is the ID of your patient.

Return type: The function returns 1 on success or -1 on failure as an integer.

Example:

 

 

GetPatientID

After calling the function, a window opens, where you can search a patient.

<tbody> </tbody>

function GetPatientID (AUser, APassword: PAnsiChar; AFilter: PAnsiChar = nil): PAnsiChar; stdcall; 
Parameters:
AUser, APassword (PAnsiChar)  
A specific user in MedITEX IVF which can be used in external programs.                        

AFilter (PAnsiChar = nil)

 

 

 

 

 

 

 

 

 

 

 

 

 

You can restrict the search by specifying the filter.

 

Filters based on the following criteria are possibly:

  • Title
  • First name
  • Surname
  • Gender
  • Date of birth
  • City
  • Street
  • Phone number
  • Mobile phone number

 

Examples:

  • Date of birth > '01/01/1985'
  • First name like 'Example%'

Return type: The type of the return value is PAnsiChar. The function returns the PatientenID on success or -1 on failure.

Example:

 

 

GetPatientName

With this function, you can get the name of a patient.

<tbody> </tbody>

function GetPatientName (AUser, APassword: PAnsiChar; APatientID: PAnsiChar): PAnsiChar; stdcall; 

Parameter:

As parameter the function expects the PatientenID, AUser and APassword of type PAnsiChar.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
APatientID (PAnsiChar) This is the ID of your patient.

Return type: The function returns the name of the patient on success or -1 on failure with type PAnsiChar.

Example:

 

 

GetPartnerPatID

With this function, you can get the ID of the patients partner.

<tbody> </tbody>

function GetPartnerPatID (AUser, APassword: PAnsiChar; APatientID: PAnsiChar): PAnsiChar; stdcall;

Parameter:

As parameter the function expects the PatientenID of type PAnsiChar.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
APatientID (PAnsiChar) This is the ID of your patient.

Return type: The type of the return value is integer. The function returns the name of the partner on success or -1 on failure.

Example:

 

 

GetTherapieID

This function allows you to see all cycles of the transferred patient.

<tbody> </tbody>

function GetTherapieID (AUser, APassword: PAnsiChar; APatientID: PAnsiChar): Integer; stdcall;

Parameter:

As parameter the function expects the PatientenID of type PAnsiChar.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
APatientID (PAnsiChar) This is the ID of your patient.

After this function has been called, the following overview window opens:

<tbody> </tbody>
Bild

Tihs window is showing all cycles from the transferred patient. Choose the wished cycle.

Return type: The type of the return value is integer. The function returns the TherapieID on success or -1 on failure.

Example:

 

 

GetSpermiogrammID

This function enables to see all semen analysis of the transferred patient.

<tbody> </tbody>

function GetSpermiogrammID (AUser, APassword: PAnsiChar; APatientID: PAnsiChar): Integer; stdcall;

Parameter:

As parameter the function expects the PatientenID of type PAnsiChar.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
APatientID (PAnsiChar) This is the ID of your patient.

After this function has been called, the following window opens:

<tbody> </tbody>
Bild

This window is showing all semen analysis from the transferred patient. Choose the wished semen analysis.

Return type: The type of the return value is integer. The function returns the SpermiogrammID on success or -1 on failure.

Example:

 

 

GetEZID

 

<tbody> </tbody>

function GetEZID (AUser, APassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;

Parameter:

As parameter the function expects the TherapieID of type integer.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
ATherapieID (Integer) This is the ID of a cycle.

After calling this function, the following window opens:

<tbody> </tbody>
Bild

This window is showing all egg cells from the transferred cycle. You can choose the wished egg cell.

Return type: The function returns the EZID on success or -1 on failure of type integer.

Example:

 

 

GetMeditexEZID

 

<tbody> </tbody>

function GetMeditexEZID (AUser, APassword: PAnsiChar; aEZID: Integer): Integer; stdcall;

Parameter:

This function expects as parameter the EZID from type integer.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
aEZID (Integer) This is the ID of an egg cell.

Return type: The type of the return value is the corresponding MeditexEZID on success or -1 of the type integer on failure.

Example:

 

 

GetKulturtag

 

<tbody> </tbody>

function GetKulturtag (AUser, APassword: PAnsiChar; aEZID: Integer): Integer; stdcall;

Parameter:

This function expects as parameter the EZID from type integer.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
aEZID (Integer) This is the ID of an egg cell.

Return type: The function returns the corresponding culture day on success or -1 on failure of type integer.

Example:

 

 

GetKulturtagAsDate

 

<tbody> </tbody>

function GetKulturtagAsDate (AUser, APassword: PAnsiChar; aEZID: Integer): PAnsiChar; stdcall;

Parameter:

This function expects as parameter the EZID from type integer.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
aEZID (Integer) This is the ID of an egg cell.

Return type: The function returns the corresponding culture day on success or -1 on failure of type PAnsiChar.

Example:

 

 

SaveEZImage

 

 

<tbody> </tbody>

function SaveEZImage (AUser, APassword: PAnsiChar; aEZID: Integer; APathAndFile: PAnsiChar): Integer; stdcall;

Parameter:

This function expects as parameter the EZID from type integer and the fully path of the image to be stored.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
aEZID (Integer) This is the ID of an egg cell.
APathAndFile (PAnsiChar) Path where the file should be saved.                                                              

Return type: The function returns the 1 on success or -1 on failure.

Example:

 

 

SaveUSImage

 

<tbody> </tbody>

function SaveUSImage (AUser, APassword: PAnsiChar; APatID: PAnsiChar; ADatum: PAnsiChar; APathAndFile: PAnsiChar; ATypUS: Integer = 1; AAnamneseSubTyp: Integer = 37): Integer; stdcall;

Parameter:

This function expects as a required parameter the User, Password and PatientenID as PAnsiChar, the Date and the full file path of the image to be stored. Optional the US type can be entered (1: follicle, 2: pregnancy) and the particular AnamneseItemSubtyp has to be 37.
AUser, APassword (PAnsiChar) 
A specific user in MedITEX IVF which can be used in external programs.                        
APatID (PAnsiChar)
 This is the ID of your patient.
ADatum (PAnsiChar) The date of recording.
APathAndFile (PAnsiChar) Path where the file should be saved.                                                              
ATypUS (Integer = 1)  
AAnamneseSubTyp (Integer = 37)  

Return type: The function returns the 1 on success or -1 on failure.

Example:

 

 

GetInkubatorID

 

<tbody> </tbody>

function GetInkubatorID (AUser, APassword: PAnsiChar; AFilter: PAnsiChar = nil): Integer; stdcall;
Parameters:
AUser, APassword (PAnsiChar)  
A specific user in MedITEX IVF which can be used in external programs.                        

AFilter (PAnsiChar = nil)

 

 

 

 

 

 

 

 

 

 

 

You can restrict the search by specifying the filter.

 

Filters based on the following criteria are possibly:

  • Description
  • Active
  • Manufacturer.name
  • Model.name
  • Location of incubator.name
  • Incubator no.

 

Examples:

  • Active = 1
  • Manufacturer.name like ‘XY%’
  • Incubator no > 20

After calling this function, a selection dialog opens:

<tbody> </tbody>

Bild

Return type:

Example:

 

 

SaveFileToInkubator

 

<tbody> </tbody>

function SaveFileToInkubator (AUser, APassword: PAnsiChar; aInkubatorID: Integer; APathAndFile: PAnsiChar; ADatum : PAnsiChar = nil; NewRecordInDatabase: boolean = true): Integer; stdcall;

Parameters:

This function expects as parameter the InkubatorID from type integer and the fully path of the file to be stored.
AUser, APassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       
aInkubatorID (Integer) This is the ID of your incubator.
APathAndFile (PAnsiChar) Path where the file should be saved.                                                             
ADatum (PAnsiChar = nil) The date of recording.
NewRecordInDatabase(Boolean = true)  

 

Optional parameters:
Date (PAnsiChar) Default -> file date.

NewRecordInDatabase (Boolean)

 

 

Default -> true.

  • True: File is copied into the storage directory and a database entry takes place.
  • False: File is copied into the storage directory.

Return type: The function returns the 1 on success or -1 on failure.

Example:

 

 

SaveFileByPatient

 

<tbody> </tbody>

function SaveFileByPatient (AUser, APassword: PAnsiChar; APatientID: PAnsiChar; APathAndFile: PAnsiChar; ADescription: PAnsiChar = nil; ADatum: PAnsiChar = nil; AFileTyp: Integer = 10; ASubTyp: Integer = 12): Integer; stdcall;

Parameters:

This function expects as parameter the PatientenID from type integer and the fully path of the file to be stored.
AUser, APassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       
aPatientID (PAnsiChar)  This is the ID of your patient.
APathAndFile (PAnsiChar) Path where the file should be saved.                                                             
ADescription (PAnsiChar = nil)  
ADatum (PAnsiChar = nil) The date of recording.
AFileTyp (Integer= 10)  
ASubTyp (Integer= 12)  

 

Optional parameters:
Description (PAnsiChar) Default -> file name.
Date (PAnsiChar)

Default -> file date.
File type (Integer) Default -> 10.
Subtype (Integer) Default -> 12.

 

The following file type - sub type combinations are possible:

<tbody> </tbody>
File type Sub type Designation
3 9 Long-term medication
8 1 Previous diseases
8 4 Semen analysis
8 5 Hormones
8 22 Microbiology
8 23 Genetics
8 24 Endocrinology
8 25 Serology
8 26 Clinical chemistry
9 6 DIR Medical history
9 7 CAVE
9 8 DIR Medical history
9 10 Finding
9 21 Note
10 12 Document general
10 20 Cryo Gyn
10 30 Cryo Andro
10 33 Medical history questionnaire
10 100 Administration of documents
10 101 Egg cell pictures form MedITEX IVF
11 3 fallopian status
11 11 Andro findings
11 13 Gyn findings
11 14 Uterus/Ovaries
11 15 Ultrasound
11 16 Hysteroscopy
11 17 Laparscopy/HSSG
11 18 Abrasio
11 19 Laparotomy
11 27 PCT/Mucus
11 28 Transvaginale endoscopy
11 31 Hepatitis
11 32 Examinations
11 102 DICOM

Return type: The function returns the 1 on success or -1 on failure.

Example:

 

 

 

 

 

 

 

 

<tbody> </tbody>
<a href="/index.php?title=Main_Page">Back to MedITEX products</a> <a href="#top">Back to top</a>