CheckWare partner API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

treatmentInstance

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.

Grouping method: sequence
Multiplicity:  

ElementMultiplicityTypeRestrictionDescription
treatmentInstanceID1 .. 1treatmentInstanceID 


The unique identifier for this treatment instance. It is auto generated by the system.
treatmentTypeID1 .. 1treatmentTypeID 


The identifier for the treatment type. It can not be modified.
respondentID1 .. 1respondentID 


The identifier for the respondent - owner of treatment. It can not be modified after adding.
name1 .. 1string 

Name of treatment
status1 .. 1treatmentInstanceStatus 

Status of treatment
startAt0 .. 1dateTime 

The date and time of start of treatment. If it is not sent, current date-time will be used.
endAt0 .. 1dateTime 

The date and time of end of treatment.
createdAt0 .. 1dateTime 

The date and time when treatment was created. Only for read. It can not be modified.
enabled1 .. 1boolean 

Flag if treatment is enabled or not.
treatmentInstanceAttributeCollection0 .. 1treatmentInstanceAttributeCollection 

Collection of treatment instance attributes
userIDCollection0 .. 1userIDCollection 

Collection of clinician usernames assigned directly to treatment.
treatmentInstanceRoleCollection0 .. 1treatmentInstanceRoleCollection 

Collection of treatment instance roles assigned to treatment and set to clinicians/respondents

© Copyright CheckWare AS - http://www.checkware.com/ - Document generated: 10. March, 2020 (10:22:51+01:00)