Struktura bloků a souborů datového standardu a jejich popis
Definice každého bloku datového standardu je dána:
· jeho textovým popisem ve formě tabulek a poznámek
· jeho přepisem do tvaru DTD
· příkladem použití bloku
Textovým popisem nelze exaktně vyjádřit strukturu DTD a naopak ve struktuře DTD nelze popsat vše potřebné pro definici bloků.
Textový popis a DTD jsou nedílnou součástí definice DS.
Textový popis je nadřazený vyjádření DTD.
Příklady by měly odpovídat textovému popisu a DTD, slouží ale pouze jako ilustrace.
V hypertextovém tvaru popisu DS je odpovídající struktura DTD k dispozici vždy za tabulkou ve formě hypertextového odkazu. Zde je k dispozici i odkaz na příklad.
STRUKTURA
BLOKU:
*blok - označení bloku
Základní informace o bloku.
{stav}
kód |
T |
D |
V |
plný název |
hodnota |
podmínky, pokyny,
poznámky |
změny |
|
a |
000 |
? |
název určující obsah |
”výčet zde” |
volný text |
|
|
e |
|
* |
|
TAB A |
podrobněji viz XYZ |
|
|
d |
|
|
|
|
|
|
aaa |
|
|
1 |
|
[XXXX] |
|
|
eee |
|
|
+ |
|
[NZIS:yyy] |
|
|
[DTD] [Příklad]
POPIS
BLOKU:
*blok - označení bloku:
Pojmenování
příslušného elementu XML, jehož struktura dále následuje. Malá písmena bez
diakritiky.
S ohledem
na předchozí verzi datového standardu je používáno původní označení ”blok” (z
hlediska XML se jedná o elementy).
Znak
” * ” není součástí jména, je uváděn pouze v textovém tvaru
popisu (pro vyhledávání začátků ”bloků” v dokumentech).
Základní informace o bloku:
Stručná základní informace o
tomto bloku včetně případné fakultativní informace o
původním označení tohoto bloku v DS 1.20.
Může mít výjimečně i několik
řádků.
{stav}:
Stav celého bloku:
{rozpracováno} - na bloku se dosud pracuje
{distribuováno od
verze 2.01.01} - blok je oficiálně uvolněn
a je platný počínaje uvedenou verzí
-----
{OBSOLETNÍ!} - dříve platný
blok byl navržen na zrušení - již by neměl být používán, po určité době bude
NEAKTUÁLNÍ
{NEAKTUÁLNÍ!} - dříve platný
blok byl zrušen a nyní je již neplatný - již nesmí být používán
Do finálního tvaru
příslušné verze DS budou zařazovány pouze bloky označené jako {distribuováno...}
a s příslušnou poznámkou také bloky {OBSOLETNÍ!}.
[DTD]:
Hypertextový odkaz na
odpovídající zápis ”DTD”. Váže se vždy jen k uvedené oficiální verzi.
Aktuální tvar ”DTD” je vždy
k dispozici v plném funkčním znění v příslušné deklarované příloze.
Popis DTD je v souladu
s popisem textovým! Vzájemně se doplňují. Nadřazený je textový pois!
[Příklad]:
Hypertextový
odkaz na příklady řešení bloku - pouze ilustrace řešení.
TABULKA:
Vlastní
tabulka má pevně definované sloupce, jejich šířka je ale variabilní. Popis
sloupců je uveden dále.
V řádcích
je uváděn výčet jednotlivých atributů a elementů. Uspořádání řádků
v tabulce je voleno s ohledem na logiku a přehlednost (pro čtenáře).
V dokumentu
XML je pořadí:
1.
povinné atributy (REQUIRED), 2. nepovinné atributy (IMPLIED), 3. povinné
elementy, 4. nepovinné elementy.
Kód:
Identifikátor pro potřeby XML
(malými písmeny a bez diakritiky).
Odkazy na jiné elementy (v DS
označované jako ”bloky”) jsou v textové formě tučně s dvojitým
podtržením a v hypertextové formě jsou jako skutečné aktivní odkazy na
příslušný element (blok).
T:
Typ pro XML:
·
a = atribut
Údaj
(datový obsah) je obsahem atributu elementu představující popisovaný datový
blok. Možný výskyt atributů je ”1” (#REQUIRED) nebo ”?” (#IMPLIED).
příklad:
<a typ="0" >...</a>
·
e = element - vnořený
element (vnořený blok)
Údaj
(datový obsah) je obsahem jednoduchého elementu nebo jde o vnořenou strukturu
dalších elementů (tzv. vnořený blok - jeho kód je zvýrazněn, v textu je uveden
tučně s dvojitým podtržením a v hypertextu je jako aktivní odkaz na uvedený
blok). Možný výskyt pro typ e ”?”, ”*”, ”1”, ”+” (viz výskyt V)
příklad:
<a ><jmeno>Karel</jmeno>...</a>
·
d = data, v DTD symbol
"#PCDATA"
Údaj
(datový obsah) je přímo obsahem elementu představující popisovaný datový blok.
Tento blok pak nemůže obsahovat vnořené struktury, může obsahovat atributy.
Možný výskyt pro typ e je "1" - musí obsahovat alespoň jeden znak,
maximálně počet znaků uvedený ve sloupci D (délka).
příklad:
<autor>MUDr. Josef Mokrý</autor>
D:
Délka položky (pro potřebu
databází příslušných IS).
Je-li uvedeno číslo, znamená
to pevnou délku položky.
Je-li před číslem uveden znak
”-”, znamená to, že délka položky nesmí být větší než toto číslo.
Není-li uvedeno číslo, pak se
jedná o element nebo o atribut s délkou libovolnou vhodnou.
V:
Výskyt (pro XML):
·
? = nepovinný, může se vyskytovat maximálně 1x
; (= 0, 1)
·
* = nepovinný, může se vyskytovat opakovaně; (= 0 až N)
·
1 = povinný, vyskytuje se jen 1x - v XML
je default; (= 1)
·
+ = povinný, vyskytuje se
alespoň 1x; (= 1 až N)
Upozornění: pokud je potřeba
v tabulce popsat, že se může např. vyskytovat pouze jeden z uvedených
elementů, je toto realizováno symbolicky prostřednictvím lomítka (” / ”)
a připojeným popisem - podrobněji a správně bude v zápisu DTD.
Plný název:
Volným textem ve formě plného názvu
položky a případně i její stručné charakteristiky.
Případný odkaz na podrobnější
popis nebo další informace je uváděn v poznámce nebo ve sloupci ”viz”.
Hodnota:
Jsou možné varianty:
·
není vyplněno (například
u odkazů na vnořené bloky)
·
přímo výčet zapsaný do
tohoto sloupce (bez popisu) - jednotlivé prvky množiny jsou oddělovány čárkou,
podrobnější popis je uveden v příslušné poznámce (na ni je odkaz ve
sloupci ”viz”)
·
odvolání na tabulku
hodnot uvedenou pod tabulkou touto (váže se jen k tomuto bloku a je
používáno výjimečně)
·
odvolání na číselník -
číselníky mohou být:
·
interní číselníky
k DS 2.00 a výše (viz program ČLP nebo systém SLP) - zápis: [XXXX] = označení
číselníku
·
externí číselníky (nejsou
v programu ČLP ani v systému SLP) - zápis: [NZIS:yyy] = zdroj a označení číselníku
·
zápis typu ”format XZ”
pro element dat_xx (formáty se vyjadřují pomocí kódů D, DT, DTS, R, MR -
viz dat_ )
Pokud se za odkazem na interní
číselník vyskytují znaky # nebo #! nebo #!+, jedná se o pokyn ke kontrole
hodnoty proti uvedenému číselníku:
# = lze testovat dle
interního číselníku, ale lze také použít výčet uvedený v poznámce (v
tabulce nebo pod tabulkou)
a
zabudovaný také do XML (údaje v poznámce i v interním číselníku jsou
a budou totožné)
#! = testovat pouze
dle interního číselníku! (pokud je v poznámce připojen výčet, je pouze
informačního charakteru)
#!+ = testovat pouze
dle interního číselníku s příslušným dalším pokynem zapsaným do
poznámky (a realizovaným v DTD)
(pokud je v poznámce připojen výčet, je pouze
informačního charakteru)
Poznámka:
Varianta # dovoluje
kontrolu jak prostřednictvím číselníku ”typu DS”, tak i rovnou z definice
DTD. Interní číselník se zdá být pro DS zbytečný - je ale vytvořen nejen
s ohledem na DS (alternativní využití), ale zejména také pro jiné
související agendy a spolupracující informační systémy. Tímto symbolem jsou
označovány většinou také číselníky ÚZIS ČR, které mohou být k dispozici v IS
pro i jiné agendy a v různých modifikovaných tvarech.
Podmínky, pokyny, poznámky:
Další
údaje volným textem nebo hypertextovými odkazy. Fyzicky jsou odkazy nejčastěji zařazené
pod tabulkou.
Vždy
je uváděno, zda se jedná o podmínku, pokyn, výklad nebo poznámku.
změny:
Informace o změnách po
vydání DS 3.01.01. Uvádí se rovnou, pokud je změn více, může být i
odkazem.
VLASTNÍ OBSAH BLOKU
Vlastní obsah bloku je
vytvořen na základě popisu struktury bloku - ta je definována tabulkou
v textové podobě (viz výše) a příslušným přepisem této tabulky do
struktury DTD.
Textový popis je
nadřazený nad strukturou (popisem) DTD.
VLASTNÍ OBSAH DATOVÉHO
SOUBORU
Vlastní obsah datového souboru je tvořen záhlavím a obsahem, který je určen zněním DS a je realizován z jednotlivých bloků.
Blíže v odkazu záhlaví datového souboru DS.
ZNAKOVÉ SADY PŘÍPUSTNÉ V DATOVÉM STANDARDU
V datovém standardu se připouští kódování češtiny:
· utf-8 (unicode transformation 8-bit)
· IBM852 (PC Latin 2) = cp852
· ISO-8859-2 (ISO Latin 2)
· Windows-1250 (MS Windows)
Podrobněji v odkazu znakové sady pro DS.
VYJADŘOVÁNÍ DESETINNÝCH
ČÍSEL
K oddělování desetinné části sdělovaných desetinných čísel se používá desetinná čárka (v souladu s platnou českou normou).
BAREVNÁ SYMBOLIKA V POPISU DS
V popisu bloků
datového standardu je používána následující barevná symbolika:
Texty šedozelené sdělují, že
obsah se týká položek (pouze) pro Slovensko.
Texty modré sdělují, že toto
je dosud neřešené - bude realizováno až v další verzi (řeší se).
Texty tmavě žluté jsou většinou pouze poznámky k původní
verzi DS 1.20, které bylo vhodné ponechat. Později zaniknou.
Varování,
důležitá upozornění a informace o platnosti datového bloku jsou červeně.