API docs by Redocly

HearLink API (1.0.0)

Download OpenAPI specification:

License: MIT

Programmatic access to HearLink services.

Create a patient

Creates a new patient.
Field groups (exactly one required per group): - referralId or referralName - primaryClinicId or primaryClinicName - statusId or statusName

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
title
string
fullName
required
string non-empty
object (Address)

Patient address details

referralId
string

Provide exactly one of referralId or referralName

referralName
string

Provide exactly one of referralId or referralName

primaryClinicId
string

Provide exactly one of primaryClinicId or primaryClinicName

primaryClinicName
string

Provide exactly one of primaryClinicId or primaryClinicName

statusId
string

Provide exactly one of statusId or statusName

statusName
string

Provide exactly one of statusId or statusName

primaryPhoneNumber
required
string non-empty
secondaryPhoneNumber
string
emailAddress
string <email>
dob
string^\d{4}-\d{2}-\d{2}$

Optional date of birth in YYYY-MM-DD format

age
integer >= 0
gender
string
notes
string
required
object (Tracking)

Tracking/marketing information

Responses

Request samples

Content type
application/json
{
  • "fullName": "John Smith",
  • "primaryPhoneNumber": "07123456789",
  • "emailAddress": "john.smith@example.com",
  • "dob": "1985-07-12",
  • "statusName": "Patient Created",
  • "primaryClinicName": "Manchester",
  • "referralName": "Facebook",
  • "tracking": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}