 assessment | complex | An assessment is equivalent to a questionnaire or interview.
By issuing an assesment to a respondent you will spawn an assessmentInstance. |
| assessmentCollection | complex | An assessment collection is a collection of assessments. |
 assessmentID | simple | The assessment identifier. Identifying one unique assessment.
|
| assessmentInstance | complex | An assessment instance represents an assessment issued to a respondent. The instance keeps track of scheduling and status of that particular assessment.
|
| assessmentInstanceAnswer | complex | Assessment instance answer is |
| assessmentInstanceAnswersCollection | complex | Collection of answers for assessment instance. |
| assessmentInstanceCalculation | complex | Code and value of calculation defined for assessment |
| assessmentInstanceCalculationsCollection | complex | Collection of assessment instance calculations. |
| assessmentInstanceCollection | complex | Assessment instance collection contains a set of assessment instances. |
| assessmentInstanceData | complex | Object grouping assessment instance object (optional), collection of answers, collection of calculations and flags raised for assessment instance. |
| assessmentInstanceFlag | complex | Code and value of flag defined for assessment. Value true means that flag is raised. |
| assessmentInstanceFlagsCollection | complex | Collection of assessment instance flags. |
| assessmentInstanceID | simple | The assessment identifier. Identifying one unique assessment for one unique respondent.
|
| assessmentInstanceQuery | complex | The assessment instance query defines the selection criterias for retreving assessment instances from the system.
You may use the elements in combination. All of the criterias that are defined in the query must be met before the assessment instance is part of the resulting assessment instance collection.
|
| assessmentInstanceReport | complex | An assessment report is a file generated by the assessment system for a given assessment.
One assessment may contain multiple reports. One report may in some cases contain information from more than one assessment but is always initiated from one assessment instance point of view.
Important note: This structure only contains the information about the report, not the actual report data. |
| assessmentInstanceReportCollection | complex | An assessment report collection is a collection of references to assessment reports. |
| assessmentInstanceReportFile | complex | The assessment instance report file contains the actual data for the report (attachment).
|
| assessmentInstanceReportFileKITH | complex | The assessment instance report file contains the actual data for the report in KITH message format (attachment).
|
| assessmentInstanceReportID | simple | The assessment instance report identifier. |
| assessmentPlan | complex | Template with defined group of assessments or other components to assign to respondent by application |
| assessmentPlanCollection | complex | Collection of assessment plans |
| assessmentPlanID | simple | Id of template of assessment plan |
| assessmentPlanInstance | complex | Instance of assessment plan represents group of assessments or other components |
| assessmentPlanInstanceID | simple | Id of instance of assessment plan |
| assessmentReportID | simple | The assessment report indentifier. |
| attributeMetaParameterCollection | complex | List of options which could used to defined attribute Meta. This list could be use only in type of attribute meta is dropdown. |
| attributeMetaTypes | simple | Possible types of custom attributes meta. |
| dateRangeType | simple | List of possible option to use as filter in export assessment instances operation. Option "past" means that only assessments which have start date in the past, "future" that only assessments with start date in the future will be exported and "all" (default value) means that information fro all assessments will be exported. |
| exportAssessmentInstanceData | complex | Model of export assessment instances. Contains parameters and filters to return list of assessment instances with answers, calculations, flags and other information about instances. |
| exportAssessmentInstanceStatusData | complex | Model of export assessment instances statuses. Contains parameters and filters to return list of assessment instances. |
| exportAssessmentPlanData | complex | Model of export assessment plans with related informations. |
| exportData | simple | Data in csv format. |
| exportDataObject | complex | Data in csv format. |
| exportLoginSessionData | complex | Contains parameters and filters to export informations about respondent and users sessions. |
| exportRespondentData | complex | Contains parameters and filters to export informations about respondent. |
| exportRespondentGroupData | complex | Contains parameters and filters to export informations about respondent groups and respondent's informations. |
| exportUserData | complex | Contains parameters and filters to export informations about clinicians. |
| exportUserGroupData | complex | Contains parameters and filters to export user groups and user's informations . |
| ownerID | simple | Id of clinician who is owner of assessement instance |
| respondent | complex | The respondent is the structure representing a respondent (the individual that responds to an assessment).
|
| respondentAttribute | complex | Model of respondent attribute. Attribute is additional information about respondent. Attribute could be taken only from list of respondent attribute meta. Attribute is mandatory if value of respondentAttributeMetaRequired is true. |
| respondentAttributeCollection | complex | Collection of custom attributes defined for respondent |
| respondentAttributeMeta | complex | Model of respondent's attribute to stored additional information about respondent |
| respondentAttributeMetaCollection | complex | Collection of custom attributes which could be added to respondent. |
| respondentAttributeMetaID | simple | Id of respondent attribute meta field. |
| respondentChange | complex | The respondentChange structure is used to change respondentID for an existing respondent. |
| respondentCollection | complex | A respondentCollection is a collection of zero to many respondents. |
| respondentGroup | complex | The respondent group represents the id and name of a valid respondent group. |
| respondentGroupCollection | complex | Contains a set of respondent groups.
|
| respondentGroupID | simple | The respondent group identifier.
|
| respondentID | simple | The respondent identifier. Identifying one unique respondent. |
| user | complex | A user represent a clinician in medical terms. The user is the one evaluating the reports and issuing assessment instances for a given respondent. |
| userAttribute | complex | Model of user attribute. Attribute is additional information about user. Attribute could be taken only from list of user attribute meta. Attribute is mandatory if value of userAttributeMetaRequired is true.
|
| userAttributeCollection | complex | Collection of custom attributes defined for user |
| userAttributeMeta | complex | Model of custom attribute to stored additional information about respondent. |
| userAttributeMetaCollection | complex | Collection of custom attributes which could be added to respondent. |
| userAttributeMetaID | simple | Id of clinician attribute meta field. |
| userID | simple | The user identifier. Identifies one unique |
| userRole | complex | A user role represents the id and name of a specific user role.
|
| userRoleCollection | complex | User role collection contains a set of user roles. |
| userRoleID | simple | The user role identifier. |
| void | simple | The void type is just an indicator that you should not expect any useful response. It is there to be able to send a fault if something goes wrong. |