Add child eligible variables for childcare programs (#1112)

* Add child eligible variables

* Rename tfc

* Rename targeted

* Rename universal and extended

* Add changelog

Author: vahid-ahmadi

changelog_entry.yaml

@@ -0,0 +1,4 @@
+- bump: minor
+  changes:
+    added:
+    - Child eligible variables for childcare programs. 

policyengine_uk/tests/policy/baseline/gov/dfe/extended_childcare_entitlement/is_child_receiving_extended_childcare.yaml

@@ -0,0 +1,65 @@
+- name: Child age 2 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 2
+    benunit:
+      members: [person]
+      extended_childcare_entitlement: 3000
+  output:
+    is_child_receiving_extended_childcare: true
+
+- name: Child age 4 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 4
+    benunit:
+      members: [person]
+      extended_childcare_entitlement: 5000
+  output:
+    is_child_receiving_extended_childcare: true
+
+- name: Child age 3 with zero entitlement - ineligible
+  period: 2025
+  input:
+    person:
+      age: 3
+    benunit:
+      members: [person]
+      extended_childcare_entitlement: 0
+  output:
+    is_child_receiving_extended_childcare: false
+
+- name: Child age 5 with positive entitlement - ineligible due to age
+  period: 2025
+  input:
+    person:
+      age: 5
+    benunit:
+      members: [person]
+      extended_childcare_entitlement: 4000
+  output:
+    is_child_receiving_extended_childcare: false
+
+- name: Child age 0 with positive entitlement - ineligible due to age
+  period: 2025
+  input:
+    person:
+      age: 0
+    benunit:
+      members: [person]
+      extended_childcare_entitlement: 2000
+  output:
+    is_child_receiving_extended_childcare: false
+
+- name: Child age 0.75 with positive entitlement - eligible (2025 parameter)
+  period: 2025
+  input:
+    person:
+      age: 0.75
+    benunit:
+      members: [person]
+      extended_childcare_entitlement: 1500
+  output:
+    is_child_receiving_extended_childcare: true

policyengine_uk/tests/policy/baseline/gov/dfe/targeted_childcare_entitlement/is_child_receiving_targeted_childcare.yaml

@@ -0,0 +1,53 @@
+- name: Child age 2 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 2
+      targeted_childcare_entitlement: 2000
+  output:
+    is_child_receiving_targeted_childcare: true
+
+- name: Child age 2.5 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 2.5
+      targeted_childcare_entitlement: 1500
+  output:
+    is_child_receiving_targeted_childcare: true
+
+- name: Child age 2 with zero entitlement - ineligible
+  period: 2025
+  input:
+    person:
+      age: 2
+      targeted_childcare_entitlement: 0
+  output:
+    is_child_receiving_targeted_childcare: false
+
+- name: Child age 3 with positive entitlement - ineligible due to age
+  period: 2025
+  input:
+    person:
+      age: 3
+      targeted_childcare_entitlement: 2500
+  output:
+    is_child_receiving_targeted_childcare: false
+
+- name: Child age 1 with positive entitlement - ineligible due to age
+  period: 2025
+  input:
+    person:
+      age: 1
+      targeted_childcare_entitlement: 1800
+  output:
+    is_child_receiving_targeted_childcare: false
+
+- name: Child age 2.9 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 2.9
+      targeted_childcare_entitlement: 2200
+  output:
+    is_child_receiving_targeted_childcare: true

policyengine_uk/tests/policy/baseline/gov/dfe/universal_childcare_entitlement/is_child_receiving_universal_childcare.yaml

@@ -0,0 +1,53 @@
+- name: Child age 3 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 3
+      universal_childcare_entitlement: 2000
+  output:
+    is_child_receiving_universal_childcare: true
+
+- name: Child age 4 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 4
+      universal_childcare_entitlement: 3000
+  output:
+    is_child_receiving_universal_childcare: true
+
+- name: Child age 3 with zero entitlement - ineligible
+  period: 2025
+  input:
+    person:
+      age: 3
+      universal_childcare_entitlement: 0
+  output:
+    is_child_receiving_universal_childcare: false
+
+- name: Child age 5 with positive entitlement - ineligible due to age
+  period: 2025
+  input:
+    person:
+      age: 5
+      universal_childcare_entitlement: 2500
+  output:
+    is_child_receiving_universal_childcare: false
+
+- name: Child age 2 with positive entitlement - ineligible due to age
+  period: 2025
+  input:
+    person:
+      age: 2
+      universal_childcare_entitlement: 1500
+  output:
+    is_child_receiving_universal_childcare: false
+
+- name: Child age 4.9 with positive entitlement - eligible
+  period: 2025
+  input:
+    person:
+      age: 4.9
+      universal_childcare_entitlement: 2800
+  output:
+    is_child_receiving_universal_childcare: true

policyengine_uk/tests/policy/baseline/gov/hmrc/tax_free_childcare/is_child_receiving_tax_free_childcare.yaml

@@ -0,0 +1,59 @@
+- name: Child under 12 with positive TFC amount - eligible
+  period: 2025
+  input:
+    person:
+      age: 8
+      tax_free_childcare_child_age_eligible: true
+      tax_free_childcare: 2000
+  output:
+    is_child_receiving_tax_free_childcare: true
+
+- name: Child under 12 with zero TFC amount - ineligible
+  period: 2025
+  input:
+    person:
+      age: 7
+      tax_free_childcare_child_age_eligible: true
+      tax_free_childcare: 0
+  output:
+    is_child_receiving_tax_free_childcare: false
+
+- name: Disabled child under 17 with positive TFC amount - eligible
+  period: 2025
+  input:
+    person:
+      age: 15
+      tax_free_childcare_child_age_eligible: true
+      tax_free_childcare: 4000
+  output:
+    is_child_receiving_tax_free_childcare: true
+
+- name: Child over age limit with positive TFC amount - ineligible
+  period: 2025
+  input:
+    person:
+      age: 13
+      tax_free_childcare_child_age_eligible: false
+      tax_free_childcare: 2500
+  output:
+    is_child_receiving_tax_free_childcare: false
+
+- name: Young child with positive TFC amount - eligible
+  period: 2025
+  input:
+    person:
+      age: 3
+      tax_free_childcare_child_age_eligible: true
+      tax_free_childcare: 1000
+  output:
+    is_child_receiving_tax_free_childcare: true
+
+- name: Infant with positive TFC amount - eligible
+  period: 2025
+  input:
+    person:
+      age: 1
+      tax_free_childcare_child_age_eligible: true
+      tax_free_childcare: 900
+  output:
+    is_child_receiving_tax_free_childcare: true

policyengine_uk/variables/gov/dfe/extended_childcare_entitlement/is_child_receiving_extended_childcare.py

@@ -0,0 +1,27 @@
+from policyengine_uk.model_api import *
+
+
+class is_child_receiving_extended_childcare(Variable):
+    value_type = bool
+    entity = Person
+    label = "child is eligible for extended childcare entitlement"
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        # Get child's age
+        age = person("age", period)
+
+        # Get the parameters for extended childcare entitlement hours by age
+        p = parameters(period).gov.dfe.extended_childcare_entitlement
+
+        # Check if hours > 0 for this age (using the hours parameter)
+        hours_by_age = p.hours.calc(age)
+
+        # Get the benefit unit's extended childcare entitlement amount
+        benunit = person.benunit
+        entitlement_amount = benunit("extended_childcare_entitlement", period)
+
+        # Child is eligible if:
+        # 1. Hours > 0 for this age AND
+        # 2. Benefit unit's entitlement amount > 0
+        return (hours_by_age > 0) & (entitlement_amount > 0)

policyengine_uk/variables/gov/dfe/targeted_childcare_entitlement/is_child_receiving_targeted_childcare.py

@@ -0,0 +1,26 @@
+from policyengine_uk.model_api import *
+
+
+class is_child_receiving_targeted_childcare(Variable):
+    value_type = bool
+    entity = Person
+    label = "child is eligible for targeted childcare entitlement based on age and entitlement"
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        # Get child's age
+        age = person("age", period)
+
+        # Get the parameters for targeted childcare entitlement age eligibility
+        p = parameters(period).gov.dfe.targeted_childcare_entitlement
+
+        # Check if age is eligible
+        age_eligible = p.age_eligibility.calc(age)
+
+        # Get the targeted childcare entitlement amount
+        entitlement_amount = person("targeted_childcare_entitlement", period)
+
+        # Child is eligible if:
+        # 1. Age is eligible AND
+        # 2. Targeted childcare entitlement amount > 0
+        return age_eligible & (entitlement_amount > 0)

policyengine_uk/variables/gov/dfe/universal_childcare_entitlement/is_child_receiving_universal_childcare.py

@@ -0,0 +1,26 @@
+from policyengine_uk.model_api import *
+
+
+class is_child_receiving_universal_childcare(Variable):
+    value_type = bool
+    entity = Person
+    label = "child is eligible for universal childcare entitlement based on age and entitlement"
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        # Get child's age
+        age = person("age", period)
+
+        # Get the parameters for universal childcare entitlement
+        p = parameters(period).gov.dfe.universal_childcare_entitlement
+
+        # Check if age is within eligible range
+        meets_age_condition = (age >= p.min_age) & (age < p.max_age)
+
+        # Get the universal childcare entitlement amount
+        entitlement_amount = person("universal_childcare_entitlement", period)
+
+        # Child is eligible if:
+        # 1. Age meets the condition AND
+        # 2. Universal childcare entitlement amount > 0
+        return meets_age_condition & (entitlement_amount > 0)

policyengine_uk/variables/gov/hmrc/tax_free_childcare/is_child_receiving_tax_free_childcare.py

@@ -0,0 +1,24 @@
+from policyengine_uk.model_api import *
+
+
+class is_child_receiving_tax_free_childcare(Variable):
+    value_type = bool
+    entity = Person
+    label = (
+        "child is eligible for tax-free childcare based on age and entitlement"
+    )
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        # Check if child meets the age condition
+        meets_age_condition = person(
+            "tax_free_childcare_child_age_eligible", period
+        )
+
+        # Check if tax-free childcare contribution is greater than 0
+        tfc_amount = person("tax_free_childcare", period)
+
+        # Child is eligible if:
+        # 1. Meets the age condition AND
+        # 2. Tax-free childcare amount > 0
+        return meets_age_condition & (tfc_amount > 0)