Reference types

All OpenFisca-Aotearoa variables should have a reference property allowing to trace back the implementation to some authoritative document.

Legislation

The suggested reference format is thus:

class some_variable(Variable)
  definition_period = YEAR
  reference = 'http://legislation.govt.nz/…'

Agency policy

However, all readings of regulation can not necessarily be sourced from official legislation. Often, agencies will have policies that they apply, and that is what the variable models.

In such a case, the Agency policy: prefix is to be applied to the reference field:

class number_of_dependants(Variable):
    definition_period = YEAR
    reference = "Agency policy: internal note at Ministry of Social Development"
    …

Observed practice

Finally, in some cases, no formal policy documents the reading of the law that is made by an agency or other actors.

In such a case, the Observed practice: prefix is to be applied to the reference field:

class rates_rebate(Variable):
    definition_period = MONTH
    reference = "Observed practice: spreadsheet at Department Of Internal Affairs Innovation Lab"
    …