Skip to main content

Part of Step-by-Step Guide: from registration to successful submission of the Mental Health Services Data Set (MHSDS)

Guidance documentation

Further information about using the Technical Output Specification and user guidance when submitting Mental Health Services Data Set (MHSDS) data. 

Summary

Further information about using the Technical Output Specification and user guidance when submitting Mental Health Services Data Set (MHSDS) data. 


Technical Output Specification (TOS)

This is an Excel document, with a tab for each table and additional tabs for further information. The TOS may appear incomprehensible at first, but it is vital that you become familiar with how to use it, as it is the only document that contains information on every single field in the MHSDS.

The Technical Output Specification can be downloaded from:

Implementation tools and guidance (v5.0)

One thing you will need it for is to view the options that you are allowed to submit to certain fields. These can be found in the National Code and National Code Definition columns.

You can also see the unabbreviated names of each of the fields in column Data Item Name (Data Dictionary Element) and a description in the column Data Item Description. The column IDB Element Name will match the column headers in the access database

Screenshot of columns ‘Data Item Name (Data Dictionary Element)’, ‘IDB Element Name’ and ‘Data Item Description’ from the TOS, for the field ‘Person Marital Status’

The TOS also tells you whether a field is Mandatory, Required, Optional, Pilot or Derived. You can see this information in the column ‘M/R/O/P/D’.

The column ‘Format’ tells you what format the data has to be in. For example, “max an20” means that it accepts an alphanumeric value up to a maximum of 20 characters long. These formats are described in the Technical Glossary tab.

The TOS has many more useful columns and tabs, which you can start to investigate as you become more comfortable with the MHSDS. We will look at the columns ‘Validation Rules’ and ‘Record Level Error/Warning Messages’ in the validation reports and data quality section.  

To help navigate the TOS, right click on the arrows in the bottom left corner of the window. This will bring up a list of all the tabs, which you can jump to by double clicking. 

Screenshot of bottom left corner of TOS, with the ‘Activate’ pop-up window visible, listing each of the tabs in the TOS

 


User guidance

This is a PDF document that provides more detailed descriptions on the tables and some of the fields in the MHSDS, along with many other chapters that we recommend you browse for any information relevant to you. This is not a document to read cover to cover, but one to search if you find that the Technical Output Specification doesn’t answer your question.

You should ensure you read the appendices as they provide a lot of useful information.  

 


Download the user guide


Data Model

This is a PDF document that provides a graphical representation of the database tables making up the data submission, as well as the relationships between them.

The colour coding matches the colours of the tabs in the Technical Output Specification and represents a logical grouping of tables, such as tables on patient details, tables on referrals, tables on care activity etc.


Download the Data Model


Last edited: 17 March 2022 10:32 am