Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
integer
required
Required range: x > 0

Response

200 - application/json
id
integer
required

Patient Id

Required range: x > 0
firstname
string
required

Patient first name

lastname
string
required

Patient last name

middleName
string | null
required

Patient middle name

preferredName
string | null
required

Patient preferred name

title
string | null
required

Patient title

email
string | null
required

Patient email

sex
string | null
required

Patient sex

genderIdentity
string | null
required

Patient gender identity

pronouns
string | null
required

Patient pronouns

alert
string | null
required

Patient alert messages

invoiceRecipientId
integer | null
required

The invoice receipient (contact) id of this patient

Required range: x > 0
birthdate
string | null
required

Patient birthdate in YYYY-MM-DD format

timezone
string | null
required

Patient timezone

extraInfo
string | null
required

Patient extra info

extraBillingInfo
string | null
required

Patient extra billing info

addressL1
string | null
required

Patient address line 1

addressL2
string | null
required

Patient address line 2

addressL3
string | null
required

Patient address line 3

city
string | null
required

Patient city

state
string | null
required

Patient state

postalCode
string | null
required

Patient post code

country
string | null
required

Patient country

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

Patient privacy policy status

Available options:
No response,
Accepted,
Rejected,
ndisNumber
string | null
required

Patient NDIS number

medicareNum
string | null
required

Patient Medicare number

irn
string | null
required

Patient Medicare reference number

veteransFileNumber
string | null
required

Patient veterans information

emergencyContactNumber
string | null
required

Patient emergency contact number

emergencyContactName
string | null
required

Patient emergency contact name

emergencyContactRelationship
string | null
required

Patient emergency contact relationship

patientTags
string[]
required

Patient tags

createdAt
required

Object creation date time

updatedAt
required

Object update date time

healthFund
object
ndisInfo
object | null
archived
boolean | null
default: false

Whether the patient has been archived

customFields
object[] | null