assessmentInstanceID
The unique identifier for this assessment
instance.
assessmentID
The identifier for the assessment.
respondentID
The identifier for the respondent.
treatmentInstanceID
The identifier for the treatment.
treatmentInstanceRoleID
If you want to add assessment to role, use this parameter to get role of this type.
assessmentName
The name of the assessment.
This is not required when adding data - the
assessment ID will be used. When retreiving data
this will always be present to ease use of
result.
lastModified
The date and time for when this assessment instance was last modified.
issueDate
The date and time when the assessmentInstance
was created (issued to respondent).
startDate
The assessment is available in the respondent
GUI from the start date and forwards.
By controlling the start date you can create a
series of assessment instances that will appear
at the given time in the respondent GUI.
ExpireDate
The assessment instance expire date is the date
where alerts will be displayed if the assessment
instance is not completed.
isCompleted
If an assessment instance is completed
(delivered by respondent) the assessment
instance is no longer visible for the respondent
and reports can be generated on the data.
completedDate
If the assessment is completed the completedDate
will be populated with the timestamp
representing the time it was completed by the
respondent.
startDateTime
The assessment is available in the respondent
GUI from the start date and forwards.
By controlling the start date you can create a
series of assessment instances that will appear
at the given time in the respondent GUI.
By this field you can controll not only date but time as well. It overwrite startDate
field.
Format must be concurring with ISO 8601 standard, i.e.:
2015-03-15T12:50:43
2015-03-15T12:50:43+00:00
2015-03-15T14:50:43+02:00
expireDateTime
The assessment instance expire date is the date
where alerts will be displayed if the assessment
instance is not completed.
By this field you can controll not only date but time as well. It overwrite expireDate
field.
Format must be concurring with ISO 8601 standard, i.e.:
2015-03-15T12:50:43
2015-03-15T12:50:43+00:00
2015-03-15T14:50:43+02:00
contextID
Identifier of context.
ownerID
Id of clinician who is owner of assessment instance.
codeExternal resource Code
mappingData
Integration mapping data