v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

patient

Update single patient

put/patients/{id}

Path parameters

idinteger required

Example:1

Request body

firstnamestring required

Patient first name

lastnamestring required

Patient last name

emailstring email nullable required

Patient email

sexstring nullable required

Patient sex

genderIdentitystring nullable required

Patient gender identity

alertstring nullable required

Patient alert messages

birthdatestring date nullable required

Patient birthdate in YYYY-MM-DD format

timezonestring nullable

Patient timezone

citystring nullable required

Patient city

statestring nullable required

Patient state

postalCodestring nullable required

Patient post code

countrystring nullable required

Patient country

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

Patient privacy policy status

ndisNumberstring nullable required

Patient NDIS number

medicareNumstring nullable required

Patient Medicare number

irnstring nullable required

Patient Medicare reference number

veteransFileNumberstring nullable required

Patient veterans information

emergencyContactNumberstring nullable required

Patient emergency contact number

emergencyContactNamestring nullable required

Patient emergency contact name

emergencyContactRelationshipstring nullable required

Patient emergency contact relationship

patientTagsstring[] nullable

Patient tags

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

Patient communication preference

Example request

{
  "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",
  "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",
  "patientTags": [
    "Self-managed"
  ],
  "communicationPreference": "SMS"
}

Response

Return 1 on success