Get a paged array of patients

curl --request GET \
  --url https://api.splose.com/v1/patients \
  --header 'Authorization: Bearer <token>'

{
  "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,
      "birthdate": "1996-07-30T00:00:00.000Z",
      "timezone": "Australia/Adelaide",
      "extraInfo": "Some extra info",
      "extraBillingInfo": "Some extra billing info",
      "addressL1": "123 King William Street",
      "addressL2": "",
      "addressL3": "",
      "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",
      "veteransFileNumber": "",
      "emergencyContactNumber": "0412345678",
      "emergencyContactName": "Quentin Neely",
      "emergencyContactRelationship": "Brother",
      "archived": false,
      "id": 1,
      "patientTags": [
        "Self-managed"
      ],
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "healthFund": {
        "name": "AHM",
        "membershipNumber": "12345678",
        "patientNumber": "1",
        "cardIssueNumber": "01"
      },
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id_gt

integer | null

The starting object id of the next page

Example:

200

id_lt

integer | null

The starting object id of the previous page

Example:

100

update_gt

Search for objects updated after this date time

Example:

"2023-07-30T09:00:00.000Z"

update_lt

Search for objects updated before this date time

Example:

"2023-07-30T09:00:00.000Z"

include_archived

enum<string> | null

default:false

Whether archived objects should be retrieved, default is false

Available options:

true,

false

firstname

string | null

Patient firstname

Example:

"Harry"

lastname

string | null

Patient lastname

Example:

"Potter"

string | null

Patient email

Example:

"harry@hogwarts.edu"

birthdate

string | null

Patient birth date in YYYY-MM-DD format

Example:

"1990-01-01T00:00:00.000Z"

phoneNumber

string | null

Patient phone number without country code

Example:

"0412345678"

patientTag

string | null

Patient tag

Example:

"Self-managed"

Response

200 - application/json

A paged array of patients

data

object[]

required

data.firstname

string

required

Patient first name

Example:

"Harry"

data.lastname

string

required

Patient last name

Example:

"Potter"

data.timezone

string

required

Patient timezone

Example:

"Australia/Adelaide"

data.id

integer

required

Patient Id

Required range: x > 0

Example:

1

data.middleName

string | null

Patient middle name

Example:

"James"

data.preferredName

string | null

Patient preferred name

Example:

"Harry"

data.title

string | null

Patient title

Example:

"Mr."

data.email

string | null

Patient email

Example:

"harry@hogwarts.edu"

data.sex

string | null

Patient sex

Example:

"Male"

data.genderIdentity

string | null

Patient gender identity

Example:

"Man"

data.pronouns

string | null

Patient pronouns

Example:

"They/them"

data.alert

string | null

Patient alert messages

Example:

"He knows magic"

data.invoiceRecipientId

integer | null

The invoice receipient (contact) id of this patient

Required range: x > 0

Example:

1

data.birthdate

Patient birthdate in YYYY-MM-DD format

Example:

"1996-07-30T00:00:00.000Z"

data.extraInfo

string | null

Patient extra info

Example:

"Some extra info"

data.extraBillingInfo

string | null

Patient extra billing info

Example:

"Some extra billing info"

data.addressL1

string | null

Patient address line 1

Example:

"123 King William Street"

data.addressL2

string | null

Patient address line 2

Example:

""

data.addressL3

string | null

Patient address line 3

Example:

""

data.city

string | null

Patient city

Example:

"Adelaide"

data.state

string | null

Patient state

Example:

"SA"

data.postalCode

string | null

Patient post code

Example:

"5000"

data.country

string | null

Patient country

Example:

"Australia"

data.phoneNumbers

object[] | null

data.privacyPolicy

enum<string> | null

Patient privacy policy status

Available options:

No response,

Accepted,

Rejected,

Example:

"Accepted"

data.ndisNumber

string | null

Patient NDIS number

Example:

"430123456"

data.ndisInfo

object | null

data.medicareNum

string | null

Patient Medicare number

Example:

"4444444444"

data.irn

string | null

Patient Medicare reference number

Example:

"1"

data.veteransFileNumber

string | null

Patient veterans information

Example:

""

data.emergencyContactNumber

string | null

Patient emergency contact number

Example:

"0412345678"

data.emergencyContactName

string | null

Patient emergency contact name

Example:

"Quentin Neely"

data.emergencyContactRelationship

string | null

Patient emergency contact relationship

Example:

"Brother"

data.archived

boolean | null

default:false

Whether the patient has been archived

data.patientTags

string[] | null

Patient tags

Example:

["Self-managed"]

data.customFields

object[] | null

data.healthFund

object | null

data.createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

data.updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

links

object

required

Introduction Create a single patient

curl --request GET \
  --url https://api.splose.com/v1/patients \
  --header 'Authorization: Bearer <token>'

{
  "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,
      "birthdate": "1996-07-30T00:00:00.000Z",
      "timezone": "Australia/Adelaide",
      "extraInfo": "Some extra info",
      "extraBillingInfo": "Some extra billing info",
      "addressL1": "123 King William Street",
      "addressL2": "",
      "addressL3": "",
      "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",
      "veteransFileNumber": "",
      "emergencyContactNumber": "0412345678",
      "emergencyContactName": "Quentin Neely",
      "emergencyContactRelationship": "Brother",
      "archived": false,
      "id": 1,
      "patientTags": [
        "Self-managed"
      ],
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "healthFund": {
        "name": "AHM",
        "membershipNumber": "12345678",
        "patientNumber": "1",
        "cardIssueNumber": "01"
      },
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Get started

API Reference

Authorizations

Query Parameters

Response