Appointment Availability1

Appointment Reminders3

Appointment Types2

Appointments5

Charges6

Deltas1

Drugs3

Encounter Types1

Encounters4

Extended Patient Details1

Facilities1

Health Maintenance2

Inventory4

Partner Applications3

Patient Allergies1

Patient Charges3

Patient Documents5

Patient Emails1

Patient Facilities/Specialists7

Patient Free-Text Notes4

Patient Health Maintenance2

Patient Images5

Patient Invoices2

Patient Lab Results1

Patient Orders2

Patient Past Medical History1

Patient Portal4

Patient Prescriptions5

Patient Subscriptions2

Patient Supplements4

Patient Tags3

Patient Vaccines1

Patient Vitals8

Patients6

Questionnaires3

Secure Messages2

Supplements5

Tags4

Tasks4

Users3

Vitals3

Appointments

Get all appointments

Get all appointments for a specified date range

get/appointments

Request

Base URL: https://clinic-subdomain.md-hq.com/api/v1
URL: https://clinic-subdomain.md-hq.com/api/v1/appointments
Auth: HTTP basic

Query parameters

start_datestring required

Starting date of the date range. The start date should be formatted as YYYY-MM-DD.

end_datestring required

Ending date of the date range. The end date should be formatted as YYYY-MM-DD.

provider_idinteger

Provider identifier. If specified, results will be for only that provider.

pt_idinteger

Patient identifier. If specified, results will be for only that patient.

include_cancelledstring

If specified and not empty, results will include cancelled appointments. Any non-empty value is treated as true.

include_work_schedulestring

Include details about when a provider is set to work. Any non-empty value is treated as true.

statusstring[]

Appointment status. If specified, results will be for only the given statuses. Valid statuses include scheduled, confirmed, checked-in, in-room, cancelled. Clinic custom statuses may also be used.

limitinteger

Limit of how many records to return. Often used in conjunction with offset for pagination.

offsetinteger

Offset of where to start the returned records. Often used in conjunction with limit for pagination.

Response

object'list'

total_countinteger

has_moreboolean

Changes

No recorded changes to this operation across all 1 revision of this API.