Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NexHealth Appointment Types API

Defines booking parameters for services offerred by the practice

NexHealth Appointment Types API is one of 33 APIs that NexHealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Appointment Types. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version v20240412.

Requests are made against a single base URL, https://nexhealth.info.

6 operations 3 paths 14 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v20240412
Base URL
https://nexhealth.info
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

NexHealth Appointment Types API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Appointment Types 6

Defines booking parameters for services offerred by the practice

GET
/appointment_types
View appointment types
getAppointmentTypes 3 params → 200400401403404500
POST
/appointment_types
Create an appointment type
postAppointmentTypes 1 param body → 201400401403404500
PATCH
/appointment_types/{id}
Edit an appointment type
patchAppointmentTypesId 2 params body → 200400401403404500
GET
/appointment_types/{id}
View an appointment type
getAppointmentTypesId 4 params → 200400401403404500
DELETE
/appointment_types/{id}
Delete an appointment type
deleteAppointmentTypesId 3 params → 200400401403404500
GET
/appointment_types/{id}/appointment_descriptors
View appointment type appointment descriptors
getAppointmentTypesIdAppointmentDescriptors 4 params → 200400401403404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are API_V2_Entities_EmrApptDescriptor (12 properties), API_V2_Entities_AppointmentTypeWithResources (7 properties), API_V2_Entities_AppointmentTypeBasic (6 properties), API_V2_Entities_AppointmentTypeWithResources_Collection_Response (5 properties). Each schema is shown below with its type and property counts.

API_Errors_InternalServerError
object
APIErrorsInternalServerError model
4 properties
API_V2_Entities_AppointmentTypeWithResources_Response
object
APIV2EntitiesAppointmentTypeWithResourcesResponse model
5 properties
API_V2_Entities_AppointmentTypeBasic
object
6 properties
postAppointmentTypes
object
Create an appointment type
2 properties 1 required
API_V2_Entities_AppointmentTypeBasic_Response
object
APIV2EntitiesAppointmentTypeBasicResponse model
5 properties
API_Errors_Unauthorized
object
APIErrorsUnauthorized model
4 properties
API_Errors_Forbidden
object
APIErrorsForbidden model
4 properties
API_Errors_BadRequest
object
APIErrorsBadRequest model
4 properties
API_V2_Entities_EmrApptDescriptor_Collection_Response
object
APIV2EntitiesEmrApptDescriptorCollectionResponse model
5 properties
patchAppointmentTypesId
object
Edit an appointment type
2 properties 1 required
API_V2_Entities_AppointmentTypeWithResources_Collection_Response
object
APIV2EntitiesAppointmentTypeWithResourcesCollectionResponse model
5 properties
API_Errors_NotFound
object
APIErrorsNotFound model
4 properties
API_V2_Entities_EmrApptDescriptor
object
12 properties
API_V2_Entities_AppointmentTypeWithResources
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexhealth-appointment-types-api-openapi.yml Raw ↑

Other APIs NexHealth publishes across the network.

NexHealth Adjustment Types API
NexHealth Adjustments API
NexHealth Appointments API
NexHealth Authenticates API
NexHealth Available Slots API
NexHealth Balances API
NexHealth Charges API
NexHealth Claims API
NexHealth Clinical Notes API
NexHealth Document Types API
NexHealth Fee Schedules API
NexHealth Institutions API