| Required parameters | Type | Description |
| firstName | String(50) | The client’s first name |
| lastName | String(50) | The client’s surname. |
| dateOfBirth | Date | The date of birth of the client. |
| Example request | URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/
BODY: |
| Example response |
|
| Optional parameters | Type | Description | ||
| title | String | The patient’s title – Acs Prof, Dr, Master, Miss, Mr, Mrs, Ms, Prof, Rev | ||
| preferredName | String | The patient’s preferred name | ||
| gender | String | The patient’s gender – Male or Female or Other or empty. | ||
| medicareCardNumber | String(20) | The patient’s medicare card number | ||
| medicareCardIRN | String(1) | The patient’s medicare IRN number | ||
| medicareCardExpiry | Date | The expiry date of the medicare card number (YYYY-MM) | ||
| dvaCardNumber | String(20) | The patient’s dva card number | ||
| phoneNumberHome | String(50) | The patient’s home phone number | ||
| phoneNumberWork | String(50) | The patient’s work phone number | ||
| phoneNumberMobile | String(50) | The patient’s mobile phone number | ||
| Status | String(50) | The patient’s status – Current, Closed, Deleted, Deceased | ||
| String(50) | The patient’s email address | |||
| addressResidential | The patient’s address {“streetAddress”:””,”city”:””,”postcode”:””,”state”:””} | |||
| addressPostal | The Patient’s postal address {“streetAddress”:””,”city”:””,”postcode”:””,”state”:””} | |||
| postalSameAsResidential | Boolean | |||
| notes1 | String(300) | Patient Overview Notes field 1 | ||
| notes2 | String(300) | Patient Overview Notes field 2 | ||
| practitionerId | Object containing Id | Patient’s assigned case manager (from Practitioner Get endpoint) | ||
| allocatedLocationId | Object containing Id | Patient’s assigned location (from Location Get endpoint) | ||
| clientGroupId | Object containing Id | Patient’s assigned client group (from ClientGroup Get endpoint, requires advanced permissions for the calling application\user ) | ||
| Example request | URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/
BODY: |
| Example response |
|