HearLink icon

HearLink

Create HearLink patients and appointments, and retrieve HearLink records

Actions7

Appointment → Create

AI-generated

Summary

Create a HearLink appointment with specified details.

Inputs

  • simplifyOutput — Whether to return only the HearLink payload instead of the full API response envelope.
  • patientId (required) — The HearLink patient ID for the appointment.
  • appointmentTypeId (required) — The HearLink appointment type ID.
  • clinicId (required) — The HearLink clinic ID.
  • assigneeId (required) — The HearLink user ID assigned to the appointment.
  • date (required) — The appointment date in YYYY-MM-DD format.
  • start (required) — The appointment start time in HH:mm format.
  • end (required) — The appointment end time in HH:mm format.
  • location (required) — Location of the appointment; either 'clinic' or 'home'.
  • sendConfirmation — Whether HearLink should send a confirmation to the patient.
  • appointmentAdditionalFields — Additional optional fields for the appointment such as notes or referral ID.

Output shape

object representing the created appointment

If simplifyOutput is true, only the appointment payload is returned; otherwise the full API response envelope is returned. The response includes the newly created appointment data.

Examples

Example 1: Create a simple appointment

Set operation to Create, fill required fields (patientId, appointmentTypeId, clinicId, assigneeId, date, start, end, location) with placeholder values; leave simplifyOutput and sendConfirmation at defaults.

Example 2: Create an appointment with confirmation and extra fields

Enable sendConfirmation=true, add a note via appointmentAdditionalFields.additionalNote, and provide values for all required parameters.

Links

Discussion