List progress notes

curl --request GET \
  --url https://nextvisit.app/api/v1/progress-notes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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
    }
  ],
  "links": {},
  "meta": {}
}

GET

progress-notes

List progress notes

curl --request GET \
  --url https://nextvisit.app/api/v1/progress-notes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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
    }
  ],
  "links": {},
  "meta": {}
}

Authorizations

Authorization

string

header

required

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

Query Parameters

patient_id

integer

Filter notes by patient ID

per_page

integer

default:15

Number of items per page (1-100)

Required range: 1 <= x <= 100

sort_by

enum<string>

default:latest

Sort order for results

Available options:

latest,

oldest

Response

List of progress notes

data

object[]

Show child attributes

data.id

integer<int64>

required

Unique identifier for the progress note

Example:

123

data.name

string

required

Name or title of the progress note

Example:

"Follow-up Visit - Jane Doe"

data.team_id

integer

required

ID of the team this note belongs to

Example:

5

data.user_id

integer

required

ID of the user who created this note

Example:

42

data.created_at

string<date-time>

required

When the progress note was created

Example:

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

data.updated_at

string<date-time>

required

When the progress note was last updated

Example:

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

data.transcription

string

Transcribed content of the audio recording

Example:

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

data.analysis

string

AI-generated analysis of the transcription

Example:

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

data.template

object

Show child attributes

data.template.id

integer

Template ID used for this note

Example:

5

data.template.name

string

Name of the template

Example:

"Standard Follow-up"

data.template.description

string

Description of the template

Example:

"Standard template for routine follow-up visits"

data.patient

object

Associated patient information

Show child attributes

data.patient.$ref

any

data.audio

object

Show child attributes

data.audio.duration

number

Duration of the audio in seconds

Example:

480

data.audio.bitrate

integer

Bitrate of the audio file

Example:

128000

data.audio.size

integer

Size of the audio file in bytes

Example:

7680000

data.audio.uploaded_at

string<date-time>

When the audio was uploaded

Example:

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

data.audio.expires_at

string<date-time>

When the audio file will expire

Example:

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

data.audio.file_url

string

Temporary URL to access the audio file

Example:

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

data.has

object

Show child attributes

data.has.content

boolean

Whether analysis has been completed

Example:

true

data.has.transcription

boolean

Whether transcription has been completed

Example:

true

data.has.signed

boolean

Whether the note has been reviewed and signed

Example:

false

data.user

object

Information about the user who created the note

Show child attributes

data.user.$ref

any

data.transcription_started_at

string<date-time>

When transcription process started

Example:

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

data.transcription_completed_at

string<date-time>

When transcription was completed

Example:

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

data.analysis_started_at

string<date-time>

When analysis process started

Example:

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

data.analysis_completed_at

string<date-time>

When analysis was completed

Example:

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

data.error_state

string

Any error state during processing

Example:

null

links

object

Pagination links

Progress Notes

Users

Tokens

List progress notes

Authorizations

Query Parameters

Response