The Conversation object

The Conversation object is used so that a patient can communicate with one or several providers.

NameTypeDescription
idUUIDA unique identifier.
titlestring?A title describing this conversation.
summarystring?A summary of this conversation.
patientsPatients(id: UUID, username: string?, first_name: string?, last_name: string?, date_of_birth: Date?, locale: "fr" | "en" | "pt", email: string?, phone: string?, address: Address(street_address: string, zip_code: string, city: string, state: string?, country: string?)?, sex: "MALE" | "FEMALE" | "OTHER"?, updated_at: DateTime, created_at: DateTime, external_id: string?, healthcare_system_identifier: string?, summary: string?, metadata: JSON?, custom_fields: JSON?, integrations: Integrations(apero_id: string?)?, tags: string[])[]The list of patients in this conversation.
providersProviders(id: UUID, gender: "MALE" | "FEMALE"?, first_name: string, last_name: string, phone: string?, email: string?, prefix: string?, title: string?, timezone: string?, roles: "ADMINISTRATOR" | "PRACTITIONER" | "REVIEWER"[], biography: string?, metadata: JSON?, ephemeral_avatar_url: undefined?, self_login_enabled: boolean)[]The list of providers participating in this conversation.
assigned_providersAssignedProviders(id: UUID, gender: "MALE" | "FEMALE"?, first_name: string, last_name: string, phone: string?, email: string?, prefix: string?, title: string?, timezone: string?, roles: "ADMINISTRATOR" | "PRACTITIONER" | "REVIEWER"[], biography: string?, metadata: JSON?, ephemeral_avatar_url: undefined?, self_login_enabled: boolean)[]?The list of providers assigned to this conversation.
tagsTags(id: UUID, type: Type(id: UUID, name: string, created_at: DateTime, color: string, ml_predictable: boolean), status: "VALID" | "SUGGESTED" | "DISMISSED", created_at: DateTime, model: Model(id: UUID, status: "PENDING" | "TRAINING" | "READY" | "DELETED" | "ERROR", created_at: DateTime, updated_at: DateTime?)?)[]The list of tags associated with this conversation.
console_urlstringThe URL pointing to this conversation in the Nabla Console.
unread_by_patient_messages_countintegerThe number of providers' messages that haven't been read by the patient yet.
unread_by_providers_messages_countintegerThe number of patient's messages that haven't been read by any of the participating providers yet.
lockedboolean?A locked conversation can't receive new messages from the patient, providers, nor the system.
console_status"closed" | "open"?Status of the conversation in the Nabla Console.
metadataJSON?You can use this parameter to attach key-value data to the object. All values must be of type string.
type"individual_conversation" | "group_conversation"The type of the conversation. If it is an individual conversation, it cannot have multiple patients. A group conversation can have multiple providers and multiple patients.

Example

{
  "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "title": "Urinary infection",
  "summary": "Patient has a urinary infection",
  "patients": [
    {
      "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"
      ]
    }
  ],
  "providers": [
    {
      "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
      "gender": "FEMALE",
      "first_name": "Jane",
      "last_name": "Doe",
      "phone": "+33612356789",
      "email": "example_string",
      "prefix": "Pr",
      "title": "Professor",
      "timezone": "Europe/Paris",
      "roles": [
        "ADMINISTRATOR"
      ],
      "biography": "Dr John Doe, MD is a graduate of George Washington University School of Medicine.",
      "metadata": {
        "example_key": "example_string"
      },
      "ephemeral_avatar_url": {
        "url": "https://example.com",
        "expires_at": "2022-06-24T14:36:22"
      },
      "self_login_enabled": true
    }
  ],
  "assigned_providers": [
    {
      "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
      "gender": "FEMALE",
      "first_name": "Jane",
      "last_name": "Doe",
      "phone": "+33612356789",
      "email": "example_string",
      "prefix": "Pr",
      "title": "Professor",
      "timezone": "Europe/Paris",
      "roles": [
        "ADMINISTRATOR"
      ],
      "biography": "Dr John Doe, MD is a graduate of George Washington University School of Medicine.",
      "metadata": {
        "example_key": "example_string"
      },
      "ephemeral_avatar_url": {
        "url": "https://example.com",
        "expires_at": "2022-06-24T14:36:22"
      },
      "self_login_enabled": true
    }
  ],
  "tags": [
    {
      "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
      "type": {
        "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
        "name": "DERMATOLOGY",
        "created_at": "2022-03-10T19:16:23.456Z",
        "color": "#aabbcc",
        "ml_predictable": true
      },
      "status": "VALID",
      "created_at": "2022-03-10T19:16:23.456Z",
      "model": {
        "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
        "status": "READY",
        "created_at": "2022-03-10T19:16:23.456Z",
        "updated_at": "2022-03-10T19:16:23.456Z"
      }
    }
  ],
  "console_url": "https://pro.nabla.com/conversations/07839A27-39EC-4C24-87A3-8CF0A9F3451A",
  "unread_by_patient_messages_count": 3,
  "unread_by_providers_messages_count": 1,
  "locked": true,
  "console_status": "closed",
  "metadata": {
    "example_key": "example_string"
  },
  "type": "individual_conversation"
}