Datamodell

Sist endret

June 10, 2025

For hvert informasjonselement angis det om informasjonen er obligatorisk✅ Det angis også hva det internasjonale🌐 navnet er, det er dette navnet som benyttes i Vardef. Noen informasjonselementer er kun relevante for noen variabler, og de er derfor kun obligatoriske hvis man har denne typen variabler, f.eks. er «Kodeverkets URI» kun obligatorisk å fylle ut dersom det er en kvalitativ variabel . Dette angis med ⚠️. Felter som er valgfrie, angis ved (valgfritt).

Det angis også om informasjonsfeltet kan endres (patches) etter publisering. Publisering gjelder her både intern og ekstern publisering.

Kortnavn

🌐 short_name
✅

Angir variabelens kortnavn. Kortnavn er som regel et teknisk forkortet navn som er egnet som variabel(kolonne)navn i et datasett. Følgende retningslinjer foreslås for kortnavn i Vardef:

  • må være unikt.
  • minimumslengde på 2 tegn.
  • kun små bokstaver (a-z).
  • kan inneholde tall (0-9).
  • kan inneholde _ (understrek).
  • æ, ø og å er IKKE tillat. Anbefalt at disse erstattes med ae, oe og aa.
  • dersom det brukes generiske navn som «kilde» eller «kode» skal variabelen spesifisere vha. suffiks, f.eks. kilde_innt
  • prefiks og suffiks kan brukes for å gjøre et kortnavn unikt, f.eks. pers_innt og hush_innt.
  • kan ikke være en av de reserverte kortnavnene i SSB (se boks under)

Retningslinjene for kortnavn skal opp i Standardutvalget i september.

Kortnavnet kan ikke endres etter publisering.

Etter vedtak i Standardutvalget er noen kortnavn reservert som standard-kortnavn for noen bestemte variabler, og skal derfor ikke brukes av andre. Se oversikt over reserverte kortnavn i Tabell 1.

Tabell 1: Oversikt over reserverte kortnavn
Reserverte kortnavn
anloep_id
bruksenhet_id
bygg_id
bygningsstatus
bygningstype
familie_nr
fnr1
foedselsdato
matrikkelenhet_id
hush_nr
isin
kjoenn
komm_nr
kurs_id
lovbrudd_id
pers_id
reg_nr
skade_id
trafikkulykke_id
fylke_nr

Eksempel på kortnavn for variabeldefinisjonen med Navn Lønnsinntekter:

wloenn

Eksempel på kortnavn for variabeldefinisjonen med Navn Landbakgrunn:

landbak

Definisjon

🌐 definition
nb | nn | en
✅

Angir hva variabelen betyr på en så kort og presis måte som mulig. Mer utfyllende opplysninger kan legges i Merknad-feltet.

Definisjon kan endres etter publisering (f.eks. korrigering av skrivefeil).

Hvis det legges inn større endring i definisjonen, skal det opprettes en ny gyldighetsperiode. Dette gjøres ved å sette en ny gyldig f.o.m.-dato. Da vil gyldig t.o.m. for foregående gyldighetsperiode automatisk settes til gyldig f.o.m.-dato (ny gyldighetsperiode) minus en dag.

Et eksempel på en større endring som skaper en ny gyldighetsperiode, er variabelen «landbakgrunn» som i gyldighetsperioden f.o.m. 1994-01-01, kun har foreldrenes fødeland med i definisjonen, men som i gyldighetsperioden f.o.m. 2003-01-01 også har med besteforeldrenes fødeland.

Eksempel på definisjon for variabeldefinisjon med Navn Sivilstand:

Viser en persons stilling i henhold til ekteskapslovgivningen.

Eksempel på definisjon for variabeldefinisjon med Navn Kapitalinntekter:

Omfatter renteinntekter, aksjeutbytte, realisasjonsgevinster og andre kapitalinntekter i løpet av kalenderåret. Til fradrag kommer årets realisasjonstap

Eksempel på definisjon for variabeldefinisjon med Navn Ordretilgangen, bygg og anlegg:

Verdien av nye ordrer bedriften har mottatt i løpet av kvartalet. Inkluderer også ordrer fullførte i løpet av samme kvartal. Verdien er kontraktsummen eksklusive merverdiavgifter, men inklusive eventuelle produksjons- og omsetningsavgifter.

Kodeverkets URI

🌐 classification_reference
✅

Angir referansen til kodeverk (klassifikasjon eller kodeliste) i Klass som beskriver verdiene variabelen kan ha. En skal ikke legge inn hele URI-en, kun id-en for kodeverket.

Kodeverkets URI kan endres etter publisering.

Eksempel på Klass-referanse for variabeldefinisjonen med Navn Sivilstand:

91

Eksempel på Klass-referanse for variabeldefinisjonen med Navn Landbakgrunn:

25

Enhetstyper

🌐 unit_types
✅

Angir hvilke(n) enhetstype (r) variabelen sier noe om. De fleste variabler vil kun være knyttet til en enhetstype, men noen, kan være knyttet til flere (f.eks. foretak og bedrift). Enhetstyper velges fra meny.

Gyldige verdier er definert i denne Klass-kodelisten. Verdiene er også beskrevet her.

Enhetstyper kan endres etter publisering.

Eksempel på Klass-referanse for enhetstype for variabeldefinisjonen med Navn Sivilstand, der enhetstypen er Person, som har kode 91 i KlASS:

91

Eksempel på Klass-referanse for enhetstype for variabeldefinisjonen med Navn Produsentpris for tjenester, der enhetstypen Foretak og Bedrift i Klass:

25

Statistikkområder

🌐 subject_fields
✅

Angir hvilke(t) statistikkområde(r) variabelen tilhører. Statistikkområde(r) kan enten være spesifisert på det overordnede nivå 1, eller det mer detaljerte statistikkområdet på nivå 2. F.eks. kan en variabeldefinisjon ha statistikkområdet «Befolkning» på nivå 1, eller «Barn, familier og husholdninger» på nivå 2.

Gyldige verdier er definert i Kodeliste for statistikkområder i Statistikkbanken i Klass.

Statistikkområder kan endres etter publisering.

Eksempel på Klass-referanse for statistikkområde for variabeldefinisjonen med Navn Sivilstand, der området er Befolkning, som har kode be i KlASS:

“be”

Eksempel på Klass-referanse for statistikkområde for variabeldefinisjonen med Navn Kapitalinntekter, der området er Inntekt og forbruk, som har kode if i Klass:

“if”

Inneholder særlige kategorier av personopplysninger

🌐 contains_special_categories_of_personal_data
⚠️

Angir om variabelen inneholder spesielt sensitive personopplysninger. En oversikt over hvilke opplysninger dette er, finnes hos Datatilsynet.

Gyldige verdier er true og false.

Inneholder særlige kategorier av personopplysninger kan endres etter publisering.

Eksempel 1: Fagforeningsmedlemskap

true

Måletype

🌐 measurement_type

Angir hvilken måletype variabelen tilhører, f.eks. om den sier noe om energi, valuta eller masse. Brukes ev. kun for kvantitative variabler. Verdiene velges fra meny.

Måletype kan endres etter publisering.

Gyldige verdier er definert i denne Klass-kodelisten.

Eksempel på Klass-referanse for måletype for variabeldefinisjonen med Navn Total produksjon av elektrisk kraft, der måletypen er energi, som har kode 04 i Klass:

“04”

Gyldig f.o.m.

🌐 valid_from
✅

Angir datoen variabelens definisjon er gyldig f.o.m. Hvis det skjer en større endring i en definisjon, skal det lages en ny gyldighetsperiode for variabelen, og dette markeres ved at den får en ny gyldig f.o.m. dato. Datoen må være på formatet YYYY-MM-DD iht ISO 8601 Date and time format.

Alle variabler som migreres fra Vardok, og som ikke har en gyldig f.o.m. dato, vil få satt gyldig f.o.m. dato til 1900-01-01. Denne kan endres så lenge variabelen er et utkast.

Gyldig f.o.m. dato kan ikke endres etter publisering, bortsett fra i det tilfellet at det lages en ny gyldighetsperiode.

Eksempel 1:

2003-01-01

Eksempel 2:

1993-01-01

Gyldig t.o.m.

🌐 valid_until
⚠️

Angir datoen variabelens definisjon er gyldig t.o.m. Datoen må være på formatet YYYY-MM-DD iht ISO 8601 Date and time format.

Når en ny variabel opprettes, vil gyldig t.o.m. dato oftest være tom (variabelen er gyldig). Dersom en variabel går ut av bruk, dvs. at nåværende gyldighetsperiode ikke erstattes av en ny gyldighetsperiode, settes denne datoen manuelt. Dersom gyldighetsperioden erstattes av en ny gyldighetsperiode, vil datoen settes automatisk til datoen før gyldig f.o.m.-datoen til den nye gyldighetsperioden.

Gyldig t.o.m. dato kan endres etter publisering dersom variabelen slutter å være gyldig (ingen nye gyldighetsperioder).

Eksempel 1:

2003-01-01

Eksempel 2:

1993-01-01

URI til ekstern referanse

🌐 external_reference_uri

Angir ekstern definisjon/dokumentasjon, f.eks. en nettside som er relevant for variabelen.

Ekstern referanse kan endres etter publisering.

For har eksempel variabelen Fagforeningskontigent følgende ekstern referanse:

https://www.skatteetaten.no/person/skatt/hjelp-til-riktig-skatt/arbeid-trygd-og-pensjon/fagforeningsfradrag/

Merknad

🌐 comment
nb | nn | en

Angir eventuelle tilleggsopplysninger som ikke hører hjemme i selve definisjonen.

Merknad kan endres etter publisering.

Variabelen Landbakgrunn for eksempel følgende merknad:

“Fra og med 1.1.2003 ble definisjon endret til også å trekke inn besteforeldrenes fødeland.”

Variabelen Skattefrie overføringer har for eksempel følgende merknad:

“Alle mottatte overføringer gjelder i løpet av kalenderåret. Engangsstønaden ble innlemmet f.o.m. inntektsåret 1994. Kontantstøtten ble innlemmet fra august 1998. Forsørgerfradraget opphørte f.o.m. inntektsåret 2001.Skattefrie overføringer omfatter også samleposten”andre overføringer”, se eksterne kommentarer knyttet til denne variabelen.”

URI til relevante variabeldefinisjoner

🌐 related_variable_definition_uris

Angir URIer til andre Vardef-variabeldefinisjoner som er relevante.

Kan endres etter publisering.

Variabelen Inntekt etter skatt kan for eksempel lenke annen relevant variabeldefinisjon, f.eks. **Renteinntekter.

ID

🌐 id
✅

Angir den unike SSB-identifikatoren for variabelen. ID-en maskingenereres i Vardef.

ID kan ikke endres.

Eksempel på en generert ID:

“5AlkmJ6x”

Kontakt

🌐 contact
nb | nn | en
✅

Angir navn og epost for person eller gruppe som kan svare på spørsmål knyttet til variabeldefinisjonen. Tittel oppgis på bokmål, nynorsk og engelsk.

Kontakt kan endres etter publisering

For eksempel kan kontaktfeltet se slik ut:

yaml
contact:
    title:
        nb: |-
            Bedrifts- og foretaksregisteret
        nn: |-
            Bedrifts- og foretaksregisteret
        en: |-
            The Central Register of Establishments and Enterprises
    email: bof@ssb.no

Sist oppdatert

🌐 last_updated_at
✅

Angir dato for siste oppdatering av variabelen (gjelder alle typer endringer). Datoen maskingenereres.

Sist oppdatert – dato kan ikke endres.

For eksempel kan Sist oppdatert ha følgende verdi:

“2025-06-10T12: 30: 13.765000”

Eier

🌐 owner
✅

Angir eier av variabelen dvs. ansvarlig Dapla-team (statistikk-team) og informasjon om tilgangsstyringsgrupper. Team-tilhørighet og gruppe settes automatisk til det samme som team- og gruppetilhørigheten til den som oppretter variabelen.

Eier kan endres etter publisering.

For eksempel kan eierfeltet se slik ut:

yaml
owner:
    team: "dapla-felles"
    groups:
        - "dapla-felles-developers"

Variabelens status

🌐 variable_status
✅

Angir livssyklus for variabelen. Denne har tre kategorier:

Utkast

🌐 DRAFT
Utkast/kladd, dvs. under konstruksjon - “arbeid pågår” .

Publisert internt

🌐 PUBLISHED_INTERNAL
Godkjent og publisert internt.

Publisert eksternt

🌐 PUBLISHED_INTERNAL
Godkjent og publisert eksternt.

Statusen «Publisert internt» kan kun endres til «Publisert eksternt». Slik unngår en at interne brukere mister tilgang til variabler som har vært publisert internt.

Statusen «Publisert eksternt» kan ikke endres. Slik unngår en at eksterne brukere mister tilgang til variabler som har vært publisert eksternt.

Det er mulig å kun publisere en variabel internt på bokmål eller nynorsk, og uten engelsk, men for å publisere eksternt, må alle relevante felt være oversatt til bokmål, nynorsk og engelsk (dvs. navn, definisjon og ev. merknad).

Opprettet av

🌐 created_by
✅

Angir epostadressen til personen (initialer) som har opprettet variabelen. Verdien er maskingenerert.

Opprettet av kan ikke endres.

For eksempel kan Opprettet av ha følgende verdi:

“ini@ssb.no”

Opprettet

🌐 created_at
✅

Angir datoen variabelen ble opprettet. Maskingenereres ved opprettelsen av ny variabel.

Opprettet kan ikke endres.

For eksempel kan Opprettet ha følgende verdi:

“2025-06-10T12: 30: 13.765000”

Sist oppdatert av

🌐 last_updated_by
✅

Angir e-posten til personen (initialer) som sist utførte en endring i variabelen. Maskingenereres av systemet ved alle typer endringer.

Sist oppdatert av kan ikke endres.

For eksempel kan Sist oppdatert av ha følgende verdi:

“ini@ssb.no”

Endrings-ID

🌐 patch_id
✅

Angir ID for endringer på en publisert variabel. ID-en settes automatisk av systemet, og viser på et gitt tidspunkt hvor mange ganger variabelen er endret. Ved første lagring av et utkast settes endrings-ID lik 1. Ved endringer på en publisert variabel vil hver endring øke endrings-ID med 1.

Endring- id kan kun endres av systemet.

For eksempel kan Endrings-ID ha følgende verdi:

2

Fotnoter

  1. fnr er et reservert kortnavn for variabelen fødselsnummer.↩︎