# Nextvisit API API for the Nextvisit Clinical Documentation platform for developers Version: 1.0.0 License: Proprietary ## Servers Production API ``` https://nextvisit.app/api ``` Beta API ``` https://ea.nextvisit.app/api ``` ## Security ### bearerAuth Type: http Scheme: bearer ## Download OpenAPI description [Nextvisit API](https://developers.nextvisit.app/_bundle/openapi.yaml) ## Tokens User token management endpoints for secure access to the Nextvisit platform. Includes login, logout, and token management operations. ### Create a new access token - [POST /v1/auth/tokens](https://developers.nextvisit.app/openapi/tokens/apicreatetoken.md): Authenticates a user and issues a new access token. When API token verification is enabled (server configuration), users with enhanced security (2FA enabled or linked social providers like Google/Apple) must complete additional verification. Users with 2FA provide their authenticator code via two_factor_code. Users with linked social providers (without 2FA) receive a 6-digit OTP via email and provide it via otp_code. ### List all access tokens - [GET /v1/auth/tokens](https://developers.nextvisit.app/openapi/tokens/apilisttokens.md): Returns a list of the authenticated user's access tokens ### Revoke current token - [DELETE /v1/auth/tokens/current](https://developers.nextvisit.app/openapi/tokens/apirevokecurrenttoken.md): Revokes the current access token used for authentication ### Revoke specific token - [DELETE /v1/auth/tokens/{id}](https://developers.nextvisit.app/openapi/tokens/apirevoketoken.md): Revokes a specific access token by ID ### Authenticate with Google - [POST /v1/auth/google](https://developers.nextvisit.app/openapi/tokens/apigoogleauth.md): Authenticates a user using a Google ID token obtained from Google Sign-In (OAuth 2.0). This endpoint supports tokens from web applications, Chrome extensions, iOS apps, and Android apps. If the user doesn't exist, a new account is automatically created. ## Users User account management including profile updates, permission settings, role assignments, and practice affiliations. ### Get authenticated user - [GET /user](https://developers.nextvisit.app/openapi/users/getauthenticateduser.md): Retrieves the currently authenticated user's details ## Progress Notes Clinical progress note management including creating, updating, retrieving, and signing notes with associated transcriptions and analyses. ### List progress notes - [GET /v1/progress-notes](https://developers.nextvisit.app/openapi/progress-notes/listprogressnotes.md): Returns a paginated list of progress notes with optional filtering ### Create a new progress note - [POST /v1/progress-notes](https://developers.nextvisit.app/openapi/progress-notes/createprogressnote.md): Creates a new progress note either with an audio file or as a text-only note ### Get a specific progress note - [GET /v1/progress-notes/{id}](https://developers.nextvisit.app/openapi/progress-notes/getprogressnote.md): Returns a single progress note by ID ### Update a progress note - [PUT /v1/progress-notes/{id}](https://developers.nextvisit.app/openapi/progress-notes/updateprogressnote.md): Updates an existing progress note ### Delete a progress note - [DELETE /v1/progress-notes/{id}](https://developers.nextvisit.app/openapi/progress-notes/deleteprogressnote.md): Deletes a progress note and its associated files ### Sign a progress note - [PUT /v1/progress-notes/{id}/sign](https://developers.nextvisit.app/openapi/progress-notes/signprogressnote.md): Marks a progress note as reviewed and signed ### Get audio file URL - [GET /v1/progress-notes/{id}/audio-url](https://developers.nextvisit.app/openapi/progress-notes/getprogressnoteaudiourl.md): Returns a temporary signed URL to access the audio file ## Billing Billing and subscription management including plans, usage tracking, and cost estimates. ### List available billing plans - [GET /v1/billing/plans](https://developers.nextvisit.app/openapi/billing/listbillingplans.md): Returns a list of all visible billing plans with their pricing and features ### Get billing cost estimate - [GET /v1/billing/estimate](https://developers.nextvisit.app/openapi/billing/getbillingestimate.md): Returns an estimate of the current billing costs based on the number of users in the team ### Get billing usage statistics - [GET /v1/billing/usage/{module}](https://developers.nextvisit.app/openapi/billing/getbillingusage.md): Returns usage statistics for the current billing period including encounters, peer reviews, and documents ## Transcription Audio transcription services including file upload transcription and temporary API tokens for client-side transcription. ### Transcribe audio file - [POST /v1/transcribe/file](https://developers.nextvisit.app/openapi/transcription/transcribefile.md): Uploads an audio file and returns the transcribed text using AI-powered speech recognition ### Get temporary transcription token - [GET /v1/transcribe/token](https://developers.nextvisit.app/openapi/transcription/gettranscriptiontoken.md): Returns a temporary speech-to-text API token for client-side websocket audio transcription. The token is short-lived and should be used immediately. Requires a paid plan. ## Patients Patient management including creating, updating, retrieving, and searching patient records within your team. ### List patients - [GET /v1/patients](https://developers.nextvisit.app/openapi/patients/listpatients.md): Returns a paginated list of patients for the current team with optional filtering, sorting, and includes ### Create a patient - [POST /v1/patients](https://developers.nextvisit.app/openapi/patients/createpatient.md): Creates a new patient record for the current team ### Get a patient - [GET /v1/patients/{id}](https://developers.nextvisit.app/openapi/patients/getpatient.md): Returns a single patient by ID with related data including encounters and timeline events ### Update a patient - [PUT /v1/patients/{id}](https://developers.nextvisit.app/openapi/patients/updatepatient.md): Updates an existing patient record ### Delete a patient - [DELETE /v1/patients/{id}](https://developers.nextvisit.app/openapi/patients/deletepatient.md): Soft deletes a patient record ### Search patients - [GET /v1/patients/search](https://developers.nextvisit.app/openapi/patients/searchpatients.md): Full-text search across all patients in the current team using Meilisearch