Felles modelleringsregler for offentlig forvaltning

Modellen, dens modellelementer og egenskaper skal gis forståelige navn og gode beskrivelser.

Selvforklarende navn og gode beskrivelser gjør det enklere for målgruppen å forstå og bruke modellen.

Bruk terminologi som målgruppen er kjent med.

Modellen med navn “Felles Informasjonsmodell for Person og Enhet” bruker en objekttype med navn Person og en objekttype med navn Adresse. Disse er forståelige.

Egenskapene kjønn og fødeland for Person er forståelige.

Det brukes også en klasse Aktør som er mindre forståelig. Den er definert som “Person eller enhet vi samhandler med.” Forklarende tekst er “Aktør er supertype til Person og Enhet.” Denne teksten forutsetter at målgruppen forstår hva en supertype er.

Navn på modellen og dens modellelementer og egenskaper skal gjenspeile innholdet i og meningen med modellen.

Meningsfulle navn gjør at leseren lettere kan lese og tolke innholdet i modellen. Leseren unngår da å måtte gå gjennom hele modellen for å forstå innholdet.

Involver representanter for modellens målgruppe i arbeidet med navngivning.

Navnet “Felles informasjonsmodell for Person og Enhet” forteller at modellen inneholder informasjon om person og enhet.

Følg anbefalte eller standardiserte navne- og skrivekonvensjoner for datastrukturnavn

Ved å følge navnekonvensjoner gir man modellene et ensartet uttrykk og gjør det enklere å identifisere og skjelne de forskjellige modellelement- og egenskapstypene fra hverandre. Dette vil også bidra til at det blir lettere å gjenbruke fra modellen.

Navnekonvensjoner kan variere mellom modelleringsspråk og modellstandarder. Hvis ikke virksomheten følger noen gitte navnekonvensjoner, benyttes følgende regler:

Generelt:

• Anvend et vanlig utbredt tegnsett (se Referansekatalogen for IT-standarder)

• Modellelementer (objekttyper, datatyper, enkeltyper, kodelister) skrives som substantiver i ubestemt form og med stor forbokstav.

• Relasjoner/assosiasjoner skrives som verbalfraser i nåtid og med liten forbokstav

• Navn på attributter og roller) skrives som substantiver i ubestemt form og med liten forbokstav

• Navn på kodeelementer skrives fortrinnsvis med liten forbokstav, med unntak av egennavn og forkortelse.

• Bruk fortrinnsvis CamelCase/camelCase for datastrukturnavn med flere ord

Felles informasjonsmodell for Person og Enhet er i henhold til de generelle reglene gitt ovenfor.

Modellen, dens modellelementer og egenskaper skal ha en persistent identifikator.

Ved å anvende en identifikator i form av en URI har man en global og entydig identifikator. Dette muliggjør også at modellen, dens modellelementer og egenskaper kan tilgjengeliggjøres som en offentlig ressurs på nett, og i maskinprosesserbare formater. Dette gjelder også versjoner.

Identifikatorene utformes i henhold til Standard for pekere til offentlige ressurser på nett.

Identifikator for Felles informasjonsmodell for Person og Enhet: https://raw.githubusercontent.com/Informasjonsforvaltning/model-publisher/master/src/model/model-catalog.ttl#PersonOgEnhet

Modellen skal uttrykkes i et modelleringsspråk som gir en god, visuell representasjon.

Ved å bruke et modelleringsspråk som kan representere modellen og innholdet i den på en oversiktlig måte, blir det lettere for mennesker å lese og kan fungere som et kommunikasjonsmiddel mellom fag- og utviklingsressurser. Ved god visualisering, er det også enklere å avdekke hvilke modellelementer som kan gjenbrukes.

Bruk et modelleringsverktøy som har støtte for grafisk visning av modeller.

Klassediagrammer i UML

Antall modellelementer skal beholdes på et håndterbart nivå.

Blir en modell stor, blir det vanskelig å lese og tolke modellen og få en god oversikt over innholdet. Det blir også vanskelig å forvalte modellen og se konsekvenser av endringer man ønsker å gjennomføre.

Dersom antall modellelementer blir stort, grupperes beslektede modellelementer i moduler.

F.eks. GeografiskAdresse og Adresse er i modulen Adresse, i Felles informasjonsmodell for Person og Enhet.

Modellen skal være fritt tilgjengelig på internett.

Ved å tilgjengeliggjøre modellen, bidrar man til å skape forståelse av informasjonen som en virksomhet forvalter og begrepene som benyttes om denne.

Modellen tilgjengeliggjøres på internett. For ekstern tilgjengeliggjøring publiseres modellbeskrivelsen og/eller modellen til Felles datakatalog.

Felles informasjonsmodell for Person og Enhet er tilgjengelig i Felles datakatalog.

Modellen bør være tilgjengelig i et definert og åpent maskinprosesserbart format.

Ved å gjøre en modell tilgjengelig i maskinprosesserbare formater, kan modelleringsverktøy og dataapplikasjoner tolke dens innhold. På den måten unngår modeller å måtte manuelt kopiere modellens innhold.

Gjør modellen tilgjengelig i Felles datakatalogog i henhold til ModellDCAT-AP-NO. Legg modellfilen ut på internett slik at den kan høstes, f.eks. på Github.

Modellfil for Felles informasjonsmodell for Person og Enhet:https://github.com/Informasjonsforvaltning/model-publisher/blob/master/src/model/model-catalog.ttl

Modellen skal dateres.

Med tydelig datering, vil målgruppen kunne lettere vurdere modellens ferskhet og gyldighet.

Angi publiserings-, utgivelses-, endrings- og gyldighetsdato.

Ifølge Felles datakatalog var Felles informasjonsmodell for Person og Enhet var publisert 05.03.2020, utgitt 02.11.2016 og gyldig fra 11.02.2016.

Ifølge Felles datakatalog var Felles informasjonsmodell for Adresse publisert 05.03.2020 og utgitt 28.09.2016.

Ansvaret for modellen og dens innhold skal være klart og tydelig.

Dersom ansvaret ikke er klart og kjent, kan dette føre til at ingen tar på seg oppgaven med å vedlikeholde og oppdatere modellen. Kunnskap om hvem som er ansvarlig for modellen kan også bidra til at modellkonsumenter enklere kan vurdere om modellen er relevant og anvendelig.

Det skal framkomme hvilken organisasjon som har ansvar for modellen. Kontaktinformasjon skal oppgis, og organisasjon bør etablere rutiner for versjonshåndtering og varsling ved endringer i modellen.

Som det framgår av Felles datakatalog, så er det Digitaliseringsdirektoratet som er ansvarlig for Felles informasjonsmodell for Person og Enhet.

Modellen skal angis med en modellstatus

Det er viktig at de som er interessert i eller bruker en modell, er kjent med hvilken status en modell har for å kunne vurdere modellens gyldighet og modenhet, og hvor komplett og anvendelig den er.

Angi status til modellen, f.eks. om den er under utarbeidelse, ferdigstilt, foreldet eller trukket tilbake. For statustyper, kan ADMS Status vocabulary (i RDF) benyttes, eventuelt supplert med andre statustyper.

Ifølge Felles datakatalog er modellstatus «Fullført» for både Felles informasjonsmodell for Person og Enhet og Felles informasjonsmodell for Adresse

Dersom modellen har en sammenheng med én eller flere informasjonsmodeller, skal disse forholdene beskrives.

En modell kan ha ulike relasjoner til andre modeller:

• modellen erstatter eller er erstattet av én eller flere modeller, f.eks. ved at det foreligger en nyere versjon av modellen.

• modellen er utledet av én eller flere andre modeller og gjenbruker modellelementer derfra

• modellen er konform med en standard modell

• modellen kan anses som en profil av annen modell

• modellen er selvstendig, men er likevel en del av én større modell, eller omvendt, modellen består av én eller flere selvstendige modeller som til sammen utgjør en helhet.

Ved å synliggjøre sammenhengen modellen har til andre modeller, vil dette kunne gi bedre innsikt i og forståelse og sikre sporbarhet mellom modellene. Det kan også bidra til at termer og semantikk ivaretas ved gjenbruk. Det gir også et bedre grunnlag til å vurdere hvilke konsekvenser endringer i modellen kan få for andre modeller. Ved å referere mellom ulike versjoner av modeller, får man oversikt over hvilke versjoner som er gjeldende.

Angi sammenhenger mellom modellene. Sammenhengen kan ikke bare etableres mellom selve modellene, men også mellom modellelementer og egenskaper som er utledet av hverandre. Spesifikasjon for beskrivelse av informasjonsmodeller, ModellDCAT-AP-NO, har definert et sett med modellrelasjoner som kan være aktuelle å beskrive.

Felles informasjonsmodell for Person og Enhet bruker objekttypen GeografiskAdresse. Denne er nærmere beskrevet i Felles informasjonsmodell for Adresse.

Dokumenter modellelementer og egenskaper ved bruk av begreper

For å forstå hva modellelementene betyr og representerer, bør det utarbeides begreper med anbefalt term og definisjoner som entydig definerer disse. Det gjør det enklere å kunne lese og forstå modellene, og man unngår misforståelser rundt hva modellelementene og egenskapene representerer. Dette kan hindre at informasjonen som modellene beskriver mistolkes og brukes feil.

Følg eksisterende terminologi eller definer sentrale begreper som benyttes i modellen. Utform disse i henhold til gjeldende forvaltningsstandarder. Tilgjengeliggjør begreper og referer fra modellen til disse.

I Felles informasjonsmodell for Person og Enhet refererer datatypen Personnavn til begrepet personnavn og kodelisten Sivilstand til begrepet sivilstand.

Gjenbruk modellelementer og egenskaper i stedet for å definere nye.

Et viktig prinsipp ved informasjonsmodellering er å gjenbruke modellelementer og egenskaper. Gjenbruk effektiviserer modelleringsarbeidet. Man unngår også å definere samme type informasjon på ulike måter, slik at det ikke oppstår tvetydigheter rundt hvordan informasjonen skal forstås. Videre vil gjenbruk av modellelementer og egenskaper kunne bidra til å avdekke mulighet for gjenbruk av data.

Vurder om det er mulig å gjenbruke fra andre modeller, både fra egne modeller, andre virksomheter eller etablerte fellesmodeller eller standarder. Når du modellerer, vurder også om du kan gjenbruke modellelementer og egenskaper innad i modellen du jobber med.

I Felles informasjonsmodell for Person og Enhet gjenbrukes objekttypen GeografiskAdresse fra modellen Felles informasjonsmodell for Adresse.

Bruk standardiserte eller avtalte primitive datatyper

Bruk av standardiserte eller avtalte datatyper gjør det enklere å forstå og tolke dataene som modellen beskriver, og man unngår misforståelser. Det bidrar også til at modellene blir mer gjenbrukbare.

Hva som er standardiserte datatyper, kan variere mellom modelleringsspråk og modellstandarder. Hvis ikke virksomheten følger noen gitte sektorstandarder, benyttes XSD/RDFS-datatyper eller ISO/TC211-datatyper:

• XSD/RDFS Datatypes
  Se XML Schema 1.1 Part 2: Datatypes og RDF 1.1 Concepts and Abstract Syntax 
  

• ISO/TC 211 Harmonized Model er en samling av datatyper, som primært brukes av geografirelaterte modelleringsprojekter , f.eks. av INSPIRE.
  Se ISO/TC211 Harmonized Model Management Group GitHub-repositorium (HMMG) 

Sammenhengen mellom de to typesettene er formalisert her: ISO TC 211 GOM Harmonized Ontology 

xsd:date som datatype for «fødselsdato» i en konkret anvendelse av «Person»