Patients

Attribute

Type

Description

patient_id

integer

Unique patient identifier

family_head_id

integer

Family head patient ID

patient_card

string

Patient card number

family_role

enum: Family Head | Family Member

Family relationship to the family head

patient_status

enum: Active | Inactive

Current patient status

record_status

enum: Active | Inactive | Deleted

Current record status

title

string

Patient title (Mr, Mrs, Dr, etc.)

first_name

string

Patient first name

middle_name

string

Patient middle name

surname

string

Patient surname

preferred_name

string

Preferred name

gender

string

Patient gender

birthdate

date

Date of birth

occupation

string

Occupation

email

string

Email address

phone

string

Home phone number

mobile

string

Mobile phone number

work_phone

string

Work phone number

address1

string

Primary address line 1

address2

string

Primary address line 2

postcode

string

Postcode

suburb

string

Suburb

state

string

State

work_address1

string

Work address line 1

work_address2

string

Work address line 2

work_postcode

string

Work postcode

work_suburb

string

Work suburb

work_state

string

Work state

recall_comm_preference

enum: SMS | Email | Letter

Recall communications preference

appointment_comm_preference

enum: SMS | Email | Letter

Appointment communications preference

invoice_comm_preference

enum: SMS | Email | Letter

Invoice communications preference

queries_comm_preference

enum: SMS | Email | Letter

Queries (marketing) communications preference

first_seen_date

date

First seen date

first_treatment_date

date

First treatment date

new_patient_date

date

Calculated new patient date

latest_seen_date

date

Most recent treatment date

practitioner_id

integer

Assigned practitioner ID

location_id

integer

Primary practice location ID

new_patient_location_id

integer

Location where patient was first seen

health_fund_name

string

Health fund name

health_fund_ref_member_id

string

Health fund membership number

health_fund_ref_number

string

Individual reference number (IRN)

fee_level

string

Fee level for billing

medicare_no

string

Medicare number

medicare_IRN

string

Medicare IRN

discount_percent

number

Default discount percentage

recall_date

date

Next recall appointment date

medical_conditions

string

Comma-separated list of medical conditions

alerts

string

Patient alert notes

allergies

string

Comma-separated list of allergies

personal_details

string

Patient personal notes

med_hist_last_updated

date

Last medical history update date

referring_patient_id

integer

Referring patient ID (if patient referral)

referral_source_id

string

Referral source type code

referral_date

date

Date of referral

created_date

date-time

Patient record creation timestamp

updated_date

date-time

Patient record last update timestamp

custom_field_*

string

Practice-defined custom fields flattened into top-level keys using the custom_field_ prefix followed by the actual custom name (e.g. custom_field_Preferred Hygienist)