 administratorGroup | complex | |
 administratorGroupID | simple | The administrator group identifier.
|
| 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 the answer/value for a question. |
| 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.
|
| assessmentInstanceContext | complex | Context is logical space to group assessment instances. |
| assessmentInstanceContextCollection | complex | Collection of assessment instance contexts. |
| assessmentInstanceData | complex | Object grouping assessment instance object (optional), collection of answers,
collection of calculations and flags raised for assessment instance.
|
| assessmentInstanceDetailed | complex | This object conatins two collections: assessment instances belonging to assessment instance plan and grouping by plans and second: asseaament instances assigned directly to treatment.
|
| 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.
|
| assessmentInstancePortalCode | simple | Code assigned to assessment instance grants access to Assessment Instance Portal |
| 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.
|
| assessmentInstanceQuestionValueType | complex | Type of answer |
| 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.
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.
|
| assessmentInstanceReportDetailed | complex | |
| assessmentInstanceReportDetailedCollection | 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 |
| assessmentPlanFilters | complex | Parameters to filter list of assessment plans |
| assessmentPlanID | simple | Id of template of assessment plan |
| assessmentPlanInstance | complex | Instance of assessment plan represents group of assessments or other components
|
| assessmentPlanInstanceHasAssessmentInstance | complex | Object contains assessment plan instance and collection of assessment instances
added to respondet by assessment plan instance.
|
| assessmentPlanInstanceHasAssessmentInstanceCollection | complex |
|
| assessmentPlanInstanceHasAssessmentInstanceFilter | complex | Parameters to filter assessmentPlanInstanceHasAssessmentInstance objects.
|
| 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. |
| availableAssessmentsFilter | complex | Parameters to filter available assessments. |
| availableAssessmentsScope | simple |
Possible scopes of available assessments.
Scope 'all' means all available assessments will be returned (default behaviour).
Scope 'clinician-only' means only clinician' available assessments will be returned.
Scope 'respondent-only' means only respondent' available assessments will be returned.
|
| code | complex | External resource Code |
| codesCollection | complex | Collection of Codes |
| contextID | simple | The context identifier. Identifying one unique context. |
| dataExportInstance | complex | Instance of data export template, object contains body od data export file and
other meta data described exported data file.
|
| dataExportInstanceMetadata | complex | Object contains metadata of an exported data file. |
| dataExportTemplate | complex | A data export template is used for creating custom data exports.
|
| dataExportTemplateCollection | complex | A collection of data export templates. |
| dataExportTemplateContextCollection | complex | Collection of assessment instance context id to filter data results.
|
| 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.
|
| exportSystemEventLogData | complex | Model of export system event log data. Contains parameters and filters to return
list of system event log data.
|
| exportTreatmentInstanceData | complex |
Contains parameters and filters to export treatments.
|
| 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 .
|
| instanceID | simple | The instance identifier. Identifying one unique template. |
| language | complex | Language defined in system |
| languageCollection | complex | Contains a set of languages |
| languageID | simple | The language identifier. |
| mappingData | complex | Integration mapping data |
| message | complex | Object message represents comunication - messages sent beetwen respondent and
clinician(s)
|
| messageCollection | complex | Collection of messages |
| messageFilter | complex | Set of parameters to filter messages |
| messageID | simple | Identifier of message |
| 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).
Respondent ID is set in any situation also when adding a new respondent. Social security number
of the respondent or other uniquely indentifying numbers/strings are normally used.
|
| 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 | |
| respondentGroupCollection | complex | Contains a set of respondent groups.
|
| respondentGroupID | simple | The respondent group identifier.
|
| respondentGroupUserGroupConnection | complex | Connection between user group and respondent group |
| respondentGroupUserGroupMapping | complex | Respondent group - user group mapping
|
| respondentGroupUserGroupMappingCollection | complex | Collection of respondentGroupUserGroupMapping objects
|
| respondentGroupUserGroupMappingFilter | complex | Filter respondent group - user group mapping
|
| respondentID | simple | The respondent identifier. Identifying one unique respondent. |
| role | complex | If this is a respondent role, set true. If false this is not a respondent role. |
| roleCollection | complex | |
| roleID | simple | The unique identifier for a specific role for a specific treatment type. |
| roleInRoleSet | complex | |
| roleInRoleSetCollection | complex | |
| roleSet | complex | Set of roles
|
| roleSetCollection | complex | |
| roleSetHasRole | complex | |
| roleSetID | simple | The unique identifier for a specific role set. |
| roleTypes | simple | Possible types of role. |
| templateID | simple | The template identifier. Identifying one unique template. |
| treatmentFilter | complex | Filter to restrict treatments |
| treatmentInstance | complex | Treatment instance is a health unit created for respondent. Respondant may have more than one treatments.
If respondent woludn't have any treatment it will be impossible to assign him eny assessments, plans etc.
All elements like assessments, assessment plans etc. are assign to treatment instead of respondent directly.
|
| treatmentInstanceAttribute | complex |
|
| treatmentInstanceAttributeCollection | complex | Collection of treatment instance attributes |
| treatmentInstanceAttributeID | simple | The treatment instance attribute identifier. Identifying one unique treatment instance attribute assigned to
treatment instance.
|
| treatmentInstanceCollection | complex | Collection of treatment instances |
| treatmentInstanceID | simple | The treatment identifier. Identifying one unique treatment assigned to
respondent.
|
| treatmentInstanceRole | complex | |
| treatmentInstanceRoleCollection | complex | A treatment instance role collection is a collection of roles set by clinicians or users assigned to treatment
reports.
|
| treatmentInstanceRoleID | simple | The unique identifier for a single treatment instance's role. |
| treatmentType | complex | Type of treatments.
|
| treatmentTypeAttribute | complex | This is template to define some custom attributes which could be used to define treatment instance.
|
| treatmentTypeAttributeCollection | complex | Collection of treatment type attributes |
| treatmentTypeAttributeID | simple | The treatment type attribute identifier. Identifying one unique treatment type attribute defined for
treatment type.
|
| treatmentTypeCollection | complex | Collection of treatment types |
| treatmentTypeHasRoleSet | complex | |
| treatmentTypeID | simple | The treatment type identifier. Identifying one unique treatment type.
|
| 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. |
| userCollection | complex | Collection of user |
| userGroup | complex | Clinician group object |
| userGroupCollections | complex | Collection of clinician group objects |
| userGroupID | simple | The user (clinician) group identifier. Identifying one unique clinician group.
|
| userGroupIDCollection | complex | Collection of user group indentifiers |
| userID | simple | The user identifier. Identifies one unique |
| userIDCollection | complex | Collection of clinician ids |
| 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.
|