2. Upload specification

The headspace files/worksheets are an extension to the PMHC MDS. Files can be uploaded to the PMHC MDS manually via the web interface at https://pmhc-mds.net/ or by using the API which is available at https://api.pmhc-mds.net/.

2.1. File requirements

Please refer to PMHC MDS File types.

2.2. Files or worksheets to upload

All files must be internally consistent. An example of what this means is that for every HeadtoHelp episode, service contact and measures in an upload file, there must be a corresponding episode in the episodes file/worksheet. It also means that for every row in the episodes file/worksheet, there must be a corresponding client in the clients file/worksheet.

The following files/worksheets must be uploaded to the PMHC MDS as part of the headspace data specification:

Table 2.1 Summary of files to upload
File Type	CSV filename	Excel worksheet name	Required
Clients	clients.csv	Clients	Required
Episodes	episodes.csv	Episodes	Required
IAR-DST Measures	iar-dst.csv	IAR-DST	Required
Service Contacts	service-contacts.csv	Service Contacts	Required
Service Contact Practitioners	service-contact-practitioners.csv	Service Contact Practitioners	Required
Collection Occasions	collection-occasions.csv	Collection Occasions	Required
K10+ Measures	k10p.csv	K10+	Required
K5 Measures	k5.csv	K5	Required
SDQ Measures	sdq.csv	SDQ	Required
Practitioners	practitioners.csv	Practitioners	Required for first upload and when practitioner information changes. Optional otherwise
Organisations	organisations.csv	Organisations	Optional, may only be included if the user has Organisation Management Role
Metadata	metadata.csv	Metadata	Required

Example upload files can be found at Example Upload files.

2.3. File format

Same as standard PMHC MDS File format.

2.3.1. Metadata file

All headspace version 4.0 data uploads must include a Metadata file/worksheet. - In the first row, the first cell must contain ‘key’ and the second cell must contain ‘value’ - In the second row, the first cell must contain ‘type’ and the second cell must contain ‘HEADSPACE’ - In the third row, the first cell must contain ‘version’ and the second cell must contain ‘4.0’

i.e.:

key	value
type	HEADSPACE
version	4.0

Data elements for the headspace metadata upload file/worksheet are defined at Metadata.

Example Metadata files can be found at Example Upload files.

2.3.2. Organisation file format

Same as standard PMHC MDS Organisation file format.

Example Organisation files can be found in the example files at Example Upload files.

2.3.3. Client format

Same as standard PMHC MDS Client file format.

Example Client files can be found in the example files at Example Upload files.

2.3.4. Intake format

Same as standard PMHC MDS Intake file format.

Example Intake files can be found in the example files at Example Upload files.

2.3.5. IAR-DST format

Same as standard PMHC MDS IAR-DST file format.

Example IAR-DST files can be found in the example files at Example Upload files.

2.3.6. Intake Episode format

Same as standard PMHC MDS Intake Episode file format.

Example Intake Episode files can be found in the example files at Example Upload files.

2.3.7. Episode file format

The episode file/worksheet is required to be uploaded each time.

Data elements for the episode upload file/worksheet are defined at Episode.

Example Episode files can be found in the example files at Example Upload files.

2.3.8. Service Contact file format

The service contact file/worksheet is required to be uploaded each time.

Data elements for the service contact upload file/worksheet are defined at Service Contact.

Example Service Contact files can be found in the example files at Example Upload files.

2.3.9. Service Contact Practitioner file format

The service contact practitioner file/worksheet is required to be uploaded each time.

Data elements for the service contact practitioner upload file/worksheet are defined at Service Contact Practitioner.

Example Service Contact Practitioner files can be found in the example files at Example Upload files.

2.3.10. Collection Occasion file format

The collection occasion file/worksheet is required to be uploaded each time.

Data elements for the collection occasion upload file/worksheet are defined at Collection Occasion.

Example Collection Occasion files can be found in the example files at Example Upload files.

2.3.11. K10+ Collection Occasion file format

Same as standard PMHC MDS K10+ file format.

Example K10+ files can be found in any of the example files at Example Upload files.

2.3.12. K5 Collection Occasion file format

Same as standard PMHC MDS K5 file format.

Example K5 files can be found in any of the example files at Example Upload files.

2.3.13. SDQ Collection Occasion file format

Same as standard PMHC MDS SDQ file format.

Example SDQ files can be found in any of the example files at Example Upload files.

2.3.14. Practitioner file format

Same as standard PMHC MDS Practitioner file format.

Example Practitioner files can be found in any of the example files at Example Upload files.

2.4. Deleting records

Please refer to PMHC MDS Deleting records

Example files showing how to delete via upload can be found in any of the example files at Example Upload files.

2.5. Example Upload files

Each of the example files assumes the following organisation structure:

Organisation Key	Organisation Name	Organisation Type	Parent Organisation
PHN999	Test PHN	Primary Health Network	None
NFP01	Test 01 Provider Organisation	Headspace Centre	PHN999
NFP02	Test 02 Provider Organisation	Headspace Centre	PHN999

Table 2.2 Summary of example upload files
Context	CSV zip	XLSX
headspace centre	HEADSPACE-4.0.0-centre.zip	HEADSPACE-4.0.0-centre.xlsx
Deleting records	HEADSPACE-4.0.0-centre-delete.zip	HEADSPACE-4-0.0-centre-delete.xlsx

2.6. Frequently Asked Questions

Please also refer to Uploading data for answers to frequently asked questions about uploading data.