Skip to content

Provider

A provider is a healthcare professional who provides healthcare services to patients.
Examples include: doctor, physician's assistant, nurse, dentist, etc.

Provider Location

An object that pairs a provider with a practice location to surface the availability of that provider at a specific location.

  • One provider can be associated with multiple provider locations.
  • A location can also be a placeholder for virtual visits.

NPI

National Provider Identifier (NPI) is a HIPAA Administrative Simplification Standard.
It is a unique identification number for covered healthcare providers.

Visit Reason

Describes the purpose of the appointment.

Default Visit Reason

Each specialty and provider has a default visit reason.

  • It determines appointment duration and calculates availability when a specific visit reason is not selected.
  • A visit reason is required for retrieving availability.

Specialty

A branch of medical practice that a patient can choose when booking an appointment.
Examples include: dentist, dermatologist, psychiatrist.

Practice

An established entity that provides a set of related services and may consist of multiple providers.

Developer Patient ID

A unique identifier used by 3rd-party developers for internal record-keeping only.
Zocdoc does not utilize this identifier.

Insurance Carrier

A company or entity that provides insurance coverage through specific insurance plans.

Insurance Plan

A specific offering from an insurance carrier detailing:

  • Specific costs
  • Areas of coverage
  • In-network providers

Client Application

An application made by the developer that faces public users and is distributed via a browser or mobile app.

Application Server

A back-end server created by the developer to support their client application.

Client Credentials Flow

The process in which applications obtain an access token from a backend server (also known as Machine-to-Machine authentication).

User Actions on Client Applications

Developers building a patient booking experience where users can search for providers, view availability, and book appointments using a Zocdoc account.

Provider Resource

A professional who performs appointments under the supervision of a bookable provider.

Appointment Status

  • pending_booking: The appointment request has been received but not yet confirmed.
  • confirmed: The appointment is confirmed.
  • booking_failed: The appointment failed to book.
  • cancelled: The appointment is cancelled.
  • no_show: The patient did not appear for a confirmed appointment.
  • pending_reschedule: A reschedule request has been received but not yet confirmed.
  • rescheduled: The appointment is rescheduled.
  • reschedule_failed: The appointment failed to reschedule.

Zocdoc Video Service (ZVS)

Zocdoc’s telemedicine platform enabling virtual appointments via video conferencing and other digital tools.

Appointment Visit Type

  • in_person: Appointment takes place in person.
  • zocdoc_video_service: Virtual appointment on Zocdoc’s Video Service.
  • third_party_video_service: Virtual appointment hosted by the provider.

Waiting Room Path

Patient-facing URL for appointments using Zocdoc Video Service.

  • This link must be provided to the patient to join the appointment.
  • For third-party video platforms, the provider will send the link.

Note: Appointment confirmation should be expected within 24 hours.

Patient Type

Zocdoc’s best assessment of whether a patient has previously received care from a provider.
Determined based on:

  • Patient self-identification during booking
  • Presence of prior appointments with the provider on Zocdoc

Allowed Visit Reason IDs

Set of Zocdoc visit reasons that can be scheduled for a given time slot.

  • Does not override an excluded visit reason.

Excluded Visit Reason IDs

Set of Zocdoc visit reasons that cannot be scheduled for a given time slot.

  • Takes precedence over any allowed visit reason.