 addAdministratorGroup | Add new clinician group |
| addAssessmentInstance | This operation will add an instance of an assessment for a given respondent. The assessment instances can be tagged with custom attributes if required
|
| addAssessmentInstanceData | Use this operation to save answers, flags, calculation for assessment instance. It is
possible to create assessment instance if it does 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 sent as second parameter.
If data is not in proper form, exception will be thrown with list of errors.
Calculations must be done on client side in accordance with the rules for the given assessment type
NOTE: This operation can ONLY be used with assessments where the calculation algorithm is known by the client!
|
| addAssessmentPlanInstance | Add a new plan instance. Only plans with flag manual and enabled set to true can be used. Only plans which the API can access can be used. When access restrictions on plans are used, make sure the API user can access these plans. |
| addMessage | Use this operation to send message to repondent or clinician. This can only be usen in the communication module. |
| addOrUpdateRoleSetHasRole | Adding or updating relation between roles and role sets. |
| addRespondent | Add a new respondent to the system. If no treatment is defined, the treatment type defined as default will be used and automatically added. Specific treatment types can be added, included roles and attributes. If default treatment contains mandatory attributes or roles, the client must ensure that these are always populated in the request. |
| addRespondentAttributeMeta | Use this operation to define and add additional attributes for respondent.
|
| addRespondentGroup | Add new respondent group |
| addRole | Add a clinician or respondent role definition to the system. |
| addRoleSet | Add role set to the system. Optionally also the included roles to the role set. |
| addRoleSetToTreatmentType | Add role set to treatment type. |
| addTreatmentInstance | Use this operation to add treatment instance to respondent. Add treatment attributes and roles to the treatment. Mandatory roles and attributes must be set.
|
| addTreatmentType | Use this operation to add treatment type. Add treatment type with optional treatment attributes, role sets, clinician group access.
|
| addUser | Add a new clinician to the system with optional clinician attributes, access role (only one) and clinician groups (multiple groups OK). |
| addUserAttributeMeta | Use this operation to define and add additional attribute for clinician.
|
| changeRespondentID | DEPRECATED
|
| connectRespondentGroupWithUserGroup | This operation creates connection between respondent group and clinician group.
|
| deleteAssessmentInstance | This will delete a given assessment instance permanently. |
| deleteAssessmentPlanInstance | Delete assessment plan instance and corresponding assessment instances, information packages and other plan content permanently. Cannot be reversed. |
| deleteRespondent | Delete a respondent permanently from the system.
This will delete the respondent from the system. Concider using disableRespondent instead to
keep data in system. Log record of respondent creation and deletion are retained, all other log events are deleted.
|
| deleteRespondentAttributeMeta | Use this operation will delete respondent attribute definitions for respondent. NOTE: This will delete all collected data on this attribute for all respondents.
|
| deleteRole | Delete an existing role. You cannot dele a role that is connected to a role set. |
| deleteRoleSet | Delete an existing role set. NOTE: This will delete ALL connected data if the role set has been put in production. |
| deleteRoleSetHasRole | Deleting relations between roles and role set. |
| deleteTreatmentInstance | Use this operation to delete single treatment. NOTE: This deletes ALL connected data to the treatment. |
| deleteTreatmentType | Use this operation to delete treatment type. NOTE: This will delete ALL connected treatment instances and ALL connected treatment data.
|
| deleteUser | Delete a given clinician. You might consider using the disableUser operation instead. This
will give you the possibility to enable the clinician later on.
By deleting a clinician the clinician will be removed from the system.
NOTE: You cannot delete a clinician that has performed an action in the system, for example added a respondet, created plan etc.
|
| deleteUserAttributeMeta | Use this operation to delete attribute defined for clinician. NOTE: This deletes ALL collected data for all clinicians on this attribute.
|
| disableAssessmentInstancePortal | This removes the access instance token to the assessment portal for the specific assessment.
|
| disableRespondent | Disables a respondent' possibility to log in based on respondentID.
A disabled respondent can be enabled for login later, as opposed
to a deleted respondent which is removed from the system.
NOTE: Disabling a respondent does not mean that plans are stopped. Plans and notifications must be stopped separately.
|
| disableUser | Disable login to the system for a given clinician. This removes the possibility for a clinician to log in to the system. It does not stop any notification from plans.
You cannot add a disabled clinician to a role in a treatment or as an assigned clinician. Already assigned clinicians that are deactivated will still receive any notification..
See also enableUser.
|
| editMessage | Use this operation to change the status on a message to answered by clinician.
|
| enableAssessmentInstancePortal | This operation will retrieve an access code for access to a specific assessment in the Assessment Portal.
|
| enableRespondent | Enable login to the system for a specific respondent based on respondentID.
This changes a previously disabled respondent back to enabled status.
|
| enableUser | Enables login to the system for a given clinician. 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. NOTE: The returned ID of the data export instance must be kept so that the export instance can be fetched later. This method only initiates the generation of the export. It does not retrieve the actual data.
|
| exportAssessmentInstanceData | Use this operation to export data from assessments |
| exportAssessmentInstanceStatusData | Use this operation to export information about assessment instance statuses. This also contains links to parent workflow for assessment instance, where this exists.
|
| exportAssessmentPlanData | Use this operation to export information about plans instances. |
| exportLoginSessionData | Use this operation for get informatioon about login of respondents and 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 connections between respondent groups and
clinician groups.
|
| findAssessmentInstanceDetailed | This will return a list of assessment instances based on the requested parameters. This includes all metadata, like role, treatment type etc.
|
| findAssessmentInstances | This will return a list of assessment instances based on the requested parameters. This does not include metadata about the assessment instance.
|
| findAssessmentPlanInstance | Get all plans templates |
| getAssessmentInstance | This will retrieve basic set of information about a given assessmentInstance.
Use the getAssessmentInstanceReport to retrieve 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 type.
|
| getAssessmentInstanceContexts | Operation returns all available contexts in the system. |
| getAssessmentInstanceData | Get assessment instance with answers, calculations and flags. |
| getAssessmentInstanceReportFile | This method will retrieve a given report for a given assessment instance report ID. This include code collections that are pushed to the API (respondent ID and mapping data collection).
Use the getAssessmentInstanceAvailableReports operation to see available report for a given assessment instance.
|
| getAssessmentInstanceReportFileHL7v3 | Get report file in HL7v3 message format. NOTE: For configuration of HL7v3, this must be configurered server side prior to use. |
| getAssessmentInstanceReportFileKITH | Get report file in KITH message format. NOTE: For configuration of KITH, this must be configurered server side prior to use. |
| getAssessmentPlanInstanceHasAssessmentInstance | Operation returns collection of assessment plan instances with assessment instances
assigned by plan
|
| getAssessmentPlans | Get all plan templates. You may filter by clinician group, treatment type, enabled, allowed manual. You will also get information about for example role set, as well as treatment attributes. |
| getAvailableAssessments |
This operation returns a list of all available assessments in the system. NOTE: Only the latest enabled versions of the assessments are shown. This means that you will not get disabled previous versions of the assessment. Historical assessment instances may refer to these previous versions.
|
| 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 clinician roles.
To be able to add a clinician, a clincian role must be assigned to the clinician.
|
| getDataExportAvailableTemplates | Operation returns collection of available data export templates. It includes both public and private data export template and all visible GUI options. |
| getDataExportInstance | Get the export instance files based on data export templates with the corresponding data |
| getMessage | Operation returns message sent to or by respondent |
| getNewReportInstances | Get all assessment report instances which have not been marked as archived/exported. NOTE: It is possible to limit the number of retries for fetching a report.
Reports that have exceeded the given limit for fetching the report, are no longer shown in the list.
|
| 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. NOTE: It is possible to limit the number of retries for fetching a report.
Reports that have exceeded the given limit for fetching the report, are no longer shown in the list.
|
| getRespondent | Get data for a given respondent by respondent ID. NOTE: This will show all information on the respondent. |
| getRespondentAttributesMeta | Use this operation to get all available attributes for respondent.
|
| getRespondentByLoginName | Get a respondent record using the loginName as the key.
See also getRespondent
|
| getRespondentGroupUserGroupMapping | Operation returns collection of connections between respondent and clinician groups
|
| getRole | Get a specific role defined by ID. |
| getRoles | Use this operation to get a list of roles which can be used in treatments.
|
| getRoleSet | Get an existing role set defined by role set ID. |
| getRoleSets | Use this operation to get a list of role-sets which can be used to define pack of treatment roles.
|
| getTreatmentInstance | Use this operation to get one treatment by treatment instance ID
|
| getTreatmentInstances | Use this operation to get list of treatments. Respondent ID, treatment type and treatment status can be used as filters.
|
| 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 clinician.
|
| getUserAttributesMeta | Use this operation to get list of all attributes defined for clinician.
|
| removeRoleSetFromTreatmentType | Remove role set from treatment type. NOTE: This will remove role sets from all running treatments of the given type. This will affect exising and future content in the treatment. |
| 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. This means that the report is marked as transferred. This cannot be undone. |
| terminateAssessmentPlanInstance | Terminate plan instance. NOTE: This only affect assessments in the plan instance. The operation will delete all unsubmitted assessments. Submitted assessments will be kept. |
| updateAssessmentInstance | Update information for an existing assessment instance.
Example usage: reschedule an assessment.
NOTE: Must NOT be used on an assessment instance in a plan.
|
| updateRespondent | Update data for a respondent. Password is not mandatory in update and should normally not be updated.
|
| updateRespondentAttributeMeta | Use this operation to change additional attributes for respondent. |
| updateRole | Modify existing role. If setting a previously option role to mandatory, ensure that existing treatments are updated accordingly. |
| updateRoleSet | Update an existing role set. If adding new mandatory roles, make sure that treatments and plans using this role set are updated. |
| updateTreatmentInstance | Use this operation to update property of treatment. You can update e.g. roles, attributes, end date, completed flag.
|
| updateTreatmentType | Use this operation to change properties of treatment type. NOTE: Removal of treatment type attributes will affect all treatment instances of this treatment type.
|
| updateUser | Update data for a given clinician.
|
| updateUserAttributeMeta | Use this operation to update additional attribute defined for clinician.
|