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

Appointment Types

Create a new appointment type

Creates a new appointment type for the practice. Appointment types define the default duration, color, portal visibility, and automated reminder settings for appointments of this type.

Note: New appointment types are always created as active. To deactivate an appointment type, use the update endpoint after creation.

post/appointment_types

Request

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

Request body

namestring required

The name of the appointment type. Must be unique and contain at least one letter or number.

default_lengthinteger required

Default duration in minutes. Must be between 5 minutes and 12 hours (720 minutes).

name_portalstring

Name displayed on the patient portal. Defaults to the same value as name if not specified.

color_hexstring

Six-character hexadecimal color code (without #) for calendar display. A random color is assigned if not specified.

descriptionstring

Internal description of the appointment type.

allow_on_portalboolean

Whether patients can book this type via the portal.

number_of_overlaps_to_allowinteger

Maximum concurrent appointments of this type allowed (for group appointments).

portal_noticestring

Notice displayed to patients when booking via portal.

which_providersinteger[]

Array of provider IDs who can have this appointment type. Use [0] for all providers.

sort_orderinteger

Display order in appointment type lists.

telemedicineboolean

Whether this is a telemedicine appointment type.

email_notice_onboolean

Send email notification when appointment is created.

email_noticestring

Email body for appointment creation notification.

email_notice_subjectstring

Subject line for appointment creation email.

email_reminder_onboolean

Send automated email reminder before appointment.

email_reminderstring

Email body for reminder.

email_reminder_subjectstring

Subject line for reminder email.

email_reminder_hrs_beforeinteger

Hours before appointment to send email reminder (1 hour to 30 days).

sms_reminder_onboolean

Send automated SMS reminder before appointment.

sms_reminderstring

SMS message text for reminder (max 220 characters).

sms_reminder_hrs_beforeinteger

Hours before appointment to send SMS reminder (1 hour to 30 days).

Example request

{
  "name": "New Patient Consultation",
  "default_length": 60,
  "name_portal": "Initial Consultation",
  "color_hex": "3498DB",
  "description": "First visit for new patients",
  "which_providers": [
    1,
    2,
    5
  ]
}

Response

Appointment type created successfully

object'appointment_type'

idinteger

namestring