Siirry sisältöön

Ryhti-tietojärjestelmän alueidenkäytön rajoitusten elinkaari- ja laatusäännöt

Tälle sivulle on koottu kansallisen alueidenkäytön rajoitusten tietomallin elinkaari- ja laatusäännöt, jotka ovat käytössä rakennetun ympäristön tietojärjestelmän toteutuksessa.

Sivua on luotu 11.11.2024, sivun muutoshistoria

Johdanto

Ryhti-järjestelmä vastaanottaa kansallisen alueidenkäytön rajoitusten tietomallin(siirryt toiseen palveluun) (eli Yhteentoimivuusalustan loogisen tason alueidenkäytön rajoitusten tietomallin) mukaisesti määriteltyä alueidenkäytön rajoitustietoa.

Kansallisen alueidenkäytön rajoitusten tietomallin mukaan alueidenkäytön rajoitukset tallennetaan Ryhti-järjestelmään ainoastaan voimassa elinkaaren vaiheessa. Tätä määrittelyä varten Ryhti-järjestelmän kehittämisen yhteydessä on laadittu alueidenkäytön rajoitustiedoille elinkaarisäännöt.

Elinkaarisääntöjen määrittely liittyy olennaisesti voimaan tulevien ja jatkettavien alueidenkäytön rajoitusten ja kumoutuvien alueidenkäytön rajoitusten ja niiden kohteiden elinkaaren hallintaan.

Tässä annetut säännöt pohjautuvat paikkatietokohteiden yksilöivien tunnusten ja elinkaarisääntöjen periaatteisiin, jotka on kuvattu julkishallinnon suosituksessa JHS 193. Alueidenkäytön rajoituksille yhteiset elinkaari- ja laatusäännöt toimivat lähtökohtana Ryhti-järjestelmän validointisäännöille, jotka kuvataan yleiset tietomääritykset ja laatusäännöt -sivulla.

Tunnukset ja niiden hallinta

Pysyvä ihmisluettava alueidenkäytön rajoitustunnus

Pysyvä alueidenkäytön rajoitustunnus on ennakolta Ryhti-järjestelmästä haettava kansallisesti pysyvä yksilöivä tunnus. Tällöin voidaan tarkistaa, onko tallennettavaksi tarkoitettu pysyvä alueidenkäytön rajoitustunnus myönnetty organisaatiolle, jonka alueidenkäytön rajoitusta ollaan tallentamassa. Pysyvä alueidenkäytön rajoitustunnus voidaan hakea Ryhti-järjestelmästä hyödyntämällä rajapintoja kuntien tietojärjestelmistä tai hakemalla Ryhti-käyttöliittymän kautta.

Kansallisessa alueidenkäytön rajoitusten tietomallissa alueidenkäytön rajoitustunnus kuvataan AlueidenkäytönRajoituksenAsia-luokan attribuutilla pysyväAlueidenkäytönRajoituksenTunnus.

Tuottava tietojärjestelmä vastaa alueidenkäytön rajoitustunnuksen asettamisesta AlueidenkäytönRajoituksenAsia-luokan pysyväAlueidenkäytönRajoituksenTunnus-attribuutiksi. Se tulee olla asetettuna alueidenkäytön rajoitukselle Ryhti-järjestelmään tehtävän tallennuksen yhteydessä.

Pysyvän alueidenkäytön rajoitustunnuksen rakenne muodostuu kahdesta alkukirjaimesta (RK) ja kuudesta juoksevasta numerosta.

Esimerkki alueidenkäytön rajoitusten pysyvästä tunnuksesta: RK-000001

Rajapinta uuden pysyvän alueidenkäytön rajoituksen tunnuksen hakemiseen:
POST /api/LandUseRestrictionMatter/permanentLandUseRectrictionIdentifier

HTTP-URI tunnisteet

HTTP URI -muotoiset tunnukset ovat RFC 3986 -standardiin perustuvia HTTP(S) -protokollan mukaisia URI-osoitteita(siirryt toiseen palveluun) (Uniform Resource Identifier), joiden globaali yksilöivyys varmistetaan Internetin DNS-nimipalveluun (DNS, Domain Name System) rekisteröityjen verkkotunnusten avulla. Kullakin DNS-palveluun rekisteröidyllä verkkotunnuksella (esim. uri.suomi.fi, uri.rakennetunymparistontietojarjestelma.fi) on yksiselitteinen omistaja, joka on suoraan tai välillisesti vastuussa ko. verkkotunnuksen alla julkaistavasta sisällöstä. Nimen omistaja on myös ainoa taho, joka voi päättää ko. verkkotunnusta käyttävien osoitteiden ohjautumisesta haluttuihin resursseihin, mikä tekee siitä luontevan perustan yksilöivien tunnusten nimiavaruuksille (esimerkiksi https://uri.rakennetunymparistontietojarjestelma.fi/tonttijakotontti/). HTTP URI -muotoisen tunnuksen yksilöivyys perustuu siis verkkotunnusten ja siten niihin perustuvien nimiavaruuksien keskitettyyn hallintaprosessiin.

URI-tunnuksen ei tarvitse viitata konkreettiseen sijaintiin internetissä, vaan se voi olla abstraktimpi tunnus. JHS 193 Paikkatiedon yksilöivät tunnukset määrittelee paikkatiedon yksilöiville tunnuksille muodon http://paikkatiedot.fi/{tunnustyyppi}/{aineistotunnus}/{paikallinen tunnus} , jossa paikkatietokohteiden tunnustyyppi on so. Kansallisessa alueidenkäytön rajoitusten tietomallissa on käytetty tunnusmuotoa https://uri.rakennetunymparistontietojarjestelma.fi/{class}/{permanentidentifier}. HTTP URI -muotoisen tunnuksen etuna on luettavuus sekä DNS- ja HTTP-protokollien tarjoama kyky ratkaista tunnus ja ohjata kysyjä sitä kuvaavaan Internet-resurssiin ilman tarvetta erityiselle keskitetylle tunnusrekisterille ja siihen perustuvalle ratkaisupalvelulle.

Kansallisessa alueidenkäytön rajoitusten tietomallissa HTTP URI -muotoa käytetään attribuuteissa, joiden arvoina esiintyy koodistot.suomi.fi-koodiston arvoja sekä viitattaessa alueidenkäytön rajoituksen asiaan tai yksittäisten luokkien yksilöihin Ryhti-järjestelmän ulkopuolelta.

UUID-tunnukset

UUID (Universally Unique Identifier) on OSF:n (Open Software Foundation) määrittelemä standardoitu tunnusmuoto, jonka avulla voidaan luoda vakiokokoisia, hyvin suurella todennäköisyydellä yksilöiviä tunnuksia ilman keskitettyä hallintajärjestelmää. UUID-tunnukset voivat perustua satunnaislukuihin, aikaleimoihin, tietokoneiden verkkokorttien MAC-osoitteisiin tai merkkijonomuotoisiin nimiavaruuksiin eri yhdistelmissä. UUID-tunnukset toimivat erityisen hyvin tietojärjestelmissä, joissa uusia globaalisti pysyviä ja yksilöiviä tunnuksia on tarpeen luoda hajautetusti ilman keskitettyä tunnusrekisteriä.

Kansallisessa alueidenkäytön rajoitusten tietomallissa UUID-muotoisia tunnuksia käytetään GUID (Globally Unique Identifier) -toteutuksena. UUID:n GUID-toteutus on 128-bittinen satunnaisluku, joka esitetään yleensä 32 heksalukuna yhdysmerkein ryhmiteltynä. Esim. {21EC2020-3AEA-4069-A2DD-08002B30309D}. GUID-toteutusta käytetään Ryhti-järjestelmän luokkien avainattribuuttien arvoina esim. alueidenkäytönRajoitusAvain (bindingPlotDivisionKey), jotka luodaan alueidenkäytön rajoituksia tuottavissa järjestelmissä.

Luokkakohtainen avaintunnus

Luokkakohtainen avaintunnus yksilöi luokan mukaisen yksilön yhden tallennusversion Ryhti-järjestelmän sisällä.

Kansallisessa alueidenkäytön rajoitusten tietomallissa luokkakohtainen avaintunnus kuvataan attribuutilla {luokka}Avain. Kaikilla Ryhti-järjestelmän saman luokan yksilöillä (ml. saman luokan yksilöiden eri vaiheiden tallennusversiot) tulee olla eri {Luokka}Avain-attribuutin arvo.

Kansallisessa alueidenkäytön rajoitusten tietomallissa luokkien avain attribuuttien arvoina käytetään GUID-toteutusta.

Esimerkki: alueidenkäytönRajoitusAvain (landUseRestrictionKey): 640bff6b-c16a-4947-af8d-d86f89106be1

Nimiavaruus

Nimiavaruus määrää kansallisessa alueidenkäytön rajoitusten tietomallissa kaikkien luokkien viittaustunnusten alkuosan. Nimiavaruus on HTTP URI -muotoinen. Rakennetun ympäristön tietojärjestelmään (Ryhti) ei tallenneta nimiavaruutta, vaan nimiavaruutta käytetään uudelleen ohjaamaan kutsuttavaan luokkakohtaiseen Ryhti-järjestelmän rajapintapalveluun (HTTP redirect) (Tulossa myöhemmässä vaiheessa).

Ryhti-järjestelmän nimiavaruus: https://uri.rakennetunymparistontietojarjestelma.fi

Viittaustunnus

Viittaustunnus yksilöi Ryhti-järjestelmään tallennetun luokan yksilön tallennusversion globaalisti.

Viittaustunnus on HTTP URI -muotoinen ja se muodostuu nimiavaruudesta, luokasta ja luokan avaintunnuksesta yhdessä kauttaviivoilla (/) erotettuina.

Esimerkki: https://uri.rakennetunymparistontietojarjestelma.fi/landUserestriction/640bff6b-c16a-4947-af8d-d86f89106be1

Viittaustunnus ohjautuu aina ko. luokan yksilön tallennusversion tietosisältöön kulloinkin toiminnassa olevassa Ryhti-järjestelmän latauspalvelussa. (Tulossa myöhemmässä vaiheessa)

Luokkien yksilöihin viittaaminen

Saman alueidenkäytön rajoituksen luokkien keskinäiset assosiaatiot toteutetaan viitattavan yksilön {Luokka}Avain-attribuuttia käyttäen.

Luokkakohtaiset assosiaatiot eri alueidenkäytön rajoitusten välillä tai alueidenkäytön rajoitusten ja muiden alueidenkäyttöpäätösten luokkien välillä toteutetaan viitattavan luokan viittaustunnusta käyttäen.

Pysyvät viittaukset Ryhti-järjestelmän ulkopuolelta alueidenkäytön rajoitusten tietomallin luokkiin toteutetaan viitattavan luokan yksilön viittaustunnusta käyttäen.

Koodistojen koodien tunnuksiin liittyvät vaatimukset

Kullakin koodiston koodilla on pysyvä tunnus, joka sellaisenaan yksilöi kyseisen koodin globaalisti ilman erillistä tietoa koodistosta, johon koodi kuuluu. Koodin tunnus on HTTP URI -muotoinen.

Olkoon koodi A mikä tahansa hierarkkisen koodiston sisältämä koodi. Koodin A alakoodilla tarkoitetaan koodia, joka on hierarkiassa sijoitettu koodin A alle. Koodi voi olla useamman ylemmän tason koodin alakoodi, vain mikäli ko. ylemmän tason koodit ovat alakoodisuhteessa keskenään.

Kansallisen alueidenkäytön rajoitusten tietomallin luokkakohtaisten attribuuttien koodistojen arvoina käytetään HTTP URI -muotoa.

Kansallisen alueidenkäytön rajoitusten tietomallin kohteiden elinkaaren hallinnan periaatteet

Kansallisen alueidenkäytön rajoitusten tietomallin elinkaarisäännöt mahdollistavat tietomallin tietokohteiden tallentamisen ja muuttamisen hallitusti voimassaolovaiheessa. Kansallisten tietomallien mukaiset tietosisällöt ovat merkittäviä oikeusvaikutuksia aiheuttavia, juridisesti päteviä aineistoja, joita käsitellään hajautetusti eri toimijoiden tietojärjestelmissä. Tämän vuoksi niiden tunnusten, viittausten ja elinkaaren hallintaan on syytä kiinnittää erityistä huomiota.

Seuraavat keskeiset periaatteet ohjaavat kansallisten tietomallien elinkaaren hallintaa:

Tietojen tuominen ja muokkaaminen

Alueidenkäytön rajoituksen asian tallennusoperaatio Ryhti-järjestelmään muodostaa uuden tallennusversion tallennettavista luokkien yksilöistä.

Alueidenkäytön rajoituksen kaikkien luokkakohtaisten yksilöiden viittaustunnukset viittaavat aina vain tiettyyn, sisällöllisesti muuttumattomaan tallennusversioon viitatusta yksilöstä.

Alueidenkäytön rajoituksen voimaan tulo

Alueidenkäytön rajoituksen asian tallennusversio luo kokonaisuudessaan tietomallin mukaiset luokkien yksilöt voimassa olevasta alueidenkäytön rajoituksesta Ryhti-järjestelmään. Kullakin AlueidenkäytönRajoituksenAsia-luokan yksilöllä on pysyvä alueidenkäytön rajoituksen tunnus (pysyväAlueidenkäytönRajoitusTunnus-attribuutti, permanentLandUseRectrictionIdentifier).

Rajapinta alueidenkäytön rajoituksen asian luomiseen:
POST /api/LandUseRectrictionMatter/{permanentLandUseRectrictionIdentifier}

Alueidenkäytön rajoitus voi tulla voimaan ennen asemakaavan vireilletuloa tai vireilletulon yhteydessä erillisellä päätöksellä.

Voimaantullut alueidenkäytön rajoitus tallennetaan Ryhti-järjestelmään tallennusversiona, jossa sen

Alueidenkäytön rajoituksen jatkaminen, kumoutuminen ja raukeaminen

Alueidenkäytön rajoitusta jatkettaessa alueidenkäytön rajoituskohteet voivat muuttua, lisääntyä tai vähentyä. Alueidenkäytön rajoitus voi kumoutua kokonaan tai osittain, jos alueelle tulee voimaan kaava kokonaan tai osittain, jonka toteuttamiseksi alueidenkäytön rajoitus on määrätty. Voimassaoleva alueidenkäytön rajoitus raukeaa sen voimassaoloajan mennessä umpeen.

Kaavan kokonaan tai osittainen kumoutuminen sekä raukeaminen ei vaadi toimenpiteitä tiedontuottajalta Ryhti-järjestelmän suuntaan, jos kunta on asettanut AlueidenkäytönRajoituksenKohde -luokan liittyväKaava -attribuutin arvoksi pysyvän kaavatunnuksen. Jos tietoa ei ole asetettu liittyväKaava-attribuutin arvoksi tulee alueidenkäytön rajoituksen tai sen kohteiden kumoaminen tehdä erillisellä päätöksellä.

Lisäksi alueidenkäytön rajoitus voi kumoutua erillisellä päätöksellä.

Rajapinta alueidenkäytön rajoituksen asian jatkamiseen ja kumoamiseen:
POST /api/LandUseRectrictionMatter/{permanentLandUseRectrictionIdentifier}

Alueidenkäytön rajoituksen jatkaminen

Alueidenkäytön rajoitusta jatkettaessa voimassaoloajan umpeutuessa tallennetaan rajoituksesta uusi versio Ryhti-järjestelmään seuraavasti

Alueidenkäytön rajoituksen kumoaminen erillisellä päätöksellä

Alueidenkäytön rajoitus tai sen kohteita voidaan kumota erillisellä päätöksellä tarpeen mukaan. Kaavan tullessa voimaan kokonaan tai osittain aiheuttaa alueidenkäytön rajoituksen tai sen kohteiden kumoutumisen. Jos alueidenkäytön rajoituksen kohteille on asetettu kumoavan kaavan pysyvä kaavatunnus, kumoutuu nämä kohteet Ryhti-järjestelmän toimesta.

Jos alueidenkäytön rajoitus kumotaan erillisellä päätöksellä kokonaan, tällöin tallennetaan uusi versio Ryhti-järjestelmään seuraavasti

Jos alueidenkäytön rajoitus kumotaan erillisellä päätöksellä osittain, tällöin tallennetaan uusi versio Ryhti-järjestelmään seuraavasti

Alueidenkäytön rajoitus tietojen lisääminen ja muokkaaminen (nämä tulossa myöhemmin)

Ryhti-järjestelmään tallennetun alueidenkäytön asian tietoja voidaan lisätä, muokata tai poistaa.

Tiedontuottajan järjestelmän tulee tallentaa muokatessa luokkien yksilöt edellisen tallennusversion samoilla {luokka}Avain-attribuutin arvoilla Ryhti-järjestelmään. Muokkausoperaatio historioi edellisen AlueidenkäytönRajoituksenAsia-luokan ja sen aliluokien yksilöiden tallennusversiot.

Rajapinta alueidenkäytön rajoitusten luokkien yksilöiden lisäämiseen, muokkaamiseen tai poistamiseen:
PUT /api/LandUseRectrictionMatter/{permanentLandUseRectrictionIdentifier}/

Ryhti-järjestelmän historioimiin tallennusversion yksilöihin voidaan viitata myöhemmin seuraavalla viittaustunnuksella https://uri.rakennetunymparistontietojarjestelma.fi/{class}/{permanentidentifier}/{version}

Esimerkki version sisältävästä viittaustunnuksesta: Esimerkki: https://uri.rakennetunymparistontietojarjestelma.fi/landuserectrictionobject/640bff6b-c16a-4947-af8d-d86f89106be1/1

Liiteasiakirjojen lisääminen alueidenkäytön rajoituksen asialle ja päätökselle

Tallennettavalle alueidenkäytön rajoituksen asialle voidaan lisätä liiteasiakirjoja niille luokille missä liiteasiakirjoja esiintyy. Liiteasiakirjoja esiintyy seuraavilla luokilla:

Liiteasiakirjoja lisätään Ryhti-järjestelmään kuntien tietojärjestelmistä rajapinnan tai tallentamalla Ryhti-järjestelmän käyttöliittymän kautta. Tietojärjestelmän näkökulmasta tiedostojen lisääminen toteutetaan kahdessa vaiheessa:

  1. Ensimmäisessä vaiheessa tiedosto tallennetaan Ryhti-järjestelmään
    Rajapinta uusien tiedostojen lisäämiseen:
    POST /api/File
  2. Tiedoston tallennuksen yhteydessä saatu tiedostoavain (GUID) arvo asetetaan Liiteasiakirja-luokan tiedostoAvain-attribuutille

Tiedostojen sallitut koot ja tiedostotyypit kuvataan laatusäännöissä [linkki lukuun]. Näiden vaiheiden jälkeen voidaan alueidenkäytön rajoituksen asia validoida ja tallentaa Ryhti-järjestelmään.

Alueidenkäytön rajoituksen elinkaaren vaiheet ja elinkaaritila-attribuutin käyttö

Alueidenkäytön rajoituksen elinkaareen liittyvää tilaa hallitaan AlueidenkäytönRajoituksenAsianVaihe-luokan elinkaaritila-attribuutilla ja sen mahdolliset arvot kuvaavan Elinkaaren tila-koodiston avulla. AlueidenkäytönRajoituksenAsianVaihe-luokan elinkaaritila-attribuutti on pakollinen.

Elinkaaritila-koodisto kuvaa kolme mahdollista tilaa, joissa alueidenkäytön rajoitus voi olla sen elinkaaren eri vaiheissa:

Alueidenkäytön rajoituksen elinkaaren tilan muutokset

Alueidenkäytön rajoituksen elinkaaritila voi sen voimassaolo- ja kumoutumisvaiheissa esiintyä ja muuttua vain tässä luvussa kuvatuilla tavoilla.

AlueidenkäytönRajoituksenAsianVaihe-luokan elinkaaritila-attribuutin arvo voi muuttua vain seuraavilla tavoilla:

Tilasta Voimassa tilaan Rauennut tapahtuu voimassaoloajan umpeuduttua Ryhti-järjestelmän toimesta. Tiedontuottajan ei tarvitse tallentaa Rauennut tilassa alueidenkäytön rajoitusta Ryhti-järjestelmään.

Laatusäännöt

Tämä dokumentti laajentaa Ryhti-järjestelmän yleisiä laatusääntöjä seuraavin osin:

Kansallisten tietomallin mukaisuus

Ryhti-järjestelmään tallennettavien fyysisten tietomallien tulee noudattaa kansallisen alueidenkäytön rajoitusten tietomallin kuvauksia.

API-kuvausten mukaisuus

Ryhti-järjestelmään tallennettavien tallennussanomien tulee noudattaa API-kuvauksia.
Tunnisteet ja sisäisten viittausten eheys
Ryhti-järjestelmään tallennettavilla luokkien yksilöillä tulee olla yksilöivät luokkakohtaiset avaintunnukset, joiden luomisessa ja käyttämisessä viittaamiseen toisiin luokkiin tulee noudattaa luvun Tunnukset ja niiden hallintavaatimuksia.

Elinkaarisääntöjen mukaisuus

Ryhti-järjestelmään tallennettavien aineistojen tulee noudattaa kansallisen alueidenkäytön rajoitusten elinkaarisääntöjen (tämä dokumentti) ja validointisääntöjen vaatimuksia ja suosituksia [linkki validointisääntöihin].

Tiedostojen koot ja tiedostotyypit

Kansallisen alueidenkäytön rajoitusten tietomallin edellyttämien tiedostojen tallentaminen Ryhti-järjestelmään toteutetaan /api/File -rajapinnan kautta, ennen tietomallin mukaisten tallennusversioiden tallentamista. Rajapinta palauttaa tiedostoavaimen arvon (GUID), joka annetaan Liiteasiakirja-luokkien tiedostoAvain-attribuutin arvoksi. Tallennettaville tiedostoille on asetettu seuraavat vaatimukset:

Liiteasiakirja-luokka
content-type image/pdf;
Max koko 1 Gb;
Lisäksi tiedostojen tallennustapahtumassa tiedostoille tehdään virustarkistus.

Sivun muutoshistoria

Sivu luotu 11.11.2024

Takaisin ylös