Update a progress note

curl --request PUT \
  --url https://nextvisit.app/api/v1/progress-notes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "transcription": "<string>",
  "analysis": "<string>"
}
'

{
  "id": 123,
  "name": "Follow-up Visit - Jane Doe",
  "team_id": 5,
  "user_id": 42,
  "created_at": "2023-04-10T15:30:00Z",
  "updated_at": "2023-04-10T15:45:00Z",
  "transcription": "Patient reports improvement in symptoms since last visit...",
  "analysis": "Patient's condition has improved with current treatment regimen...",
  "template": {
    "id": 5,
    "name": "Standard Follow-up",
    "description": "Standard template for routine follow-up visits"
  },
  "patient": {
    "$ref": "<unknown>"
  },
  "audio": {
    "duration": 480,
    "bitrate": 128000,
    "size": 7680000,
    "uploaded_at": "2023-04-10T15:30:00Z",
    "expires_at": "2023-05-10T15:30:00Z",
    "file_url": "https://storage.nextvisit.app/encounters/abc123.mp3?token=xyz"
  },
  "has": {
    "content": true,
    "transcription": true,
    "signed": false
  },
  "user": {
    "$ref": "<unknown>"
  },
  "transcription_started_at": "2023-04-10T15:35:00Z",
  "transcription_completed_at": "2023-04-10T15:40:00Z",
  "analysis_started_at": "2023-04-10T15:40:00Z",
  "analysis_completed_at": "2023-04-10T15:45:00Z",
  "error_state": null
}

PUT

progress-notes

{id}

Update a progress note

curl --request PUT \
  --url https://nextvisit.app/api/v1/progress-notes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "transcription": "<string>",
  "analysis": "<string>"
}
'

{
  "id": 123,
  "name": "Follow-up Visit - Jane Doe",
  "team_id": 5,
  "user_id": 42,
  "created_at": "2023-04-10T15:30:00Z",
  "updated_at": "2023-04-10T15:45:00Z",
  "transcription": "Patient reports improvement in symptoms since last visit...",
  "analysis": "Patient's condition has improved with current treatment regimen...",
  "template": {
    "id": 5,
    "name": "Standard Follow-up",
    "description": "Standard template for routine follow-up visits"
  },
  "patient": {
    "$ref": "<unknown>"
  },
  "audio": {
    "duration": 480,
    "bitrate": 128000,
    "size": 7680000,
    "uploaded_at": "2023-04-10T15:30:00Z",
    "expires_at": "2023-05-10T15:30:00Z",
    "file_url": "https://storage.nextvisit.app/encounters/abc123.mp3?token=xyz"
  },
  "has": {
    "content": true,
    "transcription": true,
    "signed": false
  },
  "user": {
    "$ref": "<unknown>"
  },
  "transcription_started_at": "2023-04-10T15:35:00Z",
  "transcription_completed_at": "2023-04-10T15:40:00Z",
  "analysis_started_at": "2023-04-10T15:40:00Z",
  "analysis_completed_at": "2023-04-10T15:45:00Z",
  "error_state": null
}

Authorizations

Authorization

string

header

required

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

Path Parameters

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

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

Show child attributes

template.id

integer

Template ID used for this note

Example:

5

template.name

string

Name of the template

Example:

"Standard Follow-up"

template.description

string

Description of the template

Example:

"Standard template for routine follow-up visits"

patient

object

Associated patient information

Show child attributes

patient.$ref

any

audio

object

Show child attributes

audio.duration

number

Duration of the audio in seconds

Example:

480

audio.bitrate

integer

Bitrate of the audio file

Example:

128000

audio.size

integer

Size of the audio file in bytes

Example:

7680000

audio.uploaded_at

string<date-time>

When the audio was uploaded

Example:

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

audio.expires_at

string<date-time>

When the audio file will expire

Example:

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

audio.file_url

string

Temporary URL to access the audio file

Example:

"https://storage.nextvisit.app/encounters/abc123.mp3?token=xyz"

has

object

Show child attributes

has.content

boolean

Whether analysis has been completed

Example:

true

has.transcription

boolean

Whether transcription has been completed

Example:

true

has.signed

boolean

Whether the note has been reviewed and signed

Example:

false

user

object

Information about the user who created the note

Show child attributes

user.$ref

any

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

Get a specific progress note Delete a progress note

⌘I

Progress Notes

Users

Tokens

Update a progress note

Authorizations

Path Parameters

Body

Response