Guaranteed Income Supplement + Spousal Allowance

policyengine_canada/parameters/gov/cra/benefits/gis_spa/widows_eligibility_age.yaml

@@ -0,0 +1,8 @@
+description: Age at which a widow becomes eligible for the GIS
+values:
+  2020-01-01: 60
+metadata:
+  label: SPA Widow Eligibility Age
+  reference:
+  - title: Government of Canada - Guaranteed Income Supplement
+    href: https://www.canada.ca/en/services/benefits/publicpensions/cpp/old-age-security/guaranteed-income-supplement/allowance-survivor.html

policyengine_canada/tests/gov/cra/benefits/gis_spa/gis_spa_category.yaml

@@ -0,0 +1,34 @@
+- name: Single OAS Pensioner
+  period: 2022
+  input:
+    is_married: false
+    old_age_security_pension_eligibility: true
+  output:
+    gis_spa_category: "SINGLE_WITH_OAS"
+
+- name: Single OAS Pensioner
+  period: 2022
+  input:
+    is_widow: true
+    old_age_security_pension_eligibility: false
+    age: 61
+  output:
+    gis_spa_category: "WIDOW_60_64"
+
+- name: Couple, both are OAS eligible
+  period: 2022
+  input:
+    is_married: true
+    people:
+      head:
+        age: 70
+        old_age_security_pension_eligibility: true
+      spouse:
+        age: 70
+        old_age_security_pension_eligibility: true
+    household:
+      is_married: true
+      members: [head, spouse]
+  output:
+      gis_spa_category: ["COUPLE_BOTH_OAS", "COUPLE_BOTH_OAS"]
+

policyengine_canada/tests/gov/cra/benefits/gis_spa/spouse_oas_eligible.yaml

@@ -0,0 +1,32 @@
+- name: Spouse is OAS eligible
+  period: 2022
+  input:
+    is_married: true
+    people:
+      head:
+        age: 70
+        old_age_security_pension_eligibility: true
+      spouse:
+        age: 70
+        old_age_security_pension_eligibility: true
+    household:
+      members: [head, spouse]
+  output:
+      spouse_oas_eligible: [true, true]
+
+- name: Spouse is not OAS eligible
+  period: 2022
+  input:
+    is_married: true
+    people:
+      head:
+        age: 70
+        old_age_security_pension_eligibility: false
+      spouse:
+        age: 70
+        old_age_security_pension_eligibility: true
+    household:
+      members: [head, spouse]
+  output:
+      spouse_oas_eligible: [false, true]
+

policyengine_canada/variables/gov/cra/benefits/gis_spa/gis_eligible.py

@@ -0,0 +1,18 @@
+from policyengine_canada.model_api import *
+
+class gis_eligible(Variable):
+    value_type = bool
+    entity = Person
+    label = "Eligible for guaranteed income supplement"
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        p = parameters(period).gov.cra.benefits.gis
+        age = person("age", period) 
+        # using the pre-repayment amount here because the documentation says "receives the OAS". 
+        oas = person("old_age_security_pension_pre_repayment", period)
+        income = 3
+
+        # MAKE A 'type of household' variable!!
+        # MAKE A 'maximum amount' parameter based on 'type of household'!!
+        # MAKE A 'reduction rate' parameter based on 'type of household'? Copy GISRLS for example.

policyengine_canada/variables/gov/cra/benefits/gis_spa/gis_spa_category.py

@@ -0,0 +1,40 @@
+from policyengine_canada.model_api import *
+
+# Categories as listed in SPSD/M variable 'imoldtyp'
+class GISSPACategory(Enum):
+    NONE            = "none"
+    SINGLE_WITH_OAS = "single_with_oas"
+    WIDOW_60_64     = "widow_60_64"
+    COUPLE_BOTH_OAS = "couple_both_oas"
+    COUPLE_ELDER_OAS_YOUNGER_60_64 = "couple_elder_oas_younger_60_64"
+    COUPLE_YOUNGER_OAS = "couple_younger_oas"
+
+class gis_spa_category(Variable):
+    value_type = Enum
+    entity = Person
+    possible_values = GISSPACategory
+    default_value = GISSPACategory.NONE
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        household = person.household
+        age = person("age", period)
+        married = household("is_married", period)
+        widow = person("is_widow", period)
+        oas_eligible = person("old_age_security_pension_eligibility", period)
+        spouse_oas_eligible = person("spouse_oas_eligible", period)
+        p = parameters(period).gov.cra.benefits.gis_spa
+        return select(
+            [
+                ~married & oas_eligible,
+                # The law specifies widows aged 60-64, but that cutoff of 64 is just because at 65 you become eligible for OAS. I just reference OAS eligibilty directly.
+                widow & ~married & ~oas_eligible & (age >= p.widows_eligibility_age),
+                married & oas_eligible & spouse_oas_eligible 
+            ],
+            [
+                GISSPACategory.SINGLE_WITH_OAS,
+                GISSPACategory.WIDOW_60_64,
+                GISSPACategory.COUPLE_BOTH_OAS
+            ],
+            default=0,
+        )

policyengine_canada/variables/gov/cra/benefits/gis_spa/spouse_oas_eligible.py

@@ -0,0 +1,17 @@
+from policyengine_canada.model_api import *
+
+class spouse_oas_eligible(Variable):
+    value_type = bool
+    entity = Person
+    label = "Spouse is eligible for the Old Age Security Pension"
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        oas_eligible = person("old_age_security_pension_eligibility", period)
+        head_or_spouse = person("is_head", period) | person("is_spouse", period)
+        head_or_spouse_oas_eligible = head_or_spouse & oas_eligible
+        household = person.household
+        count_head_or_spouse_oas_eligible = household.sum(head_or_spouse_oas_eligible)
+        spouse_oas_eligible = count_head_or_spouse_oas_eligible - where(oas_eligible, 1, 0)
+
+        return spouse_oas_eligible

policyengine_canada/variables/household/person/is_widow.py

@@ -0,0 +1,8 @@
+from policyengine_canada.model_api import *
+
+class is_widow(Variable):
+    value_type = bool
+    entity = Person
+    label = "Widow or widower"
+    documentation = "Spouse or common-law partner has died and since their death the person has not remarried or become a common-law partner to another person"
+    definition_period = YEAR

setup.py

@@ -27,7 +27,7 @@
     "tqdm>=4.46.0,<5",
     "requests>=2.27.1,<3",
     "pandas>=1.4.2,<2",
-    "policyengine_core>=1.10.18,<2",
+    "policyengine_core>=1.11.4,<2",
     "plotly>=5.6.0,<6",
 ]