View location appointment descriptors

This endpoint returns EHR appointment descriptors associated with the given location, optionally filtered by descriptor_type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the health record system's appointment descriptors for one location, such as procedure codes. The location id goes in the path. Filter by descriptor_type to get one kind of descriptor.

Use the descriptor IDs in the emr_appt_descriptor_ids field of an appointment type. See Appointment types and Read and write procedure codes.

descriptor_type values

descriptor_type is an exact, case-sensitive match on the type name. Every descriptor in the response carries its descriptor_type, so read the unfiltered response first if in doubt. The names by system:

Systemdescriptor_type values
athenahealthAppointment Type
Cloud9Appointment Type, Appointment Status
Curve HeroAppointment Type, Procedure Codes
DenticonAppointment Type, Procedure Codes
DentrixDentrix Appointment Types, Procedure Codes
Dentrix AscendProcedure Codes
Dentrix EnterpriseDentrix Enterprise Appointment Types, Procedure Codes
DolphinAppointment Type, Procedure Codes
EaglesoftEaglesoft Appointment Types, Service Codes
eClinicalWorksVisit Types
ModMedAppointment Type, Visit Reason
NextGen OfficeAppointment Type
Open DentalOpendental Appointment Types, Procedure Codes
OrthoTracOrthotrac Appointment Types, Procedure Codes

A location returns only the types its system has.

Path Params
int32
required

The NexHealth location ID

Query Params
string

Return only descriptors of this type

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.Nexhealth+json;version=2
ChangelogMCP serverErrorsdevelopers@nexhealth.com