Skip to main content
Update single patient

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
required

Patient first name

Minimum string length: 1
Example:

"Harry"

lastname
string
required

Patient last name

Minimum string length: 1
Example:

"Potter"

email
string<email> | null
required

Patient email

Example:

"harry@hogwarts.edu"

sex
string | null
required

Patient sex

Example:

"Male"

genderIdentity
string | null
required

Patient gender identity

Example:

"Man"

alert
string | null
required

Patient alert messages

Example:

"He knows magic"

birthdate
string<date> | null
required

Patient birthdate in YYYY-MM-DD format

Example:

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

city
string | null
required

Patient city

Example:

"Adelaide"

state
string | null
required

Patient state

Example:

"SA"

postalCode
string | null
required

Patient post code

Example:

"5000"

country
string | null
required

Patient country

Example:

"Australia"

phoneNumbers
object[]
required
privacyPolicy
enum<string> | null
required

Patient privacy policy status

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

"Accepted"

ndisNumber
string | null
required

Patient NDIS number

Example:

"430123456"

medicareNum
string | null
required

Patient Medicare number

Example:

"4444444444"

irn
string | null
required

Patient Medicare reference number

Example:

"1"

veteransFileNumber
string | null
required

Patient veterans information

Example:

""

emergencyContactNumber
string | null
required

Patient emergency contact number

Example:

"0412345678"

emergencyContactName
string | null
required

Patient emergency contact name

Example:

"Quentin Neely"

emergencyContactRelationship
string | null
required

Patient emergency contact relationship

Example:

"Brother"

timezone
string | null

Patient timezone

Example:

"Australia/Adelaide"

ndisInfo
object | null
patientTags
string[] | null

Patient tags

Example:
communicationPreference
enum<string>

Patient communication preference

Available options:
NONE,
SMS,
SMS_EMAIL,
EMAIL
Example:

"SMS"

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