MedITEX API manual

From MedITEX - Wiki

(Difference between revisions)
Jump to: navigation, search
Line 220: Line 220:
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<p>&nbsp;</p>
+
<h2>GetTherapieID</h2>
−
<p>&nbsp;</p>
+
<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)&nbsp; <br /></td>
 +
<td>A specific user in MedITEX IVF which can be used in external programs.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp; <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, the following overview window opens:</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td>Bild</td>
 +
</tr>
 +
<tr>
 +
<td>
 +
<p>Tihs window is showing all cycles from the transferred patient. Choose the wished cycle.</p>
 +
</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<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>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>

Revision as of 09:43, 31 July 2013

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

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

 

Contents

ExportCSVData

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

<tbody> </tbody>

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

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

Filter condition for the export.

Example: Patient_ID = 1000 and dt_gewinnung > '01.01.2010'

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

Example:

 

OpenPatientCryoOverview

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

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

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

<tbody> </tbody>

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

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

Example:

 

OpenPatientOverview

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

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

<tbody> </tbody>

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

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

Example:

 

 

GetPatientID

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

<tbody> </tbody>

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

AFilter (PAnsiChar = nil)

 

 

 

 

 

 

 

 

 

 

 

 

 

You can restrict the search by specifying the filter.

 

Filters based on the following criteria are possibly:

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

 

Examples:

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

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

Example:

 

 

GetPatientName

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

<tbody> </tbody>

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

Parameter:

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

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

Example:

 

 

GetPartnerPatID

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

<tbody> </tbody>

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

Parameter:

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

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

Example:

 

 

GetTherapieID

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

<tbody> </tbody>

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

Parameter:

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

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

<tbody> </tbody>
Bild

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

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

Example:

 

 

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