Abstrakt

Tento dokument je otevřenou formální normou ve smyslu § 3a odst. 3 zákona č. 106/1999 Sb., o svobodném přístupu k informacím, pro zveřejňování číselníků. Norma popisuje konceptuální model číselníků a stanovuje podobu jejich reprezentace ve strojově čitelné podobě ve formátech JSON-LD [[json-ld11]], a tedy i JSON [[ECMA-404]], a CSV [[rfc4180]]. Jednotlivé způsoby reprezentace číselníků také demonstruje na příkladech.

Konceptuální model

V této sekci je definován konceptuální model.

Diagram konceptuálního modelu
Diagram konceptuálního modelu.

Číselník

Číselník je seznam přípustných hodnot (vlastnosti, datového prvku, ...).

kód

Typ
Řetězec
Popis
Kód číselníku identifikuje číselník v rámci sady číselníků spravovaných daným správcem. Nejedná se tedy o globálně jednoznačnou identifikaci číselníku.
Povinnost
Nepovinná

název

Typ
Text
Popis
Název číselníku krátce charakterizuje význam jeho obsahu a jeho položek.
Povinnost
Povinná

akronym

Typ
Řetězec
Popis
Zkrácené označení číselníku používané i jako jeho identifikátor v rámci sady číselníků spravovaných daným správcem. Nejedná se tedy o globálně jednoznačnou identifikaci číselníku.
Povinnost
Nepovinná

definice

Typ
Text
Popis
Delší text přesně definující číselník a jeho obsah. Pokud není možné poskytnout přesnou definici, lze využít popis číselníku.
Povinnost
Nepovinná

popis

Typ
Text
Popis
Popis číselníku blíže vysvětluje obsah či způsob užití číselníku.
Povinnost
Nepovinná

Vztah: platnost

Typ
Časový interval
Popis
Přiřazuje číselníku časový interval, ve kterém byl, je nebo bude platný. Použití položek číselníku mimo časový kontext tohoto intervalu nedává smysl. Pro snazší strojové zpracování se doporučuje nespoléhat na to, že uživatel aplikuje platnost číselníku i na jednotlivé položky. Je doporučeno platnost položek uvést přímo pro jednotlivé položky.
Povinnost
Nepovinná

Vztah: eviduje

Typ
Položka
Popis
Zařazuje položku do číselníku. Číselník může obsahovat více různých položek. Položka může patřit do více číselníků.
Povinnost
Nepovinná

Položka

Položka číselníku reprezentuje jednu přípustnou hodnotu datového prvku z množiny všech přípustných hodnot, které jsou kódovány číselníkem, do kterého položka patří.

kód

Typ
Řetězec
Popis
Unikátní kód položky číselníku v rámci číselníku, do kterého položka patří.
Povinnost
Povinná

plný název

Typ
Text
Popis
Plný (tj. úplný) název (hodnota) položky číselníku.
Povinnost
Povinná

alternativní název

Typ
Text
Popis
Alternativní název (hodnota) položky číselníku.
Povinnost
Nepovinná

zkrácený název

Typ
Text
Popis
Zkrácený název (hodnota) položky číselníku.
Povinnost
Nepovinná

definice

Typ
Text
Popis
Definice položky číselníku přesně specifikuje její význam. Pokud není možné poskytnout přesnou definici položky, je možné využít popis položky číselníku.
Povinnost
Nepovinná

popis

Typ
Text
Popis
Popis položky číselníku, který blíže vysvětluje položku číselníku. Oproti definici je méně formální a více vysvětlující.
Povinnost
Nepovinná

Vztah: platnost

Typ
Časový interval
Popis
Přiřazuje položce číselníku časový interval, ve kterém byla, je nebo bude platná. Použití položky číselníku mimo časový kontext tohoto intervalu nedává smysl.
Povinnost
Nepovinná

Serializace JSON-LD

V této sekci je specifikována reprezentace ve formátu JSON-LD [[json-ld11]] ilustrovaná příklady.

Struktura

V této sekci je specifikována reprezentace ve formátu JSON-LD [[json-ld11]]. Reprezentace je definována v JSON schématu a JSON-LD kontextu.

Číselník

Popis
Číselník je seznam přípustných hodnot (vlastnosti, datového prvku, ...).
Příklad
  {
    "@context": "https://ofn.gov.cz/číselníky/2022-02-08/kontexty/číselník.jsonld",
    "typ": "Číselník",
    "iri": "https://data.poskytovatel.cz/zdroj/číselník/měny"
  }
kód
Klíč
kód
Typ
Řetězec
Popis
Kód číselníku identifikuje číselník v rámci sady číselníků spravovaných daným správcem. Nejedná se tedy o globálně jednoznačnou identifikaci číselníku.
Povinnost
Nepovinná
Příklad
  {
    "kód": "745"
  }
název
Klíč
název
Typ
Text
Popis
Název číselníku krátce charakterizuje význam jeho obsahu a jeho položek.
Povinnost
Povinná
Příklad
  {
    "název": {
      "cs":  "Číselník měn"
    }
  }
akronym
Klíč
akronym
Typ
Řetězec
Popis
Zkrácené označení číselníku používané i jako jeho identifikátor v rámci sady číselníků spravovaných daným správcem. Nejedná se tedy o globálně jednoznačnou identifikaci číselníku.
Povinnost
Nepovinná
Příklad
  {
    "akronym": "CISCUR"
  }
definice
Klíč
definice
Typ
Text
Popis
Delší text přesně definující číselník a jeho obsah. Pokud není možné poskytnout přesnou definici, lze využít popis číselníku.
Povinnost
Nepovinná
Příklad
  {
    "definice": {
      "cs":  "Číselník měn se všemi světovými měnami, které jsou aktuálně používány."
    }
  }
popis
Klíč
popis
Typ
Text
Popis
Popis číselníku blíže vysvětluje obsah či způsob užití číselníku.
Povinnost
Nepovinná
Příklad
  {
    "popis": {
      "cs":  "Číselník měn obsahuje položku pro každou existující světovou měnu. Nejsou zde tedy historicky používané měny, které již zanikly."
    }
  }
Vztah: platnost
Klíč
platnost
Typ
Časový interval
Popis
Přiřazuje číselníku časový interval, ve kterém byl, je nebo bude platný. Použití položek číselníku mimo časový kontext tohoto intervalu nedává smysl. Pro snazší strojové zpracování se doporučuje nespoléhat na to, že uživatel aplikuje platnost číselníku i na jednotlivé položky. Je doporučeno platnost položek uvést přímo pro jednotlivé položky.
Povinnost
Nepovinná
Příklad
viz Časový interval
Vztah: eviduje
Klíč
položky
Typ
Položka
Popis
Zařazuje položku do číselníku. Číselník může obsahovat více různých položek. Položka může patřit do více číselníků.
Povinnost
Nepovinná
Příklad
  {
    "položky": []
  }

Položka

Popis
Položka číselníku reprezentuje jednu přípustnou hodnotu datového prvku z množiny všech přípustných hodnot, které jsou kódovány číselníkem, do kterého položka patří.
Příklad
  {
    "typ": "Položka",
    "iri": "https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064"
  }
kód
Klíč
kód
Typ
Řetězec
Popis
Unikátní kód položky číselníku v rámci číselníku, do kterého položka patří.
Povinnost
Povinná
Příklad
  {
    "kód": "064"
  }
plný název
Klíč
název
Typ
Text
Popis
Plný (tj. úplný) název (hodnota) položky číselníku.
Povinnost
Povinná
Příklad
  {
    "název": {
      "cs":  "bhútánský ngultrum"
    }
  }
alternativní název
Klíč
alt_název
Typ
Text
Popis
Alternativní název (hodnota) položky číselníku.
Povinnost
Nepovinná
Příklad
  {
    "alt_název": {
      "cs":  "ngultrum"
    }
  }
zkrácený název
Klíč
zkr_název
Typ
Text
Popis
Zkrácený název (hodnota) položky číselníku.
Povinnost
Nepovinná
Příklad
  {
    "zkr_název": {
      "cs":  "BTN"
    }
  }
definice
Klíč
definice
Typ
Text
Popis
Definice položky číselníku přesně specifikuje její význam. Pokud není možné poskytnout přesnou definici položky, je možné využít popis položky číselníku.
Povinnost
Nepovinná
Příklad
  {
    "definice": {
      "cs":  "1 ngultrum=100 chhetrum"
    }
  }
popis
Klíč
popis
Typ
Text
Popis
Popis položky číselníku, který blíže vysvětluje položku číselníku. Oproti definici je méně formální a více vysvětlující.
Povinnost
Nepovinná
Příklad
  {
    "popis": {
      "cs":  "Bhútánský ngultrum je měnou asijského království Bhútán. Jeho ISO 4217 kód je BTN."
    }
  }
Vztah: platnost
Klíč
platnost
Typ
Časový interval
Popis
Přiřazuje položce číselníku časový interval, ve kterém byla, je nebo bude platná. Použití položky číselníku mimo časový kontext tohoto intervalu nedává smysl.
Povinnost
Nepovinná
Příklad
viz Časový interval

Příklady v serializaci JSON-LD

V této sekci jsou uvedeny příklady serializace dle této otevřené formální normy ve formátu JSON-LD [[!json-ld11]], a tedy i JSON [[!ECMA-404]].

Číselník měn - základní podoba

Příklad ukazuje reprezentaci číselníku měn v základní podobě.

Číselník měn - různé jazyky

Příklad ukazuje reprezentaci číselníku měn v různých jazycích.

Číselník měn - platnosti

Příklad ukazuje reprezentaci číselníku měn s platnostmi položek číselníku a platností číselníku jako takového.

Číselník měn - kompletní popis

Příklad ukazuje reprezentaci číselníku měn s alternativním pojmenováním a dalšími atributy měn.

Serializace CSV

V této sekci je specifikována reprezentace ve formátu CSV a ilustrována příklady.

Struktura

V této sekci je specifikována reprezentace ve formátu CSV. Reprezentace je definována pomocí schématu dle CSV on the Web [[tabular-metadata]].

Číselník

Číselník je seznam přípustných hodnot (vlastnosti, datového prvku, ...). Instance třídy Číselník je reprezentována jako součást řádku tabulky reprezentované v CSV formátu dle CSVW schématu.

IRI
Název sloupce
číselník
Typ
IRI
Popis
Identifikace instance třídy Číselník v podobě jejího IRI.
Povinnost
Povinná
Příklad
    číselník
    https://data.poskytovatel.cz/zdroj/číselník/měny
kód
Název sloupce
číselník_kód
Typ
Řetězec
Popis
Kód číselníku identifikuje číselník v rámci sady číselníků spravovaných daným správcem. Nejedná se tedy o globálně jednoznačnou identifikaci číselníku.
Povinnost
Povinná
Příklad
  číselník,číselník_kód
  https://data.poskytovatel.cz/zdroj/číselník/měny,745
název
Název sloupce
číselník_název
Typ
Text
Popis
Název číselníku krátce charakterizuje význam jeho obsahu a jeho položek.
Povinnost
Povinná
Příklad
  číselník,číselník_název_cs
  https://data.poskytovatel.cz/zdroj/číselník/měny,Číselník měn
akronym
Název sloupce
číselník_akronym
Typ
Řetězec
Popis
Zkrácené označení číselníku používané i jako jeho identifikátor v rámci sady číselníků spravovaných daným správcem. Nejedná se tedy o globálně jednoznačnou identifikaci číselníku.
Povinnost
Nepovinná
Příklad
                      číselník,číselník_akronym
                      https://data.poskytovatel.cz/zdroj/číselník/měny,CISCUR
definice
Název sloupce
číselník_definice
Typ
Text
Popis
Delší text přesně definující číselník a jeho obsah. Pokud není možné poskytnout přesnou definici, lze využít popis číselníku.
Povinnost
Nepovinná
Příklad
                      číselník,číselník_definice_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny,Číselník měn se všemi světovými měnami, které jsou aktuálně používány.
popis
Název sloupce
číselník_popis
Typ
Text
Popis
Popis číselníku blíže vysvětluje obsah či způsob užití číselníku.
Povinnost
Nepovinná
Příklad
                      číselník,číselník_popis_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny,Číselník měn se všemi světovými měnami, které jsou aktuálně používány.
Vztah: platnost
Název sloupce
číselník_platnost
Typ
Časový interval
Popis
Přiřazuje číselníku časový interval, ve kterém byl, je nebo bude platný. Použití položek číselníku mimo časový kontext tohoto intervalu nedává smysl. Pro snazší strojové zpracování se doporučuje nespoléhat na to, že uživatel aplikuje platnost číselníku i na jednotlivé položky. Je doporučeno platnost položek uvést přímo pro jednotlivé položky.
Povinnost
Nepovinná
Příklad
viz Časový interval
Vztah: eviduje
Název sloupce
viz Položka
Typ
Položka
Popis
Zařazuje položku do číselníku. Číselník může obsahovat více různých položek. Položka může patřit do více číselníků.
Povinnost
Nepovinná
Příklad
viz Položka

Položka

Položka číselníku reprezentuje jednu přípustnou hodnotu datového prvku z množiny všech přípustných hodnot, které jsou kódovány číselníkem, do kterého položka patří. Instance třídy Položka je reprezentována jako součást řádku tabulky reprezentované v CSV formátu dle CSVW schématu popisující denormalizovanou reprezentaci.

IRI
Název sloupce
číselník_položka
Typ
IRI
Popis
Identifikace instance třídy Položka v podobě jejího IRI.
Povinnost
Povinná
Příklad
                      číselník_položka
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064
kód
Název sloupce
číselník_položka_kód
Typ
Řetězec
Popis
Unikátní kód položky číselníku v rámci číselníku, do kterého položka patří.
Povinnost
Povinná
Příklad
                      číselník_položka,číselník_položka_kód
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064,064
plný název
Název sloupce
číselník_položka_název
Typ
Text
Popis
Plný (tj. úplný) název (hodnota) položky číselníku.
Povinnost
Povinná
Příklad
                      číselník_položka,číselník_položka_název_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064,bhútánský ngultrum
alternativní název
Název sloupce
číselník_položka_alt_název
Typ
Text
Popis
Alternativní název (hodnota) položky číselníku.
Povinnost
Nepovinná
Příklad
                      číselník_položka,číselník_položka_alt_název_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064,ngultrum
zkrácený název
Název sloupce
číselník_položka_zkr_název
Typ
Text
Popis
Zkrácený název (hodnota) položky číselníku.
Povinnost
Nepovinná
Příklad
                      číselník_položka,číselník_položka_zkr_název_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064,BTN
definice
Název sloupce
číselník_položka_definice
Typ
Text
Popis
Definice položky číselníku přesně specifikuje její význam. Pokud není možné poskytnout přesnou definici položky, je možné využít popis položky číselníku.
Povinnost
Nepovinná
Příklad
                      číselník_položka,číselník_položka_definice_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064,1 ngultrum=100 chhetrum
popis
Název sloupce
číselník_položka_popis
Typ
Text
Popis
Popis položky číselníku, který blíže vysvětluje položku číselníku. Oproti definici je méně formální a více vysvětlující.
Povinnost
Nepovinná
Příklad
                      číselník_položka,číselník_položka_popis_cs
                      https://data.poskytovatel.cz/zdroj/číselník/měny/položka/064,Bhútánský ngultrum je měnou asijského království Bhútán. Jeho ISO 4217 kód je BTN.
Vztah: platnost
Název sloupce
číselník_položka_platnost
Typ
Časový interval
Popis
Přiřazuje položce číselníku časový interval, ve kterém byla, je nebo bude platná. Použití položky číselníku mimo časový kontext tohoto intervalu nedává smysl.
Povinnost
Nepovinná
Příklad
viz Časový interval

Příklady v serializaci CSV

V této sekci jsou uvedeny příklady serializace dle této otevřené formální normy ve formátu CSV [[!rfc4180]]. Pro konkrétní datovou sadu musí poskytovatel vytvořit vlastní CSVW deskriptor. Jako základ může zvolit předpřipravené CSVW schéma, které si upraví pro svoje potřeby. Úprava typicky znamená vymázání těch definici sloupců z CSVW schématu, které v CSV serializaci poskytovatel nepoužije.

Číselník měn - základní podoba

Příklad ukazuje reprezentaci číselníku měn v základní podobě.

Číselník měn - různé jazyky

Příklad ukazuje reprezentaci číselníku měn v různých jazycích.

Číselník měn - platnosti

Příklad ukazuje reprezentaci číselníku měn s platnostmi položek číselníku a platností číselníku jako takového.

Číselník měn - kompletní popis

Příklad ukazuje reprezentaci číselníku měn s alternativním pojmenováním a dalšími atributy měn.

Předpřipravená metadata

Tato sekce obsahuje odkaz na vzorový metadatový záznam datové sady použitelný pro registraci datové sady do Národního katalogu otevřených dat. Registrace pomocí tohoto předpřipraveného záznamu umožní vyhledávat podobné datové sady publikované dle této otevřené formální normy. V metadatovém záznamu je třeba přidat či odebrat dostupné distribuce a vyplnit co nejvíce údajů, zejména kontaktní bod, název, popis, atd.