{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/VNG-Realisatie/ddas/main/v1.0/json_schema_Uitwisselmodel.json",
    "title": "Uitwisselmodel",
    "type": "object",
    "description": "Het uitwisselmodel is een model dat de gegevens bevat die uitgewisseld worden tussen de verschillende partijen.",
    "properties": {
        "startdatumLevering": {
            "description": "De begindatum van de periode waarover gerapporteerd wordt binnen de levering",
            "$ref": "#/$defs/datum"
        },
        "einddatumLevering": {
            "description": "De einddatum van de periode waarover gerapporteerd wordt binnen de levering",
            "$ref": "#/$defs/datum"
        },
        "aanleverdatumEnTijd": {
            "description": "De datum en tijd waarop de gegevens zijn aangeleverd.",
            "$ref": "#/$defs/datum-tijd"
        },
        "codeGegevensleverancier": {
            "description": "Code van de gegevensleverancier (softwareleverancier of hosting partij) die de gegevens voor 1 of meer partijen levert.",
            "type": "string"
        },
        "leveringen": {
            "type": "array",
            "items": {
                "type": "object",
                "description": "Een levering bevat steeds van \u00e9\u00e9n gemeente de verzameling van vroegsignalen en vroegsignaalzaken die over een bepaalde periode worden aangeleverd.",
                "properties": {
                    "teller": {
                        "description": "Teller van het aantal leveringen dat in het bestand is opgenomen.",
                        "type": "integer"
                    },
                    "gemeentecode": {
                        "description": "Code van de gemeente names wie de levering is gedaan.",
                        "type": "string"
                    },
                    "aanleverende_organisatie": {
                        "type": "object",
                        "description": "Organisatie de data aanlevert aan het CBS. Het kan hier gaan om de gemeente zelf, of een partij die namens de gemeente uitvoering geeft aan de afhandeling van vroegsignalen. ",
                        "properties": {
                            "naam": {
                                "type": "string"
                            },
                            "kvk-nummer": {
                                "type": "string"
                            },
                            "contactpersoonen": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "description": "Contactpersoon bij de aanleverende organisatie.",
                                    "properties": {
                                        "naam": {
                                            "type": "string"
                                        },
                                        "telefoonnummer": {
                                            "type": "string"
                                        },
                                        "email": {
                                            "$ref": "#/$defs/email"
                                        },
                                        "functietitel": {
                                            "type": "string"
                                        }
                                    }
                                },
                                "minItems": 1,
                                "uniqueItems": true
                            }
                        }
                    },
                    "vroegsignalen": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "description": "Een Vroegsignaal is een bericht dat door een signaalpartner (zoals een zorgverzekeraar, energieleverancier of verhuurder) aan de gemeente wordt verstrekt, met als doel de gemeente te informeren over een mogelijk beginnende schuldsituatie van een inwoner. Het vroegsignaal vormt het startpunt van het gemeentelijk proces van vroegsignalering van schulden.\n\nDe juridische grondslag voor het ontvangen en verwerken van vroegsignalen is vastgelegd in artikel 2.2.1 van de Wet gemeentelijke schuldhulpverlening (Wgs). Deze wet verplicht gemeenten om vroegtijdig signalen van betalingsachterstanden te ontvangen en op basis daarvan inwoners passende hulp aan te bieden.\n",
                            "properties": {
                                "ID": {
                                    "type": "string"
                                },
                                "crisissignaal": {
                                    "description": "Betreft het een crisis?\n",
                                    "type": "boolean"
                                },
                                "warmeOverdracht": {
                                    "description": "Er is al contact met persoon. Betreft verzoek deze persoon op te pakken in het kader van vroegsignalering. ",
                                    "type": "boolean"
                                },
                                "bedrag": {
                                    "$ref": "#/$defs/bedrag"
                                },
                                "ontstaansdatum": {
                                    "$ref": "#/$defs/datum"
                                },
                                "signaaldatum": {
                                    "description": "Datum waarop de signaalpartner het signaal heeft verstuurd.",
                                    "$ref": "#/$defs/datum"
                                },
                                "status": {
                                    "$ref": "#/$defs/EnumSignaalstatus"
                                },
                                "signaalpartner": {
                                    "type": "object",
                                    "description": "Een signaalpartner is een organisatie die op grond van artikel 2.2.1 van de Wet gemeentelijke schuldhulpverlening (Wgs) bevoegd is om signalen van betalingsachterstanden door te geven aan de gemeente met het doel vroegtijdige hulpverlening bij schulden mogelijk te maken. Signaalpartners zijn dienstverleners met een maatschappelijk belang, zoals zorgverzekeraars, energieleveranciers, drinkwaterbedrijven en woningverhuurders.\n\nEen signaalpartner verstrekt een vroegsignaal aan de gemeente wanneer bij een klant of huurder sprake is van een betalingsachterstand die voldoet aan de wettelijke en/of contractuele criteria voor signalering.\n",
                                    "properties": {
                                        "type": {
                                            "$ref": "#/$defs/EnumSignaalpartner"
                                        }
                                    }
                                },
                                "client": {
                                    "type": "object",
                                    "description": "Een ingeschreven persoon die gebruik maakt van producten en diensten van de gemeente.",
                                    "properties": {
                                        "Burgerservicenummer": {
                                            "type": "string"
                                        },
                                        "Voorletters": {
                                            "type": "string"
                                        },
                                        "Voorvoegsel": {
                                            "type": "string"
                                        },
                                        "Achternaam": {
                                            "type": "string"
                                        },
                                        "Geboortedatum": {
                                            "description": "De datum waarop de persoon is geboren.",
                                            "$ref": "#/$defs/datum"
                                        },
                                        "Straatnaam": {
                                            "type": "string"
                                        },
                                        "Postcode": {
                                            "type": "string"
                                        },
                                        "Huisnummer": {
                                            "type": "string"
                                        },
                                        "Huisnummertoevoeging": {
                                            "type": "string"
                                        },
                                        "Plaatsnaam": {
                                            "type": "string"
                                        }
                                    }
                                }
                            },
                            "required": [
                                "signaalpartner",
                                "client",
                                "ID"
                            ],
                            "additionalProperties": false
                        }
                    },
                    "vroegsignaalzaken": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "description": "Een Vroegsignaalzaak is procesmatige eenheid binnen de gemeentelijke organisatie waarin de behandeling van één of meerdere vroegsigna(a)len is/zijn ondergebracht. De vroegsignaalzaak omvat alle handelingen die de gemeente verricht naar aanleiding van het ontvangen vroegsignaal, zoals het vastleggen van het signaal, het uitvoeren van een eerste beoordeling, het leggen van contact met de inwoner, het registreren van contactpogingen en -resultaten, en het eventueel toeleiden naar schuldhulpverlening of andere passende ondersteuning.",
                            "properties": {
                                "resultaat": {
                                    "$ref": "#/$defs/EnumEindresultaat"
                                },
                                "matchingsdatum": {
                                    "description": "De datum waarop de matching wordt uitgevoerd.",
                                    "$ref": "#/$defs/datum"
                                },
                                "startdatum_matchtingperiode": {
                                    "description": "De matchingperiode is het tijdvak waarover de matching plaatsvindt. Hier de startdatum van de matching, die binnen de matchingsperiode valt. ",
                                    "$ref": "#/$defs/datum"
                                },
                                "datum_opgepakt": {
                                    "description": "De datum waarop de gemeente de zaak heeft opgepakt.",
                                    "$ref": "#/$defs/datum"
                                },
                                "einddatum_matchingperiode": {
                                    "description": "De matchingperiode is het tijdvak waarover de matching plaatsvindt. Hier de einddatum van de matching, die binnen de matchingsperiode valt. \n",
                                    "$ref": "#/$defs/datum"
                                },
                                "vroegsignalen": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "description": "Referentie naar het vroegsignaal dat hoort bij de vroegsignaalzaak. ",
                                        "properties": {
                                            "ID": {
                                                "type": "string"
                                            }
                                        },
                                        "required": [
                                            "ID"
                                        ],
                                        "additionalProperties": false
                                    },
                                    "minItems": 1,
                                    "uniqueItems": true
                                },
                                "contactpogingen": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "description": "Een Contactpoging is de actie die de gemeente onderneemt om in contact te treden met de inwoner naar aanleiding van een vroegsignaal. Een contactpoging maakt onderdeel uit van de vroegsignaalzaak en kan verschillende vormen aannemen, zoals een telefoongesprek, huisbezoek, brief of digitaal bericht. Van elke contactpoging wordt vastgelegd wanneer deze is gedaan, op welke wijze, met welk doel en wat het resultaat was (bijvoorbeeld: geen gehoor, gesprek gevoerd, brief retour ontvangen).\n",
                                        "properties": {
                                            "soort": {
                                                "$ref": "#/$defs/EnumContactsoort"
                                            },
                                            "bereikt": {
                                                "description": "Er is succesvol contact met de client gemaakt.",
                                                "type": "boolean"
                                            },
                                            "datum": {
                                                "$ref": "#/$defs/datum"
                                            },
                                            "dagdeel": {
                                                "description": "Ochtend, middag of avond",
                                                "$ref": "#/$defs/EnumDagdeel"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "required": [
                    "gemeentecode",
                    "teller",
                    "aanleverende_organisatie"
                ],
                "additionalProperties": false
            },
            "minItems": 1,
            "uniqueItems": true
        }
    },
    "required": [
        "einddatumLevering",
        "codeGegevensleverancier",
        "startdatumLevering",
        "aanleverdatumEnTijd"
    ],
    "additionalProperties": false,
    "$defs": {
        "datum": {
            "type": "string",
            "format": "date",
            "description": "Een datum in het formaat YYYY-MM-DD."
        },
        "email": {
            "type": "string",
            "format": "email",
            "description": "Een emailadres."
        },
        "tijd": {
            "type": "string",
            "format": "time",
            "description": "De tijd in het formaat HH:MM:SS (ISO 8601)."
        },
        "datum-tijd": {
            "type": "string",
            "format": "date-time",
            "description": "Datum en tijd in het formaat YYYY-MM-DDTHH:MM:SSZ (ISO 8601)."
        },
        "bedrag": {
            "type": "integer",
            "description": "Een geldbedrag in hele euros nauwkeurig."
        },
        "EnumContactsoort": {
            "type": "string",
            "description": "Enumeratie met daarin de soorten onderscheiden contactsoorten bij een contactpoging.",
            "enum": [
                "Mail",
                "Brief",
                "SMS/Whatsapp",
                "Telefoon",
                "Huisbezoek",
                "Kaartje",
                "Administratief",
                "Afspraak op locatie"
            ]
        },
        "EnumEindresultaat": {
            "type": "string",
            "description": "Enumeratie met de soorten Eindresultaten van een Vroegsignaalzaak.",
            "enum": [
                "Niet opgepakt: herhaalde melding",
                "Niet opgepakt: onterecht signaal",
                "Inwoner is overleden",
                "Persoon is geen inwoner (meer) in de gemeente",
                "Niet opgepakt: andere reden",
                "Inwoner al bekend bij schuldhulpverlening",
                "Inwoner heeft al een ander lopend traject",
                "Definitief geen contact kunnen krijgen",
                "Geen reactie na eerder contact",
                "Inwoner regelt het zelf/hoeft geen hulp vanuit vroegsignalering",
                "Inwoner heeft zelf al betaald/betalingsregeling getroffen",
                "(Budget)advies en/of quick fix",
                "Vervolghulp en/of verwijzing financieel",
                "Verwijzing zonder toestemming",
                "Vervolghulp en/of verwijzing niet financieel"
            ]
        },
        "EnumDagdeel": {
            "type": "string",
            "enum": [
                "Ochtend",
                "Middag",
                "Avond"
            ]
        },
        "EnumSignaalpartner": {
            "type": "string",
            "description": "Enumeratie met de soorten te onderscheiden Signaalpartners.",
            "enum": [
                "Energie",
                "Huur",
                "Hypotheek",
                "CAK Zorgverzekeringen",
                "Zorg",
                "Water",
                "DUO",
                "Belastingdienst",
                "CAK Eigen bijdrage",
                "Overige",
                "Dienst Toeslagen"
            ]
        },
        "EnumSignaalstatus": {
            "type": "string",
            "enum": [
                "Nog niet opgepakt",
                "Niet opgepakt: onterecht signaal",
                "Inwoner is overleden",
                "Persoon is geen inwoner (meer) in de gemeente",
                "Niet opgepakt: herhaalde melding",
                "Niet opgepakt: andere reden"
            ]
        }
    }
}