NameDescriptionTypeAdditional information
ExternalId

External User ID

string

Required

Max length: 100

Username

Username

string

Required

Max length: 100

FirstName

First Name

string

Required

Max length: 50

LastName

Last Name

string

Required

Max length: 50

EmailAddress

Email Address

string

Required

Max length: 200

PracticeID

External Practice ID

string

Required

Max length: 100

SecondaryPracticeIDs

[CEHR] External Practice IDs for additional practices to which the clinician belongs.

Collection of string

None.

Password

Password. Optional. Includes 3 of the 4 following character types: Upper case letter (A-Z), lower case letter (a-z), number (0-9), and special character. If not populated, must be set by an administrator before the user can login.

string

Max length: 128

Min length: 8

IsActive

User is active. Defaults to True. If the user exists, they will be deactivated. No other updates will be performed.

boolean

None.

Role

Role - Clinician, PracticeAdmin, ReportCordinator, or EHRAdmin (Entity Admin).

string

Required

UserIdentifiers

User identifiers (such as NPI).

UserIdentifiers

None.

Address

[CEHR] Required for Direct Onboarding. Street Address & Phone Numbers.

Address

None.

CqmSolutionProgramSettings

[CQM] Submission Program settings

ProgramSettings

None.

CqmSolutionPersonalization

[CQM] User-specific customizations

Personalization

None.

DirectSettings

[CEHR] Direct account settings

DirectUserSettings

None.

OnboardingInstructions

Provides processing instructions to the Onboarding API for this item

UserInstructions

None.