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

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

List patients

Request

Returns a paginated list of patients for the current team with optional filtering, sorting, and includes

Security
bearerAuth
Query
per_pageinteger

Number of items per page

Default 50
sortstring

Sort field. Prefix with - for descending order (e.g., -created_at)

Default "-created_at"
Enum"id""-id""first_name""-first_name""last_name""-last_name""date_of_birth""-date_of_birth""created_at""-created_at"
filter[first_name]string

Filter by first name

filter[last_name]string

Filter by last name

filter[date_of_birth]string(date)

Filter by date of birth

filter[trashed]string

Include soft-deleted patients (with, only, or omit for none)

Enum"with""only"
includestring

Comma-separated list of relationships to include

Example: include=user,team,encounters,demographics
curl -i -X GET \
  'https://developers.nextvisit.app/_mock/openapi/v1/patients?per_page=50&sort=id&filter%5Bfirst_name%5D=string&filter%5Blast_name%5D=string&filter%5Bdate_of_birth%5D=2019-08-24&filter%5Btrashed%5D=with&include=user%2Cteam%2Cencounters%2Cdemographics' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of patients

Bodyapplication/json
dataArray of objects(PatientFull)
linksobject

Pagination links

metaobject

Pagination metadata

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

Create a patient

Request

Creates a new patient record for the current team

Security
bearerAuth
Bodyapplication/jsonrequired
first_namestring<= 255 charactersrequired

Patient's first name

Example: "Jane"
middle_namestring or null<= 255 characters

Patient's middle name

Example: "Marie"
last_namestring<= 255 charactersrequired

Patient's last name

Example: "Doe"
date_of_birthstring(date)required

Patient's date of birth (must be before today)

Example: "1985-03-15"
notesstring or null

Clinical notes about the patient

Example: "New patient referral from Dr. Smith"
allergiesstring or null

Known allergies

Example: "Penicillin, Sulfa drugs"
insurancestring or null

Insurance information

Example: "Blue Cross Blue Shield"
metaobject or null

Additional metadata

curl -i -X POST \
  https://developers.nextvisit.app/_mock/openapi/v1/patients \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "Jane",
    "middle_name": "Marie",
    "last_name": "Doe",
    "date_of_birth": "1985-03-15",
    "notes": "New patient referral from Dr. Smith. History of anxiety and depression.",
    "allergies": "Penicillin, Sulfa drugs",
    "insurance": "Blue Cross Blue Shield"
  }'

Responses

Patient created successfully

Bodyapplication/json
dataobject(PatientFull)
Response
application/json
{
  "data": {
    "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"
  }
}

Get a patient

Request

Returns a single patient by ID with related data including encounters and timeline events

Security
bearerAuth
Path
idintegerrequired

Patient unique identifier

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

Responses

Patient details

Bodyapplication/json
dataobject(PatientFull)
Response
application/json
{
  "data": {
    "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": { … },
    "encounters": [ … ],
    "meta": { … },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-06-20T14:45:00Z"
  }
}

Update a patient

Request

Updates an existing patient record

Security
bearerAuth
Path
idintegerrequired

Patient unique identifier

Bodyapplication/jsonrequired
first_namestring<= 255 characters

Patient's first name

Example: "Jane"
middle_namestring or null<= 255 characters

Patient's middle name

Example: "Marie"
last_namestring<= 255 characters

Patient's last name

Example: "Doe"
date_of_birthstring(date)

Patient's date of birth (must be before today)

Example: "1985-03-15"
notesstring or null

Clinical notes about the patient

Example: "Updated contact information"
allergiesstring or null

Known allergies

Example: "Penicillin, Sulfa drugs"
metaobject or null

Additional metadata

curl -i -X PUT \
  'https://developers.nextvisit.app/_mock/openapi/v1/patients/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "Jane",
    "middle_name": "Marie",
    "last_name": "Doe",
    "date_of_birth": "1985-03-15",
    "notes": "Updated contact information",
    "allergies": "Penicillin, Sulfa drugs",
    "meta": {}
  }'

Responses

Patient updated successfully

Bodyapplication/json
dataobject(PatientFull)
Response
application/json
{
  "data": {
    "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"
  }
}

Delete a patient

Request

Soft deletes a patient record

Security
bearerAuth
Path
idintegerrequired

Patient unique identifier

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

Responses

Patient deleted successfully

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

Search patients

Request

Full-text search across all patients in the current team using Meilisearch

Security
bearerAuth
Query
querystringnon-emptyrequired

Search query string

per_pageinteger[ 1 .. 100 ]

Number of results per page (1-100)

Default 20
sort_bystring

Sort order by updated_at

Default "desc"
Enum"asc""desc"
curl -i -X GET \
  'https://developers.nextvisit.app/_mock/openapi/v1/patients/search?query=string&per_page=20&sort_by=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Search results

Bodyapplication/json
dataArray of objects(PatientFull)
linksobject

Pagination links

metaobject

Pagination metadata

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