> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corti.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# embedded.interactionCreated

> Emitted when the embedded createInteraction method is successfully called.

## Event Properties

| Field          | Value                           |
| -------------- | ------------------------------- |
| `event`        | `"embedded.interactionCreated"` |
| `confidential` | `boolean`                       |
| `payload`      | `object`                        |

<Tabs>
  <Tab title="Public Payload">
    | Field              | Type                                                                                   | Description                       |
    | ------------------ | -------------------------------------------------------------------------------------- | --------------------------------- |
    | `encounterType`    | `"first_consultation" \| "consultation" \| "emergency" \| "inpatient" \| "outpatient"` | Type of clinical encounter        |
    | `encounterStatus`  | `"planned" \| "in-progress" \| "cancelled" \| "deleted" \| "on-hold" \| "completed"`   | Current status of the encounter   |
    | `hasPatient`       | `boolean`                                                                              | Whether patient data was provided |
    | `interactionId`    | `string`                                                                               | Unique interaction identifier     |
    | `interactionState` | `InteractionState`                                                                     | Current state of the interaction  |

    #### Example

    ```json theme={null}
    {
      "event": "embedded.interactionCreated",
      "confidential": false,
      "payload": {
        "encounterType": "consultation",
        "encounterStatus": "planned",
        "hasPatient": true,
        "interactionId": "int_123",
        "interactionState": "ongoing"
      }
    }
    ```
  </Tab>

  <Tab title="Confidential Payload">
    | Field                 | Type                                                                                                                                                                                                                        | Description                                                     |
    | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
    | `encounterType`       | `"first_consultation" \| "consultation" \| "emergency" \| "inpatient" \| "outpatient"`                                                                                                                                      | Type of clinical encounter                                      |
    | `encounterStatus`     | `"planned" \| "in-progress" \| "cancelled" \| "deleted" \| "on-hold" \| "completed"`                                                                                                                                        | Current status of the encounter                                 |
    | `encounterIdentifier` | `string`                                                                                                                                                                                                                    | External system's encounter identifier                          |
    | `encounterStartedAt`  | `string (ISO 8601 date)`                                                                                                                                                                                                    | When the encounter began                                        |
    | `encounterTitle`      | `string \| undefined`                                                                                                                                                                                                       | Optional descriptive title for the encounter                    |
    | `assignedUserId`      | `string \| null \| undefined`                                                                                                                                                                                               | User responsible for this interaction                           |
    | `hasPatient`          | `boolean`                                                                                                                                                                                                                   | Whether patient data was provided                               |
    | `patient`             | `{ identifier?: string \| undefined; name?: string \| undefined; gender?: "male" \| "female" \| "other" \| "unknown" \| undefined; birthDate?: string \| null \| undefined; pronouns?: string \| undefined; } \| undefined` | Patient demographic data                                        |
    | `interaction`         | `ExternalInteraction`                                                                                                                                                                                                       | Interaction context including transcripts, documents, and facts |

    <Accordion title="patient object properties">
      | Field        | Type     | Description |
      | ------------ | -------- | ----------- |
      | `identifier` | `string` | -           |
      | `name`       | `string` | -           |
      | `gender`     | `string` | -           |
      | `birthDate`  | `string` | -           |
      | `pronouns`   | `string` | -           |
    </Accordion>

    <Accordion title="interaction object properties">
      | Field             | Type                     | Description                                         |
      | ----------------- | ------------------------ | --------------------------------------------------- |
      | `id`              | `string`                 | Unique interaction identifier                       |
      | `title`           | `string \| null`         | Interaction title                                   |
      | `state`           | `InteractionState`       | Current state of the interaction                    |
      | `startedAt`       | `string (ISO 8601 date)` | When the interaction started (ISO 8601 date string) |
      | `transcriptCount` | `number`                 | Number of transcripts in the interaction            |
      | `documentCount`   | `number`                 | Number of documents in the interaction              |
      | `facts`           | `Fact[]`                 | Facts extracted during the interaction              |

      **Fact properties:**

      | Field         | Type                           | Description                                              |
      | ------------- | ------------------------------ | -------------------------------------------------------- |
      | `id`          | `string`                       | Unique fact identifier                                   |
      | `text`        | `string`                       | Fact text content                                        |
      | `group`       | `string`                       | Fact group/category name                                 |
      | `source`      | `"core" \| "system" \| "user"` | Source of the fact: core (AI extracted), system, or user |
      | `isDiscarded` | `boolean`                      | Whether the fact has been discarded                      |
    </Accordion>

    #### Example

    ```json theme={null}
    {
      "event": "embedded.interactionCreated",
      "confidential": true,
      "payload": {
        "encounterType": "consultation",
        "encounterStatus": "planned",
        "encounterIdentifier": "encounter-123",
        "encounterStartedAt": "2024-01-01T00:00:00.000Z",
        "encounterTitle": "Initial Consultation",
        "assignedUserId": "user_123",
        "hasPatient": true,
        "patient": {
          "identifier": "patient-123",
          "name": "Jane Doe",
          "gender": "female",
          "birthDate": "1980-01-01",
          "pronouns": "she/her"
        },
        "interaction": {
          "id": "int_123",
          "title": "Visit",
          "state": "ongoing",
          "startedAt": "2024-01-01T00:00:00.000+00:00",
          "transcriptCount": 0,
          "documentCount": 0,
          "facts": []
        }
      }
    }
    ```
  </Tab>
</Tabs>
