The Patient object

The Patient object.

Name	Type	Description
id	UUID	A unique identifier.
username	string?	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_name	string?	The first name that will be displayed in the Console.
last_name	string?	The last name that will be displayed in the Console.
date_of_birth	Date?	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.
email	string?	The email of the patient. It will be used to send email notifications.
phone	string?	The phone number of the patient, in E.164 format. Several patients of the same sub-organization can share the same phone number.
address	Address(street_address: string, zip_code: string, city: string, state: string?, country: string?)?	The object representing an address.
sex	"MALE" \| "FEMALE" \| "OTHER"?
updated_at	DateTime	The last update date of this object, in ISO 8601 format.
created_at	DateTime	The creation date of this object, in ISO 8601 format.
external_id	string?	A unique identifier for the patient from another system which is given to Nabla.
healthcare_system_identifier	string?	A unique identifier of the patient in their national healthcare system.
summary	string?	A summary describing the patient.
metadata	JSON?	You can use this parameter to attach key-value data to the object. All values must be of type string.
custom_fields	JSON?	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.
integrations	Integrations(apero_id: string?)?	Patient fields related to integration with other services if any (e.g. for billing).
tags	string[]	The list of tags associated to the patient.

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+"
  },
  "integrations": {
    "apero_id": "123"
  },
  "tags": [
    "example_string"
  ]
}