Sumex1.net/generalFormRequest/C++ API: IGeneralFormRequest interface

API browser of generalFormRequest450 COM module

IGeneralFormRequest interface		V4.50/ 2 Sep 2016
With the IGeneralFormRequest interface all the PDF form related data and parameters can be set by the available interface methods like SetPatient, AddAddress,... Since the set of requested data is dependent on the chosen PDF form, such a PDF form or alternatively a corresponding XML infoset of type generalFormRequest_450 or generalFormRequest_430 firstly must be loaded into the COM module. The IGeneralFormRequestManger::LoadPDF or IGeneralFormRequestManger::LoadXML methods return the instance of IGeneralFormRequest interface upon successful loading the data file.

Methods		30 methods
AddAddress	Sets the structured address and primary parameters like GLN, ZSR, etc
AddAllergy	Adds an allergy structure to the list of allergies.
AddDiagnosis	Adds a diagnosis structure to the list of diagnoses.
AddDocument	Attaches a PDF, JPG or PNG document to the list of documents
AddMedication	Adds a medication structure to the list of medications.
AddNumericResult	Adds a numerical result structure to the list of numerical result structures
AddTextResult	Adds a textual result structure to the list of textual result structures
AddUnemployability	Adds an unemployability structure to the list of unemployabilities.
AddVaccination	Adds a vaccination structure to the list of vaccinations.
AddVar	Adds a basic PDF form variable
Finalize	Finalizes and validates all data set so far in the GeneralFormRequest interface
GetAbortInfo	Get the abort information string with the error coded in the module language
GetAddressRoles	Method for collecting all address role data covered by the IGeneralFormRequest interface and returned as JSON array
GetFirstAddressRole	Retrieves the first address of all semantically well defined address defined by the currently loaded PDF file
GetFirstStructRole	Retrieves the first structure of all semantically well defined structures defined by the currently loaded PDF file
GetFirstVar	Retrieves the first basic PDF form variable
GetNextAddressRole	Retrieves the next address of all semantically well defined address defined by the currently loaded PDF file
GetNextStructRole	Retrieves the first structure of all semantically well defined structures defined by the currently loaded PDF file
GetNextVar	Retrieves the next basic PDF form variable
GetStructRoles	Method for collecting all structure role data covered by the IGeneralFormRequest interface and returned as JSON array
GetVars	Method for collecting all variable data covered by the IGeneralFormRequest interface and returned as JSON array
SetCard	Sets the patient's insurance card information (might be the patient card later on) - this information is optional.
SetFormObject	Sets the form object reference parameters
SetLaw	Sets the law and its dependent information
SetPackage	Defines the identification parameters of the main software that uses this DLL.
SetPatient	Sets the primary parameters and structured address of the patient
SetRefObject	Sets the optional depended object reference of type credit, invoice, reminder, MCD, form, or notification for which this form process is actually started
SetRequest	Sets the role and place information, as well as the processing parameters "storno" and "copy"
SetTransport	Sets transport information that is the routing information going from a sender (from) over the first intermediate (via) to the receiver (to)
SetTreatment	Sets the primary treatment input data.

Properties		3 properties
[get] CreateAddress	Create an instance of the IAddress interface
[put] DestructAddress	Destructs/invalidates the IAddress interface instance
[put] DestructGeneralFormRequest	Destructs/invalidates this IGeneralFormRequest interface instance.