Skip to main content
Update single patient
curl --request PUT \
  --url https://api.splose.com/v1/patients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstname": "Harry",
  "lastname": "Potter",
  "email": "harry@hogwarts.edu",
  "sex": "Male",
  "genderIdentity": "Man",
  "alert": "He knows magic",
  "birthdate": "1996-07-30T00:00:00.000Z",
  "timezone": "Australia/Adelaide",
  "city": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ],
  "privacyPolicy": "Accepted",
  "healthFund": {
    "name": "AHM",
    "membershipNumber": "12345678",
    "patientNumber": "1",
    "cardIssueNumber": "01"
  },
  "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",
  "patientTags": [
    "Self-managed"
  ],
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}'
1

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required
Required range: x > 0
Example:

1

Body

application/json
​
firstname
string

Patient first name

Minimum length: 1
Example:

"Harry"

​
lastname
string

Patient last name

Minimum length: 1
Example:

"Potter"

​
email
string<email> | null

Patient email

Example:

"harry@hogwarts.edu"

​
sex
string | null

Patient sex

Example:

"Male"

​
genderIdentity
string | null

Patient gender identity

Example:

"Man"

​
alert
string | null

Patient alert messages

Example:

"He knows magic"

​
birthdate
string | null

Patient birthdate in YYYY-MM-DD format

Example:

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

​
timezone
string | null

Patient timezone

Example:

"Australia/Adelaide"

​
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[]
​
privacyPolicy
enum<string> | null

Patient privacy policy status

Available options:
No response,
Accepted,
Rejected,
Example:

"Accepted"

​
healthFund
object
​
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"

​
patientTags
string[] | null

Patient tags

Example:
["Self-managed"]
​
customFields
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"

Response

200 - text

Return 1 on success

The response is of type enum<number>.

Available options:
1