Patient Anonymous Sign Up

Parameter	Type	Mandatory	Description	Example
_username	string	true	User's username. Can be an email or a regular username. With this username you login to the system.	[email protected] or john123
_password	string	true	A password	Aa123456
_nickname	string	false	The nickname of the user	Nicky123
_deviceRegistrationCode	object	true
_deviceRegistrationCode.id	string	true(*)

Parameter

Type

Mandatory

Description

Example

_username

string

true

User's username. Can be an email or a regular username. With this username you login to the system.

[email protected] or john123

_password

string

true

A password

Aa123456

_nickname

string

false

The nickname of the user

Nicky123

_deviceRegistrationCode

object

true

_deviceRegistrationCode.id

string

true(*)

The below table describes the response parameters:

Parameter	Type	Description	Example
_name	object
_name.firstName	string	A person's first name	John
_name.lastName	string	A person's last name	Smith
_description	string	A description, can be up to 5000 characters long	Lorem Ipsum
_email	string	An email address in the RFC-5322 specification	[email protected]
_phone	string	A person's phone An E.164 formatted phone number	+12345678901
_locale	string	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_gender	string	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
_dateOfBirth	string	A person's date of birth A UTC date in the ISO-8601 format	2007-12-20
_address	object
_address.countryCode	string	A 2-letter country code defined in ISO-3166	US
_address.state	string	A state	Massachusetts
_address.city	string	A city	Boston
_address.zipCode	string	A zipcode	02101
_address.address1	string	An address	11 Main St.
_address.address2	string	An address's specifics	Entry B, Apartment 1
_mfa	object
_mfa.enabled	boolean	MFA login enabled or disabled. When omitted, the template's configured default is applied.
_mfa.expirationInMinutes	integer	MFA expiration time in minutes
_credentialType	string	What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP
_additionalPhone	string	An E.164 formatted phone number	+12345678901
_nationalId	string	A person's national ID	123456789
_id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.templateName	string	The name of the referenced entity template
_ownerOrganization.template	object
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_caregiver	object
_caregiver.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_caregiver.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_caregiver.parentEntityId	string	The id of the parent entity (appears only for child entities)
_caregiver.templateName	string	The name of the referenced entity template
_caregiver.template	object
_caregiver.template.name	string	The name of the template
_caregiver.template.displayName	string	The display name of the template
_caregiver.template.parentTemplate	object
_caregiver.template.parentTemplate.id	string
_caregiver.template.parentTemplate.displayName	string
_caregiver.template.parentTemplate.name	string
_caregiver.template.id	string	The id of the template
_caregiver.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_caregiver.name	string	The caption of the referenced entity
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_invitationAccepted	boolean	Has invitation been accepted
_template	object
_template.name	string	The name of the template
_template.displayName	string	The display name of the template
_template.parentTemplate	object
_template.parentTemplate.id	string
_template.parentTemplate.displayName	string
_template.parentTemplate.name	string
_template.id	string	The id of the template
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_enabled	string	Is the user enabled Values:DISABLED,ENABLED	ENABLED
_username	string	User's username. Can be an email or a regular username. With this username you login to the system.	[email protected] or john123
_registrationSource	string	The source of the registration. Possible values: INVITATION / SELF	INVITATION
_canLogin	boolean	Determine whether a patient has the ability to login to the system or not
_nickname	string	The patient nickname. Used for anonymous users.
_caption	string

400Bad Request

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

409Code : PATIENT_USERNAME_ALREADY_EXIST, Details: [username] Code : TEMPLATE_HAS_NO_SIGN_UP_METHODS_ATTRIBUTE, Details: [templateId] Code : ORGANIZATION_NOT_SELECTED_IN_TEMPLATE_METHOD, Details: [requiredOwnerOrganizationId, selectedOrganizationsIds, templateAttributeName]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []