Skip to main content
Create a single patient

Authorizations

Authorization
string
header
required

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

Body

application/json
firstname
string
required

Patient first name

Example:

"Harry"

lastname
string
required

Patient last name

Example:

"Potter"

middleName
string | null

Patient middle name

Example:

"James"

preferredName
string | null

Patient preferred name

Example:

"Harry"

title
string | null

Patient title

Example:

"Mr."

email
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"

timezone
string | null

Patient timezone

Example:

"Australia/Adelaide"

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"

communicationPreference
enum<string>

Patient communication preference (defaults to organisation's communication preference if not set)

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

"SMS"

archived
boolean | null
default:false

Whether the patient has been archived

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 - application/json

Successfully created patient

firstname
string
required

Patient first name

Example:

"Harry"

lastname
string
required

Patient last name

Example:

"Potter"

id
integer
required

Patient Id

Required range: x > 0
Example:

1

deletedAt
required

Object archived date time

Example:

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

middleName
string | null

Patient middle name

Example:

"James"

preferredName
string | null

Patient preferred name

Example:

"Harry"

title
string | null

Patient title

Example:

"Mr."

email
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"

timezone
string | null

Patient timezone

Example:

"Australia/Adelaide"

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"

communicationPreference
enum<string>

Patient communication preference (defaults to organisation's communication preference if not set)

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

"SMS"

archived
boolean | null
default:false

Whether the patient has been archived

patientTags
string[] | null

Patient tags

Example:
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"