public class MemdocServer
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAMESPACE |
Constructor and Description |
---|
MemdocServer() |
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.
|
public static final java.lang.String NAMESPACE
public java.lang.Long getServerSessionId() throws InternalServerErrorException
InternalServerErrorException
public java.lang.Boolean loginToServer(LoginToServerRequest loginRequest) throws InternalServerErrorException
loginRequest
- LoginToServerRequest
InternalServerErrorException
public java.lang.Boolean logoutFromServer(LogoutFromServerRequest logoutFromServerRequest) throws InternalServerErrorException
InternalServerErrorException
- Throws an exception of type
InternalServerErrorException in case of any internal error.public GetListOfFormsResponse getListOfForms(GetListOfFormsRequest glofr) throws ServerSessionTimeoutException, InternalServerErrorException
glofr
- GetListOfFormsRequest
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.public GetListOfStudiesResponse getListOfStudies(GetListOfStudiesRequest glosr) throws ServerSessionTimeoutException, InternalServerErrorException
glosr
- GetListOfStudiesRequest
Identifies the language in which the output set of studies should be presented.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.public GetListOfFormDataResponse getListOfFormData(GetListOfFormDataRequest glofdr) throws ServerSessionTimeoutException, InternalServerErrorException
objects
that summarizes the set of forms associated to patient in the context of a department.glofdr
- GetListOfFormDataRequest
Object identifying the patient and department for which form data is to be searched.GetListOfFormDataResponse
is list of object
where each element summarizes a form associated to the patient being queried.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.public Form downloadFormDefinition(DownloadFormDefinitionRequest dfdr) throws ServerSessionTimeoutException, InternalServerErrorException
Form
.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.public java.lang.Long insertForm(InsertFormRequest ifr) throws ServerSessionTimeoutException, InternalServerErrorException
ifr
- InsertFormRequest
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.public java.lang.Boolean submitForm(SubmitFormRequest cr) throws ServerSessionTimeoutException, InternalServerErrorException
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.public java.lang.Boolean unSubmitForm(UnSubmitFormRequest ucr) throws ServerSessionTimeoutException, InternalServerErrorException
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.public java.lang.Boolean insertPatient(InsertPatientRequest npr) throws ServerSessionTimeoutException, InternalServerErrorException
npr
- InsertPatientRequest
ServerSessionTimeoutException
InternalServerErrorException
InsertPatientRequest
public InsertLeistungResponse insertLeistung(InsertLeistungRequest insertLeistungRequest) throws InternalServerErrorException, ServerSessionTimeoutException
insertLeistungRequest
- InsertLeistungRequest
InsertLeistungResponse
InternalServerErrorException
ServerSessionTimeoutException
public DeletePatientResponse deletePatient(java.lang.Long deletePatientRequest)
public DeletePatientResponse deletePatient(DeletePatientRequest deletePatientRequest) throws InternalServerErrorException, ServerSessionTimeoutException
deletePatientRequest
- DeletePatientRequest
Request object identifies the user's Server Session and the Patient to be deletedDeletePatientResponse
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 serverInternalServerErrorException
ServerSessionTimeoutException
Signature
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.
departmentDateFormatRequest
- GetDepartmentDateFormat
Object that identifies the department for which a date format must be returned.GetDepartmentDateFormatResponse
InternalServerErrorException
ServerSessionTimeoutException
insertForm(org.memdoc.www.yosemite.webservices.memdoc.wrappers.InsertFormRequest)
,
Date format string semanticspublic DeleteFormDataResponse deleteFormData(DeleteFormDataRequest deleteFormDataRequest) throws InternalServerErrorException, ServerSessionTimeoutException
InternalServerErrorException
ServerSessionTimeoutException
public GetSedicoImplantDataResponse getSedicoImplantData(GetSedicoImplantData getImplantDataRequest) throws InternalServerErrorException, ServerSessionTimeoutException
Returns the set of sedico implant data entries within the specified scope (clinic or department).
getImplantDataRequest
- GetSedicoImplantData
object identifying the user session, desired output language and scope of information to be retrieved.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.InternalServerErrorException
ServerSessionTimeoutException
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.
searchFormData
- Object containing a set of search filters to be used for finding form data recordsInternalServerErrorException
ServerSessionTimeoutException
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.
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.InternalServerErrorException
ServerSessionTimeoutException
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 .
InternalServerErrorException
ServerSessionTimeoutException