Docs For Class ModuleWebservice

ModuleWebservice

Description

MEMdoc Module Webservice

Located in /src/ModuleWebservice.php (line 24)

Method Summary

void createAutomaticLogin ( $createAutomaticLoginWsRequest, Object $createAutomaticLoginRequest)

void createAutomaticLoginImpl (CreateAutomaticLoginRequest $createAutomaticLoginRequestObj)

Patient createNewPatient (CreateNewPatientRequest $createNewPatientRequest)

DeletePatientResponse deletePatient (DeletePatientRequest $deletePatientRequest)

array getPatientById (GetPatientByIdRequest $getPatientByIdRequest)

array getPatientFields (GetPatientFieldRequest $getPatientFieldRequest)

User getUserById (GetUserByIdRequest $getUserByIdRequest)

GetUserFieldsResponse getUserFields (GetUserFieldsRequest $getUserFields)

array getUserInformation (GetUserInformationRequest $getUserInformationRequest)

LoginToModuleResponse loginToModule (LoginToModuleRequest $loginToModuleRequest)

boolean logoutFromModule (LogoutFromModuleRequest $logoutFromModuleRequest)

ModifyPatientResponse modifyPatient (ModifyPatientRequest $modifyPatientRequest)

array searchPatient (SearchPatientRequest $searchPatientRequest)

Methods

createAutomaticLogin (line 1155)

Allows a web service to prepare the login for another user of the MEMdoc online application.

The result of the operation is an URL with an identifier which will allow the caller of the URL to be automatically logged into the application with the context specified on this web service request.

For example, a web service user can create an automatic login url for 'Doctor A' into a view that displays the patient form list of 'patient B'.

access: public

void createAutomaticLogin ( $createAutomaticLoginWsRequest, Object $createAutomaticLoginRequest)

Object $createAutomaticLoginRequest
$createAutomaticLoginWsRequest

createAutomaticLoginImpl (line 1184)

access: public

void createAutomaticLoginImpl (CreateAutomaticLoginRequest $createAutomaticLoginRequestObj)

CreateAutomaticLoginRequest $createAutomaticLoginRequestObj

createNewPatient (line 583)

Inserts a new patient into the MEMdoc Module.

return: a Patient object
access: public

Patient createNewPatient (CreateNewPatientRequest $createNewPatientRequest)

CreateNewPatientRequest $createNewPatientRequest: createNewPatientRequest object

deletePatient (line 911)

PURPOSE: Deletes a patient from the module

PRECONDITION: The patient must first be deleted from the server, and the signature returned by the server must be passed to this operation as proof that server delete operation was successful

return: Object which indicates success on delelte when true, and failure otherwise
see: DeletePatientRequest
see: DeletePatientResponse
see: Signature
link: SOAP-RequestReply-Illustration
access: public

DeletePatientResponse deletePatient (DeletePatientRequest $deletePatientRequest)

DeletePatientRequest $deletePatientRequest: Object identifying the the moduleSessionID, the patientID to be deleted, and server signature as proof that delete operation was successful on Memdoc Server

getPatientById (line 664)

Gets patient data by the memdoc patientId. This method can return more that one object. A patient can be registerd in several clinics or departments For each registration a Patient object is returned

return: Array of Patient objects
access: public

array getPatientById (GetPatientByIdRequest $getPatientByIdRequest)

GetPatientByIdRequest $getPatientByIdRequest: getPatientByIdRequest An object with properties patientId and moduleSessionId

getPatientFields (line 376)

Get the parameters that have to be used for inserting a new patient or searching for an existing one.

return: Array of PatientField objects
access: public

array getPatientFields (GetPatientFieldRequest $getPatientFieldRequest)

GetPatientFieldRequest $getPatientFieldRequest: getPatientFieldRequest Object containing the needed parameters

getUserById (line 1091)

Processes a request for obtaining information about a specific user, namely in terms of the data fields that describe the user.

return: an object containing UserFieldData data that descibres a user
link: SOAP-RequestReply-Illustration
access: public

User getUserById (GetUserByIdRequest $getUserByIdRequest)

GetUserByIdRequest $getUserByIdRequest

getUserFields (line 1047)

processes a request to determine the user fields metadata.

return: an object containing metadata that describes the existing user fields. Each user field is a unit of information concerning a user (e.g. user's first name)
link: SOAP-RequestReply-Illustration
access: public

GetUserFieldsResponse getUserFields (GetUserFieldsRequest $getUserFields)

GetUserFieldsRequest $getUserFields

getUserInformation (line 311)

Get a list of the departments a user is registered in.

return: Array of UserDepartment objects
access: public

array getUserInformation (GetUserInformationRequest $getUserInformationRequest)

GetUserInformationRequest $getUserInformationRequest: getUserInformationRequest object containing the module session id

loginToModule (line 166)

User login.
Checks username and password and creates a Session for the user
The response object contains the user Id, the signature and the module session id and the module id.

This is only the first part of the login procedure. Next, the user has to be logged in to the server as well

return: LoginToModuleResponse object
access: public

LoginToModuleResponse loginToModule (LoginToModuleRequest $loginToModuleRequest)

LoginToModuleRequest $loginToModuleRequest: loginToModuleRequest An object with properties username, password, serverSessionId and moduleId

logoutFromModule (line 289)

Logs out the user and destroys his session object

return: TRUE or FALSE
access: public

boolean logoutFromModule (LogoutFromModuleRequest $logoutFromModuleRequest)

LogoutFromModuleRequest $logoutFromModuleRequest: logoutFromModuleRequest An object with the property moduleSessionId

modifyPatient (line 1206)

Processes a request to update patient field information of a patient.

return: an object containing internal data computed after the update action, for example the patient hash codes, and which the server.modifyPatient operations needs to see updated.
link: SOAP-RequestReply-Illustration
access: public

ModifyPatientResponse modifyPatient (ModifyPatientRequest $modifyPatientRequest)

ModifyPatientRequest $modifyPatientRequest

searchPatient (line 525)

Searches a patient. Available search parameters depend on getPatientFields()

return: Array of patient ids
access: public

array searchPatient (SearchPatientRequest $searchPatientRequest)

SearchPatientRequest $searchPatientRequest: searchPatientRequest SearchPatientRequest object, has an array of patient fields and the sessionId

Documentation generated on Fri, 19 Aug 2016 11:23:19 +0200 by phpDocumentor 1.4.4