Update Interaction

Path Parameters

string

required

The interaction ID representing the context for the request.

Body

application/json

assignedUserId

string

encounter

object

encounter.identifier

string

encounter.period

object

encounter.period.startedAt

string

required

encounter.period.endedAt

string

encounter.period.endedAtTzoffset

string

encounter.period.startedAtTzoffset

string

encounter.status

enum<string>

Available options:

planned,

in-progress,

on-hold,

completed,

cancelled,

deleted

encounter.title

string

encounter.type

enum<string>

Available options:

first_consultation,

consultation,

emergency,

inpatient,

outpatient

patient

object

patient.birthDate

string

patient.gender

enum<string>

Available options:

male,

female,

unknown,

other

patient.identifier

string

patient.name

string

patient.pronouns

string

Response

200 - application/json

assignedUserId

string

createdAt

string

createdAtTzoffset

string

encounter

object

encounter.identifier

string

required

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

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.endedAt

string

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

encounter.period.endedAtTzoffset

string

Timezone offset for endedAt

encounter.period.startedAtTzoffset

string

Timezone offset for startedAt

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.title

string

A readable name for the interaction

endedAt

string

endedAtTzoffset

string

lastUpdated

string

patient

object

patient.identifier

string

required

FHIR reference to patient identifier.

patient.birthDate

string

FHIR reference to patient birth date.

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.name

string

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

patient.pronouns

string

FHIR reference to patient extension Individual Pronouns.

updatedAt

string

updatedAtTzoffset

string

websocketUrl

string

append to this url your token, in the form: /interactions/{interactionID}/streams?token=Bearer token-value-here

interactions

stream

facts

documents

codes

recordings

transcripts

docs

Path Parameters

Body

Response