RvIG-2020-01-01.yaml

$id: https://raw.githubusercontent.com/MinBZK/poc-machine-law/refs/heads/main/schema/v0.1.3/schema.json
uuid: fcf09c18-1584-4565-9223-e8a86fbddc09
name: Bepalen persoonsgegevens BRP
law: wet_brp
valid_from: 2020-01-01
service: "RvIG"
description: >
  Regels voor het bepalen van persoonsgegevens volgens de Wet Basisregistratie
  Personen (RvIG). Dit omvat basisgegevens (artikel 1.6 en 1.7), woonsituatie (artikel 2.4)
  en verblijfsgegevens (artikel 2.7).

references:
  - law: "Wet BRP"
    article: "1.6"
    url: "https://wetten.overheid.nl/BWBR0033715/2024-01-01#Hoofdstuk1_Paragraaf1.2_Artikel1.6"
  - law: "Wet BRP"
    article: "1.7"
    url: "https://wetten.overheid.nl/BWBR0033715/2024-01-01#Hoofdstuk1_Paragraaf1.2_Artikel1.7"
  - law: "Wet BRP"
    article: "2.4"
    url: "https://wetten.overheid.nl/BWBR0033715/2024-01-01#Hoofdstuk2_Paragraaf2.1_Artikel2.4"
  - law: "Wet BRP"
    article: "2.7"
    url: "https://wetten.overheid.nl/BWBR0033715/2024-01-01#Hoofdstuk2_Paragraaf2.2_Artikel2.7"

properties:
  parameters:
    - name: "BSN"
      description: "BSN van de persoon"
      type: "string"
      required: true

  sources:
    - name: "BIRTH_DATE"
      description: "Geboortedatum van de persoon"
      type: "date"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"
      source_reference:
        table: "personen"
        field: "geboortedatum"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "PARTNER_BIRTH_DATE"
      description: "Geboortedatum van de partner"
      type: "date"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"
      source_reference:
        table: "personen"
        field: "geboortedatum"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de partner"
            type: "string"
            value: "$PARTNER_BSN"

    - name: "PARTNER_TYPE"
      description: "Type partnerschap registratie"
      type: "object"
      temporal:
        type: "period"
        period_type: "continuous"
      source_reference:
        table: "relaties"
        field: "partnerschap_type"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "PARTNER_BSN"
      description: "BSN nummer van de partner"
      type: "string"
      temporal:
        type: "period"
        period_type: "continuous"
      source_reference:
        table: "relaties"
        field: "partner_bsn"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "RESIDENCE_ADDRESS"
      description: "Woonadres van de persoon"
      type: "object"
      temporal:
        type: "period"
        period_type: "continuous"
      source_reference:
        table: "personen"
        field: "verblijfsadres"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "PARENT_ADDRESSES"
      description: "Woonadressen van de ouders"
      type: "array"
      temporal:
        type: "period"
        period_type: "continuous"
      source_reference:
        table: "relaties"
        field: "ouder_adressen"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "COUNTRY_OF_RESIDENCE"
      description: "Land van verblijf"
      type: "string"
      temporal:
        type: "period"
        period_type: "continuous"
      source_reference:
        table: "personen"
        field: "land_verblijf"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "NATIONALITY"
      description: "Nationaliteit"
      type: "string"
      temporal:
        type: "period"
        period_type: "continuous"
      source_reference:
        table: "personen"
        field: "nationaliteit"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "ADDRESS"
      description: "Adresgegevens"
      type: "object"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"
      source_reference:
        table: "verblijfplaats"
        fields: [ "straat", "huisnummer", "postcode", "woonplaats", "type" ]
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

    - name: "HOUSEHOLD"
      description: "Huishoudgegevens"
      type: "array"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"
      source_reference:
        table: "bewoners"
        field: "medebewoners"
        select_on:
          - name: "postcode"
            value: "$ADDRESS.postcode"
            description: "Postcode van het adres van de persoon"
            type: "string"
          - name: "huisnummer"
            value: "$ADDRESS.huisnummer"
            description: "Huisnummer van het adres van de persoon"
            type: "string"

    - name: "CHILDREN_DATA"
      description: "Gegevens over kinderen van de persoon"
      type: "array"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"
      source_reference:
        table: "relaties"
        field: "kinderen"
        select_on:
          - name: "bsn"
            description: "Burgerservicenummer van de persoon"
            type: "string"
            value: "$BSN"

  output:
    - name: "age"
      description: "Leeftijd van de persoon in jaren"
      type: "number"
      type_spec:
        unit: "years"
        precision: 0
        min: 0
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "has_partner"
      description: "Heeft de persoon een partner volgens RvIG"
      type: "boolean"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "partner_bsn"
      description: "BSN nummber van de partner"
      type: "string"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "living_situation"
      description: "Woonsituatie van de persoon (UIT/THUIS)"
      type: "string"
      temporal:
        type: "period"
        period_type: "month"

    - name: "country_of_residence"
      description: "Land van verblijf volgens RvIG"
      type: "string"
      temporal:
        type: "period"
        reference: "$calculation_date"

    - name: "has_dutch_nationality"
      description: "Heeft Nederlandse nationaliteit"
      type: "boolean"
      temporal:
        type: "period"
        reference: "$calculation_date"

    - name: "birth_date"
      description: "Geboortedatum van de persoon"
      type: "date"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "partner_birth_date"
      description: "Geboortedatum van de persoon"
      type: "date"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"
    - name: "has_fixed_address"
      description: "Heeft vast woonadres"
      type: "boolean"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "residence_address"
      description: "Volledig adres"
      type: "string"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "postal_address"
      description: "Volledig post adres"
      type: "string"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "woonplaats"
      description: "Woonplaats"
      type: "string"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "household_size"
      description: "Aantal personen in huishouden"
      type: "number"
      type_spec:
        precision: 0
        min: 1
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "household_members"
      description: "Lijst met gegevens van medebewoners"
      type: "array"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    - name: "children"
      description: "Lijst met gegevens van kinderen"
      type: "array"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

    # Nieuwe output voor de inkomstenbelastingwet
    - name: "has_children_under_12"
      description: "Heeft de persoon kinderen jonger dan 12 jaar"
      type: "boolean"
      temporal:
        type: "point_in_time"
        reference: "$calculation_date"

  definitions:
    DUTCH_NATIONALITIES:
      - "NEDERLANDS"
    ADDRESS_MATCH_DISTANCE_M: 100
    VALID_PARTNER_TYPES:
      - "HUWELIJK"
      - "GEREGISTREERD_PARTNERSCHAP"
    FIXED_ADDRESS_TYPES:
      - "WOONADRES"
    POSTAL_ADDRESS_TYPES:
      - "BRIEFADRES"
    CHILD_MAX_AGE_COMBINATIEKORTING: 12

requirements:
  - all:
      - subject: "$BIRTH_DATE"
        operation: NOT_NULL
      - subject: "$RESIDENCE_ADDRESS"
        operation: NOT_NULL

actions:
  - output: "birth_date"
    value: "$BIRTH_DATE"
  - output: "partner_birth_date"
    value: "$PARTNER_BIRTH_DATE"
  - output: "partner_bsn"
    value: "$PARTNER_BSN"
  - output: "age"
    operation: SUBTRACT_DATE
    unit: "years"
    values:
      - "$calculation_date"
      - "$BIRTH_DATE"
    reference: "Wet BRP Art. 1.6"

  - output: "has_partner"
    subject: "$PARTNER_TYPE"
    operation: IN
    values: "$VALID_PARTNER_TYPES"
    reference: "Wet BRP Art. 1.7"

  - output: "living_situation"
    operation: IF
    conditions:
      - test:
          subject: "$RESIDENCE_ADDRESS"
          operation: EQUALS
          value: "$PARENT_ADDRESSES"
        then: "THUIS"
      - else: "UIT"
    reference: "Wet BRP Art. 2.4"

  - output: "country_of_residence"
    value: "$COUNTRY_OF_RESIDENCE"
    reference: "Wet BRP Art. 2.7"

  - output: "has_dutch_nationality"
    subject: "$NATIONALITY"
    operation: IN
    values: "$DUTCH_NATIONALITIES"

  - output: "has_fixed_address"
    operation: IN
    subject: "$ADDRESS.type"
    values: "$FIXED_ADDRESS_TYPES"

  - output: "residence_address"
    operation: IF
    conditions:
      - test:
          subject: "$ADDRESS"
          operation: NOT_NULL
        then:
          operation: CONCAT
          values:
            - "$ADDRESS.straat"
            - " "
            - "$ADDRESS.huisnummer"
            - ", "
            - "$ADDRESS.postcode"
            - " "
            - "$ADDRESS.woonplaats"
      - else: null

  - output: "household_size"
    operation: IF
    conditions:
      - test:
          subject: "$HOUSEHOLD"
          operation: NOT_NULL
        then:
          operation: ADD
          values:
            - 1  # De persoon zelf
            - operation: FOREACH
              subject: "$HOUSEHOLD"
              combine: "ADD"
              value: 1
      - else: 1

  - output: "postal_address"
    operation: IF
    conditions:
      - test:
          subject: "$ADDRESS.type"
          operation: IN
          values: "$POSTAL_ADDRESS_TYPES"
        then:
          operation: CONCAT
          values:
            - "$ADDRESS.straat"
            - " "
            - "$ADDRESS.huisnummer"
            - ", "
            - "$ADDRESS.postcode"
            - " "
            - "$ADDRESS.woonplaats"
      - else: null

  - output: "woonplaats"
    value: "$ADDRESS.woonplaats"

  - output: "household_members"
    operation: IF
    conditions:
      - test:
          subject: "$HOUSEHOLD"
          operation: NOT_NULL
        then: "$HOUSEHOLD"
      - else:
          value: null  # Leeg resultaat
    reference: "Wet BRP Art. 2.4"

  - output: "children"
    operation: IF
    conditions:
      - test:
          subject: "$HOUSEHOLD"
          operation: NOT_NULL
        then:
          operation: FOREACH  # Gebruik FOREACH voor filtering
          subject: "$HOUSEHOLD"
          combine: "ADD"      # Combineer resultaten in een array
          value:
            operation: IF
            conditions:
              - test:
                  operation: LESS_THAN
                  values:
                    - "$age"
                    - 18
                then: "$item"  # Voeg dit item toe als kind
              - else: null     # Anders niets toevoegen
      - else:
          value: null  # Leeg resultaat
    reference: "Wet BRP Art. 1.6"

  # Nieuwe actie voor het bepalen of de persoon kinderen jonger dan 12 jaar heeft
  - output: "has_children_under_12"
    operation: IF
    conditions:
      - test:
          subject: "$CHILDREN_DATA"
          operation: NOT_NULL
        then:
          operation: EXISTS
          subject: "$CHILDREN_DATA"
          value:
            operation: LESS_THAN
            values:
              - operation: SUBTRACT_DATE
                unit: "years"
                values:
                  - "$calculation_date"
                  - "$item.geboortedatum"
              - "$CHILD_MAX_AGE_COMBINATIEKORTING"
      - else: false
    reference: "Wet BRP Art. 1.6"