MedITEX API manual

From MedITEX - Wiki

(Difference between revisions)
Jump to: navigation, search
 
(64 intermediate revisions by 2 users not shown)
Line 6: Line 6:
 
</tbody>
 
</tbody>
 
</table>
 
</table>
−
<p>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.</p>
+
<p><strong>MedITEX API</strong> consists of a series of functions that can be used to generate reports and control specific areas of <strong>MedITEX IVF</strong> from third party tools.</p>
 +
<table style="margin-left: auto; margin-right: auto;" border="0">
 +
<tbody>
 +
<tr>
 +
<td><a href="/images/Sample_for_CASA_System.xlsm"><img src="/images/plus48.png" alt="" width="48" height="48" /></a></td>
 +
<td>
 +
<p>The following <a href="/images/Sample_for_CASA_System.xlsm">Excel sheet</a> is an example of utilization of <strong>MedITEX API</strong>. Simply copy this file to the <strong>MedITEX IVF </strong>folder on your server for testing.</p>
 +
<p>With this simple example, developers can see how a VBA macro connects with our database using the <strong>API</strong>.</p>
 +
<p>The VBA macro is integrated in the Excel file.</p>
 +
</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 
<p>The MedITEX API can be expanded with the following functions:</p>
 
<p>The MedITEX API can be expanded with the following functions:</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<h2>Commands</h2>
 
<h2>Commands</h2>
 
<h3>ExportCSVData</h3>
 
<h3>ExportCSVData</h3>
−
<p>This function enables the export of files and reports out of MedITEX IVF with LDT. File format is CSV.</p>
+
<p>This function enables the export of files and reports out of MedITEX IVF. File format is CSV.</p>
 
<table border="0" width="628" height="162">
 
<table border="0" width="628" height="162">
 
<tbody>
 
<tbody>
Line 319: Line 332:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>aUser, aPassword (PAnsiChar)&nbsp; <br /></td>
+
<td>aUser, aPassword (PAnsiChar) &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp; <br /></td>
−
<td>The registration data of a user from MedITEX IVF.</td>
+
<td>The registration data of a user from MedITEX IVF.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br /></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>APatientID (PAnsiChar)</td>
+
<td>aPatientID (PAnsiChar)</td>
−
<td>The patient ID (must be the same in both programs).</td>
+
<td>The patient ID (must be the same in both programs).&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br /></td>
 
</tr>
 
</tr>
 
</tbody>
 
</tbody>
Line 570: Line 583:
 
<p><strong>Example: </strong><a href="/index.php?title=Examples_mexAPI#SaveFileByPatient">Click here</a> if you want to get an example of this function.</p>
 
<p><strong>Example: </strong><a href="/index.php?title=Examples_mexAPI#SaveFileByPatient">Click here</a> if you want to get an example of this function.</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 +
<h3>SaveConsentByPatient</h3>
 +
<p>Within this function, it would be possible to add and update consents to the patients folder in MedITEX IVF.</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td colspan="2">
 +
<p><em><span style="color: #000000;">function</span><span style="color: #3366ff;"><strong> SaveConsentByPatient </strong></span>(aUser, aPassword: PAnsiChar; APatientID, APathAndFile, ANote, ADate: PAnsiChar; ATemplateID, AGroupID, ADocID, AOrigID, AStatus: Integer): Integer;</em></p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
<p><strong>Parameters:</strong></p>
 +
<p>This function expects as parameters the PatientID and the fully path of the consent to be added.</p>
 +
<p><em>Some internal IDs, like consent Template ID, consent Group ID and consent Status ID are important for the use of this function.</em></p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>aUser, aPassword (PAnsiChar)<br /></td>
 +
<td>A specific user in MedITEX IVF which can be used in external programs.<br /></td>
 +
</tr>
 +
<tr>
 +
<td>aPatientID (PAnsiChar)</td>
 +
<td>The ID of the patient.</td>
 +
</tr>
 +
<tr>
 +
<td>APathAndFile (PAnsiChar)</td>
 +
<td>The path where the consent should be saved.<br /></td>
 +
</tr>
 +
<tr>
 +
<td>ANote (PAnsiChar)</td>
 +
<td>The note associated to the consent.<br /></td>
 +
</tr>
 +
<tr>
 +
<td>ADate (PAnsiChar)</td>
 +
<td>The consent date.</td>
 +
</tr>
 +
<tr>
 +
<td>ATemplateID (Integer)</td>
 +
<td>The consent template ID.<br /></td>
 +
</tr>
 +
<tr>
 +
<td>AGroupID (Integer)</td>
 +
<td>The consent group ID.<br /></td>
 +
</tr>
 +
<tr>
 +
<td>ADocID, AOrigID (Integer)</td>
 +
<td>
 +
<p>With ADocID and AOrigID, it would be possible to replace the existing consent.</p>
 +
<p>ADocID is an ID that can be used in case of the consent update.</p>
 +
<p><strong>E.g.</strong><br />If you create a consent with ADocID = 17, it is possible to update it calling the procedure.<br />But, sending ADocID = 18 and AOrigID = 17.</p>
 +
<p>If you're not planning to update the consents, you can send "-1" for both parameters.</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>AStatus (Integer)</td>
 +
<td>The consent status ID.</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p><strong>Return type:</strong> The function returns 1 on success or -1 on failure.</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<h3>SaveLabData</h3>
 
<h3>SaveLabData</h3>
Line 733: Line 806:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>aUser, aPassword (PAnsiChar)<br /></td>
+
<td>aUser, aPassword (PAnsiChar)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; <br /></td>
−
<td colspan="2">The registration data of a user from MedITEX IVF.</td>
+
<td colspan="2">The registration data of a user from MedITEX IVF.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br /></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>APatientID (PAnsiChar)<br /></td>
+
<td>aPatientID (PAnsiChar)<br /></td>
 
<td colspan="2">The patient ID (must be the same in both programs).</td>
 
<td colspan="2">The patient ID (must be the same in both programs).</td>
 
</tr>
 
</tr>
Line 1,389: Line 1,462:
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<h3>OpenTherapieOverview</h3>
+
<h3>OpenCycleOverview</h3>
 
<p>With this function it is possible to open the cycle overview window in MedITEX IVF using the DLL.</p>
 
<p>With this function it is possible to open the cycle overview window in MedITEX IVF using the DLL.</p>
 
<p>After calling the function the cycle overview window opens, if MedITEX IVF is running.</p>
 
<p>After calling the function the cycle overview window opens, if MedITEX IVF is running.</p>
Line 1,396: Line 1,469:
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
−
<p><em>function <span style="color: #3366ff;"><strong>OpenTherapieOverview </strong></span>(aUser,aPassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;</em></p>
+
<p><em>function <span style="color: #3366ff;"><strong>OpenCycleOverview </strong></span>(aUser,aPassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;</em></p>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 1,407: Line 1,480:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>ATherapieID (PAnsiChar)</td>
+
<td>ATherapieID (Integer)</td>
 
<td>This is the ID of the cycle.</td>
 
<td>This is the ID of the cycle.</td>
 
</tr>
 
</tr>
Line 1,429: Line 1,502:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>aUser, aPassword (PAnsiChar)&nbsp;&nbsp;&nbsp; <br /></td>
+
<td>aUser, aPassword (PAnsiChar)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; <br /></td>
−
<td>The registration data of a user from MedITEX IVF.</td>
+
<td>The registration data of a user from MedITEX IVF.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br /></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
<td>aPatientID (PAnsiChar)</td>
+
<td>aMedicalHistoryID (Integer)</td>
−
<td>The patient ID (must be the same in both programs).</td>
+
<td>This is the Medical History ID.</td>
 
</tr>
 
</tr>
 
</tbody>
 
</tbody>
Line 1,441: Line 1,514:
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<h3>OpenEizellOverview</h3>
+
<h3>OpenCultureOverview</h3>
 
<p>With this function it is possible to open the egg cell overview window in MedITEX IVF using the DLL.</p>
 
<p>With this function it is possible to open the egg cell overview window in MedITEX IVF using the DLL.</p>
 
<p>After calling the function the egg cell overview window opens, if MedITEX IVF is running.</p>
 
<p>After calling the function the egg cell overview window opens, if MedITEX IVF is running.</p>
Line 1,448: Line 1,521:
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
−
<p><em>function <span style="color: #3366ff;"><strong>OpenEizellOverview </strong></span>(aUser,aPassword: PAnsiChar; aEZID: Integer): Integer; stdcall;</em></p>
+
<p><em>function <span style="color: #3366ff;"><strong>OpenCultureOverview </strong></span>(aUser,aPassword: PAnsiChar; aEZID: Integer): Integer; stdcall;</em></p>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 1,502: Line 1,575:
 
<tbody>
 
<tbody>
 
<tr>
 
<tr>
−
<td style="text-align: right;"><span><a href="/index.php?title=Main_Page">Back to MedITEX products</a></span></td>
+
<td style="text-align: right;"><span><a href="/index.php?title=MedITEX_API">Back to MedITEX API</a><a href="/index.php?title=Main_Page"><br /></a></span></td>
 
<td style="text-align: right;"><a href="#top">Back to top</a></td>
 
<td style="text-align: right;"><a href="#top">Back to top</a></td>
 
</tr>
 
</tr>
 
</tbody>
 
</tbody>
 
</table>
 
</table>

Latest revision as of 16:58, 21 August 2017

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

MedITEX API consists of a series of functions that can be used to generate reports and control specific areas of MedITEX IVF from third party tools.

<tbody> </tbody>
<a href="/images/Sample_for_CASA_System.xlsm"><img src="/images/plus48.png" alt="" width="48" height="48" /></a>

The following <a href="/images/Sample_for_CASA_System.xlsm">Excel sheet</a> is an example of utilization of MedITEX API. Simply copy this file to the MedITEX IVF folder on your server for testing.

With this simple example, developers can see how a VBA macro connects with our database using the API.

The VBA macro is integrated in the Excel file.

 

The MedITEX API can be expanded with the following functions:

 

Contents

Commands

ExportCSVData

This function enables the export of files and reports out of MedITEX IVF. 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: <a href="/index.php?title=Examples_mexAPI#ExportCSVData">Click here</a> if you want to get an example of this function.

 

 

SaveData

<tbody> </tbody>

function SaveData (aUser,aPassword: PAnsiChar; ATabelle, AKeyField, AKeyValue, ASaveField, ASaveValue: PAnsiChar): PAnsiChar; stdcall;

Parameters:
aUser, aPassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       
ATabelle (PAnsiChar) A table name in MedITEX. Example: PERSON.
AKeyField (PAnsiChar) A keyfield to be used in the where condition. Example: PATIENT_ID.
AKeyValue (PAnsiChar)
 A value to be used in combination with AKeyField. Example: PAT123.
ASaveField (PAnsiChar) A field where the information should be saved. Example: P_ADDR_POSTAL_CITY.
ASaveValue (PAnsiChar) A value to be saved in the field defined on ASaveField. Example: New York.

Return type:

Example: <a href="/index.php?title=Examples_mexAPI#SaveData">Click here</a> if you want to get an example of this function.

 

 

GetData

With this function, you can get data of patients.

<tbody> </tbody>

function GetData (aUser,aPassword: PAnsiChar; ATabelle, AKeyField, AKeyValue, AGetKey: PAnsiChar): PAnsiChar; stdcall;

Parameters:
aUser, aPassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       
ATabelle, AKeyField, AGetKey (PAnsiChar)

Return type:

Example: <a href="/index.php?title=Examples_mexAPI#GetData">Click here</a> if you want to get an example of this function.

 

 

GetLanguageCode

This function returns the language code shortcut.

<tbody> </tbody>

function GetLanguageCode (aUser,aPassword: PAnsiChar): PAnsiChar; stdcall;

Parameters:
aUser, aPassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       

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

Example: <a href="/index.php?title=Examples_mexAPI#GetLanguageCode">Click here</a> if you want to get an example of this function.

 

 

GetExpertData

<tbody> </tbody>

function GetExpertData (aUser,aPassword: PAnsiChar; inputSQL: PAnsiChar; savePath: PAnsichar=nil):PAnsiChar; stdcall;

Parameters:
aUser, aPassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       
inputSQL (PAnsiChar)  
savePath (PAnsiChar = nil)  

Return type: 

Example: <a href="/index.php?title=Examples_mexAPI#GetExpertData">Click here</a> if you want to get an example of this function.

<tbody> </tbody>
<a href="#top">Back to top</a>

 

 

Patient

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: <a href="/index.php?title=Examples_mexAPI#GetPatientID">Click here</a> if you want to get an example of this function.

 

 

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 from type PAnsiChar.

Example: <a href="/index.php?title=Examples_mexAPI#GetPatientName">Click here</a> if you want to get an example of this function.

 

 

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: <a href="/index.php?title=Examples_mexAPI#GetPartnerPatID">Click here</a> if you want to get an example of this function.

 

 

GetLatestMedicalHistoryID

With this function, it is possible to get the latest patient Medical History.

<tbody> </tbody>

function GetLatestMedicalHistoryID (aUser, aPassword, aPatientID: PAnsiChar): Integer;

Parameter:

As parameter the function expects the PatientenID of type PAnsiChar.
aUser, aPassword (PAnsiChar)                 
The registration data of a user from MedITEX IVF.                                                            
aPatientID (PAnsiChar) The patient ID (must be the same in both programs).     

Return type: Medical History ID as Integer. If no result is found, -1 is returned.

 

SaveFileByPatient

With this function you can save files directly in one patients folder in MedITEX IVF.

<tbody> </tbody>

function SaveFileByPatient (aUser, aPassword: PAnsiChar; APatientID: PAnsiChar; APathAndFile: PAnsiChar; ADescription: PAnsiChar = nil; ADatum: PAnsiChar = nil; AFileTyp: Integer = 10; ASubTyp: Integer = 12; NewRecordInDatabase: boolean = true): 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.                                                             

 

Optional parameters:
ADescription (PAnsiChar = nil) Default -> file name.
ADatum (PAnsiChar = nil)

Default -> file date.
AFileTyp (Integer = 10) Default -> 10.
ASubTyp (Integer = 12) Default -> 12.
NewRecordInDatabase(Boolean = true)

Default -> true.

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

 

The following file type - sub type combinations are possible:

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


10 20 Cryo Gyn  

10 30 Cryo Andro  

10 33 Medical history questionnaire  

10 100 Administration of documents      
10 101 Oocyte pictures form MedITEX IVF  

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

Example: <a href="/index.php?title=Examples_mexAPI#SaveFileByPatient">Click here</a> if you want to get an example of this function.

 

SaveConsentByPatient

Within this function, it would be possible to add and update consents to the patients folder in MedITEX IVF.

<tbody> </tbody>

function SaveConsentByPatient (aUser, aPassword: PAnsiChar; APatientID, APathAndFile, ANote, ADate: PAnsiChar; ATemplateID, AGroupID, ADocID, AOrigID, AStatus: Integer): Integer;

Parameters:

This function expects as parameters the PatientID and the fully path of the consent to be added.

Some internal IDs, like consent Template ID, consent Group ID and consent Status ID are important for the use of this function.
aUser, aPassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.
aPatientID (PAnsiChar) The ID of the patient.
APathAndFile (PAnsiChar) The path where the consent should be saved.
ANote (PAnsiChar) The note associated to the consent.
ADate (PAnsiChar) The consent date.
ATemplateID (Integer) The consent template ID.
AGroupID (Integer) The consent group ID.
ADocID, AOrigID (Integer)

With ADocID and AOrigID, it would be possible to replace the existing consent.

ADocID is an ID that can be used in case of the consent update.

E.g.
If you create a consent with ADocID = 17, it is possible to update it calling the procedure.
But, sending ADocID = 18 and AOrigID = 17.

If you're not planning to update the consents, you can send "-1" for both parameters.
AStatus (Integer) The consent status ID.

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

 

SaveLabData

With this function you can save lab values directly at one patients laboratory folder in MedITEX IVF.

<tbody> </tbody>

function SaveLabData (aUser, aPassword: PAnsiChar; APatID: PAnsiChar; ADatum: PAnsiChar; AProbeID: PAnsiChar; ALaborParam: PAnsiChar; AValue: PAnsiChar): Integer; stdcall;

Parameters:
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) Enter the date of the evaluation.

AProbeID (PAnsiChar)

 Add the Id of your sample.
ALaborParam (PAnsiChar) Input the name of the laboratory parameter.
AValue (PAnsiChar) Add the value of the parameter.

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

Example: <a href="/index.php?title=Examples_mexAPI#SaveLabData">Click here</a> if you want to get an example of this function.

 

 

SavePatientImage

With this function you can save a picture of the patient in MedITEX IVF.

<tbody> </tbody>

function SavePatientImage(aUser,aPassword: PAnsiChar; APatientID: PAnsiChar; APathAndFile: PAnsiChar): 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.                                                             

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

Example: <a href="/index.php?title=Examples_mexAPI#SavePatientImage">Click here</a> if you want to get an example of this function.

<tbody> </tbody>
<a href="#top">Back to top</a>

 

 

Therapie - Cycle

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, a window opens. This 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: <a href="/index.php?title=Examples_mexAPI#GetTherapieID">Click here</a> if you want to get an example of this function.

 

 

GetTherapieIDEx

<tbody> </tbody>

function GetTherapieIDEx (aUser,aPassword: PAnsiChar; APatientID: PAnsiChar; aTIDList:string): Integer;

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.
aTIDList (string)  

Return type:

Example: <a href="/index.php?title=Examples_mexAPI#GetTherapieIDEx">Click here</a> if you want to get an example of this function.

 

 

GetLatestCycleID

<tbody> </tbody>

function GetLatestCycleID (aUser, aPassword, aPatientID: PAnsiChar): Integer;

Parameters:
aUser, aPassword (PAnsiChar)                    
The registration data of a user from MedITEX IVF.                                                              
aPatientID (PAnsiChar)
 The patient ID (must be the same in both programs).

Return type: Therapie ID as Integer. If no result is found, -1 is returned.

 

 

SaveUSImage

This function enables you to save ultrasound images of a us examination in the patients folder in MedITEX IVF.

<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) Type of ultrasound: follicle or pregnancy.
AAnamneseSubTyp (Integer = 37) AnamneseSubType.

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

Example: <a href="/index.php?title=Examples_mexAPI#SaveUSImage">Click here</a> if you want to get an example of this function.

<tbody> </tbody>
<a href="#top">Back to top</a>

 

 

Kultur - Culture

GetEZID

After calling this function, a new window opens. This window is showing all egg cells from the transferred cycle. You can choose the wished egg cell.

<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.

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

Example: <a href="/index.php?title=Examples_mexAPI#GetEZID">Click here</a> if you want to get an example of this function.

 

 

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 oocyte.

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

Example: <a href="/index.php?title=Examples_mexAPI#GetMeditexEZID">Click here</a> if you want to get an example of this function.

 

 

GetKulturtag

With this function you can get the exact culture day of one oocyte.

<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 oocyte.

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

Example: <a href="/index.php?title=Examples_mexAPI#GetKulturtag">Click here</a> if you want to get an example of this function.

 

 

GetKulturtagAsDate

With this function you can get the exact culture day of one oocyte in the format date.

<tbody> </tbody>

function GetKulturtagAsDate (aUser, a Password: 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 oocyte.

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

Example: <a href="/index.php?title=Examples_mexAPI#GetKulturtagAsDate">Click here</a> if you want to get an example of this function.

 

 

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 oocyte.
APathAndFile (PAnsiChar) Path where the file should be saved.                                                              

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

Example: <a href="/index.php?title=Examples_mexAPI#SaveEZImage">Click here</a> if you want to get an example of this function.

<tbody> </tbody>
<a href="#top">Back to top</a>

 

 

Spermiogramm - Semen analysis

GetNewSpermiogrammID

After calling the function, a new semen analysis with the passed parameters will be created.

<tbody> </tbody>

function GetNewSpermiogrammID (aUser, aPassword: PAnsiChar; APatientID: PAnsiChar; ADatum: PAnsiChar = nil; ABemerkung: PAnsiChar = nil; Uhrzeit: PAnsiChar = nil; Indikation: PAnsiChar = nil; Spendersperma: Boolean = false; Gewinnungsart: Integer = 0): Integer; stdcall;

Parameters:

This function expects as parameter the PatientenID from type integer.
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.
Indikation (PAnsiChar = nil)

Indication of the semen analysis.

Values can be:

0 for Semen analysis

1 for IVf

2 for ICSI

3 for Insemination

4 for Cryopreservation

5 for Control

6 for IMSI

7 for IVM

8 for Fertility preservation

 

Optional parameters:
ADatum (PAnsiChar = nil) The date of recording.
ABemerkung (PAnsiChar = nil) Enter a comment if it is necessary.
Uhrzeit (PAnsiChar = nil) Date of the sample.
Spendersperma (Boolean = false) Sperm from donor.
Gewinnungsart (Integer = 0)

Collection method.

Values can be:

0 for Not specified

1 for antegrade ejaculation

2 for retrograde ejaculation

3 for Cryo sperm

4 for MESA

5 for frozen/thawed MESA

6 for PESA

7 for frozen/thawed PESA

8 for TESE

9 for frozen/thawed TESE

10 for Electrostimulation

11 for Spermatocele

12 for Donor

13 for TESA

14 for frozen/thawed TESA

15 for ESA

16 for frozen/thawed ESA

23 for Micro-TESA

24 for Micro-TESE

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

Example: <a href="/index.php?title=Examples_mexAPI#GetNewSpermiogrammID">Click here</a> if you want to get an example of this function.

 

 

SaveSpermData

After calling the function, all entered values of the CSV-String will be added to the associated semen analysis.

<tbody> </tbody>

function SaveSpermData (aUser, aPassword: PAnsiChar; ASpermID: Integer; UpdateCSV: PAnsiChar): Integer; stdcall;

Parameters:

This function expects as parameter the SpermiogrammID from type integer and a CSV-String from type PAnsiChar, including the fields of the semen analysis which should be updated.
aUser, aPassword (PAnsiChar) A specific user in MedITEX IVF which can be used in external programs.                      
aSpermID (PAnsiChar) This is the ID of a semen analysis.

UpdateCSV (PAnsiChar)

 

 

 

 

The CSV-String looks like:

 

Delimiter                ;


QuoteChar              "

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

Example: "PH_VA = 0.45";"DIAGNOSE_TEXT = 'TestDiagnose'";"NORMOSPERMIE_VA=23"

<a href="/index.php?title=Examples_mexAPI#SaveSpermData">Click here</a> if you want to get an example of this function.

 

GetSpermiogrammID

This function enables you 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, a window opens. 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: <a href="/index.php?title=Examples_mexAPI#GetSpermiogrammID">Click here</a> if you want to get an example of this function.

 

 

SaveFileBySpermiogramm

You can save semen analysis files directly in the patients folder in MedITEX IVF with this function.

<tbody> </tbody>

function SaveFileBySpermiogramm (aUser, aPassword: PAnsiChar; ASpermID: Integer; APathAndFile: PAnsichar; ATyp: Integer; ADescription: PAnsiChar = nil; ADatum: PAnsiChar = nil): Integer; stdcall;

Parameters:

This function expects as parameter the SpermiogrammID from type integer, the type as 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.                       
aSpermID (PAnsiChar) This is the ID of the semen analysis.
APathAndFile (PAnsiChar)

Path where the file should be saved.

ATyp (Integer)

 

 

 

 

 

 

 

Following types are possible:

Type

Integer value
General document 0
File (Native) 1
File (After perperation) 2

 

Optional parameters:
ADescription (PAnsiChar = nil) Default -> file name 
ADatum (PAnsiChar = nil) Default -> file date 

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

Example: <a href="/index.php?title=Examples_mexAPI#SaveFileBySpermiogramm">Click here</a> if you want to get an example of this function.

<tbody> </tbody>
<a href="#top">Back to top</a>

 

 

Inkubator - Incubator

GetInkubatorID

With this function you get a list with all incubators of the program MedITEX IVF.

After calling this function, a selection dialog opens.

<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

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

Example: <a href="/index.php?title=Examples_mexAPI#GetInkubatorID">Click here</a> if you want to get an example of this function.

 

 

SaveFileToInkubator

This function enables you to save files to an incubator.

<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.

 

Optional parameters:

 
ADatum (PAnsiChar = nil) Default -> file date.
NewRecordInDatabase(Boolean = true)

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: <a href="/index.php?title=Examples_mexAPI#SaveFileToInkubator">Click here</a> if you want to get an example of this function.

<tbody> </tbody>
<a href="#top">Back to top</a>

 

 

OpenCommands

OpenPatientCryoOverview

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

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

<tbody> </tbody>

function OpenPatientCryoOverview (APatientID: PAnsiChar): Integer; stdcall;
Parameters:
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: <a href="/index.php?title=Examples_mexAPI#OpenPatientCryoOverview">Click here</a> if you want to get an example of this function.

 

 

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: <a href="/index.php?title=Examples_mexAPI#OpenPatientOverview">Click here</a> if you want to get an example of this function.

 

 

OpenCycleOverview

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

After calling the function the cycle overview window opens, if MedITEX IVF is running.

<tbody> </tbody>

function OpenCycleOverview (aUser,aPassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;
Parameters:
aUser, aPassword (PAnsiChar)   
A specific user in MedITEX IVF which can be used in external programs.                         
ATherapieID (Integer) This is the ID of the cycle.

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

Example:<a href="/index.php?title=Examples_mexAPI#OpenTherapieOverview"> </a><a href="/index.php?title=Examples_mexAPI#OpenTherapieOverview">Click here</a> if you want to get an example of this function.

 

 

OpenMedicalHistory

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

<tbody> </tbody>

function OpenMedicalHistory (aUser, aPassword: PAnsiChar; aMedicalHistoryID: Integer): Integer;

Parameters:
aUser, aPassword (PAnsiChar)                
The registration data of a user from MedITEX IVF.                                                                 
aMedicalHistoryID (Integer) This is the Medical History ID.

Return type: If the execution is successful, 1 is returned, otherwise -1.

 

 

OpenCultureOverview

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

After calling the function the egg cell overview window opens, if MedITEX IVF is running.

<tbody> </tbody>

function OpenCultureOverview (aUser,aPassword: PAnsiChar; aEZID: Integer): Integer; stdcall;
Parameters:
aUser, aPassword (PAnsiChar)   
A specific user in MedITEX IVF which can be used in external programs.                         
aEZID (Integer) This is the ID of the egg cell.

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

Example: <a href="/index.php?title=Examples_mexAPI#OpenEizellOverview">Click here</a> if you want to get an example of this function.

 

 

GetAblageDateien

<tbody> </tbody>

function GetAblageDateien (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 the patient.

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

Example: <a href="/index.php?title=Examples_mexAPI#GetAblageDateien">Click here</a> if you want to get an example of this function.

 

 

Login

Enter here your username and password.

Example: <a href="/index.php?title=Examples_mexAPI#Login">Click here</a> if you want to get an example.

 

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