post https://example.com/organization/v1/users/patients
Create a new Patient
Email confirmation landing page is required as a header
Custom attributes can be specified in the request body
The below table describes the request parameters:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| emailConfirmationLandingPage | String | true | Landing page that will be sent in confirmation mail |
| _name.firstName | String | true | |
| _name.lastName | String | true | |
| _description | String | false | |
| _email | String | true | An email address in the RFC-5322 specification |
| _phone | String | false | An E.164 formatted phone number |
| _locale | String | false | |
| _gender | String | false | Supported values are: MALE, FEMALE, UNDISCLOSED |
| _dateOfBirth | LocalDate | false | A UTC date in the ISO-8601 format |
| _address.countryCode | String | false | A 2-letter country code defined in ISO-3166 |
| _address.state | String | false | |
| _address.city | String | false | |
| _address.zipCode | String | false | |
| _address.address1 | String | false | |
| _address.address2 | String | false | |
| _mfa.enabled | Boolean | false | |
| _mfa.expirationInMinutes | Integer | false | |
| _additionalPhone | String | false | |
| _nationalId | String | true | A person's national ID |
| _ownerOrganization.id | UUID | true | |
| _caregiver.id | UUID | false | |
| _templateId | UUID | true | The id of a Patient template that is configured in the settings service. |
| <customAttributes1> | <customAttributes1Type> | false | Custom attribute 1 value |
| <customAttributesN> | <customAttributesNType> | false | Custom attribute N value |