Overview of operations
addAdministratorGroup

Add new administrator group

addAssessmentInstance

This operation will add an instance of an assessment for a given respondent.

addAssessmentInstanceData

Use this oeration to save answers, flags, calculation for assessment instance. It is
possible to create assessment instance if it is not exist, in this case object assessmentInstanceData
should
contain assessmentInstance object to create assessment instance. If assessment instance already exists
in system id should be sen as second parameter.

If data is not in proper form, exception will be thrown with list of errors.

addAssessmentPlanInstance

Add a new assessment plan instance

addMessage

Use this operation to send message repondent or clinician

addOrUpdateRoleSetHasRole

addRespondent

Add a new respondent to the assessment system.

addRespondentAttributeMeta

Use this operation to define and add additional attribute for respondent.

addRespondentGroup

Add new respondent group

addRole

addRoleSet

addRoleSetToTreatmentType

addTreatmentInstance

Use this operation to add treatment to respondent

addTreatmentType

Use this operation to add treatment type

addUser

Add a new user to the assessment system.

addUserAttributeMeta

Use this operation to define and add additional attribute for clinicia.

changeRespondentID

NOT AVAILABLE since tng 2.4.1
The operation changeRespondentID makes it possible to change the respondentID for a given respondent.

connectRespondentGroupWithUserGroup

This operation creates connection between respondent group and user (clinician) group

deleteAssessmentInstance

This will delete a given assessment instance.

deleteAssessmentPlanInstance

Delete assessment plan instance

deleteRespondent

Delete a respondent from the system.

This will physically delete the respondent from the system. Concider using disableRespondent instead to
keep data in system.

deleteRespondentAttributeMeta

Use this operation to delete additional attribute defined for respondent.

deleteRole

deleteRoleSet

deleteRoleSetHasRole

deleteTreatmentInstance

Use this operation to delete treatment

deleteTreatmentType

Use this operation to delete treatment type

deleteUser

Delete a given user. You might concider using the disableUser operation instead. This
will give you the possibility to enable the user later on.

By deleting a user the user will be removed from the system

deleteUserAttributeMeta

Use this operation to delete additional attribute defined for clinician.

disableAssessmentInstancePortal

This operation will remove access to assessment instance via Assessment Instance Portal

disableRespondent

Disable a respondent based on respondentID.

This is an alternative to deleteRespondent. A disabled respondent is possible to revoke again as opposed
to a deleted respondent that is physically removed from the assessment system.

disableUser

Disable a given user. This is an alternative til deleteUser.

See also enableUser.

editMessage

Use this operation to change status that clinician answered on this message

enableAssessmentInstancePortal

This operation will retrieve a access code for Assessment Instance Portal

enableRespondent

Enable a respondent based on respondentID.

Revoke a disabled respondent back to enabed status.

enableUser

Enable a given user. See also disableUser.

executeDataExportTemplate

Operation runs data export based on data export template. It possible to send set of
filters to customize data export result.

exportAssessmentInstanceData

Use this operation to export data fro assessments

exportAssessmentInstanceStatusData

Use this operation to export information about assessment instance statuse.

exportAssessmentPlanData

Use this operation to export information about assessment plans..

exportLoginSessionData

Use this operation for get informatioon about login respondents, clinicians to portals

exportRespondentData

Use this operation to export data about respondents.

exportRespondentGroupData

Use this operation to export data about respondent groups

exportTreatmentInstanceData

Use this operation to export treatments.

exportUserData

Use this operation to export data about clinicians.

exportUserGroupData

Use this operation to export data about clinician groups.

exportUserGroupRespondentGroupMappingData

Use this operation to export data about conections between respondent groups and
clinician groups

findAssessmentInstanceDetailed

This will return a list of assessment instances based on the requested parameters.

findAssessmentInstances

This will return a list of assessment instances based on the requested parameters.

findAssessmentPlanInstance

Get all assessment plans templates

getAssessmentInstance

This will retreive information about a given assessmentInstance. Available reports for
the instance is also returned.

Use the getAssessmentInstanceReport to retreive the actual report

getAssessmentInstanceAvailableReports

This method will retreive a list of available reports for a given assessment instance.

Use the getAssessmentInstanceReportFile to retreive the actual report.

getAssessmentInstanceAvailableReportsFilter

Get assessment instance reports based on assessment instance reportid.

getAssessmentInstanceContexts

Operation returns all assessment instance contexts

getAssessmentInstanceData

Get assessment instance with answers, claculations and flags

getAssessmentInstanceReportFile

This method will retreive a given report for a given assessment instance.

Use the getAssessmentInstanceAvailableReports operation to see available reports for a given assessment
instance.

getAssessmentInstanceReportFileHL7v3

Get report file in HL7v3 message format.

getAssessmentInstanceReportFileKITH

Get report file in KITH message format.

getAssessmentPlanInstanceHasAssessmentInstance

Operation returns collection of assessment plan instances with assessment instances
assigned by plan

getAssessmentPlans

Get all assessment plans templates

getAvailableAssessments


This operation returns a list of all available assessments in the system.

getAvailableLanguages

Operation returns collection of available languages defined in the system

getAvailableRespondentGroups

Get a collection of all respondent groups.

getAvailableUserGroups

Operation returns collection all clinician groups

getAvailableUserRoles

Use this operation to get a list of available user roles.

To be able to add a user, a user role must be assigned to the user.

getDataExportAvailableTemplates

Operation returns collection of available data export templates

getDataExportInstance

Get the instance with the results

getMessage

Operation returns message sent to or by respondent

getNewReportInstances

Get all assessment report instances which haven't been marked as archived/exported.

getNewReportInstancesDetailed

Get a collection of detailed assessment report instances that are not already exported from the system.
Recommended method for integration purposes where additional data are needed to import properly.

getRespondent

Get data for a given respondent.

getRespondentAttributesMeta

Use this operation to get all additional attributes defined for respondent.

getRespondentByLoginName

Get a respondent recordusing the loginName as the key.

See also getRespondent

getRespondentGroupUserGroupMapping

Operation returns collection of connections between respondent and clinician groups

getRole

getRoleSet

getRoleSets

Use this operation to get a list of role-sets which can be used to define pack of treatment roles.

getRoles

Use this operation to get a list of roles which can be used in treatments.

getTreatmentInstance

Use this operation to get one treatment

getTreatmentInstances

Use this operation to get list of treatments

getTreatmentType

Use this operation to get particular treatment type

getTreatmentTypes

Use this operation to get list of treatment types

getUser

Get data for a given user.

getUserAttributesMeta

Use this operation to get list of all additional attributes defined for clinician.

removeRoleSetFromTreatmentType

resolveDuplicates

Merge two respondents into one. The merged respondent is removed and related
assessment/workflow instances are moved to the other respondent.

setReportInstanceArchived

Set assessment instance report as archived/exported

terminateAssessmentPlanInstance

Delete assessment plan instance

updateAssessmentInstance

Update information for an existing assessment instance.

Example usage: reschedule an assessment.

updateRespondent

Update data for a respondent.

updateRespondentAttributeMeta

Use this operation to change additional attribute for respondent.

updateRole

updateRoleSet

updateTreatmentInstance

Use this operation to update property of treatment

updateTreatmentType

Use this operation to change properties of treatment type

updateUser

Update data for a given user.

updateUserAttributeMeta

Use this operation to change additional attribute definedfor clinician.

© CheckWare AS - All rights reserved.