Create a new Patient

Create a new Patient

Email confirmation landing page is required as a header

Request Body Parameters:

<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_additionalPhonestringfalseAn E.164 formatted phone number+12345678901
_address.address1stringfalseAn address11 Main St.
_address.address2stringfalseAn address's specificsEntry B, Apartment 1
_address.citystringfalseA cityBoston
_address.countryCodestringfalseA 2-letter country code defined in ISO-3166US
_address.statestringfalseA stateMassachusetts
_address.zipCodestringfalseA zipcode02101
_canLoginbooleanfalseDetermine whether a patient has the ability to login to the system or not
_caregiver.idstringfalseA UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_dateOfBirthstringfalseA person's date of birth A UTC date in the ISO-8601 formatThu Dec 20 00:00:00 UTC 2007
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_emailstringfalseAn email address in the RFC-5322 specification[email protected]
_genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_localestringfalseA person's locale A java locale supported by the java runtime environmenten_US
_mfa.enabledbooleanfalseMFA login enabled or disabled
_mfa.expirationInMinutesintegerfalseMFA expiration time in minutes
_name.firstNamestringfalseA person's first nameJohn
_name.lastNamestringfalseA person's last nameSmith
_nationalIdstringfalseA person's national ID123456789
_ownerOrganization.idstringfalseA UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_phonestringfalseA person's phone An E.164 formatted phone number+12345678901
_templateIdstringtrueThe id of a template that is configured in the settings service.3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires PROTECTED_API permission(s).

Click Try It! to start a request and see the response here!