Skip to end of metadata
Go to start of metadata

Koodistot-työkalu tarjoaa mekanismin, jonka avulla koodistojen ylläpitäjät voivat kontrolloidusti laajentaa koodiston tietosisältöä erilaisia tarpeita varten. Koodistot-työkalu tarjoaa tällä hetkellä vajaat kymmenkunta laajennuskokonaisuutta käytettäväksi ja uusia on mahdollista toteuttaa työkaluun tarpeen mukaan. Mikäli Koodistot-työkalun tarjoamat ominaisuudet eivät sellaisenaan riitä käyttötapaukseesi, saattaa uusi laajennuskokonaisuus olla ratkaisu ongelmaan.

Otathan tällöin yhteyttä: yhteentoimivuus@dvv.fi

Laajempi käyttöohje löytyy osoitteesta https://github.com/haeronen/koodisto-laajennukset-ohje/blob/master/koodisto-laajennukset-ohje.md


Koodistot-työkalun laajennusmekanismin keskeiset osat ovat laajennustyyppi, laajennus ja jäsen.

Laajennustyyppi
  • Laajennustyyppi määrittelee koodistoon liitettävissä olevat lisäominaisuudet sekä niiden semantiikan.
  • Koodistot-työkalu tarjoaa tällä hetkellä vajaat kymmenkunta erilaista laajennustyyppiä käytettäväksi, kukin näistä liittää omanlaisiaan näkymiä ja/tai tietokenttiä osaksi koodistoa.
  • Tuetut laajennustyypit on kuvattu tarkemmin kohdassa Tuetut laajennustyypit.
Laajennus
  • Laajennustyypin tarjoamat ominaisuudet otetaan käyttöön luomalla koodistoon laajennus.
  • Koodistoon luodaan laajennus ja valitaan sille sovelias laajennustyyppi, sen mukaan mitä lisäominaisuuksia koodistossa halutaan hyödyntää.
Jäsen
  • Laajennuksen varsinainen sisältö koostuu jäsenistä.
  • Jäsen sisältää laajennustyypin määrittelemät lisätietokentät sekä viittaukset koodeihin.



Koodistot-työkalun tarjoamat laajennustyypit ovat jaoteltavissa keskeisten ominaisuuksiensa puolesta kahteen kategoriaan: hierarkialaajennuksiin ja koodilaajennuksiin.
Hierarkialaajennusten avulla voidaan muodostaa hierarkisia koosteita koodeista. Koodilaajennusten avulla puolestaan voidaan listätä koodeihin uusia tietokenttiä.

Hierarkialaajennukset
  • Mahdollistavat hierarkisten rakenteiden koostamisen koodeista.
  • Liittävät hierarkian jäseniin ennalta määriteltyjä tietokenttiä, esimerkiksi nimi tai vastaavia tarkenteita.
  • Ovat varsin yleiskäyttöisiä ja niitä voidaan käyttää laajasti erilaisissa käyttötapauksissa jäsentämään olemassa olevia koodeja.
  • Eivät aseta rajotteita samaa laajennustyyppiä olevien laajennusten määrälle per koodisto.
Koodilaajennukset
  • Laajentavat koodia ennalta määrätyillä tietokentillä.
  • Ovat tyypillisesti räätälöity tietyyn käyttötarkoitukseen ja rajaavat kenttien sallittuja arvoja.
  • Rajoittavat että tiettyä laajennustyyppiä olevia laajennuksia voi olla enintään yksi per koodisto.



Koodistot-työkalun tukemat laajennustyypit.

LaajennustyyppiArkkityyppiKuvaus
MäärityshierarkiaHierarkialaajennusMahdollistaa vaihtoehtoisen hierarkian muodostamisen koodeista. Hierarkiaan voidaan sisällyttää koodeja yhdestä tai useammasta koodistosta ja kustakin koodistosta voidaan ottaa joko kaikki tai osajoukko koodeista mukaan. Kullekin hierarkian jäsenelle voidaan antaa tarkentava nimi kuvaamaan jäsenen roolia hierarkiassa.
LaskentahierarkiaHierarkialaajennusPerusominaisuuksiltaan vastaava kuin Määrityshierarkia -laajennus, mutta tukee lisäksi summaus- ja vertailuoperaattorien määrittämistä kullekin hierarkian jäsenelle.
KoodiliitosHierarkialaajennusMahdollistaa yksisuuntaisen linkityksen muodostamisen koodien välille. Linkitettävät koodit voivat olla yhdestä tai useammasta koodistosta.
DPM MetricKoodilaajennusLisää koodin tietosisältöön Data Point Modeling -metodologian mukaisen Metric käsitteen vaatimat kentät. Mahdollistaa näin DPM Metric käsitteiden esittämisen Koodistot-työkalun koodeina.
DPM Explicit DomainKoodilaajennusOminaisuuksiltaan vastaava kuin DPM Metric -laajennus, mutta sisältäen DPM Explicit Domain käsitteen kentät.
DPM Typed DomainKoodilaajennusOminaisuuksiltaan vastaava kuin DPM Metric -laajennus, mutta sisältäen DPM Typed Domain käsitteen kentät.
DPM DimensionKoodilaajennusOminaisuuksiltaan vastaava kuin DPM Metric -laajennus, mutta sisältäen DPM Dimension käsitteen kentät.
  • No labels