---
title: "GetEmployeeDetails"
id: "getemployeedetails"
project: "EHR User Guide"
url: "https://help.cloud5.com.au/articles/ehr-user-guide/getemployeedetails"
updated: 2026-10-19T00:53:40Z
---

# GetEmployeeDetails

Below are the request restrictions available when retrieving the employee personal details returned by the EmpowerStandardExtract web service via ‘GetEmployeeDetails’.

| **Request Element** | **Options** | **Default** |
| --- | --- | --- |
| Restriction/EmployeeCodes/EmployeeCode | Include <br>exclude |  |
| Restriction/EmployeeStatuses/StatusCode | Include <br>exclude |  |
| Restriction/NonEmployees | Include <br>exclude | include |
| Restriction/DeletedEmployees | Include <br>exclude | exclude |
| Restriction/Surname | Include <br>exclude |  |
| Restriction/GivenName | Include <br>exclude |  |
| Restriction/StartDate | Include <br>exclude |  |

To include deleted employees set the ‘Restriction/DeletedEmployees’ element to ‘include’. By default deleted employees are not included in the extract.

Employees retrieved can be restricted via their employee codes and status codes. The restriction can either be to include or exclude employees based on their employee and status codes.

Below is an example where only employees with employee codes of ‘000001’ or ‘000008’ would be retrieved:

![](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2025-09-12.png)

Below is an example where employees with employee codes of ‘000001’ or ‘000008’ would not be retrieved:

![](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2025-09-12-1.png)

Below is an example where only employees with status codes of ‘e’ or ‘epla’ would be retrieved:

![](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2025-09-12-2.png)

Below is an example where employees with status codes of ‘e’ or ‘epla’ would not be retrieved:

![](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2025-09-12-3.png)

To exclude non employees set the ‘Restriction/NonEmployees’ element to ‘exclude’. By default, non employees are included in the extract.

| Available from version 2025.1.05
If you're using EmpowerHR 2025.1.05 or later, you can filter employees by surname, given name, and start date.<br><br>The 'Restriction/Surname' element filters by exact surname (case-insensitive). The 'Restriction/GivenName' element filters from the beginning of the given name field (case-insensitive), so 'Rob' would<br>match 'Robert', 'Robin', or 'Rob James'. The 'Restriction/StartDate' element filters by employment start date and accepts formats such as dd/MM/yyyy, dd MMM yyyy, and ddMMMyyyy.<br><br>Below is an example where employees with surname 'Smith' and given name 'John' would be retrieved:<br><br><br>![Screenshot of example where employees with surname 'Smith' and given name 'John' would be retrieved](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2026-03-23-1.png)<br><br><br><br>Below is an example where employees with start date '24 Apr 2024' would be retrieved:<br><br><br>![Screenshot of example where employees with start date '24 Apr 2024' would be retrieved](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2026-03-23-2.png)<br><br><br><br>Below is an example where employees with surname 'Johnstone' and start date '24 Apr 2024' would be retrieved:<br><br><br>![Screenshot of example where employees with surname 'Johnstone' and start date '24 Apr 2024' would be retrieved](/resources/Storage/ehr-user-guide/getemployeedetails/getemployeedetails-2026-03-23-3.png)<br><br> |
| --- |

Below are the employee personal fields returned by the EmpowerStandardExtract web service via ‘GetEmployeeDetails’.

| **Element** | **Default Screen Title** |
| --- | --- |
| Employee /EmployeeCode | Employee Code |
|  | **Personal Tab** |
| Employee/Personal/Name/Title | Title |
| Employee/Personal/Name/FamilyName | Surname |
| Employee/Personal/Name/FirstName | Given Names |
| Employee/Personal/Name/PreferredName | Preferred Name |
| Employee/Personal/Name/PreviousSurname | Previous Surname |
| Employee/Personal/BirthDate | Birth Date |
|  |  |
| Employee/Personal/PrivatePhoneNumber | Private Phone |
| Employee/Personal/PrivateMobile | Private Mobile |
| Employee/Personal/PrivateFax | Private Fax |
| Employee/Personal/PrivateEmail | Private email |
| Employee/Personal/Reference | Reference Number |
| Employee/Personal/Honours | Honours |
| Employee/Personal/ResidencyCitizenship/Code | Residency / Citizenship Code |
| Employee/Personal/ResidencyCitizenship/Description | Residency / Citizenship |
| Employee/Personal/ResidencyCitizenship/Abbreviation | Residency / Citizenship |
| Employee/Personal/Narrative | Narrative |
|  | **Work Place Tab** |
| Employee/WorkPlace/CommencementDateWithAgency | Date Comm Agency |
| Employee/WorkPlace/DateCommService | Date Commenced Service |
| Employee/WorkPlace/AgencyService | N/A |
| Employee/WorkPlace/DateConfirmed | Date Confirmed |
| Employee/WorkPlace/Status/Code | Status Code |
| Employee/WorkPlace/Status/Description | Status |
| Employee/WorkPlace/Status/Abbreviation | Status |
| Employee/WorkPlace/DatePermanent | Date Permanent |
| Employee/WorkPlace/Date | Status Date |
| Employee/WorkPlace/ProbationDate | Probation Date |
| Employee/WorkPlace/EmployeeUserName | Employee User Name |
| Employee/WorkPlace/ExternalAdminUnit/Code | Admin Unit |
| Employee/WorkPlace/ExternalAdminUnit/Description | Admin Unit |
| Employee/WorkPlace/ExternalAdminUnit/Abbreviation | Admin Unit |
| Employee/WorkPlace/BusinessPhone | Work Phone |
| Employee/WorkPlace/BusinessMobile | Mobile Phone |
| Employee/WorkPlace/BusinessFax | Fax |
| Employee/WorkPlace/BusinessEmail | Work Email Address |
| Employee/WorkPlace/FreeField1 | Free Field 1 |
| Employee/WorkPlace/FreeField2 | Free Field 2 |
| Employee/WorkPlace/FreeField7 | Free Field 7 |
| Employee/WorkPlace/FreeField8 | Free Field 8 |
| Employee/WorkPlace/Location1 | Location 1 |
| Employee/WorkPlace/Location2 | Location 2 |
| Employee/WorkPlace/OperatorTemplate | Operator Template |
| Employee/WorkPlace/EssAccess | ESS Access |
| Employee/WorkPlace/AlternateEssTemplate | Alternate ESS Template |
|  | **Addresses Tab** |
| Employee/Addresses/ResidentialAddress/Address1 | Private Address Line 1 |
| Employee/Addresses/ResidentialAddress/Address2 | Private Address Line 2 |
| Employee/Addresses/ResidentialAddress/Suburb | Private Address Suburb |
| Employee/Addresses/ResidentialAddress/Postcode | Private Address Postcode |
| Employee/Addresses/ResidentialAddress/State | Private Address State |
| Employee/Addresses/ResidentialAddress/Country | Private Address Country |
| Employee/Addresses/ResidentialAddress/NewZealandOnly/TownOrCityOrMailtown | Town/City/Mailtown |
| Employee/Addresses/ResidentialAddress/NewZealandOnly/PostCode | Post Code |
| Employee/Addresses/PostalAddress/Address1 | Postal Address Line 1 |
| Employee/Addresses/PostalAddress/Address2 | Postal Address Line 2 |
| Employee/Addresses/PostalAddress/Suburb | Postal Address Suburb |
| Employee/Addresses/PostalAddress/Postcode | Postal Address Postcode |
| Employee/Addresses/PostalAddress/State | Postal Address State |
| Employee/Addresses/PostalAddress/Country | Postal Address Country |
| Employee/Addresses/PostalAddress/NewZealandOnly/TownOrCityOrMailtown | Town/City/Mailtown |
| Employee/Addresses/PostalAddress/NewZealandOnly/PostCode | Post Code |
|  | **Emergency Contact Tab** |
| Employee /EmergencyContacts/EmergencyContact1/NextOfKinName | Next of Kin Name |
| Employee /EmergencyContacts/EmergencyContact1/Relationship/Code | Relationship Code |
| Employee /EmergencyContacts/EmergencyContact1/Relationship/Description | Relationship |
| Employee /EmergencyContacts/EmergencyContact1/Relationship/Abbreviation | Relationship |
| Employee /EmergencyContacts/EmergencyContact1/Phone | Phone |
| Employee /EmergencyContacts/EmergencyContact1/WorkPhone | Emgcy Work Num |
| Employee /EmergencyContacts/EmergencyContact1/MobileNumber | Emgcy Mobile Num |
| Employee /EmergencyContacts/EmergencyContact1/Address/Address1 | Address Line 1 |
| Employee /EmergencyContacts/EmergencyContact1/Address/Address2 | Address Line 2 |
| Employee /EmergencyContacts/EmergencyContact1/Address/Suburb | Address Line 3 |
| Employee /EmergencyContacts/EmergencyContact1/Address/Postcode | Postal Code |
| Employee /EmergencyContacts/EmergencyContact1/Address/State | State |
| Employee /EmergencyContacts/EmergencyContact1/Address/Country | Country |
| Employee/EmergencyContacts /FreeField3 | Free Field 3 |
| Employee /EmergencyContacts/EmergencyContact2/NextOfKinName | Next of Kin Name |
| Employee /EmergencyContacts/EmergencyContact2/Relationship/Code | Relationship Code |
| Employee /EmergencyContacts/EmergencyContact2/Relationship/Description | Relationship |
| Employee /EmergencyContacts/EmergencyContact2/Relationship/Abbreviation | Relationship |
| Employee /EmergencyContacts/EmergencyContact2/Phone | Phone |
| Employee /EmergencyContacts/EmergencyContact2/WorkPhone | Work Phone |
| Employee /EmergencyContacts/EmergencyContact2/MobileNumber | Mobile |
| Employee /EmergencyContacts/EmergencyContact2/Address/Address1 | Address Line 1 |
| Employee /EmergencyContacts/EmergencyContact2/Address/Address2 | Address Line 2 |
| Employee /EmergencyContacts/EmergencyContact2/Address/Suburb | Address Line 3 |
| Employee /EmergencyContacts/EmergencyContact2/Address/Postcode | Postal Code |
| Employee /EmergencyContacts/EmergencyContact2/Address/State | State |
| Employee /EmergencyContacts/EmergencyContact2/Address/Country | Country |
| Employee/EmergencyContacts /FreeField4 | Free Field 4 |
|  | **Next of Kin Tab** |
| Employee/NextOfKin/NextOfKinName | Next of Kin Name |
| Employee/NextOfKin/Relationship/Code | Relationship |
| Employee/NextOfKin/Relationship/Description | Relationship |
| Employee/NextOfKin/Relationship/Abbreviation | Relationship |
| Employee/NextOfKin/Phone | Home Phone |
| Employee/NextOfKin/WorkPhone | Work Phone |
| Employee/NextOfKin/MobileNumber | Mobile |
| Employee/NextOfKin/Address/Address1 | Address Line 1 |
| Employee/NextOfKin/Address/Address2 | Address Line 2 |
| Employee/NextOfKin/Address/Suburb | Address Line 3 |
| Employee/NextOfKin/Address/PostCode | Postal Code |
| Employee/NextOfKin/Address/State | State |
| Employee/NextOfKin/Address/Country | Country |
|  | **Demographics Tab** |
| Employee/Demographics/Indigenous /code | Indigenous Code |
| Employee/Demographics/Indigenous/Description | Indigenous |
| Employee/Demographics/Indigenous/Abbreviation |  |
| Employee/Demographics/CountryofOrigin/Code | Country Of Origin |
| Employee/Demographics/CountryOfOrigin/Description |  |
| Employee/Demographics/CountryOfOrigin/Code/Abbreviation |  |
| Employee/Demographics/Nationality/Code | Nationality |
| Employee/Demographics/Nationality/Description |  |
| Employee/Demographics/Nationality/Abbreviation |  |
| Employee/Demographics/Ethnicity/Code | Ethnicity |
| Employee/Demographics/Ethnicity/Description |  |
| Employee/Demographics/Ethnicity/Abbreviation |  |
| Employee/Demographics/Religion/Code | Religion |
| Employee/Demographics/Religion/Description |  |
| Employee/Demographics/Religion/Abbreviation |  |
| Employee/Demographics/MainLanguage/Code | Main Language Spoken at Home |
| Employee/Demographics/MainLanguage/Description |  |
| Employee/Demographics/MainLanguage/Abbreviation |  |
| Employee/Demographics/CarersResponsibility/Code | Carer’s Responsibility |
| Employee/Demographics/CarersResponsibility/Description |  |
| Employee/Demographics/CarersResponsibility/Abbreviation |  |
| Employee/Demographics/Qualifications/Qualifications level/Code | Highest Qualification Level |
| Employee/Demographics/Qualifications/Qualifications level/Description |  |
| Employee/Demographics/Qualifications/Qualifications level/Abbreviation |  |
| Employee/Demographics/Qualifications/FieldOfStudy/Code | Field Of Study |
| Employee/Demographics/Qualifications/FieldOfStudy/Description |  |
| Employee/Demographics/Qualifications/FieldOfStudy/Abbreviation |  |
| Employee/Demographics /Disability/DisabilityCategory/ Code | Disability Category |
| Employee/Demographics /Disability/DisabilityCategory/Description |  |
| Employee/Demographics /Disability/DisabilityCategory/Abbreviation |  |
| Employee/Demographics/Disability/DisabilityType/Code | Disability Type |
| Employee/Demographics/Disability/DisabilityType/Description |  |
| Employee/Demographics/Disability/DisabilityType/Abbreviation |  |
| Employee/Demographics/Disability/WorkplaceModification/Code | Workplace Modification |
| Employee/Demographics/Disability/WorkplaceModification/Description |  |
| Employee/Demographics/Disability/WorkplaceModification/Abbreviation |  |
| Employee/Demographics/Disability/ImplementedDate | Implemented Date |
| Employee/Demographics/Disability/LastReviewed | Last Reviewed Date |
|  | **Gender Diversity Tab** |
| Employee/GenderDiversity/Gender/Code | Gender |
| Employee/GenderDiversity/Gender/Description |  |
| Employee/GenderDiversity/Gender/Abbreviation |  |
| Employee/GenderDiversity/GenderDescription | Comment |
| Employee/GenderDiversity/GenderIdentity/Code | How do you describe your gender? |
| Employee/GenderDiversity/GenderIdentity/Description |  |
| Employee/GenderDiversity/GenderIdentity/Abbreviation |  |
| Employee/GenderDiversity/<br> <br>AdditionalGenderIdentityInformation | Gender Information |
| Employee/GenderDiversity/SexualOrientation/Code | How do you describe your sexual orientation? |
| Employee/GenderDiversity/SexualOrientation/Description |  |
| Employee/GenderDiversity/SexualOrientatin/Abbreviation |  |
| Employee/GenderDiversity/ AdditionalSexualOrientationInformation | Sexual orientation information |
| Employee/GenderDiversity/Intersex/code | Were you born with a variation of sex characterstics? |
| Employee/GenderDiversity/Intersex/Description |  |
| Employee/GenderDiversity/Intersex/Abbreviation |  |

| Next topic<br> <br>[GetEmployeePositions](/articles/ehr-user-guide/getemployeepositions) |
| --- |

© 2023 Fusion5. All rights reserved.