Validation rules¶
HeadtoHelp is an extension of the Primary Mental Health Care Minimum Data Set (PMHC MDS); the current PMHC MDS Validations rules apply. These are available to be viewed at https://docs.pmhc-mds.com/data-specification/validation-rules.html.
This document defines validation rules between HeadtoHelp items and record types. The domain of individual HeadtoHelp items is defined in Record formats.
Current HeadtoHelp validations¶
1. Episode¶
Under the HeadtoHelp specification the following episode validations exist for Episodes as well as the default PMHC episode validations at https://docs.pmhc-mds.com/projects/data-specification/en/latest/validation-rules.html#episode
- Any changes to an Episode record require that HeadtoHelp Episode - Context be set to
a value other than
9: Unknown
.
2. HeadtoHelp - Episode¶
- Episode Key must be an existing PMHC episode within the PMHC MDS.
!covid19
tag should be included in the Episode - Tags field of the corresponding PMHC episode, otherwise the system will automatically include it.- If a HeadtoHelp Episode - Intake Organisation Path is specified, that organisation must be an existing organisation within the PMHC MDS.
- If a HeadtoHelp Episode - Intake Episode Key is specified, a HeadtoHelp Episode - Intake Organisation Path must also be specified.
- HeadtoHelp Episode - Referral Out Organisation Type is a multivalued field.
- Multivalued fields can not have duplicates, For example,
1 1 1
is not allowed. - If
0: None/Not applicable
is provided, no other values are permitted.
- Multivalued fields can not have duplicates, For example,
- Any changes to a HeadtoHelp Episode record require that HeadtoHelp Episode - Context be
set to a value other than
9: Unknown
. - HeadtoHelp Episode - Context value of
9: Unknown
cannot be used on new records. - Existing records already containing a HeadtoHelp Episode - Context value of
9: Unknown
may be updated to one of the non9: Unknown
values. - Existing records already containing a HeadtoHelp Episode - Context value that is not
9: Unknown
cannot be changed to9: Unknown
. - HeadtoHelp Episode - Context shall only be allowed to be changed between
1: Intake
and2: Hub
where all other validations pertaining to the new value for HeadtoHelp Episode - Context are satisfied. - Where HeadtoHelp Episode - Context is set to
1: Intake
HeadtoHelp Episode - Intake Organisation Path and HeadtoHelp Episode - Intake Episode Key must not be specified - Where HeadtoHelp Episode - Context is set to
2: Hub
HeadtoHelp Episode - Intake Organisation Path and HeadtoHelp Episode - Intake Episode Key should be specified
2. Collection Occasion¶
- Episode Key must be an existing PMHC episode within the PMHC MDS.
- The Collection Occasion - Date
- must not be before 1 January 2016
- and must not be before Episode - Referral Date
- and must not be before Provider Organisation - Start Date
- and must not be more than 7 days after Episode - End Date
- and must not be after Provider Organisation - End Date
- and must not be in the future
3. K10+¶
- Collection Occasion Key must be an existing Collection Occasion within the PMHC MDS.
- If both item scores and a total score are specified, the item scores must add up to the total score (as per Scoring the K10+).
- K10+ records must not be associated with an Episode where HeadtoHelp Episode - Context
is
1: Intake
.
4. K5¶
- Collection Occasion Key must be an existing Collection Occasion within the PMHC MDS.
- If both item scores and a total score are specified, the item scores must add up to the total score (as per Scoring the K5).
- K5 records must not be associated with an Episode where HeadtoHelp Episode - Context
is
1: Intake
.
5. SDQ¶
- Collection Occasion Key must be an existing Collection Occasion within the PMHC MDS.
- Use the table at SDQ Data Elements to validate the items that are used in each version of the SDQ
- If both item scores and subscales are specified, the sum of the items must agree with the subscales score (as per Scoring the SDQ)
- If both subscales and total score are specified, the sum of the subscales must agree with the total score (as per Scoring the SDQ)
- SDQ records must not be associated with an Episode where
HeadtoHelp Episode - Context is
1: Intake
.
6. IAR-DST¶
- Collection Occasion Key must be an existing Collection Occasion within the PMHC MDS.
- Both all 8 domains and the level of care must be provided.
- The level of care must be consistent with the 8 domain scores provided.
- IAR-DST records must not be associated with an Episode where
HeadtoHelp Episode - Context is
2: Hub
.
7. HeadtoHelp - Service Contact¶
- HeadtoHelp - Service Contact - Practitioner Category is a multivalued field.
- Multivalued fields can not have duplicates, For example,
1 1 1
is not allowed. - If
0: None/Not applicable
is provided, no other values are permitted.
- Multivalued fields can not have duplicates, For example,
Current PMHC validations¶
HeadtoHelp is an extension of the Primary Mental Health Care Minimum Data Set (PMHC MDS); the current PMHC MDS Validations rules may apply, depending on how you add your HeadtoHelp data. The current PMHC MDS validations rules are available to be viewed at https://docs.pmhc-mds.com/data-specification/validation-rules.html.