Skip to main content
PUT
Update a progress note

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Progress note unique identifier

Body

application/json
name
string

Name or title of the progress note

transcription
string

Transcribed content of the audio recording

analysis
string

AI-generated analysis of the transcription

Response

Progress note updated successfully

id
integer<int64>
required

Unique identifier for the progress note

Example:

123

name
string
required

Name or title of the progress note

Example:

"Follow-up Visit - Jane Doe"

team_id
integer
required

ID of the team this note belongs to

Example:

5

user_id
integer
required

ID of the user who created this note

Example:

42

created_at
string<date-time>
required

When the progress note was created

Example:

"2023-04-10T15:30:00Z"

updated_at
string<date-time>
required

When the progress note was last updated

Example:

"2023-04-10T15:45:00Z"

transcription
string

Transcribed content of the audio recording

Example:

"Patient reports improvement in symptoms since last visit..."

analysis
string

AI-generated analysis of the transcription

Example:

"Patient's condition has improved with current treatment regimen..."

template
object
patient
object

Associated patient information

audio
object
has
object
user
object

Information about the user who created the note

transcription_started_at
string<date-time>

When transcription process started

Example:

"2023-04-10T15:35:00Z"

transcription_completed_at
string<date-time>

When transcription was completed

Example:

"2023-04-10T15:40:00Z"

analysis_started_at
string<date-time>

When analysis process started

Example:

"2023-04-10T15:40:00Z"

analysis_completed_at
string<date-time>

When analysis was completed

Example:

"2023-04-10T15:45:00Z"

error_state
string

Any error state during processing

Example:

null