Skip to content

Nextvisit API (1.0.0)

API for the Nextvisit Clinical Documentation platform for developers

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Nextvisit Support
hello@nextvisit.ai
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://developers.nextvisit.app/_mock/openapi
Production API
https://nextvisit.app/api
Beta API
https://ea.nextvisit.app/api

Tokens

User token management endpoints for secure access to the Nextvisit platform. Includes login, logout, and token management operations.

Operations

Users

User account management including profile updates, permission settings, role assignments, and practice affiliations.

Operations

Progress Notes

Clinical progress note management including creating, updating, retrieving, and signing notes with associated transcriptions and analyses.

Operations

List progress notes

Request

Returns a paginated list of progress notes with optional filtering

Security
bearerAuth
Query
patient_idinteger

Filter notes by patient ID

per_pageinteger[ 1 .. 100 ]

Number of items per page (1-100)

Default 15
sort_bystring

Sort order for results

Default "latest"
Enum"latest""oldest"
curl -i -X GET \
  'https://developers.nextvisit.app/_mock/openapi/v1/progress-notes?patient_id=0&per_page=15&sort_by=latest' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of progress notes

Bodyapplication/json
dataArray of objects(ProgressNote)
linksobject

Pagination links

metaobject

Pagination metadata

Response
application/json
{
  "data": [
    { … }
  ],
  "links": {},
  "meta": {}
}

Create a new progress note

Request

Creates a new progress note either with an audio file or as a text-only note

Security
bearerAuth
Bodymultipart/form-datarequired
One of:
namestring<= 255 charactersrequired

Name or title of the progress note

Example: "Follow-up Visit - Jane Doe"
patient_idinteger

ID of the associated patient (optional)

Example: 123
filestring(binary)required

Audio file of the encounter

model_idinteger

ID of the prompt/template to use (optional)

Default 1
Example: 1
contextstring

Additional context information for the note (optional)

Example: "Patient reports improved sleep quality"
curl -i -X POST \
  https://developers.nextvisit.app/_mock/openapi/v1/progress-notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'name=Follow-up Visit - Jane Doe' \
  -F 'note=Patient presents for follow-up visit. Reports improvement in symptoms since last visit. Sleep quality has improved with current medication regimen. No adverse effects reported.' \
  -F model_id=1 \
  -F patient_id=123 \
  -F 'context=Patient reports improved sleep quality' \
  -F 'documents[0]=0'

Responses

Progress note created successfully

Bodyapplication/json
idinteger(int64)required

Unique identifier for the progress note

Example: 123
namestringrequired

Name or title of the progress note

Example: "Follow-up Visit - Jane Doe"
transcriptionstring

Transcribed content of the audio recording

Example: "Patient reports improvement in symptoms since last visit..."
analysisstring

AI-generated analysis of the transcription

Example: "Patient's condition has improved with current treatment regimen..."
templateobject
patientobject

Associated patient information

audioobject
hasobject
team_idintegerrequired

ID of the team this note belongs to

Example: 5
user_idintegerrequired

ID of the user who created this note

Example: 42
userobject

Information about the user who created the note

transcription_started_atstring(date-time)

When transcription process started

Example: "2023-04-10T15:35:00Z"
transcription_completed_atstring(date-time)

When transcription was completed

Example: "2023-04-10T15:40:00Z"
analysis_started_atstring(date-time)

When analysis process started

Example: "2023-04-10T15:40:00Z"
analysis_completed_atstring(date-time)

When analysis was completed

Example: "2023-04-10T15:45:00Z"
error_statestring or null

Any error state during processing

Example: null
created_atstring(date-time)required

When the progress note was created

Example: "2023-04-10T15:30:00Z"
updated_atstring(date-time)required

When the progress note was last updated

Example: "2023-04-10T15:45:00Z"
Response
application/json
{
  "id": 123,
  "name": "Follow-up Visit - Jane Doe",
  "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": {
    "id": 789,
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "Jane",
    "middle_name": "Marie",
    "last_name": "Doe",
    "gender": "female",
    "date_of_birth": "1985-03-15",
    "notes": "Patient has a history of anxiety. Prefers afternoon appointments.",
    "latest_medications": [ … ],
    "user": { … },
    "timeline": [ … ],
    "encounters": [ … ],
    "meta": {},
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  },
  "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
  },
  "team_id": 5,
  "user_id": 42,
  "user": {
    "id": 12345,
    "name": "Dr. Sarah Johnson",
    "email": "sarah.johnson@nextvisit.ai",
    "created_at": "2023-03-15T09:12:34Z",
    "updated_at": "2023-05-22T14:07:53Z"
  },
  "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,
  "created_at": "2023-04-10T15:30:00Z",
  "updated_at": "2023-04-10T15:45:00Z"
}

Get a specific progress note

Request

Returns a single progress note by ID

Security
bearerAuth
Path
idintegerrequired

Progress note unique identifier

curl -i -X GET \
  'https://developers.nextvisit.app/_mock/openapi/v1/progress-notes/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Progress note details

Bodyapplication/json
idinteger(int64)required

Unique identifier for the progress note

Example: 123
namestringrequired

Name or title of the progress note

Example: "Follow-up Visit - Jane Doe"
transcriptionstring

Transcribed content of the audio recording

Example: "Patient reports improvement in symptoms since last visit..."
analysisstring

AI-generated analysis of the transcription

Example: "Patient's condition has improved with current treatment regimen..."
templateobject
patientobject

Associated patient information

audioobject
hasobject
team_idintegerrequired

ID of the team this note belongs to

Example: 5
user_idintegerrequired

ID of the user who created this note

Example: 42
userobject

Information about the user who created the note

transcription_started_atstring(date-time)

When transcription process started

Example: "2023-04-10T15:35:00Z"
transcription_completed_atstring(date-time)

When transcription was completed

Example: "2023-04-10T15:40:00Z"
analysis_started_atstring(date-time)

When analysis process started

Example: "2023-04-10T15:40:00Z"
analysis_completed_atstring(date-time)

When analysis was completed

Example: "2023-04-10T15:45:00Z"
error_statestring or null

Any error state during processing

Example: null
created_atstring(date-time)required

When the progress note was created

Example: "2023-04-10T15:30:00Z"
updated_atstring(date-time)required

When the progress note was last updated

Example: "2023-04-10T15:45:00Z"
Response
application/json
{
  "id": 123,
  "name": "Follow-up Visit - Jane Doe",
  "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": {
    "id": 789,
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "Jane",
    "middle_name": "Marie",
    "last_name": "Doe",
    "gender": "female",
    "date_of_birth": "1985-03-15",
    "notes": "Patient has a history of anxiety. Prefers afternoon appointments.",
    "latest_medications": [ … ],
    "user": { … },
    "timeline": [ … ],
    "encounters": [ … ],
    "meta": {},
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  },
  "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
  },
  "team_id": 5,
  "user_id": 42,
  "user": {
    "id": 12345,
    "name": "Dr. Sarah Johnson",
    "email": "sarah.johnson@nextvisit.ai",
    "created_at": "2023-03-15T09:12:34Z",
    "updated_at": "2023-05-22T14:07:53Z"
  },
  "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,
  "created_at": "2023-04-10T15:30:00Z",
  "updated_at": "2023-04-10T15:45:00Z"
}

Update a progress note

Request

Updates an existing progress note

Security
bearerAuth
Path
idintegerrequired

Progress note unique identifier

Bodyapplication/jsonrequired
namestring

Name or title of the progress note

Example: "Follow-up Visit - Jane Doe"
transcriptionstring

Transcribed content of the audio recording

Example: "Patient reports improvement in symptoms since last visit."
analysisstring

AI-generated analysis of the transcription

Example: "Patient presents with improved symptoms. Continue current treatment plan."
curl -i -X PUT \
  'https://developers.nextvisit.app/_mock/openapi/v1/progress-notes/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Follow-up Visit - Jane Doe",
    "transcription": "Patient reports improvement in symptoms since last visit.",
    "analysis": "Patient presents with improved symptoms. Continue current treatment plan."
  }'

Responses

Progress note updated successfully

Bodyapplication/json
idinteger(int64)required

Unique identifier for the progress note

Example: 123
namestringrequired

Name or title of the progress note

Example: "Follow-up Visit - Jane Doe"
transcriptionstring

Transcribed content of the audio recording

Example: "Patient reports improvement in symptoms since last visit..."
analysisstring

AI-generated analysis of the transcription

Example: "Patient's condition has improved with current treatment regimen..."
templateobject
patientobject

Associated patient information

audioobject
hasobject
team_idintegerrequired

ID of the team this note belongs to

Example: 5
user_idintegerrequired

ID of the user who created this note

Example: 42
userobject

Information about the user who created the note

transcription_started_atstring(date-time)

When transcription process started

Example: "2023-04-10T15:35:00Z"
transcription_completed_atstring(date-time)

When transcription was completed

Example: "2023-04-10T15:40:00Z"
analysis_started_atstring(date-time)

When analysis process started

Example: "2023-04-10T15:40:00Z"
analysis_completed_atstring(date-time)

When analysis was completed

Example: "2023-04-10T15:45:00Z"
error_statestring or null

Any error state during processing

Example: null
created_atstring(date-time)required

When the progress note was created

Example: "2023-04-10T15:30:00Z"
updated_atstring(date-time)required

When the progress note was last updated

Example: "2023-04-10T15:45:00Z"
Response
application/json
{
  "id": 123,
  "name": "Follow-up Visit - Jane Doe",
  "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": {
    "id": 789,
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "Jane",
    "middle_name": "Marie",
    "last_name": "Doe",
    "gender": "female",
    "date_of_birth": "1985-03-15",
    "notes": "Patient has a history of anxiety. Prefers afternoon appointments.",
    "latest_medications": [ … ],
    "user": { … },
    "timeline": [ … ],
    "encounters": [ … ],
    "meta": {},
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  },
  "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
  },
  "team_id": 5,
  "user_id": 42,
  "user": {
    "id": 12345,
    "name": "Dr. Sarah Johnson",
    "email": "sarah.johnson@nextvisit.ai",
    "created_at": "2023-03-15T09:12:34Z",
    "updated_at": "2023-05-22T14:07:53Z"
  },
  "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,
  "created_at": "2023-04-10T15:30:00Z",
  "updated_at": "2023-04-10T15:45:00Z"
}

Delete a progress note

Request

Deletes a progress note and its associated files

Security
bearerAuth
Path
idintegerrequired

Progress note unique identifier

curl -i -X DELETE \
  'https://developers.nextvisit.app/_mock/openapi/v1/progress-notes/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Progress note deleted successfully

Bodyapplication/json
messagestring
Example: "Progress note deleted successfully"
Response
application/json
{
  "message": "Progress note deleted successfully"
}

Sign a progress note

Request

Marks a progress note as reviewed and signed

Security
bearerAuth
Path
idintegerrequired

Progress note unique identifier

curl -i -X PUT \
  'https://developers.nextvisit.app/_mock/openapi/v1/progress-notes/{id}/sign' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Progress note signed successfully

Bodyapplication/json
idinteger(int64)required

Unique identifier for the progress note

Example: 123
namestringrequired

Name or title of the progress note

Example: "Follow-up Visit - Jane Doe"
transcriptionstring

Transcribed content of the audio recording

Example: "Patient reports improvement in symptoms since last visit..."
analysisstring

AI-generated analysis of the transcription

Example: "Patient's condition has improved with current treatment regimen..."
templateobject
patientobject

Associated patient information

audioobject
hasobject
team_idintegerrequired

ID of the team this note belongs to

Example: 5
user_idintegerrequired

ID of the user who created this note

Example: 42
userobject

Information about the user who created the note

transcription_started_atstring(date-time)

When transcription process started

Example: "2023-04-10T15:35:00Z"
transcription_completed_atstring(date-time)

When transcription was completed

Example: "2023-04-10T15:40:00Z"
analysis_started_atstring(date-time)

When analysis process started

Example: "2023-04-10T15:40:00Z"
analysis_completed_atstring(date-time)

When analysis was completed

Example: "2023-04-10T15:45:00Z"
error_statestring or null

Any error state during processing

Example: null
created_atstring(date-time)required

When the progress note was created

Example: "2023-04-10T15:30:00Z"
updated_atstring(date-time)required

When the progress note was last updated

Example: "2023-04-10T15:45:00Z"
Response
application/json
{
  "id": 123,
  "name": "Follow-up Visit - Jane Doe",
  "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": {
    "id": 789,
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "Jane",
    "middle_name": "Marie",
    "last_name": "Doe",
    "gender": "female",
    "date_of_birth": "1985-03-15",
    "notes": "Patient has a history of anxiety. Prefers afternoon appointments.",
    "latest_medications": [ … ],
    "user": { … },
    "timeline": [ … ],
    "encounters": [ … ],
    "meta": {},
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  },
  "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
  },
  "team_id": 5,
  "user_id": 42,
  "user": {
    "id": 12345,
    "name": "Dr. Sarah Johnson",
    "email": "sarah.johnson@nextvisit.ai",
    "created_at": "2023-03-15T09:12:34Z",
    "updated_at": "2023-05-22T14:07:53Z"
  },
  "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,
  "created_at": "2023-04-10T15:30:00Z",
  "updated_at": "2023-04-10T15:45:00Z"
}

Get audio file URL

Request

Returns a temporary signed URL to access the audio file

Security
bearerAuth
Path
idintegerrequired

Progress note unique identifier

curl -i -X GET \
  'https://developers.nextvisit.app/_mock/openapi/v1/progress-notes/{id}/audio-url' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Audio URL generated successfully

Bodyapplication/json
urlstring

Temporary URL to access the audio file

Example: "https://storage.nextvisit.app/encounters/abc123.mp3?token=xyz"
Response
application/json
{
  "url": "https://storage.nextvisit.app/encounters/abc123.mp3?token=xyz"
}

Billing

Billing and subscription management including plans, usage tracking, and cost estimates.

Operations

Transcription

Audio transcription services including file upload transcription and temporary API tokens for client-side transcription.

Operations

Patients

Patient management including creating, updating, retrieving, and searching patient records within your team.

Operations