Skip to content
/
Create 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
Prod server
https://api.pracsuite.com/v1/

Appointment

test

SchemasOperations

Appointment Type

test

SchemasOperations

Available Appointment

Avaiasldfsdflsd

SchemasOperations

Available Group Appointment

Avaiasldfsdflsd

SchemasOperations

Business

sdfsfd

SchemasOperations

Fee Category

sdfsfd

SchemasOperations

Item

sdfsfd

SchemasOperations

Item Group

sdfsfd

SchemasOperations

Patient

Patients are the people that book in for appointments.

When you're working with patient information, make sure you abide by the relevant regulations for security and privacy.

A couple of fields in the patient record deserve special consideration:

accepted_privacy_policy stores the patient's consent to the business's own privacy policy. Values can be null (no response), true (accepted) or false (rejected). Please consider how this may affect you storing information on this patient.

time_zone will contain a valid IANA time zone identifier if the patient's time zone has been set, or null if it hasn't. It can be set via the API, in which case it accepts IANA time zone identifiers.

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-time)
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)
medicare_claimantsstring

Raw JSON string of claimant objects

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
{
  "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"
  },
  "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-24T14:15:22Z",
  "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": "2019-08-24T14:15:22Z",
  "medicare_claimants": "string",
  "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
}

List all Patients

Request

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

Comma separated search fields

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
emailstring
home_phonestring
work_phonestring
mobilestring
phonestring
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

A list of all patients

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

Security
x-api-key and A-api-key
Bodyapplication/json
first_namestringrequired
surnamestringrequired
date_of_birthstring(date)
address_1string
suburbstring
address_statestring
postcodestring
countrystring
emailstring(email)
genderstring
home_phonestring
mobilestring
preferred_phoneinteger

Home Phone = 1 Mobile = 3

Enum13
fee_cat_idinteger
default_practitioner_business_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 'A-api-key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -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_practitioner_business_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

Successfully create Patient

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-time)
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)
medicare_claimantsstring

Raw JSON string of claimant objects

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
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"
  },
  "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-24T14:15:22Z",
  "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": "2019-08-24T14:15:22Z",
  "medicare_claimants": "string",
  "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
}

Get Patient

Request

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

Responses

Get Patient 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-time)
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)
medicare_claimantsstring

Raw JSON string of claimant objects

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
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"
  },
  "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-24T14:15:22Z",
  "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": "2019-08-24T14:15:22Z",
  "medicare_claimants": "string",
  "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
}

Practitioner

test

SchemasOperations

Profession

test

SchemasOperations

Pronoun

test

SchemasOperations

Resource

test

SchemasOperations

Sex

test

SchemasOperations