Changelog

• Item
  • Add the following q[] filters to List Items endpoint (accepts a timestamp)
    • created
    • updated
    • archived

• Add preferred_name field to practitioner schema

• Update practitioner_name to return preferred name instead of first name in the following endpoints:
  • List available appointment times
  • Get next available appointment time
  • List available group appointments
  • Get next available group appointment time

• Available Appointment
  • Add duration query parameter to List Available Appointments endpoint

• Clinical Note
  • Add account_id field to Create Clinical Note request body
  • Add account_id field to Create Memo request body

• Patient
  • Add the following q[] filters to List Patients endpoint (accepts an integer array)
    • tag_any_ids - matches patients who have any of the supplied tag IDs
    • tag_all_ids - matches patients who have all of the supplied tag IDs
    • tag_exclude_ids - excludes patients who have any of the supplied tag IDs
• Add Integer Array as a new q[] filter value type in Query Filtering

• Patient
  • Add the following fields to Create Patient and Edit Patient request bodies
    • patient_notes
    • patient_warnings
    • health_fund_id
    • health_fund_member_no
    • health_fund_patient_id
    • health_fund_card_issue_no
    • pension_no
    • pension_expiry
    • medicare_no
    • medicare_irn
    • medicare_expiry_year
    • medicare_expiry_month
    • dva_no
    • dva_type
    • ndis_number

• Available Appointment
  • Add requires_single_resource query parameter to List Available Appointments endpoint
  • Add requires_single_resource query parameter to Next Available Appointment endpoint

• Payment
  • Replace payment_date q[] filter with payment_time across all GET Payment endpoints (note: payment_date remains functional)
    • List Payments
    • List Payments by Patient
    • List Payments by Patient Account
    • List Payments by Payer
    • List Payments by Invoice

New Endpoints

• Patient Account - New List Accounts for a Payer endpoint

General

• Payer links response now includes accounts link
• Add payer_id q[] filter to Patient Account list endpoint

• Available Appointment response now returns field row_num
• Available Group Appointment response now returns field row_num
• Increase page_size limit to 200
• Allow sort_by query parameters to include direction modifiers
  eg sort_by=["field_here:asc","field_here:desc"]. See Sorting

Filtering Updates

• Referrer

  • Add created q[] filter
  • Add updated q[] filter

• Add appointment_id q[] filter to these Endpoint groups

  • Appointment Book
  • Appointment
  • Group Appointment
  • Note
  • Rule Out

• Patient Account

  • Remove the following q[] filters
    • phone
    • email

New Endpoints

• Patient Account - New List Patient Accounts endpoint

General

• Add notes field to Create/Edit/Finalise Appointment request body
• Add notes field to Add Group Appointment Member request body
• Add resource_ids field to Reserve Appointment request body
• Add exclude_group_appointments_with_client_ids query parameter to Available Group Appointment endpoints to filter out groups a patient is already booked into

New Endpoint Groups

• Appointment Book - Returns a list of all appointment categories in one call (Appointments, Group Appointments, Notes and Rule Outs)
• Group Appointment

New Endpoints

• Group Appointment Member - New Edit Group Appointment Member endpoint

General

• Business response now returns field appointment_intervals
• Appointment Type response now returns field resource_ids
• Account response now only returns fee_cat_id when override is enabled

Filtering Improvements

• Add phone number query normalisation
  • Phone values passed via q[] filters (eg. q[]=phone:=0411-111-111) are normalised by stripping spaces and dashing before matching
• Payment
  • Add payment_date q[] filter
• Invoice
  • Add invoice_date q[] filter
  • Add invoice_number q[] filter
• Available Appointment
  • Add buffer query parameter
    • Defines minimum buffer in minutes when searching for available appointments
  • Add distinct_times query parameter
    • Allows multiple results for the same time where more than one practitioner is available

General

• Add referrals field to Patient Account response
• Add treatment_plans field to Patient Account response

New Endpoint Groups

• Note
• Rule Out
• Cancelled Appointment
• Health Fund
• Invoice
• Payment
• Organisation
• Patient Attachment
• Patient Contact
• Clinical Note
• Payer
• Payer Contact
• Practitioner Provider Number
• Referrer
• Referrer Type
• Tag
• Tag Category