Get a single patient

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

{
  "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"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Required range: x > 0

Example:

1

Response

200 - application/json

Object with patient data.

firstname

string

required

Patient first name

Example:

"Harry"

lastname

string

required

Patient last name

Example:

"Potter"

timezone

string

required

Patient timezone

Example:

"Australia/Adelaide"

integer

required

Patient Id

Required range: x > 0

Example:

1

middleName

string | null

Patient middle name

Example:

"James"

preferredName

string | null

Patient preferred name

Example:

"Harry"

title

string | null

Patient title

Example:

"Mr."

string | null

Patient email

Example:

"harry@hogwarts.edu"

sex

string | null

Patient sex

Example:

"Male"

genderIdentity

string | null

Patient gender identity

Example:

"Man"

pronouns

string | null

Patient pronouns

Example:

"They/them"

alert

string | null

Patient alert messages

Example:

"He knows magic"

invoiceRecipientId

integer | null

The invoice receipient (contact) id of this patient

Required range: x > 0

Example:

1

birthdate

Patient birthdate in YYYY-MM-DD format

Example:

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

extraInfo

string | null

Patient extra info

Example:

"Some extra info"

extraBillingInfo

string | null

Patient extra billing info

Example:

"Some extra billing info"

addressL1

string | null

Patient address line 1

Example:

"123 King William Street"

addressL2

string | null

Patient address line 2

Example:

""

addressL3

string | null

Patient address line 3

Example:

""

city

string | null

Patient city

Example:

"Adelaide"

state

string | null

Patient state

Example:

"SA"

postalCode

string | null

Patient post code

Example:

"5000"

country

string | null

Patient country

Example:

"Australia"

phoneNumbers

object[] | null

privacyPolicy

enum<string> | null

Patient privacy policy status

Available options:

No response,

Accepted,

Rejected,

Example:

"Accepted"

ndisNumber

string | null

Patient NDIS number

Example:

"430123456"

ndisInfo

object | null

medicareNum

string | null

Patient Medicare number

Example:

"4444444444"

irn

string | null

Patient Medicare reference number

Example:

"1"

veteransFileNumber

string | null

Patient veterans information

Example:

""

emergencyContactNumber

string | null

Patient emergency contact number

Example:

"0412345678"

emergencyContactName

string | null

Patient emergency contact name

Example:

"Quentin Neely"

emergencyContactRelationship

string | null

Patient emergency contact relationship

Example:

"Brother"

archived

boolean | null

default:false

Whether the patient has been archived

patientTags

string[] | null

Patient tags

Example:

["Self-managed"]

customFields

object[] | null

healthFund

object | null

createdAt

Object creation date time

Example:

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

updatedAt

Object update date time

Example:

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

Create a single patient Update one patient

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

{
  "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"
}

Get started

API Reference

Authorizations

Path Parameters

Response