Upload specification¶
File types¶
Files will be accepted in the following types:
- Comma Separated Values (CSV)
- Excel (XLSX)
Comma Separated Values (CSV)¶
Requirements for CSV files:
- The CSV files must conform to RFC 4180.
- In addition, CSV files must be created using UTF-8 character encoding.
- CSV files must have the file extension .csv
- Multiple CSV files must be uploaded - one CSV file for each format described below.
- The CSV files must be compressed into a single file by zipping before upload. The filename of the zip file doesn’t matter as long as it has the file extension .zip
Excel (XLSX)¶
Requirements for XLSX files:
Excel files must be in XLSX format. The following versions of Excel support this format:
- Excel 2007 (v12.0)
- Excel 2010 (v14.0)
- Excel 2013 (v15.0)
- Excel 2016 (v16.0)
One XLSX file must be uploaded containing multiple worksheets - one worksheet for each format described below.
When saving your file, please choose the filetype ‘Excel Workbook (.xlsx)’.
The filename of the Excel file doesn’t matter as long as it has the file extension .xlsx
AMHC Base Version¶
The AMHC upload format is slightly different to the PMHC MDS Version 2.0 upload format.
The AMHC upload format separates collection occasion data into a separate Collection Occasions worksheet so that multiple measures can be collected at a single collection occasion.
The AMHC upload format aligns with a future PMHC MDS Version 3.0 file format. No date has been set for the release of the PMHC MDS Version 3.0 upload file format.
In addition to the collection occasion/measure changes, the AMHC upload format adds additional values to support the AMHC extension.
How to upload AMHC Files¶
AMHC files/worksheets can be uploaded to the PMHC MDS in one of two ways:
- Option A: Separate PMHC and AMHC uploads - Option A is recommended for organisations who have not yet changed their standard upload files to include AMHC data. It allows these organisations to do their normal PMHC MDS upload and then do a second upload for AMHC data. Option A is also recommended for organisations who use Data Entry instead of upload for the PMHC MDS data, but who wish to upload AMHC data.
- Option B: One upload including PMHC and AMHC clients - Option B is recommended for organisations who have already migrated their standard PMHC MDS uploads to allow AMHC uploads at the same time. It allows both PMHC MDS and AMHC data to be uploaded together in one upload.
Option A: Separate PMHC and AMHC uploads¶
When uploading standard PMHC clients and AMHC clients separately, the upload for the standard PMHC clients will continue to use the PMHC MDS Version 2.0 upload format and the upload for the AMHC clients must use the format as described in this document.
Option B: One upload including PMHC and AMHC clients¶
For those organisations who are ready to change their standard PMHC MDS uploads, PMHC MDS and AMHC uploads can be combined together in the one upload to the PMHC MDS.
Files or worksheets to upload¶
The AMHC extension is used in two contexts:
- The AMHC Intake team provide data to the PMHC MDS about clients that they have helped through the intake phone number.
- The AMHC Hubs provide data to the PMHC MDS about clients who have been referred to them by the Intake teams.
Which files/worksheets need to be uploaded to the PMHC MDS depends on the context for which the data is being provided.
Files/worksheets for the Intake context¶
When uploading AMHC data files for the Intake context only the following files/worksheets need to be uploaded to the PMHC MDS:
| File Type | CSV filename | Excel worksheet name | Required |
|---|---|---|---|
| Metadata | metadata.csv | Metadata | Required |
| Organisations | organisations.csv | Organisations | Optional and only available to PHN users if the user has the Organisation Management role |
| Clients | clients.csv | Clients | Optional |
| Intake | intakes.csv | Intakes | Required |
| Intake Collection Occasion | intake-collection-occasions.csv | Intake Collection Occasions | Required |
| IAR-DST Measures | iar-dst.csv | IAR-DST | Required |
Files/worksheets for the Hub context¶
When uploading AMHC data files for the Hub context only the following files/worksheets need to be uploaded to the PMHC MDS:
| File Type | CSV filename | Excel worksheet name | Required |
|---|---|---|---|
| Metadata | metadata.csv | Metadata | Required |
| Organisations | organisations.csv | Organisations | Optional and only available to PHN users if the user has the Organisation Management role |
| Clients | clients.csv | Clients | Optional |
| Episodes | episodes.csv | Episodes | Optional |
| AMHC Episodes | amhc-episodes.csv | AMHC Episodes | 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 |
| Service Contacts | service-contacts.csv | Service Contacts | Required |
| AMHC Service Contacts | amhc-service-contacts.csv | AMHC Service Contacts | Required |
All files must be internally consistent. An example of what this means is that for every AMHC episode, service contact and measures in an upload file, there must be a corresponding episode in the episodes file/worksheet. It also means that or every row in the episodes file/worksheet, there must be a corresponding client in the clients file/worksheet.
File format¶
Requirements for file formats:
- The first row must contain the column headings as defined for each file type.
- Each item is a column in the file/worksheet. The ‘Field Name’ must be used for the column headings. The columns must be kept in the same order.
- The second and subsequent rows must contain the data.
- Data elements for each file/worksheet are defined at Record formats.
- For data elements that allow multiple values, each value should be separated by a space; for example: 1 3 6.
All AMHC data uploads must include a Metadata file/worksheet. See Metadata file.
Each of the below example files assumes the following organisation structure:
| Organisation Key | Organisation Name | Organisation Type | Parent Organisation | Organisation Path | |
|---|---|---|---|---|
| PHN999 | Example PHN | Primary Health Network | None | PHN999 |
| Intake01 | Example Intake Organisation | Other | PHN999 | PHN999:Intake01 |
| Hub01 | Example Hub Organisation | State/Territory Health Service Organisation | PHN999 | PHN999:Hub01 |
Metadata file¶
All AMHC data uploads in both Intake and Hub contexts 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 ‘AMHC’ - In the third row, the first cell must contain ‘version’ and the second cell must contain ‘3.0’
i.e.:
| key | value |
| type | AMHC |
| version | 3.0 |
Data elements for the AMHC metadata upload file/worksheet are defined at Metadata.
Example AMHC metadata data:
Organisation file format¶
This file is for PHN use only. The organisation file/worksheet is optional. This is similar to the standard PMHC MDS Provider Organisation file/worksheet.
Data elements for the Provider Organisation upload file/worksheet are defined at Provider Organisation data elements.
Example organisation data:
Client file format¶
The client file/worksheet is required to be uploaded each time.
Data elements for the client upload file/worksheet are defined at Client data elements.
Example intake client data:
Example hub client data:
Intake file format¶
The intake file/worksheet is required to be uploaded each time.
Data elements for the intake upload file/worksheet are defined at Intake.
Example data:
Intake Collection Occasion file format¶
The Intake Collection Occasion file/worksheet is required to be uploaded each time.
Data elements for the Intake Collection Occasion upload file/worksheet are defined at Intake Collection Occasion.
Example Intake Collection Occasion data:
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 data elements.
Example intake episode data:
Example hub episode data:
AMHC Episode file format¶
The AMHC episode file/worksheet is required to be uploaded each time.
Data elements for the AMHC Episode upload file/worksheet are defined at AMHC Episode.
Example AMHC episode data:
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 Hub Collection Occasion data:
K10+ file format¶
The K10+ file/worksheet is required to be uploaded each time.
Data elements for the K10+ upload file/worksheet are defined at K10+ Measure.
Example Hub K10+ data:
K5 file format¶
The K5 file/worksheet is required to be uploaded each time.
Data elements for the K5 upload file/worksheet are defined at K5 Measure.
Example Hub K5 data:
SDQ file format¶
The SDQ file/worksheet is required to be uploaded each time.
Data elements for the SDQ upload file/worksheet are defined at SDQ Measure.
Example Hub SDQ data:
IAR-DST file format¶
The IAR-DST file/worksheet is required to be uploaded each time.
Data elements for the IAR-DST upload file/worksheet are defined at IAR-DST Measure.
Example Intake IAR-DST data:
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 Hub service contact data:
AMHC Service Contact file format¶
The AMHC service contact file/worksheet is required to be uploaded each time.
Data elements for the AMHC Service Contact upload file/worksheet are defined at AMHC Service Contact.
Example Hub AMHC service contact data:
Practitioner file format¶
The Practitioner file/worksheet is required for the first hub upload and when practitioner information changes. It is optional otherwise. It can be left out of an Intake upload.
Data elements for the Practitioner upload file/worksheet are defined at Practitioner data elements.
Example Intake Practitioner data:
Practitioner data is not required in an Intake upload file.
Example Hub Practitioner data:
Deleting records¶
- Records of the following type can be deleted via upload:
- Client
- Intake
- Intake Collection Occasion
- Episode
- AMHC Episode
- Collection Occasion
- K10+
- K5
- SDQ
- IAR-DST
- Service Contact
- AMHC Service Contact
- Practitioner
- An extra optional “delete” column can be added to each of the supported upload files/worksheets.
- If included, this column must be the third column in each file, after the organisation path and the record’s entity key.
- To delete a record, include its organisation path and its entity key, leave all other fields blank and put “delete” in the “delete” column. Please note that case is important. “DELETE” will not be accepted.
- Marking a record as deleted will require all child records of that record also to be marked for deletion. For example, marking a client as deleted will require all episodes, service contacts and collection occasions of that client to be marked for deletion.
- While deletions can be included in the same upload as insertions/updates, we recommend that you include all deletions in a separate upload that is uploaded before the insertions/updates.
Example AMHC files showing how to delete via upload:
AMHC Episode data¶
- CSV delete metadata file.
- CSV delete client file.
- CSV delete episode file.
- CSV delete AMHC episode file.
- CSV delete collection occasion file.
- CSV delete K10+ file.
- CSV delete K5 file.
- CSV delete SDQ file.
- CSV delete IAR-DST file.
- CSV delete service contacts file.
- CSV delete AMHC service contacts file.
- CSV delete practitioners file.
- XLSX delete file.