Skip to main content
GET
/
v1
/
progress-notes
/
{id}
Get a specific progress note
curl --request GET \
  --url https://nextvisit.app/api/v1/progress-notes/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.nextvisitai.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Response

Progress note details

​
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