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

Create a new appointment

post/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

Request body

start_date_timestring required

Starting datetime of the date range. This field should be formatted as YYYY-MM-DD HH:MM.

end_date_timestring required

Ending datetime of the date range. This field should be formatted as YYYY-MM-DD HH:MM.

provider_idsinteger[] required

An array of provider identifiers associated with this appointment.

pt_idinteger

A patient identifier associated with this appointment.

appointment_typestring required

Valid appointment type name.

titlestring required

Display title of the appointment.

appointment_notestring required

Accompanying notes for the appointment.

statusstring

The status of the appointment. Valid statuses include scheduled, confirmed, checked-in, in-room, cancelled. Clinic custom statuses may also be used.

telemedicineboolean

Flag for whether or not this is a telemedicine appointment.

Example request

{
  "start_date_time": "2020-01-01 09:00",
  "end_date_time": "2020-02-01 09:30",
  "provider_ids": [
    1
  ],
  "pt_id": 1,
  "appointment_type": "Preventative Care"
}

Response

Changes

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