Self sign up for patients

Parameter	Type	Mandatory	Description	Example
_name	object	true
_name.firstName	string	true(*)	A person's first name	John
_name.lastName	string	true(*)	A person's last name	Smith
_description	string	false	A description, can be up to 5000 characters long	Lorem Ipsum
_email	string	true	An email address in the RFC-5322 specification	[email protected]
_phone	string	false	A person's phone An E.164 formatted phone number	+12345678901
_locale	string	false	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_gender	string	false	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
_dateOfBirth	string	false	A person's date of birth A UTC date in the ISO-8601 format	Thu Dec 20 00:00:00 UTC 2007
_address	object	false
_address.countryCode	string	true(*)	A 2-letter country code defined in ISO-3166	US
_address.state	string	false	A state	Massachusetts
_address.city	string	false	A city	Boston
_address.zipCode	string	false	A zipcode	02101
_address.address1	string	false	An address	11 Main St.
_address.address2	string	false	An address's specifics	Entry B, Apartment 1
_mfa	object	false
_mfa.enabled	boolean	true(*)	MFA login enabled or disabled
_mfa.expirationInMinutes	integer	false	MFA expiration time in minutes
_credentialType	string	false	What type of credentials is used when logging in to the system. Default:PASSWORD Values:PASSWORD,OTP
_additionalPhone	string	false	An E.164 formatted phone number	+12345678901
_nationalId	string	false	A person's national ID	123456789
_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
_deviceRegistrationCode	string	false	The registration code entity that is attached to the device	RegistrationCode123
_ownerOrganization	object	true
_ownerOrganization.id	string	true(*)	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_caregiver	object	false
_caregiver.id	string	true(*)	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6

The below table describes the response parameters:

Parameter	Type	Description	Example
device	object
device._description	string	Device description
device._timezone	string	A java time zone supported by the java runtime environment	Europe/Oslo
device._id	string	The id of the device
device._ownerOrganization	object
device._ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
device._ownerOrganization.templateName	string	The name of the referenced entity template
device._ownerOrganization.template	object
device._ownerOrganization.template.name	string	The name of the template
device._ownerOrganization.template.displayName	string	The display name of the template
device._ownerOrganization.template.parentTemplate	object
device._ownerOrganization.template.parentTemplate.id	string
device._ownerOrganization.template.parentTemplate.displayName	string
device._ownerOrganization.template.parentTemplate.name	string
device._ownerOrganization.template.id	string	The id of the template
device._ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._ownerOrganization.name	string	The caption of the referenced entity
device._template	object
device._template.name	string	The name of the template
device._template.displayName	string	The display name of the template
device._template.parentTemplate	object
device._template.parentTemplate.id	string
device._template.parentTemplate.displayName	string
device._template.parentTemplate.name	string
device._template.id	string	The id of the template
device._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)
device._configuration	object	An object that holds the entity configuration attributes
device._status	object
device._status._fwVersion	string
device._status._hwVersion	string
device._status._certificateStatus	string	Values:NOT_INSTALLED,BOOTSTRAP,PERMANENT
device._status._bootTime	string	A UTC date in the ISO-8601 format
device._status._connection	object
device._status._connection._connected	boolean	If the device is connected to the MQTT the value is true, otherwise false	true
device._status._connection._ipAddress	string	The IP Address of the connected device	2007-12-20
device._status._connection._lastConnectedTime	string	The last time that the device was connected
device._status._operational	object
device._status._operational._status	string	Operational status of the device Values:OK,MINOR,MAJOR,CRITICAL
device._status._operational._message	string	Operational status message
device._patient	object
device._patient.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._patient.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._patient.parentEntityId	string	The id of the parent entity (appears only for child entities)
device._patient.templateName	string	The name of the referenced entity template
device._patient.template	object
device._patient.template.name	string	The name of the template
device._patient.template.displayName	string	The display name of the template
device._patient.template.parentTemplate	object
device._patient.template.parentTemplate.id	string
device._patient.template.parentTemplate.displayName	string
device._patient.template.parentTemplate.name	string
device._patient.template.id	string	The id of the template
device._patient.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._patient.name	string	The caption of the referenced entity
device._registrationCode	object
device._registrationCode.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._registrationCode.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._registrationCode.parentEntityId	string	The id of the parent entity (appears only for child entities)
device._registrationCode.templateName	string	The name of the referenced entity template
device._registrationCode.template	object
device._registrationCode.template.name	string	The name of the template
device._registrationCode.template.displayName	string	The display name of the template
device._registrationCode.template.parentTemplate	object
device._registrationCode.template.parentTemplate.id	string
device._registrationCode.template.parentTemplate.displayName	string
device._registrationCode.template.parentTemplate.name	string
device._registrationCode.template.id	string	The id of the template
device._registrationCode.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
device._registrationCode.name	string	The caption of the referenced entity
device._creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
device._lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
device._caption	string	The caption of the command instance	mydevice1
patient	object
patient._name	object
patient._name.firstName	string	A person's first name	John
patient._name.lastName	string	A person's last name	Smith
patient._description	string	A description, can be up to 5000 characters long	Lorem Ipsum
patient._email	string	An email address in the RFC-5322 specification	[email protected]
patient._phone	string	A person's phone An E.164 formatted phone number	+12345678901
patient._locale	string	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
patient._gender	string	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
patient._dateOfBirth	string	A person's date of birth A UTC date in the ISO-8601 format	Thu Dec 20 00:00:00 UTC 2007
patient._address	object
patient._address.countryCode	string	A 2-letter country code defined in ISO-3166	US
patient._address.state	string	A state	Massachusetts
patient._address.city	string	A city	Boston
patient._address.zipCode	string	A zipcode	02101
patient._address.address1	string	An address	11 Main St.
patient._address.address2	string	An address's specifics	Entry B, Apartment 1
patient._mfa	object
patient._mfa.enabled	boolean	MFA login enabled or disabled
patient._mfa.expirationInMinutes	integer	MFA expiration time in minutes
patient._credentialType	string	What type of credentials is used when logging in to the system. Default:PASSWORD Values:PASSWORD,OTP
patient._additionalPhone	string	An E.164 formatted phone number	+12345678901
patient._nationalId	string	A person's national ID	123456789
patient._id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._ownerOrganization	object
patient._ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
patient._ownerOrganization.templateName	string	The name of the referenced entity template
patient._ownerOrganization.template	object
patient._ownerOrganization.template.name	string	The name of the template
patient._ownerOrganization.template.displayName	string	The display name of the template
patient._ownerOrganization.template.parentTemplate	object
patient._ownerOrganization.template.parentTemplate.id	string
patient._ownerOrganization.template.parentTemplate.displayName	string
patient._ownerOrganization.template.parentTemplate.name	string
patient._ownerOrganization.template.id	string	The id of the template
patient._ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._ownerOrganization.name	string	The caption of the referenced entity
patient._caregiver	object
patient._caregiver.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._caregiver.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._caregiver.parentEntityId	string	The id of the parent entity (appears only for child entities)
patient._caregiver.templateName	string	The name of the referenced entity template
patient._caregiver.template	object
patient._caregiver.template.name	string	The name of the template
patient._caregiver.template.displayName	string	The display name of the template
patient._caregiver.template.parentTemplate	object
patient._caregiver.template.parentTemplate.id	string
patient._caregiver.template.parentTemplate.displayName	string
patient._caregiver.template.parentTemplate.name	string
patient._caregiver.template.id	string	The id of the template
patient._caregiver.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
patient._caregiver.name	string	The caption of the referenced entity
patient._creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
patient._lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
patient._invitationAccepted	boolean	Has invitation been accepted
patient._template	object
patient._template.name	string	The name of the template
patient._template.displayName	string	The display name of the template
patient._template.parentTemplate	object
patient._template.parentTemplate.id	string
patient._template.parentTemplate.displayName	string
patient._template.parentTemplate.name	string
patient._template.id	string	The id of the template
patient._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)
patient._enabled	string	Is the user enabled Values:DISABLED,ENABLED	ENABLED
patient._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
patient._registrationSource	string	The source of the registration. Possible values: INVITATION / SELF	INVITATION
patient._canLogin	boolean	Determine whether a patient has the ability to login to the system or not
patient._nickname	string	The patient nickname. Used for anonymous users.
patient._caption	string

400Bad Request

500Code : FACADE_ROLLBACK_FAILED, Details: [] Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []