Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
patient

Create a single patient

Create a single patient

post/patients

Request body

firstnamestring required

Patient first name

lastnamestring required

Patient last name

middleNamestring nullable

Patient middle name

preferredNamestring nullable

Patient preferred name

titlestring nullable

Patient title

emailstring nullable

Patient email

sexstring nullable

Patient sex

genderIdentitystring nullable

Patient gender identity

pronounsstring nullable

Patient pronouns

alertstring nullable

Patient alert messages

invoiceRecipientIdinteger nullable

The invoice receipient (contact) id of this patient

timezonestring nullable

Patient timezone

extraInfostring nullable

Patient extra info

extraBillingInfostring nullable

Patient extra billing info

addressL1string nullable

Patient address line 1

addressL2string nullable

Patient address line 2

addressL3string nullable

Patient address line 3

citystring nullable

Patient city

statestring nullable

Patient state

postalCodestring nullable

Patient post code

countrystring nullable

Patient country

privacyPolicy'No response' | 'Accepted' | 'Rejected' | '' nullable

Patient privacy policy status

ndisNumberstring nullable

Patient NDIS number

medicareNumstring nullable

Patient Medicare number

irnstring nullable

Patient Medicare reference number

veteransFileNumberstring nullable

Patient veterans information

emergencyContactNumberstring nullable

Patient emergency contact number

emergencyContactNamestring nullable

Patient emergency contact name

emergencyContactRelationshipstring nullable

Patient emergency contact relationship

communicationPreference'NONE' | 'SMS' | 'SMS_EMAIL' | 'EMAIL'

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

archivedboolean nullable

Whether the patient has been archived

Example request

{
  "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,
  "timezone": "Australia/Adelaide",
  "extraInfo": "Some extra info",
  "extraBillingInfo": "Some extra billing info",
  "addressL1": "123 King William Street",
  "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",
  "emergencyContactNumber": "0412345678",
  "emergencyContactName": "Quentin Neely",
  "emergencyContactRelationship": "Brother",
  "communicationPreference": "SMS"
}

Response

Successfully created patient

firstnamestring required

Patient first name

lastnamestring required

Patient last name

middleNamestring nullable

Patient middle name

preferredNamestring nullable

Patient preferred name

titlestring nullable

Patient title

emailstring nullable

Patient email

sexstring nullable

Patient sex

genderIdentitystring nullable

Patient gender identity

pronounsstring nullable

Patient pronouns

alertstring nullable

Patient alert messages

invoiceRecipientIdinteger nullable

The invoice receipient (contact) id of this patient

timezonestring nullable

Patient timezone

extraInfostring nullable

Patient extra info

extraBillingInfostring nullable

Patient extra billing info

addressL1string nullable

Patient address line 1

addressL2string nullable

Patient address line 2

addressL3string nullable

Patient address line 3

citystring nullable

Patient city

statestring nullable

Patient state

postalCodestring nullable

Patient post code

countrystring nullable

Patient country

privacyPolicy'No response' | 'Accepted' | 'Rejected' | '' nullable

Patient privacy policy status

ndisNumberstring nullable

Patient NDIS number

medicareNumstring nullable

Patient Medicare number

irnstring nullable

Patient Medicare reference number

veteransFileNumberstring nullable

Patient veterans information

emergencyContactNumberstring nullable

Patient emergency contact number

emergencyContactNamestring nullable

Patient emergency contact name

emergencyContactRelationshipstring nullable

Patient emergency contact relationship

communicationPreference'NONE' | 'SMS' | 'SMS_EMAIL' | 'EMAIL'

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

archivedboolean nullable

Whether the patient has been archived

idinteger required

Patient Id

patientTagsstring[] nullable

Patient tags

Example response

{
  "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,
  "timezone": "Australia/Adelaide",
  "extraInfo": "Some extra info",
  "extraBillingInfo": "Some extra billing info",
  "addressL1": "123 King William Street",
  "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",
  "emergencyContactNumber": "0412345678",
  "emergencyContactName": "Quentin Neely",
  "emergencyContactRelationship": "Brother",
  "communicationPreference": "SMS",
  "id": 1,
  "patientTags": [
    "Self-managed"
  ],
  "healthFund": {
    "name": "AHM",
    "membershipNumber": "12345678",
    "patientNumber": "1",
    "cardIssueNumber": "01"
  }
}