Corti API Documentation home page

Support
Legacy Documentation

interactions

Update Interaction

interactions

GET
List All Interactions
POST
Create Interaction
GET
Get Existing Interaction
DEL
Delete Interaction
PATCH
Update Interaction

stream

GET
Stream Interaction
TRACE
WSS client/server messages.

facts

GET
List Facts
POST
Add Facts
PATCH
Update Facts
PATCH
Update Fact

documents

GET
List Documents
POST
Generate Document
GET
Get Document
DEL
Delete Document
PATCH
Update Document

codes

GET
List codes
PUT
Select codes
POST
Generate Codes

recordings

GET
List Recordings
POST
Upload Recording
GET
Get Recording
DEL
Delete Recording

transcripts

GET
List Transcripts
POST
Create Transcript
GET
Get Transcript
DEL
Delete Transcript

experimental

POST
Align Sections
POST
Create Classification
POST
Contextual Query Assistant
POST
Guidelines Tool API
POST
Mentions Tool API
POST
Question Prompts Tool API

interactions

Update Interaction

Patches an existing interaction.

PATCH

https://api.{environment}.corti.app/v2/

interactions

{id}

environment

enum<string>

environment

enum<string>

string

Required

string

The interaction ID representing the context for the request.

object

assignedUserId

string

assignedUserId

string

encounter

object

encounter

object

identifier

string

identifier

string

status

enum<string>

status

enum<string>

type

enum<string>

type

enum<string>

period

object

period

object

startedAt

string

startedAt

Required

string

startedAtTzoffset

string

startedAtTzoffset

string

Add Example Value

endedAt

string

endedAt

string

endedAtTzoffset

string

endedAtTzoffset

string

Add Example Value

title

string

title

string

patient

object

patient

object

identifier

string

identifier

string

name

string

name

string

gender

enum<string>

gender

enum<string>

birthDate

string

birthDate

string

pronouns

string

pronouns

string

Path Parameters

string

required

The interaction ID representing the context for the request.

Body

application/json

assignedUserId

string

encounter

object

encounter.identifier

string

encounter.status

enum<string>

Available options:

planned,

in-progress,

on-hold,

completed,

cancelled,

deleted

encounter.type

enum<string>

Available options:

first_consultation,

consultation,

emergency,

inpatient,

outpatient

encounter.period

object

encounter.period.startedAt

string

required

encounter.period.startedAtTzoffset

string

encounter.period.endedAt

string

encounter.period.endedAtTzoffset

string

encounter.title

string

patient

object

patient.identifier

string

patient.name

string

patient.gender

enum<string>

Available options:

male,

female,

unknown,

other

patient.birthDate

string

patient.pronouns

string

Response

200 - application/json

string

assignedUserId

string

encounter

object

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.

encounter.period.startedAt

string

required

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

encounter.period.startedAtTzoffset

string

Timezone offset for startedAt

encounter.period.endedAt

string

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

encounter.period.endedAtTzoffset

string

Timezone offset for endedAt

encounter.title

string

A readable name for the interaction

patient

object

patient.identifier

string

required

FHIR reference to patient identifier.

patient.name

string

FHIR reference to Text representation of the full name. Ensures the patient is referred by their name in the documentation.

patient.gender

enum<string>

FHIR reference to patient gender. Ensures the documentation is written with the correct pronouns.

Available options:

male,

female,

unknown,

other

patient.birthDate

string

FHIR reference to patient birth date.

patient.pronouns

string

FHIR reference to patient extension Individual Pronouns.

endedAt

string

endedAtTzoffset

string

createdAt

string

createdAtTzoffset

string

updatedAt

string

updatedAtTzoffset

string

websocketUrl

string

lastUpdated

string

Was this page helpful?

Delete Interaction Stream Interaction

x github linkedin