NexHealth

Introduction
Authentication
Resource relationships
Response body
Response codes
Versioning
Rate limiting
Contact us

Practice Overview

Institutions
- View institutionsget
- View institutionget
Locations
Operatories
- View operatoriesget
- View operatoryget
Patients
Procedures
- View proceduresget
Providers
- View providersget
- View providerget

Scheduling

Appointment Types
Appointments
Appointment Slots
- View appointment slotsget
Availabilities

Practice Financials

Adjustments
- View adjustmentsget
- View adjustmentget
Charges
- View chargesget
- View chargeget
Insurance Plans
- View insurance plansget
- View insurance planget
Payments
- View paymentsget
- View paymentget

Patient Communication

Document Types
- View document typesget
- View document typeget
Patient Alerts
Patient Documents
- View patient documentsget
- Create patient documentpost
Patient Recalls
- View patient recallsget
- View patient recallget
Recall Types
- View recall typesget
- View recall typeget

NexHealth API

Authenticates
- Retrieve bearer tokenpost
Sync Status
- View sync statusesget
Webhook Endpoints
Webhook Subscriptions

NexHealth

Introduction
Authentication
Resource relationships
Response body
Response codes
Versioning
Rate limiting
Contact us

Practice Overview

Institutions
- View institutionsget
- View institutionget
Locations
Operatories
- View operatoriesget
- View operatoryget
Patients
Procedures
- View proceduresget
Providers
- View providersget
- View providerget

Scheduling

Appointment Types
Appointments
Appointment Slots
- View appointment slotsget
Availabilities

Practice Financials

Adjustments
- View adjustmentsget
- View adjustmentget
Charges
- View chargesget
- View chargeget
Insurance Plans
- View insurance plansget
- View insurance planget
Payments
- View paymentsget
- View paymentget

Patient Communication

Document Types
- View document typesget
- View document typeget
Patient Alerts
Patient Documents
- View patient documentsget
- Create patient documentpost
Patient Recalls
- View patient recallsget
- View patient recallget
Recall Types
- View recall typesget
- View recall typeget

NexHealth API

Authenticates
- Retrieve bearer tokenpost
Sync Status
- View sync statusesget
Webhook Endpoints
Webhook Subscriptions

View appointment type appointment descriptors

get https://nexhealth.info/appointment_types/{id}/appointment_descriptors

URL Expired

The URL for this request expired after 30 days.

🚧
Supported Integrations

Procedure codes are supported for Dentrix, Dentrix Ascend, Dentrix Enterprise, Denticon, Eaglesoft, and Open Dental.

EHR-specific appointment types are supported for Athena health, Dentrix, Dentrix Enterprise, Eaglesoft, and Open Dental.

Learn more about appointment descriptors here.

Path Params

int32

required

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

Id of the associated location, required when appointment types are location specific

descriptor_type

string

Query by descriptor type

Responses

Response body

object

code

boolean

Indicates the success or failure of the request

description

string

Additional context on the request to help with debugging.

error

array of strings

Any errors that occur during the execution of the request.

error

data

array of objects

data

object

int32

Descriptor id

descriptor_type

string

The type of descriptor

name

string

The name of descriptor

code

string

The code of descriptor

location_id

int32

The location this object belongs to

foreign_id

string

Unique identifier of this resource from the integrated system

foreign_id_type

string

Unique identifier for the integrated system itself

data

object

The configuration object, structure depends on the underlying EMR

Has additional fields

active

boolean

Is descriptor active?

last_sync_time

string

Last Sync time

created_at

string

The datetime the descriptor was created in UTC

updated_at

string

The datetime the descriptor was last updated

count

int32

Number of total objects, in case of collection.

Response body

object

code

boolean

Indicates the success or failure of the request.

description

string

Additional context about the request to help with debugging.

data

object

Has additional fields

error

array of strings

Any errors that occured during the execution of the request.

error

Response body

object

code

boolean

Indicates the success or failure of the request.

description

string

Additional context about the request to help with debugging.

data

object

Has additional fields

error

array of strings

Any errors that occured during the execution of the request.

error

Response body

object

code

boolean

Indicates the success or failure of the request.

description

string

Additional context about the request to help with debugging.

data

object

Has additional fields

error

array of strings

Any errors that occured during the execution of the request.

error

Response body

object

code

boolean

Indicates the success or failure of the request.

description

string

Additional context about the request to help with debugging.

data

object

Has additional fields

error

array of strings

Any errors that occured during the execution of the request.

error

Response body

object

code

boolean

Indicates the success or failure of the request.

description

string

Additional context about the request to help with debugging.

data

object

Has additional fields

error

array of strings

Any errors that occured during the execution of the request.

error

Updated 1 day ago

Delete an appointment type

Appointments

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://nexhealth.info/appointment_types/id/appointment_descriptors \
3
     --header 'accept: application/vnd.Nexhealth+json;version=2'

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.Nexhealth+json;version=2

Updated 1 day ago

Delete an appointment type

Appointments

Did this page help you?

NexHealth
Introduction
Authentication
Resource relationships
Response body
Response codes
Versioning
Rate limiting
Contact us

Practice Overview
Institutions
View institutionget
View institutionsget
Locations
View location appointment descriptorsget
View locationget
View locationsget
Operatories
View operatoryget
View operatoriesget
Patients
View patient insurance coveragesget
View patientget
Create patientpost
View patientsget
Procedures
View proceduresget
Providers
View providerget
View providersget

Scheduling
Appointment Types
View appointment type appointment descriptorsget
Delete an appointment typedelete
View an appointment typeget
Edit an appointment typepatch
Create an appointment typepost
View appointment typesget
Appointments
Create appointmentpost
View appointmentsget
View appointment descriptorsget
Edit Appointmentpatch
View appointmentget
Appointment Slots
View appointment slotsget
Availabilities
Delete availabilitydelete
Edit availabilitypatch
View availabilityget
View availabilitiesget
Create availabilitypost

Practice Financials
Adjustments
View adjustmentget
View adjustmentsget
Charges
View chargeget
View chargesget
Insurance Plans
View insurance planget
View insurance plansget
Payments
View paymentget
View paymentsget

Patient Communication
Document Types
View document typeget
View document typesget
Patient Alerts
Edit patient alertpatch
View patient alertget
View patient alertsget
Create patient alertpost
Patient Documents
Create patient documentpost
View patient documentsget
Patient Recalls
View patient recallget
View patient recallsget
Recall Types
View recall typeget
View recall typesget

NexHealth API
Authenticates
Retrieve bearer tokenpost
Sync Status
View sync statusesget
Webhook Endpoints
Delete webhook endpointdelete
Edit webhook endpointpatch
Create webhook endpointpost
View webhook endpointsget
Webhook Subscriptions
Delete webhook subscriptiondelete
Edit webhook subscriptionpatch
Create webhook subscriptionpost
View webhook subscriptionsget

NexHealth
Introduction
Authentication
Resource relationships
Response body
Response codes
Versioning
Rate limiting
Contact us

Practice Overview
Institutions
View institutionget
View institutionsget
Locations
View location appointment descriptorsget
View locationget
View locationsget
Operatories
View operatoryget
View operatoriesget
Patients
View patient insurance coveragesget
View patientget
Create patientpost
View patientsget
Procedures
View proceduresget
Providers
View providerget
View providersget

Scheduling
Appointment Types
View appointment type appointment descriptorsget
Delete an appointment typedelete
View an appointment typeget
Edit an appointment typepatch
Create an appointment typepost
View appointment typesget
Appointments
Create appointmentpost
View appointmentsget
View appointment descriptorsget
Edit Appointmentpatch
View appointmentget
Appointment Slots
View appointment slotsget
Availabilities
Delete availabilitydelete
Edit availabilitypatch
View availabilityget
View availabilitiesget
Create availabilitypost

Practice Financials
Adjustments
View adjustmentget
View adjustmentsget
Charges
View chargeget
View chargesget
Insurance Plans
View insurance planget
View insurance plansget
Payments
View paymentget
View paymentsget

Patient Communication
Document Types
View document typeget
View document typesget
Patient Alerts
Edit patient alertpatch
View patient alertget
View patient alertsget
Create patient alertpost
Patient Documents
Create patient documentpost
View patient documentsget
Patient Recalls
View patient recallget
View patient recallsget
Recall Types
View recall typeget
View recall typesget

NexHealth API
Authenticates
Retrieve bearer tokenpost
Sync Status
View sync statusesget
Webhook Endpoints
Delete webhook endpointdelete
Edit webhook endpointpatch
Create webhook endpointpost
View webhook endpointsget
Webhook Subscriptions
Delete webhook subscriptiondelete
Edit webhook subscriptionpatch
Create webhook subscriptionpost
View webhook subscriptionsget

🚧Supported Integrations

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

🚧
Supported Integrations