org.memdoc.www.yosemite.webservices.memdoc

Class MemdocServer

java.lang.Object

org.memdoc.www.yosemite.webservices.memdoc.MemdocServer

public class MemdocServer
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
MemdocServer()

Method Summary

Modifier and Type	Method and Description
AddImplantToFormDataResponse	addImplantToFormData(AddImplantToFormDataRequest addImplantToFormData) Adds one ore more implants to a formdata entity that is not submitted.
DeleteFormDataResponse	deleteFormData(DeleteFormDataRequest deleteFormDataRequest) Deletes a form data record from the system.
DeletePatientResponse	deletePatient(DeletePatientRequest deletePatientRequest) Allows a user to delete a patient that he owns.
DeletePatientResponse	deletePatient(java.lang.Long deletePatientRequest)
Form	downloadFormDefinition(DownloadFormDefinitionRequest dfdr) Returns a Form object.
GetDepartmentDateFormatResponse	getDepartmentDateFormat(GetDepartmentDateFormat departmentDateFormatRequest) Allows a user to know the string format used for date values in the scope of a specific department.
GetListOfFormDataResponse	getListOfFormData(GetListOfFormDataRequest glofdr) Returns a list of objects that summarizes the set of forms associated to patient in the context of a department.
GetListOfFormsResponse	getListOfForms(GetListOfFormsRequest glofr) List all the forms of a given form type in a given language.
GetListOfStudiesResponse	getListOfStudies(GetListOfStudiesRequest glosr) List all the studies in a given language.
GetSedicoImplantDataResponse	getSedicoImplantData(GetSedicoImplantData getImplantDataRequest) Returns the set of sedico implant data entries within the specified scope (clinic or department).
java.lang.Long	getServerSessionId() Returns the server session id.
java.lang.Long	insertForm(InsertFormRequest ifr) Save the data of a given form for a given patient.
InsertLeistungResponse	insertLeistung(InsertLeistungRequest insertLeistungRequest) Inserts data into the Spitex Leistung DATA .
java.lang.Boolean	insertPatient(InsertPatientRequest npr) Inserts some module data of a newly created patient into the memdoc database This is the second part of inserting a patient into the MEMdoc documentation platform.
java.lang.Boolean	loginToServer(LoginToServerRequest loginRequest) Logs a user into the MEMdoc server.
java.lang.Boolean	logoutFromServer(LogoutFromServerRequest logoutFromServerRequest) Disconnect the user from MEMdoc.
ModifyPatientResponse	modifyPatient(ModifyPatientRequest modifyPatientRequest) Modifies information concerning a patient in the server, such as the patient hashed mrn, gender and year of birth.
SearchFormDataResponse	searchFormData(SearchFormDataRequest searchFormData) searches the system for the set of form data record ids that satisfy, simultaneously, all the search filters specified by the user.
java.lang.Boolean	submitForm(SubmitFormRequest cr) Submit a form : make it impossible to modify the form anymore.
java.lang.Boolean	unSubmitForm(UnSubmitFormRequest ucr) Unsubmit a form : make it possible to change a committed form again.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

MemdocServer

public MemdocServer()

Method Detail

getServerSessionId

public java.lang.Long getServerSessionId()
                                  throws InternalServerErrorException

Returns the server session id. This id is needed to log into the module and then for every request that is made to the server.

Returns:

the server session id

Throws:

InternalServerErrorException

loginToServer

public java.lang.Boolean loginToServer(LoginToServerRequest loginRequest)
                                throws InternalServerErrorException

Logs a user into the MEMdoc server. The user has to be logged into the module first to create a signature and get a user id and a module id. He then creates a LoginToServerRequest object which contains the necessary information

Parameters:

loginRequest - LoginToServerRequest

Returns:

true or false

Throws:

InternalServerErrorException

See Also:

SOAP-Request-Reply Example

logoutFromServer

public java.lang.Boolean logoutFromServer(LogoutFromServerRequest logoutFromServerRequest)
                                   throws InternalServerErrorException

Disconnect the user from MEMdoc. The session will be deleted

Returns:

Returns the boolean object true if the session has been deleted.

Throws:

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

getListOfForms

public GetListOfFormsResponse getListOfForms(GetListOfFormsRequest glofr)
                                      throws ServerSessionTimeoutException,
                                             InternalServerErrorException

List all the forms of a given form type in a given language. If the form doesn't exist in the given language, a form in the default language (English) is returned. If the form doesn't exist in the given language and in the default language, then the form id is returned as the form name.

Parameters:

glofr - GetListOfFormsRequest

Returns:

returns a list of forms where each form object is comprised by the following properties:

formId: id of the form

formName: language independent name of the form object

formTitle: the name of the form in the correct language

formVersion: the version of the form returned

active: flag indicating whether the form is active or not

formId: creation date of the form. The dates are in the format "dd-mm-yyyy". The date field cannot be NULL. If a date is empty the value "00-00-0000" will be sent.

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionID is not the ID of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

See Also:

SOAP-Request-Reply Example

getListOfStudies

public GetListOfStudiesResponse getListOfStudies(GetListOfStudiesRequest glosr)
                                          throws ServerSessionTimeoutException,
                                                 InternalServerErrorException

List all the studies in a given language.

Parameters:

glosr - GetListOfStudiesRequest Identifies the language in which the output set of studies should be presented.

Returns:

List all the studies in a given language. If the study doesn't exist in the given language, a study in the default language, English, is returned. If the study doesn't exist in the given language and in the default language, then the study ID is returned as the study

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionID is not the ID of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

See Also:

SOAP-Request-Reply Example, JavaDoc

getListOfFormData

public GetListOfFormDataResponse getListOfFormData(GetListOfFormDataRequest glofdr)
                                            throws ServerSessionTimeoutException,
                                                   InternalServerErrorException

Returns a list of objects that summarizes the set of forms associated to patient in the context of a department.

Parameters:

glofdr - GetListOfFormDataRequest Object identifying the patient and department for which form data is to be searched.

Returns:

GetListOfFormDataResponse is list of object where each element summarizes a form associated to the patient being queried.

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionID is not the ID of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

See Also:

SOAP-Request-Reply Example

downloadFormDefinition

public Form downloadFormDefinition(DownloadFormDefinitionRequest dfdr)
                            throws ServerSessionTimeoutException,
                                   InternalServerErrorException

Returns a Form object. The object contains Section, Group, Question and Answer objects

Returns:

returns the form as an object of class Form.

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionID is not the ID of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

See Also:

SOAP-Request-Reply Example

insertForm

public java.lang.Long insertForm(InsertFormRequest ifr)
                          throws ServerSessionTimeoutException,
                                 InternalServerErrorException

Save the data of a given form for a given patient. Once the form has been inserted, it will still be possible to add new subform to it, but it will be impossible to modify or overwrite existing subforms.

Parameters:

ifr - InsertFormRequest

Returns:

returns the formDataId associated with this data

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionId is not the id of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

See Also:

SOAP-Request-Reply Example

submitForm

public java.lang.Boolean submitForm(SubmitFormRequest cr)
                             throws ServerSessionTimeoutException,
                                    InternalServerErrorException

Submit a form : make it impossible to modify the form anymore.

Returns:

returns true if the form was successfully committed, else false

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionID is not the ID of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

unSubmitForm

public java.lang.Boolean unSubmitForm(UnSubmitFormRequest ucr)
                               throws ServerSessionTimeoutException,
                                      InternalServerErrorException

Unsubmit a form : make it possible to change a committed form again.

Returns:

returns true if the form was successfully committed

Throws:

ServerSessionTimeoutException - An Exception of type ServerSessionTimeoutException is thrown if the sessionID is not the ID of an active session.

InternalServerErrorException - Throws an exception of type InternalServerErrorException in case of any internal error.

insertPatient

public java.lang.Boolean insertPatient(InsertPatientRequest npr)
                                throws ServerSessionTimeoutException,
                                       InternalServerErrorException

Inserts some module data of a newly created patient into the memdoc database This is the second part of inserting a patient into the MEMdoc documentation platform. First you call module.createPatient which created the patient on the module. The values you get returned from the module are then used for this method.

Parameters:

npr - InsertPatientRequest

Returns:

returns true if the patient was created correctly, else false.

Throws:

ServerSessionTimeoutException

InternalServerErrorException

See Also:

InsertPatientRequest

insertLeistung

public InsertLeistungResponse insertLeistung(InsertLeistungRequest insertLeistungRequest)
                                      throws InternalServerErrorException,
                                             ServerSessionTimeoutException

Inserts data into the Spitex Leistung DATA . The Leistungskatalog is similar to the components/implants in other forms. There is no subform to put this data in, it is set in a special table (Leistungskatalogdata)

Parameters:

insertLeistungRequest - InsertLeistungRequest

Returns:

a response object with no real content InsertLeistungResponse

Throws:

InternalServerErrorException

ServerSessionTimeoutException

deletePatient

public DeletePatientResponse deletePatient(java.lang.Long deletePatientRequest)

deletePatient

public DeletePatientResponse deletePatient(DeletePatientRequest deletePatientRequest)
                                    throws InternalServerErrorException,
                                           ServerSessionTimeoutException

Allows a user to delete a patient that he owns.

Parameters:

deletePatientRequest - DeletePatientRequest Request object identifies the user's Server Session and the Patient to be deleted

Returns:

DeletePatientResponse object detailing if the operation was successful. The object is comprised by a Signature to be passed on to the Module Delete Operation as proof of successful delete on the server

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example, Module Delete Operation, Memcms Delete Patient Use Case Description, Signature

getDepartmentDateFormat

public GetDepartmentDateFormatResponse getDepartmentDateFormat(GetDepartmentDateFormat departmentDateFormatRequest)
                                                        throws InternalServerErrorException,
                                                               ServerSessionTimeoutException

Allows a user to know the string format used for date values in the scope of a specific department. The date that applies to a given department is influenced by the country where the department is located. This date format must always be respected when submitting Form Data for a specific patient in a given department by means of, for example, the WebServiceSEI.insertForm(org.memdoc.www.yosemite.webservices.memdoc.wrappers.InsertFormRequest) operation, or, WebServiceSEI.insertPatient(org.memdoc.www.yosemite.webservices.memdoc.wrappers.InsertPatientRequest) operation.

Parameters:

departmentDateFormatRequest - GetDepartmentDateFormat Object that identifies the department for which a date format must be returned.

Returns:

GetDepartmentDateFormatResponse

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example, insertForm(org.memdoc.www.yosemite.webservices.memdoc.wrappers.InsertFormRequest), Date format string semantics

deleteFormData

public DeleteFormDataResponse deleteFormData(DeleteFormDataRequest deleteFormDataRequest)
                                      throws InternalServerErrorException,
                                             ServerSessionTimeoutException

Deletes a form data record from the system. The web service user must have delete write permissions on the targeted form data.

Returns:

returns DeleteFormDataResponse

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example

getSedicoImplantData

public GetSedicoImplantDataResponse getSedicoImplantData(GetSedicoImplantData getImplantDataRequest)
                                                  throws InternalServerErrorException,
                                                         ServerSessionTimeoutException

Returns the set of sedico implant data entries within the specified scope (clinic or department).

Parameters:

getImplantDataRequest - GetSedicoImplantData object identifying the user session, desired output language and scope of information to be retrieved.

Returns:

returns org.memdoc.www.yosemite.webservices.memdoc.GetSedicoImplantDataResponse GetSedicoImplantDataResponse Object containing a list of SedicoImplantData elements. The default values used when no data exists for an output field are: xs:string maps to the empty string, xs:long maps to 0.

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example, Date format string semantics

searchFormData

public SearchFormDataResponse searchFormData(SearchFormDataRequest searchFormData)
                                      throws InternalServerErrorException,
                                             ServerSessionTimeoutException

searches the system for the set of form data record ids that satisfy, simultaneously, all the search filters specified by the user.

Parameters:

searchFormData - Object containing a set of search filters to be used for finding form data records

Returns:

returns org.memdoc.www.yosemite.webservices.memdoc.wrappers.SearchFormDataResponse a list of form data ids, where each id uniquely identifies a form data that matches the specified search criteria

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example

modifyPatient

public ModifyPatientResponse modifyPatient(ModifyPatientRequest modifyPatientRequest)
                                    throws InternalServerErrorException,
                                           ServerSessionTimeoutException

Modifies information concerning a patient in the server, such as the patient hashed mrn, gender and year of birth. This operation expects to be provided the information returned by the module as result of a modify operation on the module.

Parameters:

modifyPatientRequest - Object containing patient information that should be updated on the server. The module's modify patient web service output provides every data value that the server should see updated.

Returns:

returns org.memdoc.www.yosemite.webservices.memdoc.wrappers.ModifyPatientResponse a response object detailing the success of the operation or, otherwise, in case of error, an exception detailing the error cause.

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example

addImplantToFormData

public AddImplantToFormDataResponse addImplantToFormData(AddImplantToFormDataRequest addImplantToFormData)
                                                  throws InternalServerErrorException,
                                                         ServerSessionTimeoutException

Adds one ore more implants to a formdata entity that is not submitted.

The user has the flexibility of choosing either to manually provide the details of the implant to be added, see ImplantDescription; or to provide the barcode information of the implant, see BarcodeData. Both alternatives can be used simultaneously, see the following SOAP-Request-Reply Example .

In case that for a given barcode in the request more than one product in our catalog is a match, then one of the matched implant products shall be linked to the form data and the web service client shall be provided with information concerning the product search collisions. This is scenario is illustrated in the SOAP-Request-Reply Example .

Returns:

returns org.memdoc.www.yosemite.webservices.memdoc.AddImplantToFormDataResponse

Throws:

InternalServerErrorException

ServerSessionTimeoutException

See Also:

SOAP-Request-Reply Example