org.phenotips.data.push

Interface PushPatientData

@Unstable
@Role
public interface PushPatientData

API that allows pushing patient data to a remote PhenoTips instance. Note: this API does not check any permissions and assumes the caller has the right to push the patient.

Since:

1.0M11

Version:

$Id: 0007ca551ce355eeb29626df033c1fcb87bb323b $

Method Summary

Methods

Modifier and Type	Method and Description
PushServerGetPatientIDResponse	getPatientURL(String remoteServerIdentifier, String remoteGUID, String userName, String password, String userToken) Gets the remote patient ID and URL for viewing the remote patient.
PushServerConfigurationResponse	getRemoteConfiguration(String remoteServerIdentifier, String userName, String password, String user_token) Retrieves the list of patient fields accepted by the remote server as well as the list of groups the given remote user is a member of on the remote server.
PushServerSendPatientResponse	sendPatient(Patient patient, Set<String> exportFields, org.json.JSONObject patientState, String groupName, String remoteGUID, String remoteServerIdentifier, String userName, String password, String user_token) Submits the specified subset of patient data to the specified remote server.

Method Detail

getRemoteConfiguration

PushServerConfigurationResponse getRemoteConfiguration(String remoteServerIdentifier,
                                                     String userName,
                                                     String password,
                                                     String user_token)

Retrieves the list of patient fields accepted by the remote server as well as the list of groups the given remote user is a member of on the remote server.

Uses the provided credentials to authorize on the remote server. In case optional user_token is not null the token is used and the password is ignored.

Parameters:

remoteServerIdentifier - server name as configured in TODO

userName - user name on the remote server

password - user password on the remote server. Ignored if user_token is not null.

user_token - passwordless-login token provided by the remote server on the last successful login (optional)

Returns:

server response which, upon successful login, contains the list of remote phenotips groups the user is a part of as well as the list of accepted patient fields. If enabled on the the remote server will also contain a token for future passwordless logins, which may or may not be the same as the token provided. See PushServerConfigurationResponse.

Returns null if no response was received from the server (e.g. a wrong server IP, a network problem, etc.)

sendPatient

PushServerSendPatientResponse sendPatient(Patient patient,
                                        Set<String> exportFields,
                                        org.json.JSONObject patientState,
                                        String groupName,
                                        String remoteGUID,
                                        String remoteServerIdentifier,
                                        String userName,
                                        String password,
                                        String user_token)

Submits the specified subset of patient data to the specified remote server. The new patient created on the remote server will be created and authored by the given user, and owned by the given group (if provided) or the user otherwise.

A new remote patient will be created with each submission, unless remoteGUID is provided, and a patient with the given GUID exists on the remote server and owned by the given group and is authored by the given user - in which case remote patient will be updated (only the submitted fields)

Parameters:

patient - local patient to be pushed to the remove server

exportFields - patient fields to be pushed. All other fields will be omitted.

patientState - JSON containing different categories of patient state, such as granted consents

groupName - group name (optional, can be null)

remoteGUID - if a remote patient with the same GUID exists and is owned by the given group and is authored by the given user patient data will be updated instead of creating a new patient (optional, can be null)

remoteServerIdentifier - server name as configured in TODO

userName - user name on the remote server

password - user password on the remote server. Ignored if user_token is not null.

user_token - passwordless-login token provided by the remote server on the last successful login (optional, can be null)

Returns:

Server response, indicating whether the submit was successful, and the remote ID and GUID of the remote patient object (for linking to and future updates of the created remote patient). See PushServerSendPatientResponse for details.

Returns null if no response was received from the server (e.g. a wrong server IP, a network problem, etc.)

getPatientURL

PushServerGetPatientIDResponse getPatientURL(String remoteServerIdentifier,
                                           String remoteGUID,
                                           String userName,
                                           String password,
                                           String userToken)

Gets the remote patient ID and URL for viewing the remote patient.

Uses the provided credentials to authorize on the remote server. In case the optional user_token is not null, the token is used and the password is ignored.

Parameters:

remoteServerIdentifier - server name as configured in TODO

remoteGUID - GUID of the remote patient object, as received from the remote server when the patient was created

userName - user name on the remote server

password - user password on the remote server. Ignored if user_token is not null.

userToken - passwordless-login token provided by the remote server on the last successful login (optional, can be null)

Returns:

server response which, upon successful login, contains the remote patient URL and ID. See PushServerGetPatientIDResponse.

Returns null if no response was received from the server (e.g. a wrong server IP, a network problem, etc.)