4. Data model and specifications
4.1. Data model
The introductory wording on the YES PHN states “All information collected in this survey is anonymous. None of the information collected will be used to identify you.” In order to preserve this client anonymity, this specification uses a data model that stores the survey against a Provider Organisation, not a client.
Note
The above data model diagram is in the SVG format and can be enlarged or zoomed by opening in a new tab or window or by downloading it.
4.2. Record formats
4.2.1. Metadata
The Metadata table must be included in file uploads in order to identify the type and version of the uploaded data.
Data Element (Field Name) |
Type (min,max) |
Required |
Format / Values |
---|---|---|---|
Key (key) |
string |
yes |
A metadata key name. |
Value (value) |
string |
yes |
The metadata value. |
For this version of the specification the required content is shown in the following table:
key |
value |
type |
SURVEY |
version |
1.0 |
4.2.2. Provider Organisation
See Provider Organisation Key Concepts for the definition of a provider organisation.
Provider Organisation data is for administrative use within the PMHC MDS system. It is managed by the PHNs via the PMHC MDS administrative interface, or upload.
Data Element (Field Name) |
Type (min,max) |
Required |
Format / Values |
---|---|---|---|
Organisation Path (organisation_path) |
string |
yes |
A sequence of colon separated Organisation Keys that fully specifies the Provider Organisation providing a service to the client. |
Organisation Key (organisation_key) |
string (2,50) |
yes |
A sequence of characters which uniquely identifies the provider organisation to the Primary Health Network. Assigned by the Primary Health Network. |
Name (organisation_name) |
string (2,100) |
yes |
The name of the provider organisation. |
Legal Name (organisation_legal_name) |
string |
— |
The legal name of the provider organisation. |
ABN (organisation_abn) |
string (11) |
yes |
The Australian Business Number of the provider organisation. |
Organisation Type (organisation_type) |
string |
yes |
|
State (organisation_state) METeOR: 613718 |
string |
yes |
|
Organisation Start Date (organisation_start_date) |
date |
yes |
The date on which a provider organisation started delivering services. |
Organisation End Date (organisation_end_date) |
date |
yes |
The date on which a provider organisation stopped delivering services. |
Organisation Tags (organisation_tags) |
string |
— |
List of tags for the provider organisation. |
4.2.3. Survey
Survey data is managed by the PHNs or Provider Organisations via upload.
Data Element (Field Name) |
Type (min,max) |
Required |
Format / Values |
---|---|---|---|
Organisation Path (organisation_path) |
string |
yes |
A sequence of colon separated Organisation Keys that fully specifies the Provider Organisation providing a service to the client. |
Survey Key (survey_key) |
string (2,50) |
yes |
This is a number or code assigned to each survey activity. The Survey Key is unique and stable for each survey at the level of the organisation. |
Collection Date (collection_date) |
date |
yes |
The collection date the survey instruments. |
Survey Tags (survey_tags) |
string |
— |
List of tags for the survey. |
4.2.4. Instruments
4.2.4.1. YES PHN
Further information about the YES PHN Survey is available from Introduction and Resources.
YES PHN data is managed by the PHNs or Provider Organisations via upload.
Data Element (Field Name) |
Type (min,max) |
Required |
Format / Values |
---|---|---|---|
Organisation Path (organisation_path) |
string |
yes |
A sequence of colon separated Organisation Keys that fully specifies the Provider Organisation providing a service to the client. |
Instrument Key (instrument_key) |
string (2,50) |
yes |
A sequence of characters which uniquely identifies the survey instrument to the Primary Health Network. Assigned by the Primary Health Network. |
Survey Key (survey_key) |
string (2,50) |
yes |
A sequence of characters which uniquely identifies the survey to the Primary Health Network. Assigned by the Primary Health Network. |
YES PHN Question 1 (yes_phn_item1) |
string |
yes |
|
YES PHN Question 2 (yes_phn_item2) |
string |
yes |
|
YES PHN Question 3 (yes_phn_item3) |
string |
yes |
|
YES PHN Question 4 (yes_phn_item4) |
string |
yes |
|
YES PHN Question 5 (yes_phn_item5) |
string |
yes |
|
YES PHN Question 6 (yes_phn_item6) |
string |
yes |
|
YES PHN Question 7 (yes_phn_item7) |
string |
yes |
|
YES PHN Question 8 (yes_phn_item8) |
string |
yes |
|
YES PHN Question 9 (yes_phn_item9) |
string |
yes |
|
YES PHN Question 10 (yes_phn_item10) |
string |
yes |
|
YES PHN Question 11 (yes_phn_item11) |
string |
yes |
|
YES PHN Question 12 (yes_phn_item12) |
string |
yes |
|
YES PHN Question 13 (yes_phn_item13) |
string |
yes |
|
YES PHN Question 14 (yes_phn_item14) |
string |
yes |
|
YES PHN Question 15 (yes_phn_item15) |
string |
yes |
|
YES PHN Question 16 (yes_phn_item16) |
string |
yes |
|
YES PHN Question 17 (yes_phn_item17) |
string |
— |
My experience would have been better if … (write in). |
YES PHN Question 18 (yes_phn_item18) |
string |
— |
The best things about this service were … (write in.) |
YES PHN Question 19 (yes_phn_item19) |
string |
yes |
|
YES PHN Question 19 Other (yes_phn_item19_other) |
string |
— |
What is your gender identity (other)? |
YES PHN Question 20 (yes_phn_item20) |
string |
yes |
|
YES PHN Question 20 Other (yes_phn_item20_other) |
string |
— |
What is the main language you speak at home (other)? |
YES PHN Question 21 (yes_phn_item21) |
string |
yes |
|
YES PHN Question 22 (yes_phn_item22) |
string |
yes |
|
YES PHN Question 23 (yes_phn_item23) |
string |
yes |
|
YES PHN Question 24 (yes_phn_item24) |
string |
yes |
|
YES PHN Question 24 Other (yes_phn_item24_other) |
string |
— |
Who referred you to this service (other)? |
YES PHN Question 25 (yes_phn_item25) |
string |
yes |
|
YES PHN Question 26 (yes_phn_item26) |
string |
yes |
|
YES PHN Experience Scale (yes_phn_experience_scale) |
integer |
yes |
99 - 99, 99 = Not stated / Missing |
YES PHN Outcome Scale (yes_phn_outcome_scale) |
integer |
yes |
99 - 99, 99 = Not stated / Missing |
YES PHN Tags (yes_phn_tags) |
string |
— |
List of tags for the instrument. |
4.3. Definitions
4.3.1. ABN
The Australian Business Number of the provider organisation.
- Field name:
organisation_abn
- Data type:
string (11)
- Required:
yes
4.3.2. Collection Date
The collection date the survey instruments.
- Field name:
collection_date
- Data type:
date
- Required:
yes
- Notes:
For Date fields, data must be recorded in compliance with the standard format used across the National Health Data Dictionary; specifically, dates must be of fixed 8 column width in the format DDMMYYYY, with leading zeros used when necessary to pad out a value. For instance, 13th March 2008 would appear as 13032008.
If the date the activity was performed is unknown, 09099999 should be used.
For and intake collection occasion, the collection date must not be before 1st January 2020, otherwise, the collection date must not be before 1st January 2016.
The collection date must not be in the future.
4.3.3. Instrument Key
A sequence of characters which uniquely identifies the survey instrument to the Primary Health Network. Assigned by the Primary Health Network.
- Field name:
instrument_key
- Data type:
string (2,50)
- Required:
yes
- Notes:
PMHC MDS keys are case sensitive and must have between 2-50 valid unicode characters. Keys must start with A-Za-z0-9 (POSIX :alnum:).
Where data is being exported from client systems, these keys can be auto generated, providing that a key does not change once it is assigned.
Keys must be generated by the organisation to be unique at the Provider Organisation level and must persist across time. Creation of keys in this way allows records to be merged (where duplicate keys of the same record type have been identified) without having to re-allocate keys since they can never clash.
A recommended approach for the creation of keys is to compute random UUIDs.
4.3.4. Key
A metadata key name.
- Field name:
key
- Data type:
string
- Required:
yes
4.3.5. Legal Name
The legal name of the provider organisation.
- Field name:
organisation_legal_name
- Data type:
string
- Required:
no
4.3.6. Name
The name of the provider organisation.
- Field name:
organisation_name
- Data type:
string (2,100)
- Required:
yes
4.3.7. Organisation End Date
The date on which a provider organisation stopped delivering services.
- Field name:
organisation_end_date
- Data type:
date
- Required:
yes
4.3.8. Organisation Key
A sequence of characters which uniquely identifies the provider organisation to the Primary Health Network. Assigned by the Primary Health Network.
- Field name:
organisation_key
- Data type:
string (2,50)
- Required:
yes
- Notes:
Organisation Keys must be generated by the PHN to be unique and must persist across time. See Managing Provider Organisation Keys
Organisation keys are case sensitive and must be valid unicode characters.
4.3.9. Organisation Path
A sequence of colon separated Organisation Keys that fully specifies the Provider Organisation providing a service to the client.
- Field name:
organisation_path
- Data type:
string
- Required:
yes
- Notes:
A combination of the Primary Health Network’s (PHN’s) Organisation Key and the Provider Organisation’s Organisation Key separated by a colon.
Here is an example organisation structure showing the Organisation Path for each organisation:
Organisation Key
Organisation Name
Organisation Type
Commissioning Organisation
Organisation Path
PHN999
Test PHN
Primary Health Network
None
PHN999
PO101
Test Provider Organisation
Private Allied Health Professional Practice
PHN999
PHN999:PO101
4.3.10. Organisation Start Date
The date on which a provider organisation started delivering services.
- Field name:
organisation_start_date
- Data type:
date
- Required:
yes
4.3.12. Organisation Type
The category that best describes the provider organisation.
- Field name:
organisation_type
- Data type:
string
- Required:
yes
- Domain:
- 1:
Private Allied Health Professional Practice
- 2:
Private Psychiatry Practice
- 3:
General Medical Practice
- 4:
Private Hospital
- 5:
Headspace Centre
- 6:
Early Youth Psychosis Centre
- 7:
Community-managed Community Support Organisation
- 8:
Aboriginal Health/Medical Service
- 9:
State/Territory Health Service Organisation
- 10:
Drug and/or Alcohol Service
- 11:
Primary Health Network
- 12:
Medicare Local
- 13:
Division of General Practice
- 98:
Other
- 99:
Missing
- Notes:
- 1 - Private Allied Health Professional Practice
The provider organisation is a group of single- or multi-discipline allied health practitioners operating as private service providers. This includes both group and solo practitioner entities.
- 2 - Private Psychiatry practice
The provider organisation is a Private Psychiatry practice. This includes both group and solo practitioner entities.
- 3 - General Medical Practice
The provider organisation is a General Medical Practice. This includes both group and solo practitioner entities.
- 4 - Private Hospital
The provider organisation is a private hospital. This includes for-profit and not-for-profit hospitals.
- 5 - Headspace Centre
The provider organisation is a Headspace centre, delivering services funded by the PHN.
Note: Headspace and Early Psychosis Youth Centres currently collect and report a standardised dataset to headspace National Office. Pending the future of these arrangements, reporting of the PMHC minimum data set is not required by those organisations previously funded through headspace National Office that transitioned to PHNs. Where new or additional services are commissioned by PHNs and delivered through existing Headspace or Early Psychosis Youth Centres, local decisions will be required as to whether these services can be captured through headspace National Office sustem or are better reported through the PMHC MDS.
- 6 - Early Youth Psychosis Centre
The provider organisation is a Early Youth Psychosis Centre, delivering services funded by the PHN.
Note: See Note above re Headspace.
- 7 - Community-managed Community Support Organisation
The provider organisation is a community-managed (non-government) organisation that primarily delivers disability-related or social support services.
- 8 - Aboriginal Health/Medical Service
The provider organisation is an Aboriginal or Torres Strait Islander-controlled health service organisation.
- 9 - State/Territory Health Service Organisation
The provider organisation is a health service entity principally funded by a state or territory government. This includes all services delivered through Local Hospital Networks (variously named across jurisdictions).
- 10 - Drug and/or Alcohol Service Organisation
The provider organisation is an organisation that provides specialised drug and alcohol treatment services. The organisation may be operating in the government or non-government sector, and where the latter, may be for-profit or not-for-profit.
- 11 - Primary Heath Network
The PHN is the provider organisation and employs the service delivery practitioners. This may occur during the transition period as the PHN moves to a full commissioning role, or in cases of market failure where there is no option to commission external providers.
- 12 - Medicare Local
The provider organisation is a former Medicare Local entity.
- 13 - Division of General Practice
The provider organisation is a former Division of General Practice entity.
- 98 - Other
The provider organisation cannot be described by any of the available options.
4.3.13. State
The state that the provider organisation operates in.
- Field name:
organisation_state
- Data type:
string
- Required:
yes
- Domain:
- 1:
New South Wales
- 2:
Victoria
- 3:
Queensland
- 4:
South Australia
- 5:
Western Australia
- 6:
Tasmania
- 7:
Northern Territory
- 8:
Australian Capital Territory
- 9:
Other Territories
- Notes:
Name is taken from Australian Statistical Geography Standard (ASGS) July 2011.
Code is from Meteor with the addition of code for Other Territories.
- METeOR:
4.3.14. Survey Key
This is a number or code assigned to each survey activity. The Survey Key is unique and stable for each survey at the level of the organisation.
- Field name:
survey_key
- Data type:
string (2,50)
- Required:
yes
- Notes:
PMHC MDS keys are case sensitive and must have between 2-50 valid unicode characters. Keys must start with A-Za-z0-9 (POSIX :alnum:).
Where data is being exported from client systems, these keys can be auto generated, providing that a key does not change once it is assigned.
Keys must be generated by the organisation to be unique at the Provider Organisation level and must persist across time. Creation of keys in this way allows records to be merged (where duplicate keys of the same record type have been identified) without having to re-allocate keys since they can never clash.
A recommended approach for the creation of keys is to compute random UUIDs.
4.3.16. Value
The metadata value.
- Field name:
value
- Data type:
string
- Required:
yes
4.3.17. YES PHN Experience Scale
- Field name:
yes_phn_experience_scale
- Data type:
integer
- Required:
yes
- Domain:
99 - 99, 99 = Not stated / Missing
- Notes:
The scoring of the YES-PHN is currently under review. Until the review is complete, the only value that will be accepted is 99 = Not stated / Missing. Once the review is complete all subscales for all recorded YES-PHNs will be calculated using the approved scoring method.
The YES PHN Experience Scale is based on Questions 1 through 12.
For the YES PHN Experience Scale, the missing value used should be 99.
For validation rules please refer to YES PHN.
4.3.18. YES PHN Outcome Scale
- Field name:
yes_phn_outcome_scale
- Data type:
integer
- Required:
yes
- Domain:
99 - 99, 99 = Not stated / Missing
- Notes:
The scoring of the YES-PHN is currently under review. Until the review is complete, the only value that will be accepted is 99 = Not stated / Missing. Once the review is complete all subscales for all recorded YES-PHNs will be calculated using the approved scoring method.
The YES PHN Outcome Scale is based on Questions 13 through 15.
For the YES PHN Outcome Scale, the missing value used should be 99.
For validation rules please refer to YES PHN.
4.3.19. YES PHN Question 1
You felt welcome using this service.
- Field name:
yes_phn_item1
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.20. YES PHN Question 2
You felt safe using this service.
- Field name:
yes_phn_item2
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.21. YES PHN Question 3
You had access to this service when you needed.
- Field name:
yes_phn_item3
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.22. YES PHN Question 4
You had opportunities for your family and friends to be involved in your support or care if you wanted.
- Field name:
yes_phn_item4
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 9:
Not applicable
- 99:
Not stated / Missing
4.3.23. YES PHN Question 5
Staff were able to provide information or advice to help you manage your physical health if you wanted.
- Field name:
yes_phn_item5
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.24. YES PHN Question 6
Your individuality and values were respected (such as your culture, faith or gender identity, etc.)
- Field name:
yes_phn_item6
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.25. YES PHN Question 7
This service listened to and followed up on feedback or complaints.
- Field name:
yes_phn_item7
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.26. YES PHN Question 8
The service respected your right to make decisions.
- Field name:
yes_phn_item8
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.27. YES PHN Question 9
The support or care available met your needs.
- Field name:
yes_phn_item9
- Data type:
string
- Required:
yes
- Domain:
- 1:
Never
- 2:
Rarely
- 3:
Sometimes
- 4:
Usually
- 5:
Always
- 99:
Not stated / Missing
4.3.28. YES PHN Question 10
Access to a peer worker/ lived experience worker, if you wanted.
- Field name:
yes_phn_item10
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 9:
Not applicable
- 99:
Not stated / Missing
4.3.29. YES PHN Question 11
The support or care available met your needs.
- Field name:
yes_phn_item11
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 99:
Not stated / Missing
4.3.30. YES PHN Question 12
Development of a plan with you that considered all of your needs (including support, coordination and follow up).
- Field name:
yes_phn_item12
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 9:
Not applicable
- 99:
Not stated / Missing
4.3.31. YES PHN Question 13
The effect of this service on your hopefulness for the future.
- Field name:
yes_phn_item13
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 99:
Not stated / Missing
4.3.32. YES PHN Question 14
The effect of this service on your skills and strategies to look after your own health and wellbeing.
- Field name:
yes_phn_item14
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 99:
Not stated / Missing
4.3.33. YES PHN Question 15
The effect of this service on your ability to manage your day to day life.
- Field name:
yes_phn_item15
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 99:
Not stated / Missing
4.3.34. YES PHN Question 16
Overall, how would you rate your experience with this service in the last 3 months?
- Field name:
yes_phn_item16
- Data type:
string
- Required:
yes
- Domain:
- 1:
Poor
- 2:
Fair
- 3:
Good
- 4:
Very Good
- 5:
Excellent
- 99:
Not stated / Missing
4.3.35. YES PHN Question 17
My experience would have been better if … (write in).
- Field name:
yes_phn_item17
- Data type:
string
- Required:
no
- Notes:
As this is a free text field there is a risk that a client could provide identifying information.
Any response in this field will be suppressed in data extracts to avoid spilling any such identifying information.
4.3.36. YES PHN Question 18
The best things about this service were … (write in.)
- Field name:
yes_phn_item18
- Data type:
string
- Required:
no
- Notes:
As this is a free text field there is a risk that a client could provide identifying information.
Any response in this field will be suppressed in data extracts to avoid spilling any such identifying information.
4.3.37. YES PHN Question 19
What is your gender identity?
- Field name:
yes_phn_item19
- Data type:
string
- Required:
yes
- Domain:
- 1:
Male
- 2:
Female
- 3:
Other
- 99:
Not stated / Missing
4.3.38. YES PHN Question 19 Other
What is your gender identity (other)?
- Field name:
yes_phn_item19_other
- Data type:
string
- Required:
no
- Notes:
As this is a free text field there is a risk that a client could provide identifying information.
Any response in this field will be suppressed in data extracts to avoid spilling any such identifying information.
4.3.39. YES PHN Question 20
What is the main language you speak at home?
- Field name:
yes_phn_item20
- Data type:
string
- Required:
yes
- Domain:
- 1:
English
- 2:
Other
- 99:
Not stated / Missing
4.3.40. YES PHN Question 20 Other
What is the main language you speak at home (other)?
- Field name:
yes_phn_item20_other
- Data type:
string
- Required:
no
- Notes:
As this is a free text field there is a risk that a client could provide identifying information.
Any response in this field will be suppressed in data extracts to avoid spilling any such identifying information.
4.3.41. YES PHN Question 21
Are you of Aboriginal or Torres Strait Island origin?
- Field name:
yes_phn_item21
- Data type:
string
- Required:
yes
- Domain:
- 1:
No
- 2:
Yes — Aboriginal
- 3:
Yes — Torres Strait Islander
- 4:
Yes — Aboriginal and Torres Strait Islander
- 99:
Not stated / Missing
4.3.42. YES PHN Question 22
What is your age?
- Field name:
yes_phn_item22
- Data type:
string
- Required:
yes
- Domain:
- 1:
Under 18 years
- 2:
18 to 24 years
- 3:
25 to 44 years
- 4:
45 to 64 years
- 5:
65 years and over
- 99:
Not stated / Missing
4.3.43. YES PHN Question 23
How long have you been receiving support or care from this service?
- Field name:
yes_phn_item23
- Data type:
string
- Required:
yes
- Domain:
- 1:
1 day to 2 weeks
- 2:
3 to 4 weeks
- 3:
1 to 3 months
- 4:
4 to 6 months
- 5:
More than 6 months
- 99:
Not stated / Missing
4.3.44. YES PHN Question 24
Who referred you to this service?
- Field name:
yes_phn_item24
- Data type:
string
- Required:
yes
- Domain:
- 1:
Family doctor/GP
- 2:
Nurse
- 3:
Another health professional
- 4:
Myself
- 5:
Other
- 99:
Not stated / Missing
4.3.45. YES PHN Question 24 Other
Who referred you to this service (other)?
- Field name:
yes_phn_item24_other
- Data type:
string
- Required:
no
- Notes:
As this is a free text field there is a risk that a client could provide identifying information.
Any response in this field will be suppressed in data extracts to avoid spilling any such identifying information.
4.3.46. YES PHN Question 25
How involved were you in choosing this service?
- Field name:
yes_phn_item25
- Data type:
string
- Required:
yes
- Domain:
- 1:
Not at all involved
- 2:
A little involved
- 3:
Fully involved
- 99:
Not stated / Missing
4.3.47. YES PHN Question 26
Did someone help you complete this survey?
- Field name:
yes_phn_item26
- Data type:
string
- Required:
yes
- Domain:
- 1:
No
- 2:
Yes — family or friend
- 3:
Yes — someone from the service
- 4:
Yes — someone else
- 99:
Not stated / Missing
4.4. Download Specification Files
Available for software developers designing extracts for the PMHC MDS, please click the link below to download the PMHC MDS Specification files:
These files conform to the CSV on the Web (CSVW) standard that is defined at https://csvw.org/.
They are used:
to generate the Record formats and Definitions sections of the data specification documentation
in the first pass of upload validations