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 Appointments API

A booking on the Practice's calendar

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

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

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

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

5 operations 3 paths 23 schemas 3 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 Appointments 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 5

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

Appointments 5

A booking on the Practice's calendar

GET
/appointments/{id}
View appointment
getAppointmentsId 3 params → 200400401403404500
PATCH
/appointments/{id}
Edit Appointment
patchAppointmentsId 3 params body → 200400401403404500
GET
/appointments/{id}/appointment_descriptors
View appointment descriptors
getAppointmentsIdAppointmentDescriptors 3 params → 200400401403404500
GET
/appointments
View appointments
getAppointments 20 params → 200400401403404500
POST
/appointments
Create appointment
postAppointments 4 params body → 201400401403404500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are API_V2_Entities_Appointment (42 properties), API_V2_Entities_AppointmentWithoutIncludes (36 properties), API_V2_Entities_PatientWithGuarantor (21 properties), API_V2_Entities_User (14 properties). Each schema is shown below with its type and property counts.

API_Errors_InternalServerError
object
APIErrorsInternalServerError model
4 properties
API_Errors_Forbidden
object
APIErrorsForbidden model
4 properties
API_V2_Entities_AppointmentTypeBasic
object
6 properties
API_V2_Entities_EmrApptDescriptor_Collection_Response
object
APIV2EntitiesEmrApptDescriptorCollectionResponse model
5 properties
API_V2_Entities_Price
object
2 properties
API_V2_Entities_ProcedureBodySite
object
2 properties
API_V2_Entities_Procedure
object
13 properties
API_V2_Entities_Appointment_OnlineBookingDetail
object
5 properties
API_V2_Entities_PatientWithGuarantor
object
21 properties
postAppointments
object
Create appointment
2 properties 1 required
API_V2_Entities_EmrApptDescriptor
object
12 properties
API_V2_Entities_OperatoryBasic
object
11 properties
API_V2_Entities_AppointmentWithoutIncludes_Collection_Response_WithCursor
object
APIV2EntitiesAppointmentWithoutIncludesCollectionResponseWithCursor model
5 properties
API_V2_Entities_AppointmentResponse_Response
object
APIV2EntitiesAppointmentResponseResponse model
5 properties
API_V2_Entities_AppointmentResponse
object
2 properties
patchAppointmentsId
object
Edit Appointment
1 property 1 required
API_V2_Entities_Appointment_Response
object
APIV2EntitiesAppointmentResponse model
5 properties
API_Errors_Unauthorized
object
APIErrorsUnauthorized model
4 properties
API_V2_Entities_User
object
14 properties
API_Errors_BadRequest
object
APIErrorsBadRequest model
4 properties
API_V2_Entities_AppointmentWithoutIncludes
object
36 properties
API_Errors_NotFound
object
APIErrorsNotFound model
4 properties
API_V2_Entities_Appointment
object
42 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexhealth-appointments-api-openapi.yml Raw ↑

Other APIs NexHealth publishes across the network.

NexHealth Adjustment Types API
NexHealth Adjustments API
NexHealth Appointment Types 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