Skip to content Learn about the access keys available for Metadata.NSW
A NSW Government website
Metadata.NSW (beta)

Definition

Data source details

Path name Data Element Definition Data Type Format
CLIENTID Data Exchange: Client identifier, X(19)

A number that represents a system-generated identifier for a unique client record in the Data Exchange.

CHARACTERSTRING X(18)
DELIVERYORGID Data Exchange: Delivery Organisation identifier, X(19)

A number that represents a system-generated identifier for a unique service provider record in the Data Exchange of an organisation that has been directed to provide services.


Specific Information:

Organisations delivering services directly to clients. These organisations may receive funding directly or through a Funding Recipient.

CHARACTERSTRING X(18)
SLK Record: Linkage key, code 581 XXXXXDDMMYYYYX

A key that enables two or more records belonging to the same individual to be brought together. It is represented by a code consisting of the second, third and fifth characters of a person’s family name, the second and third letters of the person’s given name, the day, month and year when the person was born and the sex of the person, concatenated in that order.

ALPHANUMERICSTRING XXXXXDDMMYYYYX
ISPSEUDONYM Person: Pseudonym Indicator, No/Yes Code N

Whether the name used is fictitious or an alias of a human being, recorded as a numeric code representing 'true' or 'false'.


Specific Information:

Where a client does not wish to disclose their real name, the organisation should indicate that a pseudonym is being used and record a pseudonym that ideally is used again if the client returns for other services.
 

NUMBERSTRING N
BIRTHDATE Person: Date of Birth, YYYYMMDD

The date of birth of the person, expressed as YYYYMMDD.

DATE YYYYMMDD
BIRTHDATEESTIMATED Date: Estimate indicator, No/Yes Code N

An indicator of whether any component of a reported date was estimated.


Specific Information:

Service Providers are given the option to record an estimated date of birth for clients. Where a provider selects to report an estimated birth date, as recorded by the BirthDateEstimated field, providers will only be asked to enter the year of birth. In this case, the date of birth will always be recorded as 1 January. The use of this varies by Service Provider

NUMBERSTRING N
BIRTHMONTH Person: Date of birth, Month MM

The month a given client was born, represented by MM.


Specific Information:

Null where BirthDateEstimated = 1 (TRUE), Service Providers have entered the year of month only - and date of birth is recorded as 1 January within the DEX database. Where providers record full date of birth rather than choosing to record an estimated date of birth, we still do observe large counts of values such as 1 Jan 1900 recorded for example although full date has been recorded, further judgement to determine data quality of such records might be considered. This practice varies by service provider, service delivery method and by activity

BirthMonth = CASE when client.BirthDateEstimated = 0 then DATEPART(MONTH, client.BirthDate) else NULL END"
 

DATE MM
BIRTHYEAR Person: Date of birth, Year YYYY

The year a given client was born, represented by YYYY.


Specific Information:

BirthYear = DATEPART(YEAR, client.BirthDate)

DATE YYYY
GENDERCODE Person: Sex, Gender Label A(8)

The sex identified by a person, represented by a label.

ALPHASTRING A(9)
CLIENTLOCALITY Person: Suburb/town/locality name, Text X(50)

The full name of the locality contained within the specific address of a person, as represented by text.

ALPHANUMERICSTRING X(50)
CLIENTSTATE Person: Australian State/Territory Identifier, Code X(3)

The code that represents the Australian state or territory where a person can be located.

ALPHASTRING X(3)
CLIENTPOSTCODE Person: Australian Postcode, Code NNNN

The numeric descriptor for an Australian postal delivery area, aligned with locality, suburb or place for the address of a person.

NUMBERSTRING NNNN
ANCESTRYCODE Person: Ancestral cultural and ethnic group, (ASCCEG) 2016 code

The ancestral, cultural, and/or ethnic origin identified by a given client, represented by a code.

NUMBERSTRING NNNN
ATSICODE Person: Indigenous Status, Label A(10)

The Aboriginal and/or Torres Strait Islander origin identified by a given client, represented by a label.

ALPHASTRING A(10)
BIRTHCOUNTRYCODE Person: Country of birth, code (SACC 2016) NNNN

The country in which the person was born, as represented by a code.

NUMBERSTRING NNNN
MAINLANGUAGECODE Person: Main language spoken at home, Australian Standard Classification of Languages (ASCL) 2016 code

The main language spoken at home by a given client, represented by a code.

NUMBERSTRING NNNN
CALDSTATUS Person: Culturally and Linguistically Diverse Indicator, label A(8)

An indication of the cultural and linguistic background, based on whether or not an individual was born in a country other than Australia, has a cultural background other than Australian, can speak languages other than English, recorded as a label set representing 'CALD' and 'not CALD'.


Specific Information:

This is derived from BirthCountryCode & MainLanguageCode
A client is considered Culturally and Linguistically Diverse where their Country of Birth is NOT 'Australia'  and their Main Spoken Language is NOT 'English' or 'Not Stated'.

ALPHASTRING A(8)
MIGRATIONVISACODE Person: Migration visa type, label

The migration visa category granted by Australia to a person, represented by a label.

ALPHASTRING A(12)
MIGRATIONARRIVALMONTH Person: Date of first arrival in Australia, Month MM

The calendar month a person emigrated to Australia with the intention of staying at least one year.

DATE MM
MIGRATIONARRIVALYEAR Person: Date of first arrival in Australia, Year YYYY

The calendar year a person emigrated to Australia with the intention of staying at least one year.


Specific Information:

Records the date a client first arrived in Australia where appropriate for a funded activity. This field is primarily included as an eligibility indicator for the Settlement Engagement and Transition Support (SETS) Program. It can also be used as a potential indicator of disadvantage for other program activities.

DATE YYYY
EDUCATIONLEVELCODE Person: Highest level of education or qualification, Label X(50)

The highest level of education or qualification achieved by a person, represented by a label.

ALPHASTRING A(14)
EMPLOYMENTSTATUSCODE Person: Employment status, Label

The employment status of a person, whether employed or another role, represented by a label.

ALPHASTRING A(17)
DVACARDSTATUSCODE Person: Department of Veterans Affairs (DVA) Card Status, Code X(6)

The DVA Card status linked to a person, as represented by a code.

If this element is provided then it is must have value.

Mandatory based on Activity Specific Requirement with Code as “DVACARDSTATUS”

ALPHANUMERICSTRING X(6)
INCOMESOURCECODE Person: Main source of income, Label

The main source of income for a person, represented by a label.

ALPHASTRING A(12)
INCOMEAMOUNT Person: Assessable income, Total Australian currency N(8)

The value of income per week from all sources as specified and used by the agency to establish eligibility of a person for receipt of housing assistance expressed as dollars and cents.

INTEGERNUMBER N(8)
INCOMEFREQUENCYCODE Person: Income Frequency, Label

A measure of a period of time for which an amount is being paid to a person, recorded as the code set representing the frequency of recurrence.

CHARACTERSTRING X(11)
ACCOMMODATIONTYPECODE Person: Accommodation setting, label

The accommodation setting that best describes the living arrangement or lodging situation of person, represented by a label.


Specific Information:

Clients nominate the accommodation setting category that best describes their situation.

ALPHASTRING A(13)
HOMELESSCODE Person: Homelessness status, Label

The experience of unstable, inadequate or non-permanent housing identified by person, represented by a label.

ALPHASTRING A(6)
HOUSEHOLDCOMPOSITIONCODE Person: Household Composition, Label A(10)

The household composition for a person, represented by a label.


Specific Information:

Household composition is classified into standard categories that are adapted from the data collection definitions used by AIHW. Household composition is adapted to include data on whether the client is homeless.

ALPHASTRING A(10)
ISCARER Person: Is a carer, Flag

Whether a person is a carer in a carer relationship, represented by a flag.

NUMBERSTRING N
HASCARER Person: Has a carer, Flag

Whether a person is the care recipient in a carer relationship, represented by a flag.

NUMBERSTRING N
NDISELIGIBILITYCODE Person: Disability group, NDIS Eligibility Code A(10)

The status of a client's eligibility to access NDIS support who attended one or more services funded to improve their wellbeing, participation and/or independence, recorded as a code that represents a client's NDIS eligibility status.

ALPHASTRING A(10)
IDENTIFIEDCONSENTGIVEN Record: Consent Indicator, No/Yes Code N

Whether consent is given or not, recorded as a code set representing 'no' and 'yes'. (0 and 1)


Specific Information:

An organisation using the Data Exchange as a client records system will need to:
1) obtain the express consent of a client, on behalf of DSS, for DSS to collect the client's personal information from the organisation and store it on the Data Exchange
2) record that consent in the Data Exchange IT system
3) inform the client that they may withdraw this consent at any time.

DSS will not store the client's name or pseudonym, and/or street-level address on the Data Exchange unless this consent is obtained.

To meet DSS's obligations under the Privacy Act, the required consent is to be recorded in the Data Exchange. For organisations using the web-based portal, consent is recorded using the tick box provided when creating or editing a client. When reporting client-level records through bulk uploading of files or a system-to-system transfer, this consent is to be recorded in these files. Organisations are required to record that a client has consented in the Data Exchange, however they are not required to provide copies of the client's consent to DSS. Organisations should determine their own record keeping procedures in relation to client consent.

Client first name and last name, address line 1 and line 2 are not stored on DEX database. Geo coding relies on client locality, suburb and state only."

NUMBERSTRING N
CONTACTCONSENTGIVEN Record: Consent Indicator, No/Yes Code N

Whether consent is given or not, recorded as a code set representing 'no' and 'yes'. (0 and 1)


Specific Information:

Funding agencies and third parties (such as universities) are interested in commissioning future research to better understand client needs and find opportunities to improve service delivery. Obtaining client consent to participate in research will create an indicative pool of willing participants for future research projects.
 

NUMBERSTRING N
CURRENTRECORD Record: Current Record Indicator, No/Yes Code N

Whether a record is current or active, recorded as a code set representing 'no' and 'yes'.

NUMBERSTRING N
RECORDSEQNBR Record: Sequence Number, NNN

A system generated sequence of numbers that locates a client's historical record who attended one or more services funded to improve wellbeing. This number ensures a record is unique.

INTEGERNUMBER NNN
INSERTMETHODCODE Record: Insert Method, Code A(2)

A number that ensures a record is unique.


Specific Information:

The method by which the data was captured.

ALPHASTRING A(2)
SA12016BOUNDARYCODE Person: Area of usual residence, Statistical area level 1 (SA1) code (ASGS 2016) N(11)

The geographical region represented by a Statistical area level 1 (SA1) code set in which a person or group of people usually reside.

NUMBERSTRING N(11)
SA22016BOUNDARYCODE Person: Area of usual residence, Statistical area level 2 (SA2) code (ASGS 2016) N(9)

The geographical region represented by a Statistical area level 2 (SA2) code set in which a person or group of people usually reside.

NUMBERSTRING N(9)
SA32016BOUNDARYCODE Person: Area of usual residence, Statistical area level 3 (SA3) code (ASGS 2016) N(5)

The geographical region represented by a Statistical area level 3 (SA3) code set in which a person or group of people usually reside.

NUMBERSTRING N(5)
SA42016BOUNDARYCODE Person: Area of usual residence, Statistical area level 4 (SA4) code (ASGS 2016) NNN

The geographical region represented by a Statistical area level 4 (SA4) code set in which a person or group of people usually reside.

NUMBERSTRING NNN
STE2016BOUNDARYCODE Person: Australian State/Territory Identifier, Code X(3)

The code that represents the Australian state or territory where a person can be located.

ALPHASTRING X(3)
ACPR2015BOUNDARYCODE Person: Area of usual residence, Aged Care Planning Region Code N(9)

The geographical region represented by an Aged Care Planning Region in which a person is usually resides.

NUMBERSTRING N(9)
SA12021BoundaryCode - - - -
SA22021BoundaryCode - - - -
SA32021BoundaryCode - - - -
SA42021BoundaryCode - - - -
STE2021BoundaryCode - - - -
ACPR2018BoundaryCode - - - -
LGA2021BoundaryCode - - - -
SYSSTARTTIME Record: DateTime Stamp, YYYY-MM-DD

A sequence of characters or encoded information identifying when a certain event occurred, on what day, and optionally including what particular time of day.

DATETIME YYYY-MM-DD(T00:00:00)
SYSENDTIME Record: DateTime Stamp, YYYY-MM-DD

A sequence of characters or encoded information identifying when a certain event occurred, on what day, and optionally including what particular time of day.

DATETIME YYYY-MM-DD(T00:00:00)
CREATEDDATETIME Record: DateTime Stamp, YYYY-MM-DD

A sequence of characters or encoded information identifying when a certain event occurred, on what day, and optionally including what particular time of day.

DATETIME YYYY-MM-DD(T00:00:00)
INGESTTIME Record: DateTime Stamp, YYYY-MM-DD

A sequence of characters or encoded information identifying when a certain event occurred, on what day, and optionally including what particular time of day.

DATETIME YYYY-MM-DD(T00:00:00)
INGESTTYPE Record: Ingest Type, Label A(6)

File (data) ingestion process type, represented by a label.

ALPHASTRING A(6)
FILENAME Record: Filename, Text X(200)

File name (data) ingested into BigQuery, represented by text.

ALPHANUMERICSTRING X(200)
BATCHID Record: Batch Id, Text X(200)

System generated identification generated when (data) ingested into BigQuery, represented by text.

ALPHANUMERICSTRING X(200)
AECFED2016BoundaryCode Person: Area of usual residence, Federal Electorate Label X(50)

The Australian Electoral Commission (Federal) electoral division boundaries in which a person or group of people usually reside, as represented by a label.

 

CHARACTERSTRING X(50)
LGA2016BoundaryCode Person: Area of usual residence, LGA Code N(5)

A code that represents the NSW Local Government Area in which a person or group of people usually reside.

NUMBERSTRING N(5)
DCJ_NAME_2019 Person: NSW Department of Communities and Justice District, Label A(25)

The area (district) where the NSW Department of Communities and Justice (DCJ) is responsible for the delivery of services to a child or young person, as represented by a label.

ALPHASTRING A(25)
ServiceAreaType Data Exchange: Service Area Type, Name X(18)

The type or category of area within which a service is being delivered, as represented by a label.

CHARACTERSTRING X(18)
ServiceAreaName Person: NSW Department of Communities and Justice District, Label A(25)

The area (district) where the NSW Department of Communities and Justice (DCJ) is responsible for the delivery of services to a child or young person, as represented by a label.

ALPHASTRING A(25)
etl_run_dt Record: DateTime Stamp, YYYY-MM-DD

A sequence of characters or encoded information identifying when a certain event occurred, on what day, and optionally including what particular time of day.

DATETIME YYYY-MM-DD(T00:00:00)