openapi: "3.0.2"
info:
  title: "Digitaal Vlaanderen - Volledige Dossiers Handicap"
  description: "Deze dienst geeft alle info rond een dossier handicap"
  contact:
    name: "Magda helpdesk"
    url: "https://overheid.vlaanderen.be/magda"
  license:
    name: "Volledige dossiers Handicap"
    url: "https://overheid.vlaanderen.be/magda"
  version: "1.0.0"
servers:
  - url: "api/v1/socZek"
paths: 
  /handicap/volledigeDossiers:
    get:
      tags:
        - "VolledigeDossiers"
      summary: "Haalt volledige dossier op basis van rijksregisternummer"
      parameters:
        - name: x-correlation-id
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/Correlation-Id'
        - name: rrnr
          description: "Rijksregisternummer"
          in: query
          required: true
          schema:
            type: string
      responses:
        200:
          description: "Response met inhoud"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DossierInfo'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/InvalidAuthorization'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/UnexpectedServerError'
        502:
          $ref: '#/components/responses/BadGateway'
        503:
          $ref: '#/components/responses/ServiceUnavailable'
        504:
          $ref: '#/components/responses/GatewayTimeout'

components:
 parameters:
    CorrelationId:
      name: x-correlation-id
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/Correlation-Id'
 responses:
    #HTTP Status 400
    BadRequest:
      description: "Invalid data supplied"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 401
    InvalidAuthorization:
      description: "Invalid authorization"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 403
    Forbidden:
      description: "Authentication failed"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 404
    NotFound:
      description: "Resource not found"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 412
    PreConditionFailed:
      description: Precondition Failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 500
    UnexpectedServerError:
      description: "Unexpected Server Error"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 502
    BadGateway:
      description: "Bad Gateway"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 503
    ServiceUnavailable:
      description: "Service unavailable"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 504
    GatewayTimeout:
      description: "Gateway Timeout"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
 schemas:
    Correlation-Id:
      description: "ID of the transaction. Use this ID for log tracing and incident handling"
      type: string
      minLength: 10
      maxLength: 36

    DossierInfo:
      type: object
      properties:
        "@context":
          type: string
          default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/485949995/handicapvolledigeDossiers-context.jsonld?api=v2'
        wettelijkeVertegenwoordigers:
          type: array
          items:
            $ref: '#/components/schemas/WettelijkeVertegenwoordiger'
        persoonsgegevens:
          $ref: '#/components/schemas/Persoon'
        persoonsvolgendBudget:
          $ref: '#/components/schemas/PersoonsvolgendBudget'
        rth:
          $ref: '#/components/schemas/RTH'
        overeenkomsten:
          $ref: '#/components/schemas/NietPvbGebondenZorg'
        diagnose:
          $ref: '#/components/schemas/Diagnose'
        hulpmiddelen:
          $ref: '#/components/schemas/Hulpmiddelen'
    Adres:
      type: object
      properties:
        '@type':
          type: string
          enum:
            - AdresVoorstelling
        straatnaam:
          $ref: '#/components/schemas/TaalString'
        huisnummer:
          type: string
        busnummer:
          type: string
        postcode:
          type: string
        postnaam:
          $ref: '#/components/schemas/TaalString'
        land:
          $ref: '#/components/schemas/TaalString'
        volledigAdres:
          $ref: '#/components/schemas/TaalString'
    Bedrag:
      type: number
      format: double
    Punten:
      type: number
      format: double
    TaalString:
      type: object
      properties:
        nl:
          type: string
        fr:
          type: string
    Diagnose:
      type: object
      properties:
        laatsteVerslag:
          $ref: '#/components/schemas/Verslag'
        stoornissen:
          type: array
          items:
            $ref: '#/components/schemas/Stoornis'
        handicaps:
          type: array
          items:
            $ref: '#/components/schemas/Handicap'
        iqTest:
          $ref: '#/components/schemas/IQTest'
        motorischeBeperkingen:
          $ref: '#/components/schemas/MotorischeBeperkingen'
        zelfredzaamheid:
          $ref: '#/components/schemas/Zelfredzaamheid'
        zorgZwaarte:
          $ref: '#/components/schemas/ZorgZwaarte'
        beperkingen:
          type: array
          items:
            $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        stoornisCodes:
          type: array
          writeOnly: true
          items:
            $ref: '#/components/schemas/Stoornis'
    DossierInfoCodeOmschrijving:
      required:
        - code
        - omschrijving
      type: object
      properties:
        code:
          type: string
        omschrijving:
          type: string
    ErkenningHandicap:
      type: object
      properties:
        heeftHandicap:
          type: string
          enum:
            - JA
            - NEEN
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
    Fout:
      required:
        - bericht
        - type
      type: object
      properties:
        bericht:
          type: string
        code:
          type: string
        type:
          type: string
          enum:
            - BEVEILIGING
            - VALIDATIE
            - DATA
            - SYSTEEM
            - ONBEKEND
            - XSD_VALIDATIE
            - REQUEST
      xml:
        name: fout
        namespace: http://www.vaph.be/common
    Handicap:
      type: object
      properties:
        code:
          type: string
        naam:
          type: string
    HulpmiddelDoelgroep:
      type: object
      properties:
        omschrijving:
          type: string
        categorien:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
    IQTest:
      type: object
      properties:
        p:
          type: number
          format: double
        v:
          type: number
          format: double
        t:
          type: number
          format: double
        datum:
          type: string
          format: date
        type:
          type: string
        verslag:
          $ref: '#/components/schemas/Verslag'
    HulpmiddelBewijs:
      type: object
      properties:
        factuurdatum:
          type: string
          format: date
        factuurReferentie:
          type: string
        leverancier:
          type: string
        bedrag:
          $ref: '#/components/schemas/Bedrag'
        betaalbaar:
          type: boolean
    Hulpmiddelen:
      type: object
      properties:
        doelgroepen:
          type: array
          items:
            $ref: '#/components/schemas/HulpmiddelDoelgroep'
        hulpmiddel:
          type: array
          items:
            $ref: '#/components/schemas/Hulpmiddel'
    Hulpmiddel:
      type: object
      properties:
        code:
          type: string
        naam:
          type: string
        domein:
          type: string
        omschrijving:
          type: string
        aanvraagdatum:
          type: string
          format: date
        facturenBetaalbaarVanaf:
          type: string
          format: date
        toegewezenBedrag:
          $ref: '#/components/schemas/Bedrag'
        bewijzen:
          type: array
          items:
            $ref: '#/components/schemas/HulpmiddelBewijs'
        status:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
    MdtVerslagNemer:
      type: object
      properties:
        mdt:
          $ref: '#/components/schemas/Organisatie'
        mdtMedewerker:
          $ref: '#/components/schemas/Persoon'
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
    MotorischeBeperkingen:
      type: object
      properties:
        verslag:
          $ref: '#/components/schemas/Verslag'
        bovensteLedematenLinks:
          type: string
        bovensteLedematenRechts:
          type: string
        ondersteLedematenLinks:
          type: string
        ondersteLedematenRechts:
          type: string
        wervelkolom:
          type: string
        stappen300m:
          type: string
    NietPvbGebondenZorg:
      type: object
      properties:
        mfc:
          type: array
          items:
            $ref: '#/components/schemas/MfcOvereenkomst'
        odb:
          type: array
          items:
            $ref: '#/components/schemas/OdbOvereenkomst'
        geinterneerden:
          type: array
          items:
            $ref: '#/components/schemas/GeinterneerdenOvereenkomst'
        forensischeVAPHUnit:
          type: array
          items:
            $ref: '#/components/schemas/ForensischeVaphUnitOvereenkomst'
        nah:
          type: array
          items:
            $ref: '#/components/schemas/NahOvereenkomst'
    BestedingOvereenkomst:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        type:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
        zorgpunten:
          $ref: '#/components/schemas/Bedrag'
        bedrag:
          $ref: '#/components/schemas/Bedrag'
    MfcOvereenkomst:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        type:
          $ref: '#/components/schemas/OvereenkomstType'
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
        zorgpunten:
          $ref: '#/components/schemas/Punten'
        dagopvang:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        dagBesteding:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        diagnostiek:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        behandeling:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        begeleiding:
          type: boolean
        verblijf:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        toegangsPoortJeugdrechter:
          type: boolean
        toegangsPoortMaatschappelijkeNoodzaak:
          type: boolean
        intersectoraalTraject:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        datumUitstroom:
          type: string
          format: date
        redenUitstroom:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        redenUitstroomUitleg:
          type: string
    OdbOvereenkomst:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        type:
          $ref: '#/components/schemas/OvereenkomstType'
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
        dagondersteuning:
          type: number
        woonondersteuning:
          type: integer
        individuelePsychosocialeBegeleiding:
          type: integer
        datumUitstroom:
          type: string
          format: date
    GeinterneerdenOvereenkomst:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        type:
          $ref: '#/components/schemas/OvereenkomstType'
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
        module:
          type: string
    ForensischeVaphUnitOvereenkomst:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        type:
          $ref: '#/components/schemas/OvereenkomstType'
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
    NahOvereenkomst:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        type:
          $ref: '#/components/schemas/OvereenkomstType'
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
        redenUitstroom:
          type: string
    Persoon:
      type: object
      properties:
        '@type':
          type: string
          default: Persoon
        achternaam:
          type: string
        voornaam:
          type: string
        geslacht:
          type: string
        heeftGeboorte:
          $ref: '#/components/schemas/Geboorte'
        volledigeNaam:
          type: string
        contactinfo:
          $ref: '#/components/schemas/Contact'
        rijksregisternummer:
          $ref: '#/components/schemas/Registratie'
        dossiernummer:
          $ref: '#/components/schemas/Registratie'
        erkenningHandicap:
          $ref: '#/components/schemas/ErkenningHandicap'
        ondernemingsnummer:
          $ref: '#/components/schemas/Registratie'
    Geboorte:
      type: object
      properties:
        '@type':
          type: string
          enum:
            - PersoonsGebeurtenis
        datum:
          type: string
          format: date
    Contact:
      type: object
      properties:
        telefoon:
          type: string
        email:
          type: string
        adres:
          $ref: '#/components/schemas/Adres'
    Organisatie:
      type: object
      properties:
        '@type':
          type: string
          enum:
            - Organisatie
        ondernemingsnummer:
          $ref: '#/components/schemas/Registratie'
        erkenningsnummer:
          $ref: '#/components/schemas/Registratie'
        naam:
          type: string
        contactinfo:
          $ref: '#/components/schemas/Contact'
    Registratie:
      type: object
      properties:
        notatie:
          type: string
        agent:
          type: string
          enum:
            - rijksregister
            - KBO
            - VAPH
    RTH:
      type: array
      items:
        $ref: '#/components/schemas/RthRegistratie'
    RthRegistratie:
      type: object
      properties:
        zorgaanbieder:
          $ref: '#/components/schemas/Zorgaanbieder'
        registraties:
          type: array
          items:
            $ref: '#/components/schemas/RthRegistratiesPerJaar'
    RthRegistratiesPerJaar:
      type: object
      properties:
        jaar:
          type: integer
        aantalRegistraties:
          type: integer
        gebruiktePunten:
          type: number
    Stoornis:
      type: object
      properties:
        code:
          type: string
        naam:
          type: string
        verslag:
          $ref: '#/components/schemas/Verslag'
    Verslag:
      type: object
      properties:
        verzendingsdatum:
          type: string
          format: date
        mdtVerslagNemer:
          $ref: '#/components/schemas/MdtVerslagNemer'
    WettelijkeVertegenwoordiger:
      type: object
      properties:
        persoon:
          $ref: '#/components/schemas/Persoon'
        wettelijkeVertegenwoordigerType:
          _comment: Omzetten naar codetabel
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
    Zelfredzaamheid:
      type: object
      properties:
        elida:
          type: number
          format: double
        barthel:
          type: number
          format: double
        verslag:
          $ref: '#/components/schemas/Verslag'
    ZorgZwaarte:
      type: object
      properties:
        bWaarde:
          type: number
          format: double
        pWaarde:
          type: number
          format: double
        verslag:
          $ref: '#/components/schemas/Verslag'
        zziWaarden:
          type: array
          items:
            $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
    Zorgaanbieder:
      type: object
      properties:
        organisatie:
          $ref: '#/components/schemas/Organisatie'
        persoon:
          $ref: '#/components/schemas/Persoon'
    PersoonsvolgendBudget:
      type: object
      properties:
        ondersteuningsplannen:
          type: array
          items:
            $ref: '#/components/schemas/Ondersteuningsplan'
        inAfwachtingVanBudgetOfExtraBudget:
          type: string
          enum:
            - JA
            - NEEN
        budget:
          $ref: '#/components/schemas/Budget'
    Ondersteuningsplan:
      type: object
      properties:
        verzendingsdatum:
          type: string
          format: date
        gewoneVraag:
          $ref: '#/components/schemas/Vraag'
        dringendeVraag:
          $ref: '#/components/schemas/Vraag'
    Vraag:
      type: object
      properties:
        ondersteuningsfuncties:
          type: array
          items:
            $ref: '#/components/schemas/OndersteuningsFunctie'
        gevraagdeBudgetcategorie:
          _comment: Om te zetten naar codetabel
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
    OndersteuningsFunctie:
      type: object
      properties:
        functie:
          type: string
        frequentie:
          type: string
        eenheid:
          type: string
    Budget:
      type: object
      properties:
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        terugvorderbaarVoorschot:
          $ref: '#/components/schemas/Bedrag'
        budgetcategorie:
          _comment: om te zetten naar codetabel
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        toegewezenZorgpunten:
          $ref: '#/components/schemas/Punten'
        jaarbudgetten:
          type: array
          items:
            $ref: '#/components/schemas/JaarBudget'
        overeenkomsten:
          type: array
          items:
            $ref: '#/components/schemas/BestedingOvereenkomst'
        dagbesteding:
          $ref: '#/components/schemas/Dagbesteding'
        tekortenHuidigeOndersteuning:
          type: string
        noodAanToezicht:
          type: string
          enum:
            - JA
            - NEEN
        vraagMotiveringMeerwaarde:
          type: string
        vraagOndersteuningsplan:
          type: string
    JaarBudget:
      type: object
      properties:
        jaar:
          type: integer
        type:
          type: string
          enum:
            - PAB
            - PVB
            - PAB_PVB
        startdatum:
          type: string
          format: date
        einddatum:
          type: string
          format: date
        budgethoogte:
          $ref: '#/components/schemas/Bedrag'
        saldoBudget:
          $ref: '#/components/schemas/Bedrag'
    Dagbesteding:
      type: object
      properties:
        activiteiten:
          type: array
          items:
            $ref: '#/components/schemas/Activiteit'
    Activiteit:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        toelichting:
          type: string
        regime:
          type: string
          enum:
            - DEELTIJDS
            - VOLTIJDS
    OvereenkomstType:
      type: object
      properties:
        hoofdtype:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
        subtype:
          $ref: '#/components/schemas/DossierInfoCodeOmschrijving'
    ErrorMessage:
      required:
        - detail
        - title
      type: object
      properties:
        type:
          type: string
          description: "A URI reference that identifies the problem type. This specification encourages that, when de-referenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be about:blank."
        title:
          type: string
          description: "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation."
        status:
          type: string
          description: "The HTTP status code generated by the origin server for this occurrence of the problem."
        detail:
          type: string
          description: "A human-readable explanation specific to this occurrence of the problem."
        instance:
          type: string
          description: "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced."
      description: "A representation of a generic error message."