CheckWare partner API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

user

A user represents a clinician in medical terms. The clinician is the one evaluating the
reports and issuing assessment instances for a given respondent.

Grouping method: sequence
Multiplicity:  

ElementMultiplicityTypeRestrictionDescription
userID1 .. 1userID 


A unique identifier for the clinician. If
a clinician logs on to the system this will be the
sign-on userid.

Must be present in all requests, also when
adding a new clinician.

firstName1 .. 1string 


Clinician first name.

lastName1 .. 1string 


Clinician last name.

birthDate0 .. 1date 


DEPRECATED - is not use in TNG
Clinician date of birth.

gender0 .. 1string

Enumeration:

male
female

Clinician gender.

password0 .. 1string 


Clinician personal password. If a clinician logs on to the
system this will be the sign-on password.
Is required when adding, optional when updating.

mobilePhone0 .. 1string 


Clinician mobile phone. If system is setup to alert
via SMS this number will be used.

email0 .. 1string 


Clinician email address. The structure is validated.
If system is setup to alert via email, this
email will be used.

enabled1 .. 1boolean 


Clinician is either enabled or disabled. A disabled
clinician cannot login to the assessment solution.

userRoleID1 .. 1userRoleID 

Clinician role.

userAttributeCollection0 .. 1userAttributeCollection 

Collection of clinician attributes

userLanguageID0 .. 1languageID 

Id of language

testAccount0 .. 1boolean 

Information that clinician is test

userGroup0 .. 1userGroupIDCollection 

Collection of clinician group identifiers