HearLink icon

HearLink

Create HearLink patients and appointments, and retrieve HearLink records

Actions7

Patient → Create

AI-generated

Summary

Creates a new patient record in HearLink using a full name, phone number, and required identifiers for referral, clinic, and status.

Inputs

  • fullName (required) — The full name of the patient.
  • primaryPhoneNumber (required) — The patient’s primary phone number.
  • referralIdentifierType (required) — Choose whether to identify the referral by ID or by name.
  • referralId (required) — The HearLink referral ID (shown when referralIdentifierType is 'id').
  • referralName (required) — The HearLink referral name (shown when referralIdentifierType is 'name').
  • primaryClinicIdentifierType (required) — Choose whether to identify the primary clinic by ID or by name.
  • primaryClinicId (required) — The HearLink primary clinic ID (shown when primaryClinicIdentifierType is 'id').
  • primaryClinicName (required) — The HearLink primary clinic name (shown when primaryClinicIdentifierType is 'name').
  • statusIdentifierType (required) — Choose whether to identify the status by ID or by name.
  • statusId (required) — The HearLink status ID (shown when statusIdentifierType is 'id').
  • statusName (required) — The HearLink status name (shown when statusIdentifierType is 'name').
  • trackingProvider (required) — The marketing or tracking provider name required by HearLink.
  • trackingIds — Optional tracking identifiers as a JSON object.
  • address — Optional patient address as a JSON object.
  • patientAdditionalFields — A collection of optional fields including secondary phone number, email, date of birth, age, gender, notes, title, UTM parameters, and a choice between secondary status ID or name.

Output shape

a single record

Returns the full API response envelope unless 'Simplify Output' is set to false, in which case it returns only the data payload. Uses the HearLink API endpoint /patients/create.

Examples

Example 1: Create a patient with a referral by name and status by ID

Set referralIdentifierType to 'name' and provide referralName; set statusIdentifierType to 'id' and provide statusId.

Example 2: Create a patient with tracking and UTM parameters

Provide trackingProvider, populate trackingIds as JSON, and add UTM fields to patientAdditionalFields.

Links

Discussion