 administratorGroup | complex | The clinician group |
 administratorGroupID | simple | The clinician 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 contains two collections: assessment instances belonging to assessment instance plan and grouping by plans and second: assessment 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 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 | An assessment report belongs to an assessment |
| 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 respondent 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 be used to define attribute Meta. This list can only be used where 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 of data export file and
other meta data describing 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 options to use as filter in export assessment instances operation.
Option "past" includes only assessments with start date in the past.
Option "future" includes only assessments with start date in the future.
Option "all" (default value) exports information from all assessments.
|
| 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. The export contains the same parameters as the GUI equivalent.
|
| 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 information. |
| exportData | simple | Data in csv format. |
| exportDataObject | complex | Data in .csv format. |
| exportLoginSessionData | complex | Contains parameters and filters to export information about respondent and clinician
sessions.
|
| exportRespondentData | complex | Contains parameters and filters to export information about respondent.
|
| exportRespondentGroupData | complex | Contains parameters and filters to export information about respondent groups
and respondent's informations.
|
| exportTreatmentInstanceData | complex |
Contains parameters and filters to export treatments.
|
| exportUserData | complex | Contains parameters and filters to export information about clinicians.
|
| exportUserGroupData | complex | Contains parameters and filters to export clinician groups and clinician's information.
|
| instanceID | simple | The instance identifier. Identifying one unique instance. |
| 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 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 store 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 |
| respondentGroupCollection | complex | Contains a set of respondent groups.
|
| respondentGroupID | simple | The respondent group identifier.
|
| respondentGroupUserGroupConnection | complex | Connection between clinician group and respondent group |
| respondentGroupUserGroupMapping | complex | Respondent group - clinician group mapping
|
| respondentGroupUserGroupMappingCollection | complex | Collection of respondentGroupUserGroupMapping objects
|
| respondentGroupUserGroupMappingFilter | complex | Filter respondent group - clinician 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. Respondent may have more than one treatment.
If the respondent does not have any treatment it will be impossible to assign any assessments, plans etc.
All elements like assessments, assessment plans etc. are assigned 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 occupied by clinicians or respondents within the treatment instance.
|
| treatmentInstanceRoleID | simple | The unique identifier for a single treatment instance's role. |
| treatmentInstanceStatus | simple | Possible types of treatment status. |
| 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 | This treatment type has role sets |
| treatmentTypeID | simple | The treatment type identifier. Identifying one unique treatment type.
|
| user | complex | A user represents a clinician in medical terms. The clinician is the one evaluating the
reports and issuing assessment instances for a given respondent.
|
| userAttribute | complex | Model of clinician attribute. Attribute is additional information about clinician.
Attribute could be taken only from list of clinician attribute meta. Attribute is mandatory if value
of userAttributeMetaRequired is true.
|
| userAttributeCollection | complex | Collection of custom attributes defined for clinician |
| userAttributeMeta | complex | Model of custom attribute to store 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 clinician |
| userGroup | complex | Clinician group object |
| userGroupCollections | complex | Collection of clinician group objects |
| userGroupID | simple | The clinician group identifier. Identifying one unique clinician group.
|
| userGroupIDCollection | complex | Collection of clinician group indentifiers |
| userID | simple | The clinician identifier. Identifies one unique clinician. |
| userIDCollection | complex | Collection of clinician ids |
| userRole | complex | A clinician role represents the id and name of a specific clinician role.
|
| userRoleCollection | complex | Clinician role collection contains a set of clinician roles. |
| userRoleID | simple | The clinician 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.
|