The Patient object

The Patient object.

NameTypeDescription
idUUIDA unique identifier.
usernamestring?
first_namestring?The first name that will be displayed in the Console.
last_namestring?The last name that will be displayed in the Console.
locale"fr" | "en"The locale to translate content that will be displayed to the user.
emailstring?The email of the patient. It will be used to send email notifications.
phonestring?The phone number of the patient. It will be used to send SMS notifications.
sex"MALE" | "FEMALE" | "OTHER"?
updated_atDateTimeThe last update date of this object.
created_atDateTimeThe creation date of this object.
external_idstring?A unique identifier for the patient from another system which is given to Nabla.
metadataJSON?You can use this parameter to attach key-value data to the object. All values must be of type string.

Example

{
  "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "username": "johndoe",
  "first_name": "John",
  "last_name": "Doe",
  "locale": "fr",
  "email": "[email protected]",
  "phone": "33612356789",
  "sex": "MALE",
  "updated_at": "2022-03-10T19:16:23.456Z",
  "created_at": "2022-03-10T19:16:23.456Z",
  "external_id": "example_string",
  "metadata": {
    "example_key": "example_string"
  }
}