MedITEX API manual

From MedITEX - Wiki

(Difference between revisions)
Jump to: navigation, search
Line 45: Line 45:
 
<ul>
 
<ul>
 
</ul>
 
</ul>
−
<p><strong>Example: </strong>Click here if you want to get an example of this function.</p>
+
<p><strong>Example: </strong><a href="/index.php?title=Examples_mexAPI">Click here</a> if you want to get an example of this function.</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>

Revision as of 11:00, 5 August 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

Commands

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: <a href="/index.php?title=Examples_mexAPI">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, AKeyField, AKeyValue, ASaveValue (PAnsiChar)

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

Example: Click here if you want to get an example of this function.

 

 

GetData

<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: The type of the return value are the data on success or -1 on failure.

Example: Click here if you want to get an example of this function.

 

 

GetLanguageCode

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

Example: Click here 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: Click here 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: Click here 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 with type PAnsiChar.

Example: Click here 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: Click here if you want to get an example of this function.

 

 

SaveFileByPatient

<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 Egg cell pictures form MedITEX IVF  

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

Example: Click here if you want to get an example of this function.

 

 

SaveLabData

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

AProbeID (PAnsiChar)

  
ALaborParam (PAnsiChar)  
AValue (PAnsiChar)  

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

Example: Click here if you want to get an example of this function.

 

 

SavePatientImage

<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: Click here 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: Click here 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)
  
aTIDList (string)  

Return type:

Example: Click here if you want to get an example of this function.

 

 

SaveUSImage

<tbody> </tbody>

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

Parameter:

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

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

Example: Click here if you want to get an example of this function.

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

 

 

Kultur - Culture

GetEZID

<tbody> </tbody>

function GetEZID (aUser, aPassword: PAnsiChar; ATherapieID: Integer): Integer; stdcall;

Parameter:

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

After calling this function, 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: Click here 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 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: Click here if you want to get an example of this function.

 

 

GetKulturtag

<tbody> </tbody>

function GetKulturtag (aUser, aPassword: PAnsiChar; aEZID: Integer): Integer; stdcall;

Parameter:

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

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

Example: Click here if you want to get an example of this function.

 

 

GetKulturtagAsDate

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

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

Example: Click here 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 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: Click here 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)  

 

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: Click here 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"

Click here if you want to get an example of this function.

 

GetSpermiogrammID

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

<tbody> </tbody>

function GetSpermiogrammID (aUser, aPassword: PAnsiChar; APatientID: PAnsiChar): Integer; stdcall;

Parameter:

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

After this function has been called, 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: Click here if you want to get an example of this function.

 

 

SaveFileBySpermiogramm

<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: Click here if you want to get an example of this function.

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

 

 

Inkubator - Incubator

GetInkubatorID

<tbody> </tbody>

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

AFilter (PAnsiChar = nil)

 

 

 

 

 

 

 

 

 

 

 

You can restrict the search by specifying the filter.

 

Filters based on the following criteria are possibly:

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

 

Examples:

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

After calling this function, a selection dialog opens.

Return type:

Example: Click here if you want to get an example of this function.

 

 

SaveFileToInkubator

<tbody> </tbody>

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

Parameters:

This function expects as parameter the InkubatorID from type integer and the fully path of the file to be stored.
aUser, aPassword (PAnsiChar)
 A specific user in MedITEX IVF which can be used in external programs.                       
aInkubatorID (Integer) This is the ID of your incubator.
APathAndFile (PAnsiChar)

Path where the file should be saved.

 

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: Click here if you want to get an example of this function.

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

 

 

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.

<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: Click here 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: Click here if you want to get an example of this function.

 

 

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.

<tbody> </tbody>

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: Click here if you want to get an example of this function.

 

 

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.

<tbody> </tbody>

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: Click here 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: Click here if you want to get an example of this function.

 

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