Update Interaction

cURL

curl --request PATCH \
  --url https://api.{environment}.corti.app/v2/interactions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-Name: <tenant-name>' \
  --data '
{
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    },
    "title": "<string>"
  },
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  }
}
'

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    },
    "title": "<string>"
  },
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "websocketUrl": "<string>",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z"
}

PATCH

interactions

{id}

cURL

curl --request PATCH \
  --url https://api.{environment}.corti.app/v2/interactions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-Name: <tenant-name>' \
  --data '
{
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    },
    "title": "<string>"
  },
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  }
}
'

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    },
    "title": "<string>"
  },
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "websocketUrl": "<string>",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Input your token

Headers

Tenant-Name

string

required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"base"

Path Parameters

string<uuid>

required

The unique identifier of the interaction. Must be a valid UUID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json

assignedUserId

string<uuid>

The unique identifier of the medical professional responsible for this interaction. If nulled, automatically set to a uuid.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

encounter

object

Details of the encounter being updated.

Show child attributes

encounter.identifier

string

A unique identifier for the encounter, essential for tracking and referencing specific patient interactions.

encounter.status

enum<string>

Indicates the current state of the encounter, crucial for understanding the progression and current state of care.

Available options:

planned,

in-progress,

on-hold,

completed,

cancelled,

deleted

encounter.type

enum<string>

The specific type of encounter, providing context about the nature and setting of the patient interaction.

Available options:

first_consultation,

consultation,

emergency,

inpatient,

outpatient

encounter.period

object

The time period during which the encounter takes place.

Show child attributes

encounter.period.startedAt

string<date-time>

required

The start date/time of the encounter. (UTC)

encounter.period.endedAt

string<date-time> | null

The end date/time of the encounter. (UTC)

encounter.title

string | null

A readable name for the interaction

patient

object

Patient-related updates.

Show child attributes

patient.identifier

string

required

FHIR reference to patient identifier.

patient.name

string | null

FHIR reference to Text representation of the full name.

patient.gender

enum<string> | null

FHIR reference to patient gender.

Available options:

male,

female,

unknown,

other

patient.birthDate

string<date-time> | null

FHIR reference to patient birth date.

patient.pronouns

string | null

FHIR reference to patient extension Individual Pronouns.

Response

A request body containing the fields to update within the interaction.

string<uuid>

required

Unique identifier for the interaction.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

assignedUserId

string<uuid>

required

A unique identifier for the medical professional responsible for this interaction. If nulled, automatically set to a uuid.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

encounter

object

required

Information about the encounter, including type, status, and timing.

Show child attributes

encounter.identifier

string

required

A unique identifier for the encounter, essential for tracking and referencing specific patient interactions.

encounter.status

enum<string>

required

Indicates the current state of the encounter, crucial for understanding the progression and current state of care.

Available options:

planned,

in-progress,

on-hold,

completed,

cancelled,

deleted

encounter.type

enum<string>

required

The specific type of encounter, providing context about the nature and setting of the patient interaction.

Available options:

first_consultation,

consultation,

emergency,

inpatient,

outpatient

encounter.period

object

required

The time period during which the encounter takes place.

Show child attributes

encounter.period.startedAt

string<date-time>

required

The start date/time of the encounter. (UTC)

encounter.period.endedAt

string<date-time> | null

The end date/time of the encounter. (UTC)

encounter.title

string | null

A readable name for the interaction

patient

object

required

Details about the patient involved in the interaction, if applicable.

Show child attributes

patient.identifier

string

required

FHIR reference to patient identifier.

patient.name

string | null

FHIR reference to Text representation of the full name.

patient.gender

enum<string> | null

FHIR reference to patient gender.

Available options:

male,

female,

unknown,

other

patient.birthDate

string<date-time> | null

FHIR reference to patient birth date.

patient.pronouns

string | null

FHIR reference to patient extension Individual Pronouns.

createdAt

string<date-time>

required

The timestamp when the interaction was started (UTC).

updatedAt

string<date-time>

required

The timestamp when the interaction was last modified (UTC).

websocketUrl

string

required

WebSocket URL for streaming real-time interactions. Append a token in the format: /interactions/{interactionID}/streams?token=Bearer token-value-here

lastUpdated

string<date-time>

required

The timestamp indicating the last recorded update for this interaction.

endedAt

string<date-time> | null

The timestamp when the interaction concluded (UTC).

Delete Interaction List Recordings

Web Socket APIs

REST APIs

Agentic APIs (beta)

Admin APIs

Authorizations

Headers

Path Parameters

Body

Response