CheckWare partner API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

assessmentPlan

Template with defined group of assessments or other components to assign to
respondent by application

Grouping method: sequence
Multiplicity: 1 .. 1

ElementMultiplicityTypeRestrictionDescription
assessmentPlanID1 .. 1assessmentPlanID 

Assessmen plan id.

assessmentPlanTrigger1 .. 1string 

This field informs which event asssignes this plan to respondent.

assessmentPlanName1 .. 1string 

Assessment plan name.

assessmentPlanDescription1 .. 1string 

Description of assessment plan.

assessmentPlanEnabled1 .. 1boolean 

This field informs it this plan is neable and could be assigned to
respondent or not.

assessmentPlanAllowManual1 .. 1boolean 

This fields informs if this plan could be assigned directly by clinicion
or only by trigger or another aasessment plan.

assessmentPlanImage0 .. 1string 

Image coded by base64 with schema of assessment plan.

assessmentPlanLastChangeDate0 .. 1dateTime 

This field informs when assessment plan was changed last time.

assessmentPlanLastGeneratedDate0 .. 1dateTime 

This field informs when assessment plan was generated. Can be null if a plan has never been used.

treatmentType0 .. 1treatmentType 

Treatment type.

userGroupCollections0 .. 1userGroupCollections 

Collection of clinician groups assigned to plan.