The Patient object

The Patient object.

NameTypeDescription
idUUIDA unique identifier.
usernamestring?The username that will be displayed in the Console. Required if no full name is given. Should be unique among all the patients of an organization.
first_namestring?The first name that will be displayed in the Console.
last_namestring?The last name that will be displayed in the Console.
date_of_birthDate?The date of birth of the patient. The format is an ISO 8601 string (YYYY-MM-DD).
locale"fr" | "en" | "pt"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, in E.164 format. A phone number should be unique among all the patients of a sub-organization.
addressAddress(street_address: string, zip_code: string, city: string, state: string?, country: string?)?The object representing an address.
sex"MALE" | "FEMALE" | "OTHER"?
updated_atDateTimeThe last update date of this object, in ISO 8601 format.
created_atDateTimeThe creation date of this object, in ISO 8601 format.
external_idstring?A unique identifier for the patient from another system which is given to Nabla.
healthcare_system_identifierstring?A unique identifier of the patient in their national healthcare system.
summarystring?A summary describing the patient.
metadataJSON?You can use this parameter to attach key-value data to the object. All values must be of type string.
custom_fieldsJSON?Custom fields for the patient, defined in your organization's settings in the Nabla Console. All values must be of type string. These values will be shown to the practitioners on the Nabla Console, where they will be able to edit them.

Example

{
  "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "username": "johndoe",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1972-06-23T00:00:00.000Z",
  "locale": "fr",
  "email": "[email protected]",
  "phone": "+33612356789",
  "address": {
    "street_address": "6838 Hollywood Blvd",
    "zip_code": "90028",
    "city": "Los Angeles",
    "state": "California",
    "country": "United States of America"
  },
  "sex": "MALE",
  "updated_at": "2022-03-10T19:16:23.456Z",
  "created_at": "2022-03-10T19:16:23.456Z",
  "external_id": "example_string",
  "healthcare_system_identifier": "example_string",
  "summary": "example_string",
  "metadata": {
    "example_key": "example_string"
  },
  "custom_fields": {
    "blood_type": "A+"
  }
}