v1
latestOpenAPI 3.0.02026-07-26550199.6 KBpatient
Get a paged array of patients
Get a paged array of patients
get/patients
Query parameters
id_gtinteger nullable
The starting object id of the next page
Example:200
id_ltinteger nullable
The starting object id of the previous page
Example:100
include_archived'true' | 'false' nullable
Whether archived objects should be retrieved, default is false
firstnamestring nullable
Patient firstname
Example:Harry
lastnamestring nullable
Patient lastname
Example:Potter
emailstring email nullable
Patient email
Example:harry@hogwarts.edu
birthdatestring nullable
Patient birth date in YYYY-MM-DD format
Example:1990-01-01T00:00:00.000Z
phoneNumberstring nullable
Patient phone number without country code
Example:0412345678
patientTagstring nullable
Patient tag
Example:Self-managed
Response
A paged array of patients
Example response
{
"data": [
{
"firstname": "Harry",
"lastname": "Potter",
"middleName": "James",
"preferredName": "Harry",
"title": "Mr.",
"email": "harry@hogwarts.edu",
"sex": "Male",
"genderIdentity": "Man",
"pronouns": "They/them",
"alert": "He knows magic",
"invoiceRecipientId": 1,
"timezone": "Australia/Adelaide",
"extraInfo": "Some extra info",
"extraBillingInfo": "Some extra billing info",
"addressL1": "123 King William Street",
"city": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"privacyPolicy": "Accepted",
"ndisNumber": "430123456",
"ndisInfo": {
"diagnosis": "Foot Injury",
"nomineeEmail": "nominee@email.com",
"fundManagement": "Plan-managed",
"nomineeLastName": "Clark",
"nomineeFirstName": "Chris",
"nomineeMobileCode": "+61",
"nomineeMobileNumber": "433555111",
"startDate": "2024-02-09T00:00:00.000Z",
"endDate": "2024-02-18T00:00:00.000Z"
},
"medicareNum": "4444444444",
"irn": "1",
"emergencyContactNumber": "0412345678",
"emergencyContactName": "Quentin Neely",
"emergencyContactRelationship": "Brother",
"communicationPreference": "SMS",
"id": 1,
"patientTags": [
"Self-managed"
],
"healthFund": {
"name": "AHM",
"membershipNumber": "12345678",
"patientNumber": "1",
"cardIssueNumber": "01"
}
}
],
"links": {
"previousPage": "/v1/${object_type}?id_gt=200",
"nextPage": "/v1/${object_type}?id_lt=100"
}
}