| data | array | List of items that match the search request | |
| data[index] | array | List of items that match the search request | |
| data[index]._patient | object | | |
| data[index]._patient._name | object | | |
| data[index]._patient._name.firstName | string | A person's first name | John |
| data[index]._patient._name.lastName | string | A person's last name | Smith |
| data[index]._patient._description | string | A description, can be up to 5000 characters long | Lorem Ipsum |
| data[index]._patient._email | string | An email address in the RFC-5322 specification | [email protected] |
| data[index]._patient._phone | string | A person's phone An E.164 formatted phone number | +12345678901 |
| data[index]._patient._locale | string | A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase. | en-us |
| data[index]._patient._gender | string | A persons gender Values:MALE,FEMALE,UNDISCLOSED | FEMALE |
| data[index]._patient._dateOfBirth | string | A person's date of birth A UTC date in the ISO-8601 format | 2007-12-20 |
| data[index]._patient._address | object | | |
| data[index]._patient._address.countryCode | string | A 2-letter country code defined in ISO-3166 | US |
| data[index]._patient._address.state | string | A state | Massachusetts |
| data[index]._patient._address.city | string | A city | Boston |
| data[index]._patient._address.zipCode | string | A zipcode | 02101 |
| data[index]._patient._address.address1 | string | An address | 11 Main St. |
| data[index]._patient._address.address2 | string | An address's specifics | Entry B, Apartment 1 |
| data[index]._patient._mfa | object | | |
| data[index]._patient._mfa.enabled | boolean | MFA login enabled or disabled | |
| data[index]._patient._mfa.expirationInMinutes | integer | MFA expiration time in minutes | |
| data[index]._patient._credentialType | string | What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP | |
| data[index]._patient._additionalPhone | string | An E.164 formatted phone number | +12345678901 |
| data[index]._patient._nationalId | string | A person's national ID | 123456789 |
| data[index]._patient._id | string | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._ownerOrganization | object | | |
| data[index]._patient._ownerOrganization.id | string | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._ownerOrganization.templateId | string | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._ownerOrganization.parentEntityId | string | The id of the parent entity (appears only for child entities) | |
| data[index]._patient._ownerOrganization.templateName | string | The name of the referenced entity template | |
| data[index]._patient._ownerOrganization.template | object | | |
| data[index]._patient._ownerOrganization.template.name | string | The name of the template | |
| data[index]._patient._ownerOrganization.template.displayName | string | The display name of the template | |
| data[index]._patient._ownerOrganization.template.parentTemplate | object | | |
| data[index]._patient._ownerOrganization.template.parentTemplate.id | string | | |
| data[index]._patient._ownerOrganization.template.parentTemplate.displayName | string | | |
| data[index]._patient._ownerOrganization.template.parentTemplate.name | string | | |
| data[index]._patient._ownerOrganization.template.id | string | The id of the template | |
| data[index]._patient._ownerOrganization.organizationId | string | The id of the organization of the referenced entity. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._ownerOrganization.name | string | The caption of the referenced entity | |
| data[index]._patient._caregiver | object | | |
| data[index]._patient._caregiver.id | string | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._caregiver.templateId | string | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._caregiver.parentEntityId | string | The id of the parent entity (appears only for child entities) | |
| data[index]._patient._caregiver.templateName | string | The name of the referenced entity template | |
| data[index]._patient._caregiver.template | object | | |
| data[index]._patient._caregiver.template.name | string | The name of the template | |
| data[index]._patient._caregiver.template.displayName | string | The display name of the template | |
| data[index]._patient._caregiver.template.parentTemplate | object | | |
| data[index]._patient._caregiver.template.parentTemplate.id | string | | |
| data[index]._patient._caregiver.template.parentTemplate.displayName | string | | |
| data[index]._patient._caregiver.template.parentTemplate.name | string | | |
| data[index]._patient._caregiver.template.id | string | The id of the template | |
| data[index]._patient._caregiver.organizationId | string | The id of the organization of the referenced entity. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._patient._caregiver.name | string | The caption of the referenced entity | |
| data[index]._patient._creationTime | string | A UTC date-time in the ISO-8601 format | 2007-12-20T10:15:30Z |
| data[index]._patient._lastModifiedTime | string | A UTC date-time in the ISO-8601 format | 2007-12-20T10:15:30Z |
| data[index]._patient._invitationAccepted | boolean | Has invitation been accepted | |
| data[index]._patient._template | object | | |
| data[index]._patient._template.name | string | The name of the template | |
| data[index]._patient._template.displayName | string | The display name of the template | |
| data[index]._patient._template.parentTemplate | object | | |
| data[index]._patient._template.parentTemplate.id | string | | |
| data[index]._patient._template.parentTemplate.displayName | string | | |
| data[index]._patient._template.parentTemplate.name | string | | |
| data[index]._patient._template.id | string | The id of the template | |
| data[index]._patient._referencers | object | An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1) | |
| data[index]._patient._enabled | string | Is the user enabled Values:DISABLED,ENABLED | ENABLED |
| data[index]._patient._username | string | User's username. Can be an email or a regular username. With this username you login to the system. | [email protected] or john123 |
| data[index]._patient._registrationSource | string | The source of the registration. Possible values: INVITATION / SELF | INVITATION |
| data[index]._patient._canLogin | boolean | Determine whether a patient has the ability to login to the system or not | |
| data[index]._patient._nickname | string | The patient nickname. Used for anonymous users. | |
| data[index]._patient._caption | string | | |
| data[index]._alerts | array | | |
| data[index]._alerts[index] | array | | |
| data[index]._alerts[index]._state | string | The alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVE | ACTIVE |
| data[index]._alerts[index]._severity | string | The alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFO | MAJOR |
| data[index]._alerts[index]._clearNotes | string | Clear notes | |
| data[index]._alerts[index]._name | string | The name of the alert | |
| data[index]._alerts[index]._id | string | The id of the alert instance | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._template | object | | |
| data[index]._alerts[index]._template.name | string | The name of the template | |
| data[index]._alerts[index]._template.displayName | string | The display name of the template | |
| data[index]._alerts[index]._template.parentTemplate | object | | |
| data[index]._alerts[index]._template.parentTemplate.id | string | | |
| data[index]._alerts[index]._template.parentTemplate.displayName | string | | |
| data[index]._alerts[index]._template.parentTemplate.name | string | | |
| data[index]._alerts[index]._template.id | string | The id of the template | |
| data[index]._alerts[index]._referencers | object | An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1) | |
| data[index]._alerts[index]._ownerOrganization | object | | |
| data[index]._alerts[index]._ownerOrganization.id | string | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._ownerOrganization.templateId | string | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._ownerOrganization.parentEntityId | string | The id of the parent entity (appears only for child entities) | |
| data[index]._alerts[index]._ownerOrganization.templateName | string | The name of the referenced entity template | |
| data[index]._alerts[index]._ownerOrganization.template | object | | |
| data[index]._alerts[index]._ownerOrganization.template.name | string | The name of the template | |
| data[index]._alerts[index]._ownerOrganization.template.displayName | string | The display name of the template | |
| data[index]._alerts[index]._ownerOrganization.template.parentTemplate | object | | |
| data[index]._alerts[index]._ownerOrganization.template.parentTemplate.id | string | | |
| data[index]._alerts[index]._ownerOrganization.template.parentTemplate.displayName | string | | |
| data[index]._alerts[index]._ownerOrganization.template.parentTemplate.name | string | | |
| data[index]._alerts[index]._ownerOrganization.template.id | string | The id of the template | |
| data[index]._alerts[index]._ownerOrganization.organizationId | string | The id of the organization of the referenced entity. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._ownerOrganization.name | string | The caption of the referenced entity | |
| data[index]._alerts[index]._clearDateTime | string | Clear Date time of the alert | 2007-12-20T10:15:30Z |
| data[index]._alerts[index]._clearTrigger | string | The alert cleared trigger type Values:MANUAL,AUTOMATIC | AUTOMATIC |
| data[index]._alerts[index]._clearedBy | object | | |
| data[index]._alerts[index]._clearedBy.id | string | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._clearedBy.templateId | string | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._clearedBy.parentEntityId | string | The id of the parent entity (appears only for child entities) | |
| data[index]._alerts[index]._clearedBy.templateName | string | The name of the referenced entity template | |
| data[index]._alerts[index]._clearedBy.template | object | | |
| data[index]._alerts[index]._clearedBy.template.name | string | The name of the template | |
| data[index]._alerts[index]._clearedBy.template.displayName | string | The display name of the template | |
| data[index]._alerts[index]._clearedBy.template.parentTemplate | object | | |
| data[index]._alerts[index]._clearedBy.template.parentTemplate.id | string | | |
| data[index]._alerts[index]._clearedBy.template.parentTemplate.displayName | string | | |
| data[index]._alerts[index]._clearedBy.template.parentTemplate.name | string | | |
| data[index]._alerts[index]._clearedBy.template.id | string | The id of the template | |
| data[index]._alerts[index]._clearedBy.organizationId | string | The id of the organization of the referenced entity. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._clearedBy.name | string | The caption of the referenced entity | |
| data[index]._alerts[index]._creationTime | string | A UTC date-time in the ISO-8601 format | 2007-12-20T10:15:30Z |
| data[index]._alerts[index]._lastModifiedTime | string | A UTC date-time in the ISO-8601 format | 2007-12-20T10:15:30Z |
| data[index]._alerts[index]._patient | object | | |
| data[index]._alerts[index]._patient.id | string | A UUID formatted string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._patient.templateId | string | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._patient.parentEntityId | string | The id of the parent entity (appears only for child entities) | |
| data[index]._alerts[index]._patient.templateName | string | The name of the referenced entity template | |
| data[index]._alerts[index]._patient.template | object | | |
| data[index]._alerts[index]._patient.template.name | string | The name of the template | |
| data[index]._alerts[index]._patient.template.displayName | string | The display name of the template | |
| data[index]._alerts[index]._patient.template.parentTemplate | object | | |
| data[index]._alerts[index]._patient.template.parentTemplate.id | string | | |
| data[index]._alerts[index]._patient.template.parentTemplate.displayName | string | | |
| data[index]._alerts[index]._patient.template.parentTemplate.name | string | | |
| data[index]._alerts[index]._patient.template.id | string | The id of the template | |
| data[index]._alerts[index]._patient.organizationId | string | The id of the organization of the referenced entity. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| data[index]._alerts[index]._patient.name | string | The caption of the referenced entity | |
| data[index]._alerts[index]._setDateTime | string | Set Date time of the alert | 2007-12-20T10:15:30Z |
| data[index]._alerts[index]._caption | string | | |
| metadata | object | | |
| metadata.sort | array | Sort that was passed in the request | |
| metadata.sort[index] | array | Sort that was passed in the request | |
| metadata.sort[index].prop | string | The property name for the sort | |
| metadata.sort[index].order | string | The direction of sort. Default DESC Values:ASC,DESC | ASC |
| metadata.filter | object | The filter that was passed in the request | |
| metadata.page | object | | |
| metadata.page.totalResults | integer | The total number of items that match the query | 145 |
| metadata.page.page | integer | Page number | 3 |
| metadata.page.limit | integer | Number of items per page | 100 |
| metadata.freeTextSearch | string | Free text search strings that was passed in the request | cat dog |