Create a new Patient

Create a new Patient

Email confirmation landing page is required as a header

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

_name.firstNamestringtrue(*)A person's first nameJohn
_name.lastNamestringtrue(*)A person's last nameSmith
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_emailstringtrueAn email address in the RFC-5322 specification[email protected]
_phonestringfalseA person's phone An E.164 formatted phone number+12345678901
_localestringfalseA person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.en-us
_genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_dateOfBirthstringfalseA person's date of birth A UTC date in the ISO-8601 formatThu Dec 20 00:00:00 UTC 2007
_address.countryCodestringtrue(*)A 2-letter country code defined in ISO-3166US
_address.statestringfalseA stateMassachusetts
_address.citystringfalseA cityBoston
_address.zipCodestringfalseA zipcode02101
_address.address1stringfalseAn address11 Main St.
_address.address2stringfalseAn address's specificsEntry B, Apartment 1
_mfa.enabledbooleantrue(*)MFA login enabled or disabled
_mfa.expirationInMinutesintegerfalseMFA expiration time in minutes
_additionalPhonestringfalseAn E.164 formatted phone number+12345678901
_nationalIdstringfalseA person's national ID123456789
_canLoginbooleanfalseDetermine whether a patient has the ability to login to the system or not
_templateIdstringtrueThe id of a template that is configured in the settings service.3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.idstringtrue(*)A UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_caregiver.idstringtrue(*)A UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires PROTECTED_API permission(s).

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