Skip to content
/
Edit Patient

PracSuite API (v1)

This is the official PracSuite API.

It follows standard REST conventions, so you can work with it using any HTTP client and any programming language that can send HTTP requests.

All responses are returned in JSON format.

Download OpenAPI description
index.json
index.yaml
Overview
PracSuite API Support
helpdesk@pracsuite.com
License
MIT
Languages
Servers
Production
https://api.pracsuite.com/v1/

Appointment Book

SchemasOperations

Appointment

SchemasOperations

Note

SchemasOperations

Rule Out

SchemasOperations

Group Appointment

SchemasOperations

Group Appointment Member

SchemasOperations

Cancelled Appointment

SchemasOperations

Cancellation Reason

SchemasOperations

Reschedule Reason

SchemasOperations

Appointment Type

SchemasOperations

Appointment Status

SchemasOperations

Available Appointment

You may search for a maximum of 7 days of appointment availability per request.

All availability searches must specify a single appointment_type_id.

Availability may be filtered using any combination of business, practitioner, profession, or resource. When multiple filters are supplied, only times matching all provided criteria will be returned.

PracSuite users define daily practitioner availability using Rosters. Users can apply three availability flags to control which tools can book at particular times:

  • Manual - Allows staff to manually book appointments during these times
  • Online Booking - Allows these times to be booked through the PracSuite online booking system
  • Waiting List - Allows the PracSuite waiting list to offer these times to patients

Use the manual, online, and waiting_list query parameters to filter available times based on these roster flags. If none of these parameters are supplied, only times available for manual bookings will be returned.

Users define default appointment duration rules per Appointment Type. These defaults may vary based on business, profession, practitioner, and client fee category, which is determined by the combination of client_id and account_id.

When available, client_id and account_id should be provided to ensure the correct Appointment Type default configuration is applied.

SchemasOperations

Available Group Appointment

SchemasOperations

Business

SchemasOperations

Fee Category

SchemasOperations

Health Fund

SchemasOperations

Invoice

SchemasOperations

Payment

SchemasOperations

Item

SchemasOperations

Item Group

SchemasOperations

Organisation

SchemasOperations

Patient

SchemasOperations

Patient

linksobject(PatientLinks)
client_idinteger
Example: 1
first_namestring
tenant_idinteger
titlestring
middle_namestring
surnamestring
preferred_namestring
date_of_birthstring(date)
emailstring(email)
genderstring
address_1string
address_2string
address_3string
address_4string
suburbstring
address_statestring
postcodestring
countrystring
home_phonestring
work_phonestring
mobilestring
faxstring
file_nostring
patient_notesstring
patient_warningsstring
fee_categorystring
health_fundstring
health_fund_member_nostring
pension_nostring
pension_expirystring(date)
worksafe_claim_nostring
archiveboolean
occupationstring
default_account_idinteger
medicare_nostring
medicare_irnstring
medicare_expirystring(date)
medicare_claimantboolean
dva_nostring
dva_typestring
health_fund_patient_idinteger
file_createdstring(date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example: "2020-09-12T11:09:42.687393Z"
default_businessstring
default_practitionerstring
referrerstring
referrer_emailstring(email)
referrer_organisationstring
referrer_sourcestring
referral_datestring(date)
medical_warningsstring

HTML content

reminders_notificationsstring

HTML content

gp_namestring
deceasedboolean
family_notesstring
health_fund_card_issue_nostring
covid_vaccination_statusstring
covid_vaccination_datestring(date)
ndis_numberstring
email_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sms_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sexstring
pronounsstring
default_phone_reminderboolean
default_sms_reminderboolean
default_email_reminderboolean
default_sms_confirmationboolean
default_email_confirmationboolean
default_sms_follow_upboolean
default_email_follow_upboolean
medicare_claimantsArray of objects
{
  "links": {
    "self": "https://api.pracsuite.com/v1/patient/1",
    "accounts": "https://api.pracsuite.com/v1/patient/1/account",
    "appointments": "https://api.pracsuite.com/v1/patient/1/appointment",
    "invoices": "https://api.pracsuite.com/v1/patient/1/invoice",
    "patient_attachments": "https://api.pracsuite.com/v1/patient/1/patient_attachment",
    "patient_contacts": "https://api.pracsuite.com/v1/patient/1/patient_contact",
    "payments": "https://api.pracsuite.com/v1/patient/1/payment",
    "tags": "https://api.pracsuite.com/v1/patient/1/tag"
  },
  "client_id": 1,
  "first_name": "string",
  "tenant_id": 0,
  "title": "string",
  "middle_name": "string",
  "surname": "string",
  "preferred_name": "string",
  "date_of_birth": "2019-08-24",
  "email": "user@example.com",
  "gender": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "address_4": "string",
  "suburb": "string",
  "address_state": "string",
  "postcode": "string",
  "country": "string",
  "home_phone": "string",
  "work_phone": "string",
  "mobile": "string",
  "fax": "string",
  "file_no": "string",
  "patient_notes": "string",
  "patient_warnings": "string",
  "fee_category": "string",
  "health_fund": "string",
  "health_fund_member_no": "string",
  "pension_no": "string",
  "pension_expiry": "2019-08-24",
  "worksafe_claim_no": "string",
  "archive": true,
  "occupation": "string",
  "default_account_id": 0,
  "medicare_no": "string",
  "medicare_irn": "string",
  "medicare_expiry": "2019-08-24",
  "medicare_claimant": true,
  "dva_no": "string",
  "dva_type": "string",
  "health_fund_patient_id": 0,
  "file_created": "2020-09-12T11:09:42.687393Z",
  "default_business": "string",
  "default_practitioner": "string",
  "referrer": "string",
  "referrer_email": "user@example.com",
  "referrer_organisation": "string",
  "referrer_source": "string",
  "referral_date": "2019-08-24",
  "medical_warnings": "string",
  "reminders_notifications": "string",
  "gp_name": "string",
  "deceased": true,
  "family_notes": "string",
  "health_fund_card_issue_no": "string",
  "covid_vaccination_status": "string",
  "covid_vaccination_date": "2019-08-24",
  "ndis_number": "string",
  "email_marketing": "Soft Opt-In",
  "sms_marketing": "Soft Opt-In",
  "sex": "string",
  "pronouns": "string",
  "default_phone_reminder": true,
  "default_sms_reminder": true,
  "default_email_reminder": true,
  "default_sms_confirmation": true,
  "default_email_confirmation": true,
  "default_sms_follow_up": true,
  "default_email_follow_up": true,
  "medicare_claimants": [
    { … }
  ]
}

List Patients

Request

Security
x-api-key and a-api-key
Query
pageinteger>= 1
Example: page=1
page_sizeinteger[ 1 .. 200 ]
Example: page_size=50
sort_byArray of strings

Comma separated search fields. See Sorting

Example: sort_by=["client_id","first_name","surname","file_created"]
q[]Array of strings

Filter result by one or more fields.

See Query Filtering

Available filters:

ValueFormat
first_namestring
surnamestring
file_createdtimestamp
date_of_birthdate
preferred_namestring
emailstring
archivedtimestamp
updatedtimestamp
home_phonestring
work_phonestring
mobilestring
phonestring
statusinteger
= only.
Active = 1, Inactive = 2, All = 3, Inactive (excl deceased) = 4, All (excl deceased) = 5, Deceased = 6
email_marketing_typeinteger
= only.
Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4
sms_marketing_typeinteger
= only.
Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4
curl -i -X GET \
  'https://api.pracsuite.com/v1/patient?page=1&page_size=50&sort_by=%5B%22client_id%22%2C%22first_name%22%2C%22surname%22%2C%22file_created%22%5D&q%5B%5D=string' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
clientsArray of objects(PatientWithMeta)
total_entriesinteger
linksobject
Response
application/json
{
  "clients": [
    { … }
  ],
  "total_entries": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/patient?page=2",
    "previous": "https://api.pracsuite.com/v1/patient?page=1",
    "next": "https://api.pracsuite.com/v1/patient?page=3"
  }
}

Create Patient

Request

Although not enforced by the API, a default practitioner is required when creating patient records in PracSuite. If no default practitioner is provided, the system assigns the first active practitioner in the practice.

When creating a patient as part of an appointment booking flow, it is best practice to set the default practitioner to the practitioner associated with the appointment.

Security
x-api-key and a-api-key
Bodyapplication/json
first_namestring<= 40 charactersrequired
surnamestring<= 40 charactersrequired
date_of_birthstring(date)
address_1string<= 100 characters
suburbstring<= 100 characters
address_statestring<= 100 characters
postcodestring<= 10 characters
countrystring<= 100 characters
emailstring(email)<= 100 characters
genderstring<= 20 characters
home_phonestring<= 20 characters
mobilestring<= 20 characters
preferred_phoneinteger

Home Phone = 1 Mobile = 3

Enum13
fee_cat_idinteger
default_business_idinteger
default_practitioner_idinteger
default_sms_reminderboolean
default_email_reminderboolean
default_sms_confirmationboolean
default_email_confirmationboolean
default_sms_follow_upboolean
default_email_follow_upboolean
sms_marketing_typeinteger

Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4

Enum1234
email_marketing_typeinteger

Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4

Enum1234
timezonestring

see: timezones

Example: "Australia/Adelaide"
sex_idinteger
pronoun_idinteger
curl -i -X POST \
  https://api.pracsuite.com/v1/patient \
  -H 'Content-Type: application/json' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "string",
    "surname": "string",
    "date_of_birth": "2019-08-24",
    "address_1": "string",
    "suburb": "string",
    "address_state": "string",
    "postcode": "string",
    "country": "string",
    "email": "user@example.com",
    "gender": "string",
    "home_phone": "string",
    "mobile": "string",
    "preferred_phone": 1,
    "fee_cat_id": 0,
    "default_business_id": 0,
    "default_practitioner_id": 0,
    "default_sms_reminder": true,
    "default_email_reminder": true,
    "default_sms_confirmation": true,
    "default_email_confirmation": true,
    "default_sms_follow_up": true,
    "default_email_follow_up": true,
    "sms_marketing_type": 1,
    "email_marketing_type": 1,
    "timezone": "Australia/Adelaide",
    "sex_id": 0,
    "pronoun_id": 0
  }'

Responses

Successful

Bodyapplication/json
linksobject(PatientLinks)
client_idinteger
Example: 1
first_namestring
tenant_idinteger
titlestring
middle_namestring
surnamestring
preferred_namestring
date_of_birthstring(date)
emailstring(email)
genderstring
address_1string
address_2string
address_3string
address_4string
suburbstring
address_statestring
postcodestring
countrystring
home_phonestring
work_phonestring
mobilestring
faxstring
file_nostring
patient_notesstring
patient_warningsstring
fee_categorystring
health_fundstring
health_fund_member_nostring
pension_nostring
pension_expirystring(date)
worksafe_claim_nostring
archiveboolean
occupationstring
default_account_idinteger
medicare_nostring
medicare_irnstring
medicare_expirystring(date)
medicare_claimantboolean
dva_nostring
dva_typestring
health_fund_patient_idinteger
file_createdstring(date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example: "2020-09-12T11:09:42.687393Z"
default_businessstring
default_practitionerstring
referrerstring
referrer_emailstring(email)
referrer_organisationstring
referrer_sourcestring
referral_datestring(date)
medical_warningsstring

HTML content

reminders_notificationsstring

HTML content

gp_namestring
deceasedboolean
family_notesstring
health_fund_card_issue_nostring
covid_vaccination_statusstring
covid_vaccination_datestring(date)
ndis_numberstring
email_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sms_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sexstring
pronounsstring
default_phone_reminderboolean
default_sms_reminderboolean
default_email_reminderboolean
default_sms_confirmationboolean
default_email_confirmationboolean
default_sms_follow_upboolean
default_email_follow_upboolean
medicare_claimantsArray of objects
Response
application/json
{
  "links": {
    "self": "https://api.pracsuite.com/v1/patient/1",
    "accounts": "https://api.pracsuite.com/v1/patient/1/account",
    "appointments": "https://api.pracsuite.com/v1/patient/1/appointment",
    "invoices": "https://api.pracsuite.com/v1/patient/1/invoice",
    "patient_attachments": "https://api.pracsuite.com/v1/patient/1/patient_attachment",
    "patient_contacts": "https://api.pracsuite.com/v1/patient/1/patient_contact",
    "payments": "https://api.pracsuite.com/v1/patient/1/payment",
    "tags": "https://api.pracsuite.com/v1/patient/1/tag"
  },
  "client_id": 1,
  "first_name": "string",
  "tenant_id": 0,
  "title": "string",
  "middle_name": "string",
  "surname": "string",
  "preferred_name": "string",
  "date_of_birth": "2019-08-24",
  "email": "user@example.com",
  "gender": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "address_4": "string",
  "suburb": "string",
  "address_state": "string",
  "postcode": "string",
  "country": "string",
  "home_phone": "string",
  "work_phone": "string",
  "mobile": "string",
  "fax": "string",
  "file_no": "string",
  "patient_notes": "string",
  "patient_warnings": "string",
  "fee_category": "string",
  "health_fund": "string",
  "health_fund_member_no": "string",
  "pension_no": "string",
  "pension_expiry": "2019-08-24",
  "worksafe_claim_no": "string",
  "archive": true,
  "occupation": "string",
  "default_account_id": 0,
  "medicare_no": "string",
  "medicare_irn": "string",
  "medicare_expiry": "2019-08-24",
  "medicare_claimant": true,
  "dva_no": "string",
  "dva_type": "string",
  "health_fund_patient_id": 0,
  "file_created": "2020-09-12T11:09:42.687393Z",
  "default_business": "string",
  "default_practitioner": "string",
  "referrer": "string",
  "referrer_email": "user@example.com",
  "referrer_organisation": "string",
  "referrer_source": "string",
  "referral_date": "2019-08-24",
  "medical_warnings": "string",
  "reminders_notifications": "string",
  "gp_name": "string",
  "deceased": true,
  "family_notes": "string",
  "health_fund_card_issue_no": "string",
  "covid_vaccination_status": "string",
  "covid_vaccination_date": "2019-08-24",
  "ndis_number": "string",
  "email_marketing": "Soft Opt-In",
  "sms_marketing": "Soft Opt-In",
  "sex": "string",
  "pronouns": "string",
  "default_phone_reminder": true,
  "default_sms_reminder": true,
  "default_email_reminder": true,
  "default_sms_confirmation": true,
  "default_email_confirmation": true,
  "default_sms_follow_up": true,
  "default_email_follow_up": true,
  "medicare_claimants": [
    { … }
  ]
}

Get Patient

Request

Security
x-api-key and a-api-key
Path
client_idintegerrequired
curl -i -X GET \
  'https://api.pracsuite.com/v1/patient/{client_id}' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
linksobject(PatientLinks)
client_idinteger
Example: 1
first_namestring
tenant_idinteger
titlestring
middle_namestring
surnamestring
preferred_namestring
date_of_birthstring(date)
emailstring(email)
genderstring
address_1string
address_2string
address_3string
address_4string
suburbstring
address_statestring
postcodestring
countrystring
home_phonestring
work_phonestring
mobilestring
faxstring
file_nostring
patient_notesstring
patient_warningsstring
fee_categorystring
health_fundstring
health_fund_member_nostring
pension_nostring
pension_expirystring(date)
worksafe_claim_nostring
archiveboolean
occupationstring
default_account_idinteger
medicare_nostring
medicare_irnstring
medicare_expirystring(date)
medicare_claimantboolean
dva_nostring
dva_typestring
health_fund_patient_idinteger
file_createdstring(date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example: "2020-09-12T11:09:42.687393Z"
default_businessstring
default_practitionerstring
referrerstring
referrer_emailstring(email)
referrer_organisationstring
referrer_sourcestring
referral_datestring(date)
medical_warningsstring

HTML content

reminders_notificationsstring

HTML content

gp_namestring
deceasedboolean
family_notesstring
health_fund_card_issue_nostring
covid_vaccination_statusstring
covid_vaccination_datestring(date)
ndis_numberstring
email_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sms_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sexstring
pronounsstring
default_phone_reminderboolean
default_sms_reminderboolean
default_email_reminderboolean
default_sms_confirmationboolean
default_email_confirmationboolean
default_sms_follow_upboolean
default_email_follow_upboolean
medicare_claimantsArray of objects
Response
application/json
{
  "links": {
    "self": "https://api.pracsuite.com/v1/patient/1",
    "accounts": "https://api.pracsuite.com/v1/patient/1/account",
    "appointments": "https://api.pracsuite.com/v1/patient/1/appointment",
    "invoices": "https://api.pracsuite.com/v1/patient/1/invoice",
    "patient_attachments": "https://api.pracsuite.com/v1/patient/1/patient_attachment",
    "patient_contacts": "https://api.pracsuite.com/v1/patient/1/patient_contact",
    "payments": "https://api.pracsuite.com/v1/patient/1/payment",
    "tags": "https://api.pracsuite.com/v1/patient/1/tag"
  },
  "client_id": 1,
  "first_name": "string",
  "tenant_id": 0,
  "title": "string",
  "middle_name": "string",
  "surname": "string",
  "preferred_name": "string",
  "date_of_birth": "2019-08-24",
  "email": "user@example.com",
  "gender": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "address_4": "string",
  "suburb": "string",
  "address_state": "string",
  "postcode": "string",
  "country": "string",
  "home_phone": "string",
  "work_phone": "string",
  "mobile": "string",
  "fax": "string",
  "file_no": "string",
  "patient_notes": "string",
  "patient_warnings": "string",
  "fee_category": "string",
  "health_fund": "string",
  "health_fund_member_no": "string",
  "pension_no": "string",
  "pension_expiry": "2019-08-24",
  "worksafe_claim_no": "string",
  "archive": true,
  "occupation": "string",
  "default_account_id": 0,
  "medicare_no": "string",
  "medicare_irn": "string",
  "medicare_expiry": "2019-08-24",
  "medicare_claimant": true,
  "dva_no": "string",
  "dva_type": "string",
  "health_fund_patient_id": 0,
  "file_created": "2020-09-12T11:09:42.687393Z",
  "default_business": "string",
  "default_practitioner": "string",
  "referrer": "string",
  "referrer_email": "user@example.com",
  "referrer_organisation": "string",
  "referrer_source": "string",
  "referral_date": "2019-08-24",
  "medical_warnings": "string",
  "reminders_notifications": "string",
  "gp_name": "string",
  "deceased": true,
  "family_notes": "string",
  "health_fund_card_issue_no": "string",
  "covid_vaccination_status": "string",
  "covid_vaccination_date": "2019-08-24",
  "ndis_number": "string",
  "email_marketing": "Soft Opt-In",
  "sms_marketing": "Soft Opt-In",
  "sex": "string",
  "pronouns": "string",
  "default_phone_reminder": true,
  "default_sms_reminder": true,
  "default_email_reminder": true,
  "default_sms_confirmation": true,
  "default_email_confirmation": true,
  "default_sms_follow_up": true,
  "default_email_follow_up": true,
  "medicare_claimants": [
    { … }
  ]
}

Edit Patient

Request

Security
x-api-key and a-api-key
Path
client_idintegerrequired
Bodyapplication/json
first_namestring<= 40 characters
surnamestring<= 40 characters
date_of_birthstring(date)
address_1string<= 100 characters
suburbstring<= 100 characters
address_statestring<= 100 characters
postcodestring<= 10 characters
countrystring<= 100 characters
emailstring(email)<= 100 characters
genderstring<= 20 characters
home_phonestring<= 20 characters
mobilestring<= 20 characters
preferred_phoneinteger

Home Phone = 1 Mobile = 3

Enum13
fee_cat_idinteger
default_business_idinteger
default_practitioner_idinteger
default_sms_reminderboolean
default_email_reminderboolean
default_sms_confirmationboolean
default_email_confirmationboolean
default_sms_follow_upboolean
default_email_follow_upboolean
sms_marketing_typeinteger

Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4

Enum1234
email_marketing_typeinteger

Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4

Enum1234
timezonestring

see: timezones

Example: "Australia/Adelaide"
sex_idinteger
pronoun_idinteger
curl -i -X PATCH \
  'https://api.pracsuite.com/v1/patient/{client_id}' \
  -H 'Content-Type: application/json' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "first_name": "string",
    "surname": "string",
    "date_of_birth": "2019-08-24",
    "address_1": "string",
    "suburb": "string",
    "address_state": "string",
    "postcode": "string",
    "country": "string",
    "email": "user@example.com",
    "gender": "string",
    "home_phone": "string",
    "mobile": "string",
    "preferred_phone": 1,
    "fee_cat_id": 0,
    "default_business_id": 0,
    "default_practitioner_id": 0,
    "default_sms_reminder": true,
    "default_email_reminder": true,
    "default_sms_confirmation": true,
    "default_email_confirmation": true,
    "default_sms_follow_up": true,
    "default_email_follow_up": true,
    "sms_marketing_type": 1,
    "email_marketing_type": 1,
    "timezone": "Australia/Adelaide",
    "sex_id": 0,
    "pronoun_id": 0
  }'

Responses

Successful

Bodyapplication/json
linksobject(PatientLinks)
client_idinteger
Example: 1
first_namestring
tenant_idinteger
titlestring
middle_namestring
surnamestring
preferred_namestring
date_of_birthstring(date)
emailstring(email)
genderstring
address_1string
address_2string
address_3string
address_4string
suburbstring
address_statestring
postcodestring
countrystring
home_phonestring
work_phonestring
mobilestring
faxstring
file_nostring
patient_notesstring
patient_warningsstring
fee_categorystring
health_fundstring
health_fund_member_nostring
pension_nostring
pension_expirystring(date)
worksafe_claim_nostring
archiveboolean
occupationstring
default_account_idinteger
medicare_nostring
medicare_irnstring
medicare_expirystring(date)
medicare_claimantboolean
dva_nostring
dva_typestring
health_fund_patient_idinteger
file_createdstring(date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example: "2020-09-12T11:09:42.687393Z"
default_businessstring
default_practitionerstring
referrerstring
referrer_emailstring(email)
referrer_organisationstring
referrer_sourcestring
referral_datestring(date)
medical_warningsstring

HTML content

reminders_notificationsstring

HTML content

gp_namestring
deceasedboolean
family_notesstring
health_fund_card_issue_nostring
covid_vaccination_statusstring
covid_vaccination_datestring(date)
ndis_numberstring
email_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sms_marketingstring
Enum"Soft Opt-In""Opt-In""Soft Opt-Out""Opt-Out"
sexstring
pronounsstring
default_phone_reminderboolean
default_sms_reminderboolean
default_email_reminderboolean
default_sms_confirmationboolean
default_email_confirmationboolean
default_sms_follow_upboolean
default_email_follow_upboolean
medicare_claimantsArray of objects
Response
application/json
{
  "links": {
    "self": "https://api.pracsuite.com/v1/patient/1",
    "accounts": "https://api.pracsuite.com/v1/patient/1/account",
    "appointments": "https://api.pracsuite.com/v1/patient/1/appointment",
    "invoices": "https://api.pracsuite.com/v1/patient/1/invoice",
    "patient_attachments": "https://api.pracsuite.com/v1/patient/1/patient_attachment",
    "patient_contacts": "https://api.pracsuite.com/v1/patient/1/patient_contact",
    "payments": "https://api.pracsuite.com/v1/patient/1/payment",
    "tags": "https://api.pracsuite.com/v1/patient/1/tag"
  },
  "client_id": 1,
  "first_name": "string",
  "tenant_id": 0,
  "title": "string",
  "middle_name": "string",
  "surname": "string",
  "preferred_name": "string",
  "date_of_birth": "2019-08-24",
  "email": "user@example.com",
  "gender": "string",
  "address_1": "string",
  "address_2": "string",
  "address_3": "string",
  "address_4": "string",
  "suburb": "string",
  "address_state": "string",
  "postcode": "string",
  "country": "string",
  "home_phone": "string",
  "work_phone": "string",
  "mobile": "string",
  "fax": "string",
  "file_no": "string",
  "patient_notes": "string",
  "patient_warnings": "string",
  "fee_category": "string",
  "health_fund": "string",
  "health_fund_member_no": "string",
  "pension_no": "string",
  "pension_expiry": "2019-08-24",
  "worksafe_claim_no": "string",
  "archive": true,
  "occupation": "string",
  "default_account_id": 0,
  "medicare_no": "string",
  "medicare_irn": "string",
  "medicare_expiry": "2019-08-24",
  "medicare_claimant": true,
  "dva_no": "string",
  "dva_type": "string",
  "health_fund_patient_id": 0,
  "file_created": "2020-09-12T11:09:42.687393Z",
  "default_business": "string",
  "default_practitioner": "string",
  "referrer": "string",
  "referrer_email": "user@example.com",
  "referrer_organisation": "string",
  "referrer_source": "string",
  "referral_date": "2019-08-24",
  "medical_warnings": "string",
  "reminders_notifications": "string",
  "gp_name": "string",
  "deceased": true,
  "family_notes": "string",
  "health_fund_card_issue_no": "string",
  "covid_vaccination_status": "string",
  "covid_vaccination_date": "2019-08-24",
  "ndis_number": "string",
  "email_marketing": "Soft Opt-In",
  "sms_marketing": "Soft Opt-In",
  "sex": "string",
  "pronouns": "string",
  "default_phone_reminder": true,
  "default_sms_reminder": true,
  "default_email_reminder": true,
  "default_sms_confirmation": true,
  "default_email_confirmation": true,
  "default_sms_follow_up": true,
  "default_email_follow_up": true,
  "medicare_claimants": [
    { … }
  ]
}

Patient Account

SchemasOperations

Patient Attachment

SchemasOperations

Patient Contact

SchemasOperations

Clinical Note

Rich text HTML is supported with a safe, limited set of elements and inline styles. Any unsupported tags, attributes, or CSS are removed automatically.

Supported elements

p, br, strong, em, i, u, blockquote, ul, ol, li, div, span, table, thead, tbody, tfoot, tr, td, th, colgroup, col, caption, img (base64 images only)

Images

Images must be embedded as base64 data URIs. Only PNG, JPEG/JPG, GIF, and WebP image types are supported. External image URLs and other formats are not permitted.

Supported inline CSS

Common formatting and table layout styles are allowed, including text styling, alignment, spacing, borders, and table sizing (color, font-size, text-align, padding, width, height, border, etc.). Unsupported styles are removed automatically.

Content limits

Rich text content must be 150,000 characters or less after processing.

Operations

Payer

SchemasOperations

Payer Contact

SchemasOperations

Practitioner

SchemasOperations

Practitioner Provider Number

SchemasOperations

Profession

SchemasOperations

Pronoun

SchemasOperations

Referrer

SchemasOperations

Referrer Type

SchemasOperations

Resource

SchemasOperations

Sex

SchemasOperations

Tag

SchemasOperations

Tag Category

SchemasOperations