MedITEX API manual
From MedITEX - Wiki
Line 8: | Line 8: | ||
<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>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> </p> | <p> </p> | ||
− | <h2> | + | <h2>Commands</h2> |
+ | <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 with LDT. File format is CSV.</p> | ||
<table border="0" width="628" height="162"> | <table border="0" width="628" height="162"> | ||
Line 46: | Line 47: | ||
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
− | + | <p> </p> | |
− | <p> | + | <h3>SaveData</h3> |
− | < | + | <table border="0"> |
− | <table border="0 | + | |
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
− | <p><em>function | + | <p><em>function <span style="color: #3366ff;"><strong>SaveData </strong></span>(aUser,aPassword: PAnsiChar; ATabelle, AKeyField, AKeyValue, ASaveField, ASaveValue: PAnsiChar): PAnsiChar; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
+ | <p><strong>Parameters:</strong></p> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>aUser, aPassword (PAnsiChar)<br /></td> |
− | <td> | + | <td colspan="2">A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
+ | </tr> | ||
+ | <tr> | ||
+ | <td>ATabelle, AKeyField, AKeyValue, ASaveValue (PAnsiChar)</td> | ||
+ | <td colspan="2"><br /></td> | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong> The type of the return value | + | <p><strong>Return type:</strong> The type of the return value are the data on success or -1 on failure.</p> |
− | <p><strong>Example: </strong></p> | + | <p><strong>Example:</strong></p> |
<p> </p> | <p> </p> | ||
− | + | <p> </p> | |
− | <p> | + | <h3>GetData</h3> |
− | < | + | |
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
− | <p><em>function | + | <p><em>function <span style="color: #3366ff;"><strong>GetData </strong></span>(aUser,aPassword: PAnsiChar; ATabelle, AKeyField, AKeyValue, AGetKey: PAnsiChar): PAnsiChar; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
+ | <p><strong>Parameters:</strong></p> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>aUser, aPassword (PAnsiChar) | + | <td>aUser, aPassword (PAnsiChar)<br /></td> |
− | <td>A specific user in MedITEX IVF which can be used in external programs. | + | <td colspan="2">A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>ATabelle, AKeyField, AGetKey (PAnsiChar)</td> |
− | <td> | + | <td colspan="2"><br /></td> |
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type: </strong>The | + | <p><strong>Return type:</strong> The type of the return value are the data on success or -1 on failure.</p> |
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>GetLanguageCode</h3> |
− | + | ||
− | + | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
− | <p><em>function <span style="color: #3366ff;"><strong> | + | <p><em>function <span style="color: #3366ff;"><strong>GetLanguageCode </strong></span>(aUser,aPassword: PAnsiChar): PAnsiChar; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
+ | <p><strong>Parameters:</strong></p> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>aUser, aPassword (PAnsiChar) | + | <td>aUser, aPassword (PAnsiChar)<br /></td> |
− | <td>A specific user in MedITEX IVF which can be used in external programs. | + | <td colspan="2">A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type: </strong> | + | <p><strong>Return type:</strong></p> |
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>GetExpertData</h3> |
− | + | ||
− | + | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
− | <p><em>function <span style="color: #3366ff;"><strong> | + | <p><em>function <span style="color: #3366ff;"><strong>GetExpertData </strong></span>(aUser,aPassword: PAnsiChar; inputSQL: PAnsiChar; savePath: PAnsichar=nil):PAnsiChar; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="3"> |
+ | <p><strong>Parameters:</strong></p> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>aUser, aPassword (PAnsiChar) | + | <td>aUser, aPassword (PAnsiChar)<br /></td> |
− | <td>A specific user in MedITEX IVF which can be used in external programs. | + | <td colspan="2">A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>inputSQL (PAnsiChar)</td> |
− | <td> | + | <td colspan="2"> </td> |
+ | </tr> | ||
+ | <tr> | ||
+ | <td>savePath (PAnsiChar = nil)</td> | ||
+ | <td colspan="2"> </td> | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type: </strong> | + | <p><strong>Return type:</strong></p> |
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | <h2> | + | <h2>Patient</h2> |
+ | <h3>GetPatientID</h3> | ||
<p>After calling the function, a window opens, where you can search a patient.</p> | <p>After calling the function, a window opens, where you can search a patient.</p> | ||
<table border="0"> | <table border="0"> | ||
Line 211: | Line 219: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>GetPatientName</h3> |
<p>With this function, you can get the name of a patient.</p> | <p>With this function, you can get the name of a patient.</p> | ||
<table border="0"> | <table border="0"> | ||
Line 240: | Line 248: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>GetPartnerPatID</h3> |
<p>With this function, you can get the ID of the patients partner.</p> | <p>With this function, you can get the ID of the patients partner.</p> | ||
<table border="0"> | <table border="0"> | ||
Line 269: | Line 277: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>SaveFileByPatient</h3> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
− | <p><em>function <span style="color: #3366ff;"><strong>SaveFileByPatient </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: | + | <p><em>function <span style="color: #3366ff;"><strong>SaveFileByPatient </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: PAnsiChar; APathAndFile: PAnsiChar; ADescription: PAnsiChar = nil; ADatum: PAnsiChar = nil; AFileTyp: Integer = 10; ASubTyp: Integer = 12; NewRecordInDatabase: boolean = true): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 873: | Line 517: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>SaveLabData</h3> |
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>SaveLabData </strong></span>(</em><em>aUser, aPassword: PAnsiChar;</em><em> APatID: PAnsiChar; ADatum: PAnsiChar; AProbeID: PAnsiChar; ALaborParam: PAnsiChar; AValue: PAnsiChar): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameters:</strong></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>aPatID (PAnsiChar)</td> | ||
+ | <td>This is the ID of your patient.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>ADatum (PAnsiChar)</td> | ||
+ | <td> </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td> | ||
+ | <p>AProbeID (PAnsiChar)</p> | ||
+ | </td> | ||
+ | <td> </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>ALaborParam (PAnsiChar)</td> | ||
+ | <td> </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>AValue (PAnsiChar)</td> | ||
+ | <td> </td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong> The type of the return value is 1 on success or -1 on failure.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>SavePatientImage</h3> | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
Line 905: | Line 594: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | <h2> | + | <h2>Therapie - Cycle</h2> |
+ | <h3>GetTherapieID</h3> | ||
+ | <p>This function allows you to see all cycles of the transferred patient.</p> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetTherapieID </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: PAnsiChar): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>As parameter the function expects the PatientenID of type PAnsiChar.</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>This is the ID of your patient.</td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p>After this function has been called, a window opens. This window is showing all cycles from the transferred patient. Choose the wished cycle.</p> | ||
+ | <p><strong>Return type:</strong> The type of the return value is integer. The function returns the TherapieID on success or -1 on failure.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>GetTherapieIDEx</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="3"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetTherapieIDEx </strong></span>(aUser,aPassword: PAnsiChar; APatientID: PAnsiChar; aTIDList:string): Integer;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3"> | ||
+ | <p><strong>Parameters:</strong></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>aUser, aPassword (PAnsiChar)<br /></td> | ||
+ | <td colspan="2">A specific user in MedITEX IVF which can be used in external programs. <br /></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>APatientID (PAnsiChar)<br /></td> | ||
+ | <td colspan="2"> </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>aTIDList (string)</td> | ||
+ | <td colspan="2"> </td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong></p> | ||
+ | <p><strong>Example:</strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>SaveUSImage</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>SaveUSImage </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatID: PAnsiChar; ADatum: PAnsiChar; APathAndFile: PAnsiChar; ATypUS: Integer = 1; AAnamneseSubTyp: Integer = 37): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>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.</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>APatID (PAnsiChar)<br /></td> | ||
+ | <td>This is the ID of your patient.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>ADatum (PAnsiChar)</td> | ||
+ | <td>The date of recording.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>APathAndFile (PAnsiChar)</td> | ||
+ | <td>Path where the file should be saved. </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>ATypUS (Integer = 1)</td> | ||
+ | <td> </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>AAnamneseSubTyp (Integer = 37)</td> | ||
+ | <td> </td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong> The function returns the 1 on success or -1 on failure.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h2>Kultur - Culture</h2> | ||
+ | <h3>GetEZID</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetEZID </strong></span>(</em><em>aUser, aPassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>As parameter the function expects the TherapieID of type integer.</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>ATherapieID (Integer)</td> | ||
+ | <td>This is the ID of a cycle.</td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p>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.</p> | ||
+ | <p><strong>Return type: </strong>The function returns the EZID on success or -1 on failure of type integer.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>GetMeditexEZID</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetMeditexEZID </strong></span>(a</em><em>User, aPassword: PAnsiChar; </em><em>aEZID: Integer): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>This function expects as parameter the EZID from type integer.</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>aEZID (Integer)</td> | ||
+ | <td>This is the ID of an egg cell.</td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type: </strong>The type of the return value is the corresponding MeditexEZID on success or -1 of the type integer on failure.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>GetKulturtag</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetKulturtag </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>aEZID: Integer): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>This function expects as parameter the EZID from type integer.</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>aEZID (Integer)</td> | ||
+ | <td>This is the ID of an egg cell.</td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong> The function returns the corresponding culture day on success or -1 on failure of type integer.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>GetKulturtagAsDate</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetKulturtagAsDate </strong></span>(a</em><em>User, a</em><em> </em><em>Password: PAnsiChar; </em><em>aEZID: Integer): PAnsiChar; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>This function expects as parameter the EZID from type integer.</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>aEZID (Integer)</td> | ||
+ | <td>This is the ID of an egg cell.</td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong> The function returns the corresponding culture day on success or -1 on failure of type PAnsiChar.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>SaveEZImage</h3> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>SaveEZImage </strong></span>(</em><em>aUser, aPassword: PAnsiChar; a</em><em>EZID: Integer; APathAndFile: PAnsiChar): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>This function expects as parameter the EZID from type integer and the fully path of the image to be stored.</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>aEZID (Integer)</td> | ||
+ | <td>This is the ID of an egg cell.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>APathAndFile (PAnsiChar)</td> | ||
+ | <td>Path where the file should be saved. <br /></td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong> The function returns the 1 on success or -1 on failure.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h2>Spermiogramm - Semen analysis</h2> | ||
+ | <h3>GetNewSpermiogrammID</h3> | ||
<p>After calling the function, a new semen analysis with the passed parameters will be created.</p> | <p>After calling the function, a new semen analysis with the passed parameters will be created.</p> | ||
<table border="0"> | <table border="0"> | ||
Line 911: | Line 853: | ||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
− | <p><em>function <span style="color: #3366ff;"><strong>GetNewSpermiogrammID </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: | + | <p><em>function <span style="color: #3366ff;"><strong>GetNewSpermiogrammID </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: PAnsiChar; ADatum: PAnsiChar = nil; ABemerkung: PAnsiChar = nil; Uhrzeit: PAnsiChar = nil; Indikation: PAnsiChar = nil; Spendersperma: Boolean = false; Gewinnungsart: Integer = 0): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 960: | Line 902: | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | |||
− | |||
<p><strong>Return type:</strong> The type of the return value is the new SpermiogrammID on success or -1 on failure.</p> | <p><strong>Return type:</strong> The type of the return value is the new SpermiogrammID on success or -1 on failure.</p> | ||
<p><strong>Example: </strong></p> | <p><strong>Example: </strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>SaveSpermData</h3> |
<p>After calling the function, all entered values of the CSV-String will be added to the associated semen analysis.</p> | <p>After calling the function, all entered values of the CSV-String will be added to the associated semen analysis.</p> | ||
<table border="0"> | <table border="0"> | ||
Line 978: | Line 918: | ||
<td colspan="4"> | <td colspan="4"> | ||
<p><strong>Parameters:</strong></p> | <p><strong>Parameters:</strong></p> | ||
− | <p>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.</p> | + | <p>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.</p> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,012: | Line 952: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>GetSpermiogrammID</h3> |
+ | <p>This function enables to see all semen analysis of the transferred patient.</p> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><em>function <span style="color: #3366ff;"><strong>GetSpermiogrammID </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: PAnsiChar): Integer; stdcall;</em></p> | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | <p><strong>Parameter: </strong></p> | ||
+ | <p>As parameter the function expects the PatientenID of type PAnsiChar.</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>This is the ID of your patient.</td> | ||
+ | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p>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.</p> | ||
+ | <p><strong>Return type:</strong> The type of the return value is integer. The function returns the SpermiogrammID on success or -1 on failure.</p> | ||
+ | <p><strong>Example:</strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>SaveFileBySpermiogramm</h3> | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
<td colspan="3"> | <td colspan="3"> | ||
− | <p><em>function <span style="color: #3366ff;"><strong>SaveFileBySpermiogramm </strong></span>(</em><em>aUser, aPassword: PAnsiChar;</em><em> ASpermID: Integer; APathAndFile: PAnsichar; ATyp: Integer; | + | <p><em>function <span style="color: #3366ff;"><strong>SaveFileBySpermiogramm </strong></span>(</em><em>aUser, aPassword: PAnsiChar;</em><em> ASpermID: Integer; APathAndFile: PAnsichar; ATyp: Integer; ADescription: PAnsiChar = nil; ADatum: PAnsiChar = nil): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,023: | Line 993: | ||
<td colspan="3"> | <td colspan="3"> | ||
<p><strong>Parameters:</strong></p> | <p><strong>Parameters:</strong></p> | ||
− | <p>This function expects as parameter the SpermiogrammID from type | + | <p>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.</p> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,095: | Line 1,065: | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | <h2> | + | <h2>Inkubator - Incubator</h2> |
+ | <h3>GetInkubatorID</h3> | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"> |
− | <p><em>function <span style="color: #3366ff;"><strong> | + | <p><em>function <span style="color: #3366ff;"><strong>GetInkubatorID </strong></span>(</em><em>aUser, aPassword: PAnsiChar; </em><em>AFilter: PAnsiChar = nil): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"><strong>Parameters:</strong></td> |
− | + | ||
− | </td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>aUser, aPassword (PAnsiChar)<br /></td> | + | <td>aUser, aPassword (PAnsiChar) <br /></td> |
− | <td | + | <td>A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td> |
− | <td | + | <p>AFilter (PAnsiChar = nil)</p> |
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | </td> | ||
+ | <td> | ||
+ | <p>You can restrict the search by specifying the filter.</p> | ||
+ | <p> </p> | ||
+ | <p>Filters based on the following criteria are possibly:</p> | ||
+ | <ul> | ||
+ | <li>Description</li> | ||
+ | <li>Active</li> | ||
+ | <li>Manufacturer.name</li> | ||
+ | <li>Model.name</li> | ||
+ | <li>Location of incubator.name</li> | ||
+ | <li>Incubator no.</li> | ||
+ | </ul> | ||
+ | <p> </p> | ||
+ | <p>Examples:</p> | ||
+ | <ul> | ||
+ | <li>Active = 1</li> | ||
+ | <li>Manufacturer.name like ‘XY%’</li> | ||
+ | <li>Incubator no > 20</li> | ||
+ | </ul> | ||
+ | </td> | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong> | + | <p>After calling this function, a selection dialog opens.</p> |
+ | <p><strong>Return type: </strong></p> | ||
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>SaveFileToInkubator</h3> |
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"> |
− | <p><em>function <span style="color: #3366ff;">< | + | <p><em>function <strong><span style="color: #3366ff;">SaveFileToInkubator </span></strong>(</em><em>aUser, aPassword: PAnsiChar;</em><em> aInkubatorID: Integer; APathAndFile: PAnsiChar; ADatum : PAnsiChar = nil; NewRecordInDatabase: boolean = true): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"> |
<p><strong>Parameters:</strong></p> | <p><strong>Parameters:</strong></p> | ||
+ | <p>This function expects as parameter the InkubatorID from type integer and the fully path of the file to be stored.</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>aUser, aPassword (PAnsiChar)<br /></td> | <td>aUser, aPassword (PAnsiChar)<br /></td> | ||
− | <td | + | <td>A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>aInkubatorID (Integer)</td> |
− | <td | + | <td>This is the ID of your incubator.</td> |
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
− | <td | + | <td>APathAndFile (PAnsiChar)</td> |
− | + | <td> | |
+ | <p>Path where the file should be saved.</p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td | + | <td> |
− | <p><strong> | + | <p> </p> |
+ | <p><strong>Optional parameters:</strong></p> | ||
+ | </td> | ||
+ | <td> | ||
+ | <p> </p> | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>ADatum (PAnsiChar = nil)</td> |
− | <td | + | <td>Default -> file date.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>NewRecordInDatabase(Boolean = true)</td> |
− | <td | + | <td> |
+ | <p>Default -> true.</p> | ||
+ | <ul> | ||
+ | <li>True: File is copied into the storage directory and a database entry takes place.</li> | ||
+ | <li>False: File is copied into the storage directory.</li> | ||
+ | </ul> | ||
+ | </td> | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong> The | + | <p><strong>Return type: </strong>The function returns the 1 on success or -1 on failure.</p> |
− | <p><strong>Example:</strong></p> | + | <p><strong>Example: </strong></p> |
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | <h2> | + | <h2>OpenComands</h2> |
− | <table border="0"> | + | <h3>OpenPatientCryoOverview</h3> |
+ | <p>This function offers the opportunity to call up the cryo storage in MedITEX IVF using the DLL.</p> | ||
+ | <p>After each call of the function, if MedITEX is running, the cryo storage of the respective patient will open.</p> | ||
+ | <table border="0" width="793" height="84"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
− | <p><em>function <span style="color: #3366ff;">< | + | <p><em>function <strong><span style="color: #3366ff;">OpenPatientCryoOverview</span></strong> (</em><em>APatientID: PAnsiChar): Integer; <span style="color: #000000;">stdcall</span>;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan="2" | + | <td colspan="2"><strong>Parameters:</strong></td> |
− | + | ||
− | </td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>APatientID (PAnsiChar)</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
<td>This is the ID of your patient.</td> | <td>This is the ID of your patient.</td> | ||
</tr> | </tr> | ||
+ | </tbody> | ||
+ | </table> | ||
+ | <p><strong>Return type:</strong> The type of the return value is integer. The function returns 1 on success or -1 on failure.</p> | ||
+ | <p><strong>Example: </strong></p> | ||
+ | <p> </p> | ||
+ | <p> </p> | ||
+ | <h3>OpenPatientOverview</h3> | ||
+ | <p>With this function it is possible to open the patient overview window in MedITEX IVF using the DLL.</p> | ||
+ | <p>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.</p> | ||
+ | <table border="0"> | ||
+ | <tbody> | ||
<tr> | <tr> | ||
− | <td> | + | <td colspan="2"> |
− | < | + | <p><em>function <strong><span style="color: #3366ff;">OpenPatientOverview</span></strong> (</em><em>aUser, aPassword: PAnsiChar; </em><em>APatientID: PAnsiChar): Integer; stdcall;</em><em> </em></p> |
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td colspan="2"><strong>Parameters:</strong></td> |
− | < | + | |
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>aUser, aPassword (PAnsiChar) <br /></td> |
− | <td> </td> | + | <td>A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>APatientID (PAnsiChar)</td> |
− | <td> | + | <td>This is the ID of your patient.</td> |
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong> The | + | <p><strong>Return type: </strong>The function returns 1 on success or -1 on failure as an integer.</p> |
− | <p><strong>Example: </strong></p> | + | <p><strong>Example:</strong></p> |
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>OpenTherapieOverview</h3> |
+ | <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> | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"> |
− | <p><em>function <span style="color: #3366ff;"><strong> | + | <p><em>function <span style="color: #3366ff;"><strong>OpenTherapieOverview </strong></span>(aUser,aPassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"><strong>Parameters:</strong></td> |
− | + | ||
− | </td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>aUser, aPassword (PAnsiChar)<br /></td> | + | <td>aUser, aPassword (PAnsiChar) <br /></td> |
− | <td | + | <td>A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
+ | </tr> | ||
+ | <tr> | ||
+ | <td>ATherapieID (PAnsiChar)</td> | ||
+ | <td>This is the ID of the cycle.</td> | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong></p> | + | <p><strong>Return type: </strong>The function returns 1 on success or -1 on failure as an integer.</p> |
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>OpenEizellOverview</h3> |
+ | <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> | ||
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"> |
− | <p><em>function <span style="color: #3366ff;"><strong> | + | <p><em>function <span style="color: #3366ff;"><strong>OpenEizellOverview </strong></span>(aUser,aPassword: PAnsiChar; aEZID: Integer): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan=" | + | <td colspan="2"><strong>Parameters:</strong></td> |
− | + | ||
− | </td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>aUser, aPassword (PAnsiChar)<br /></td> | + | <td>aUser, aPassword (PAnsiChar) <br /></td> |
− | <td | + | <td>A specific user in MedITEX IVF which can be used in external programs. <br /></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>aEZID (Integer)</td> |
− | <td | + | <td>This is the ID of the egg cell.</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong></p> | + | <p><strong>Return type: </strong>The function returns 1 on success or -1 on failure as an integer.</p> |
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
<p> </p> | <p> </p> | ||
<p> </p> | <p> </p> | ||
− | < | + | <h3>GetAblageDateien</h3> |
<table border="0"> | <table border="0"> | ||
<tbody> | <tbody> | ||
<tr> | <tr> | ||
<td colspan="3"> | <td colspan="3"> | ||
− | <p><em>function <span style="color: #3366ff;"><strong> | + | <p><em>function <span style="color: #3366ff;"><strong>GetAblageDateien </strong></span>(aUser,aPassword: PAnsiChar; APatientID: PAnsiChar): Integer; stdcall;</em></p> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,293: | Line 1,304: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>APatientID (PAnsiChar | + | <td>APatientID (PAnsiChar)</td> |
− | + | <td colspan="2">This is the ID of the patient.</td> | |
− | + | ||
− | + | ||
− | + | ||
− | <td colspan="2"> | + | |
</tr> | </tr> | ||
</tbody> | </tbody> | ||
</table> | </table> | ||
− | <p><strong>Return type:</strong></p> | + | <p><strong>Return type:</strong> The type of the return value is 1 on success or -1 on failure.</p> |
<p><strong>Example:</strong></p> | <p><strong>Example:</strong></p> | ||
− | |||
− | |||
<p> </p> | <p> </p> | ||
<table style="float: right;" border="0"> | <table style="float: right;" border="0"> |
Revision as of 10:31, 5 August 2013
<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 |
Commands
ExportCSVData
This function enables the export of files and reports out of MedITEX IVF with LDT. File format is CSV.
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:
SaveData
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, AKeyField, AKeyValue, ASaveValue (PAnsiChar) |
Return type: The type of the return value are the data on success or -1 on failure.
Example:
GetData
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: The type of the return value are the data on success or -1 on failure.
Example:
GetLanguageCode
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:
Example:
GetExpertData
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:
Patient
GetPatientID
After calling the function, a window opens, where you can search a patient.
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:
Examples:
|
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.
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.
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:
SaveFileByPatient
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.
|
The following file type - sub type combinations are possible:
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 | Egg cell pictures form MedITEX IVF |
Return type: The function returns the 1 on success or -1 on failure.
Example:
SaveLabData
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) | |
AProbeID (PAnsiChar) |
|
ALaborParam (PAnsiChar) | |
AValue (PAnsiChar) |
Return type: The type of the return value is 1 on success or -1 on failure.
Example:
SavePatientImage
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:
Therapie - Cycle
GetTherapieID
This function allows you to see all cycles of the transferred patient.
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:
GetTherapieIDEx
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) |
||
aTIDList (string) |
Return type:
Example:
SaveUSImage
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:
Kultur - Culture
GetEZID
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, a new window opens. 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
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
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
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 egg cell. |
Return type: The function returns the corresponding culture day on success or -1 on failure of type PAnsiChar.
Example:
SaveEZImage
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:
Spermiogramm - Semen analysis
GetNewSpermiogrammID
After calling the function, a new semen analysis with the passed parameters will be created.
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) | |
Optional parameters: |
|
ADatum (PAnsiChar = nil) | The date of recording. |
ABemerkung (PAnsiChar = nil) | |
Uhrzeit (PAnsiChar = nil) | |
Spendersperma (Boolean = false) | Sperm from donor. |
Gewinnungsart (Integer = 0) | Collection method. |
Return type: The type of the return value is the new SpermiogrammID on success or -1 on failure.
Example:
SaveSpermData
After calling the function, all entered values of the CSV-String will be added to the associated semen analysis.
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 ;
|
||
Return type: The function returns 1 on success or -1 on failure.
Example: "PH_VA = 0.45";"DIAGNOSE_TEXT = 'TestDiagnose'";"NORMOSPERMIE_VA=23"
GetSpermiogrammID
This function enables to see all semen analysis of the transferred patient.
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:
SaveFileBySpermiogramm
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:
Inkubator - Incubator
GetInkubatorID
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:
Examples:
|
After calling this function, a selection dialog opens.
Return type:
Example:
SaveFileToInkubator
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.
|
Return type: The function returns the 1 on success or -1 on failure.
Example:
OpenComands
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.
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:
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.
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:
OpenTherapieOverview
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.
function OpenTherapieOverview (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 (PAnsiChar) | This is the ID of the cycle. |
Return type: The function returns 1 on success or -1 on failure as an integer.
Example:
OpenEizellOverview
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.
function OpenEizellOverview (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:
GetAblageDateien
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=Main_Page">Back to MedITEX products</a> | <a href="#top">Back to top</a> |