treatmentInstance

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.

Grouping method: sequence
Multiplicity: 1 .. 1

Element	Multiplicity	Type	Description
treatmentInstanceID	1 .. 1	treatmentInstanceID	The unique identifier for this treatment instance. It is auto generated by system.
treatmentTypeID	1 .. 1	treatmentTypeID	The identifier for the treatment type. It can not be modified.
respondentID	1 .. 1	respondentID	The identifier for the respondent - owner of treatment. It can not be modified after adding.
name	1 .. 1	string	Name of treatment
startAt	0 .. 1	dateTime	The date and time of start of treatment. If it desn't send current date and time will set up.
endAt	0 .. 1	dateTime	The date and time of end of treatment.
createdAt	0 .. 1	dateTime	The date and time when treatment was created. Only for read. It can not be modified.
enabled	1 .. 1	boolean	Flag if treatment is enabled or not.
treatmentInstanceAttributeCollection	0 .. 1	treatmentInstanceAttributeCollection	Collection of treatment instance attributes
userIDCollection	0 .. 1	userIDCollection	Collection of clinician usernames assigned directly to treatment.
treatmentInstanceRoleCollection	0 .. 1	treatmentInstanceRoleCollection	Collection of treatment instance roles assigned to treatment and set by clinicians/respondents

CheckWare partner API reference guide

Datatypes

treatmentInstance