JHS XXX Julkisen hallinnon palvelujen metatiedot ja ryhmittely verkkopalveluissa Liite 2 XML-skeeman kuvaus ja esimerkit Versio: 15.3.2012 Julkaistu: xx.xx.2012 Voimassaoloaika: toistaiseksi Sisällys 1 Johdanto... 2 2 Skeeman rakenne... 2 3 Skeeman käyttö... 2 4 Esimerkkejä XML-dokumenteista... 2 4.1 Listaus organisaatioista... 2 4.2 Listaus paikallisista toimipisteistä... 3 4.3 Listaus puhelinpalveluista... 5 4.4 Listaus sähköisistä asiointipalveluista... 7 4.5 Listaus palveluista... 8 4.6 Listaus verkkosivuista... 9 1/9
1 Johdanto Tässä dokumentissa kuvataan, miten JHS XXX Julkisen hallinnon palvelujen metatiedot ja ryhmittely verkkopalveluissa -suosituksen mukainen metatieto voidaan esittää XML-kuvauskielellä. Kuvauksen määrittelee täsmällisesti XML Schema -kielellä esitetty koneluettava skeema. Skeema määrittelee teknisen formaatin, jolla palvelutiedon tuottaja voi esittää JHS XXX -metatietomallin mukaista tietoa yhteentoimivassa, koneluettavassa muodossa. Varsinaiset skeematiedostot ovat erillisissä liitteissä (liitteet 3-5). 2 Skeeman rakenne Skeema on tehty JHS XXX -metatietomallin pohjalta. Luokat ja kentät on kuvattu XML-elementteinä. Skeema on tehty JHS 170 Julkishallinnon XML-skeemat -suosituksen mukaisesti. Skeemassa käytetyt elementti- ja attribuuttinimet ovat samat kuin metatietomallissa sillä erotuksella, että skandinaaviset merkit on poistettu ja XML-elementtien nimet alkavat isolla alkukirjaimella (JHS 170:n mukaisesti). XML-skeema koostuu neljästä osasta: 1. Elementtiskeema jhs145.xsd 2. Tietotyyppiskeema jhs145cdt.xsd 3. Koosteskeema jhs145palvelutietokanta.xsd Lisäksi skeema vaatii JHS 170 -ydinskeeman (JHS 170-suosituksen liite 1, JHSYdin20091019.xsd). Koosteskeema määrittelee päätason elementin jhs145k:palvelutietokanta, joilla voi esittää listoja seuraavista objektityypeistä: jhs145:organisaatio, jhs145:paikallinentoimipiste, jhs145:puhelinpalvelu, jhs145:sahkoinenasiointipalvelu, jhs145:palvelu, jhs145:verkkosivu. 3 Skeeman käyttö Vaikka JHS XXX ei sisällä varsinaisia rajapintamäärittelyjä, on tämä XML-skeema tehty rajapintakäyttöä silmällä pitäen. Sitä voidaan käyttää esimerkiksi REST-tyyppisessä rajapinnassa siten, että rajapinta palauttaa koosteskeeman mukaisia XML-dokumentteja. Rajapinnoille voi myös määritellä omat rajapintaskeemat JHS 170 suosituksen mukaisesti käyttäen hyväksi JHS XXX -elementti- ja tietotyyppiskeemoja. Skeemaa voi myös käyttää siirtotiedostojen tuottamiseen ja validointiin. 4 Esimerkkejä XML-dokumenteista Tässä luvussa on esitetty esimerkkejä skeeman mukaisista XML-dokumenteista. Esimerkkidokumentit ovat koosteskeeman mukaisia listauksia, joissa kuitenkin on pääasiallisesti annettu vain yksi objekti. Organisaatioiden ja palveluiden listauksissa on kuitenkin useita objekteja, jotka muodostavat hierarkian. 4.1 Listaus organisaatioista Tässä esimerkissä on annettu organisaatiolistaus, jossa on kuvattu Helsingin kaupunki sekä sen organisaatioyksiköt Sosiaalivirasto ja Opetusvirasto. Esimerkin tiedot perustuvat Pääkaupunkiseudun Palvelukartan REST-rajapintaan, josta ne on haettu 12.3.2012. 2/9
<jhs145:organisaatio> <jhs145:organisaatiotunnus>091</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">helsingin kaupunki</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">helsingfors stad</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="en">city of Helsinki</jhs145:Nimi> <jhs145:organisaatioyksikkoorganisaatio> <jhs145:organisaatiotunnus>sosv</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">sosiaalivirasto, Helsinki</jhs145:Nimi> <jhs145:nimi cdt:kielikoodi="sv">socialverket, Helsingfors</jhs145:Nimi> <jhs145:nimi cdt:kielikoodi="en">social Services Department, Helsinki</jhs145:Nimi> </jhs145:organisaatioyksikkoorganisaatio> <jhs145:organisaatioyksikkoorganisaatio> <jhs145:organisaatiotunnus>opev</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">opetusvirasto, Helsinki</jhs145:Nimi> <jhs145:nimi cdt:kielikoodi="sv">utbildningsverket, Helsingfors</jhs145:Nimi> <jhs145:nimi cdt:kielikoodi="en">education Department, Helsinki</jhs145:Nimi> </jhs145:organisaatioyksikkoorganisaatio> </jhs145:organisaatio> 4.2 Listaus paikallisista toimipisteistä Tässä esimerkissä on annettu palvelupistelistaus, jossa on kuvattu Päiväkoti Apila sekä sen yhteystiedot, sijainti, esteettömyystiedot ja palvelut. Esimerkin tiedot perustuvat pääosin Pääkaupunkiseudun Palvelukartan REST-rajapintaan. xmlns:jhs="http://skeemat.jhs-suositukset.fi/yhteiset/2009/10/19" <jhs145:paikallinentoimipiste> <jhs145:palvelupistetunnus>1</jhs145:palvelupistetunnus> <jhs145:nimi cdt:kielikoodi="fi">päiväkoti Apila</jhs145:Nimi> <jhs145:tuottajatyyppikoodi>http://www.yso.fi/onto/jupo/p1053</jhs145:tuottajatyyppikoodi> <jhs145:verkkosivu> <jhs145:urltunnus>http://www.hel.fi/hki/sosv/fi/p_iv_hoito/p_iv_kodit/p_iv_koti+apila/</jhs145:urlt 3/9
unnus> <jhs145:nimeketeksti cdt:kielikoodi="fi">päiväkoti Apila</jhs145:NimekeTeksti> </jhs145:verkkosivu> <jhs145:palvelutunnus>27726</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">päivähoito</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">dagvård</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="en">day care</jhs145:nimi> <jhs145:palvelutunnus>27894</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">esiopetus kunnallisessa päiväkodissa</jhs145:nimi> <jhs145:palvelutunnus>27874</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">kerhotoiminta</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">klubbverksamhet</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="en">club activities</jhs145:nimi> <!-- jätetty pois muutama tarjottu palvelu esimerkin selventämiseksi --> <jhs145:postiosoite> <jhs145:osoitetunnus>1posti</jhs145:osoitetunnus> <jhs:kuntakoodi>091</jhs:kuntakoodi> <jhs145:lahiosoiteteksti cdt:kielikoodi="fi">pl 41810</jhs145:LahiosoiteTeksti> <jhs:postinumerokoodi>00099</jhs:postinumerokoodi> <jhs145:postitoimipaikkateksti cdt:kielikoodi="fi">helsingin kaupunki</jhs145:postitoimipaikkateksti> </jhs145:postiosoite> <jhs145:esteettomyyskuvaus> <jhs145:nimeketeksti cdt:kielikoodi="fi">saattoliikenne</jhs145:nimeketeksti> <jhs145:kuvausteksti cdt:kielikoodi="fi">saattoliikenteen pysähtymispaikka sijaitsee sisäänkäynnin läheisyydessä, josta jalkakäytävälle pääsee siirtymään sujuvasti.</jhs145:kuvausteksti> <jhs145:kuvausteksti cdt:kielikoodi="sv">hållplatsen för skjutstrafik ligger i närheten av ingången, på en plats varifrån det är lätt att ta sig till trottoaren.</jhs145:kuvausteksti> <jhs145:kuvausteksti cdt:kielikoodi="en">the pick-up and drop-off area is located in the vicinity of the entrance, giving easy access to the pavement.</jhs145:kuvausteksti> </jhs145:esteettomyyskuvaus> <jhs145:esteettomyyskuvaus> <jhs145:nimeketeksti cdt:kielikoodi="fi">kulkureitti sisäänkäynnille</jhs145:nimeketeksti> <jhs145:kuvausteksti cdt:kielikoodi="fi">kulkureitti sisäänkäynnille on tasainen ja riittävän leveä.</jhs145:kuvausteksti> <jhs145:kuvausteksti cdt:kielikoodi="sv">rutten till ingången är jämn och tillräckligt bred.</jhs145:kuvausteksti> <jhs145:kuvausteksti cdt:kielikoodi="en">the route to the entrance is smooth and sufficiently wide.</jhs145:kuvausteksti> </jhs145:esteettomyyskuvaus> <!-- jätetty pois muutama esteettömyyskuvaus esimerkin selventämiseksi --> <jhs145:puhelin> <jhs:puhelinnumeroteksti>+358931041572</jhs:puhelinnumeroteksti> </jhs145:puhelin> <jhs145:puhelin> 4/9
<jhs145:kuvausteksti cdt:kielikoodi="fi">johtaja</jhs145:kuvausteksti> <jhs:puhelinnumeroteksti>+358931041571</jhs:puhelinnumeroteksti> </jhs145:puhelin> <jhs145:sahkoposti> <jhs:sahkopostiosoiteteksti>pk.apila@hel.fi</jhs:sahkopostiosoiteteksti> </jhs145:sahkoposti> <jhs145:hallinnoijaorganisaatio> <jhs145:organisaatiotunnus>sosv</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">sosiaalivirasto, Helsinki</jhs145:Nimi> <jhs145:nimi cdt:kielikoodi="sv">socialverket, Helsingfors</jhs145:Nimi> <jhs145:nimi cdt:kielikoodi="en">social Services Department, Helsinki</jhs145:Nimi> </jhs145:hallinnoijaorganisaatio> <jhs145:leveysastearvo>60.24441</jhs145:leveysastearvo> <jhs145:pituusastearvo>24.855764</jhs145:pituusastearvo> <jhs145:koordinaatitasetettukasinkytkin>false</jhs145:koordinaatitasetettukasinkytkin> <jhs145:kayntiosoite> <jhs145:osoitetunnus>1kaynti</jhs145:osoitetunnus> <jhs:kuntakoodi>091</jhs:kuntakoodi> <jhs145:lahiosoiteteksti cdt:kielikoodi="fi">arentikuja 3</jhs145:LahiosoiteTeksti> <jhs145:lahiosoiteteksti cdt:kielikoodi="sv">arrendegränden 3</jhs145:LahiosoiteTeksti> <jhs145:lahiosoiteteksti cdt:kielikoodi="en">arentikuja 3</jhs145:LahiosoiteTeksti> <jhs:postinumerokoodi>00410</jhs:postinumerokoodi> <jhs145:postitoimipaikkateksti cdt:kielikoodi="fi">helsinki</jhs145:postitoimipaikkateksti> <jhs145:postitoimipaikkateksti cdt:kielikoodi="sv">helsingfors</jhs145:postitoimipaikkateksti> <jhs145:postitoimipaikkateksti cdt:kielikoodi="en">helsinki</jhs145:postitoimipaikkateksti> </jhs145:kayntiosoite> </jhs145:paikallinentoimipiste> 4.3 Listaus puhelinpalveluista Tässä esimerkissä on kuvattu Helsingin ja Uudenmaan sairaanhoitopiirin (09) 10023 - terveysneuvontapuhelin, sen aukioloajat, yhteystiedot sekä hallinnoija- ja toteuttajaorganisaatiot. Tiedot perustuvat pääasiassa puhelinpalvelun omiin verkkosivuihin. xmlns:jhs="http://skeemat.jhs-suositukset.fi/yhteiset/2009/10/19" <jhs145:puhelinpalvelu> <jhs145:palvelupistetunnus>10023</jhs145:palvelupistetunnus> <jhs145:nimi cdt:kielikoodi="fi">(09) 10023 terveysneuvonta</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">(09) 10023 hälsorådgivning</jhs145:nimi> <jhs145:kuvausteksti cdt:kielikoodi="fi">soita (09) 10023 aina kun tarvitset tietoa terveyspalveluista tai sairauksien hoito-ohjeita. 10023 5/9
vastaa joka päivä 24 h, ammattitaidolla ja luottamuksellisesti. Puhelun hinta on operaattorin perimä maksu + paikallispuhelun hinta. Puhelusta ei peritä erillistä palvelumaksua.</jhs145:kuvausteksti> <!-- yksityisen yrityksen (sopimuksella) tuottama --> <jhs145:tuottajatyyppikoodi>http://www.yso.fi/onto/jupo/p2470</jhs145:tuottajatyyppikoodi> <!-- käyttö rajattu HUS:n alueen kuntiin --> <jhs:kuntakoodi>049</jhs:kuntakoodi> <!-- Espoo --> <jhs:kuntakoodi>091</jhs:kuntakoodi> <!-- Helsinki --> <jhs:kuntakoodi>235</jhs:kuntakoodi> <!-- Kauniainen --> <jhs:kuntakoodi>245</jhs:kuntakoodi> <!-- Kerava --> <jhs:kuntakoodi>257</jhs:kuntakoodi> <!-- Kirkkonummi --> <jhs:kuntakoodi>092</jhs:kuntakoodi> <!-- Vantaa --> <!-- ilmeisesti palvelu on tarjolla myös muissa HUS-kunnissa, mutta luettelo lyhennetty esimerkin selkeyden vuoksi --> <jhs145:verkkosivu> <jhs145:urltunnus>http://www.0910023.fi/</jhs145:urltunnus> <jhs145:nimeketeksti cdt:kielikoodi="fi">(09) 10023 terveysneuvonta vastaa aina</jhs145:nimeketeksti> </jhs145:verkkosivu> <jhs145:palvelutunnus>12345</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">terveysneuvonta</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">hälsorådgivning</jhs145:nimi> <!-- palvelutyyppi: terveyspalvelujen neuvonta --> <jhs145:palvelutyyppikoodi>http://www.yso.fi/onto/jupo/p1113</jhs145:palvelutyyppikoodi> <!-- kohderyhmä: kaikki --> <!-- toteutustapa: ostopalvelu --> <jhs145:toteutustapakoodi>http://www.yso.fi/onto/jupo/p79</jhs145:toteutustapakoodi> <jhs145:aukioloaika> <!-- auki 24h viikon jokaisena päivänä --> <jhs145:avaamisaika>00:00:00</jhs145:avaamisaika> <jhs145:sulkemisaika>23:59:59</jhs145:sulkemisaika> <jhs145:viikonpaivakoodi>1</jhs145:viikonpaivakoodi> <jhs145:viikonpaivakoodi>2</jhs145:viikonpaivakoodi> <jhs145:viikonpaivakoodi>3</jhs145:viikonpaivakoodi> <jhs145:viikonpaivakoodi>4</jhs145:viikonpaivakoodi> <jhs145:viikonpaivakoodi>5</jhs145:viikonpaivakoodi> <jhs145:viikonpaivakoodi>6</jhs145:viikonpaivakoodi> <jhs145:viikonpaivakoodi>7</jhs145:viikonpaivakoodi> </jhs145:aukioloaika> <jhs145:puhelin> <jhs:puhelinnumeroteksti>+358910023</jhs:puhelinnumeroteksti> </jhs145:puhelin> <jhs145:hallinnoijaorganisaatio> <jhs145:organisaatiotunnus>hus</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">helsingin ja Uudenmaan sairaanhoitopiiri</jhs145:nimi> 6/9
<jhs145:nimi cdt:kielikoodi="fi">helsingfors och Nylands sjukvårdsdistrikt</jhs145:nimi> <jhs145:vaihtoehtoinennimi cdt:kielikoodi="fi">hus</jhs145:vaihtoehtoinennimi> <jhs145:vaihtoehtoinennimi cdt:kielikoodi="sv">hns</jhs145:vaihtoehtoinennimi> </jhs145:hallinnoijaorganisaatio> <jhs145:toteuttajaorganisaatio> <jhs145:organisaatiotunnus>mawellcare</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">mawell Care Oy</jhs145:Nimi> <jhs:yritystunnus>0584723-5</jhs:yritystunnus> </jhs145:toteuttajaorganisaatio> </jhs145:puhelinpalvelu> 4.4 Listaus sähköisistä asiointipalveluista Tässä esimerkissä on kuvattu Poliisin sähköinen rikosilmoitus. Tiedot perustuvat pääosin Suomi.fi-portaalin tietoihin. xmlns:jhs="http://skeemat.jhs-suositukset.fi/yhteiset/2009/10/19" <jhs145:sahkoinenasiointipalvelu> <jhs145:palvelupistetunnus>rikosilm</jhs145:palvelupistetunnus> <jhs145:nimi cdt:kielikoodi="fi">rikosilmoitus</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">brottsanmälan</jhs145:nimi> <!-- tuottajatyyppi: valtio --> <jhs145:tuottajatyyppikoodi>http://www.yso.fi/onto/jupo/p655</jhs145:tuottajatyyppikoodi> <jhs145:palvelutunnus>23456</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">rikosilmoitus</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">brottsanmälan</jhs145:nimi> <jhs145:hallinnoijaorganisaatio> <jhs145:organisaatiotunnus>pol</jhs145:organisaatiotunnus> <jhs145:nimi cdt:kielikoodi="fi">poliisi</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">polisen</jhs145:nimi> </jhs145:hallinnoijaorganisaatio> <jhs145:vaatiitunnistautumisenkytkin>true</jhs145:vaatiitunnistautumisenkytkin> <jhs145:vaatiimaksunkytkin>false</jhs145:vaatiimaksunkytkin> <jhs145:vaatiiallekirjoituksenkytkin>false</jhs145:vaatiiallekirjoituksenkytkin> <jhs145:kytkettyasiointitiliinkytkin>false</jhs145:kytkettyasiointitiliinkytkin> <jhs145:allekirjoituslkm>0</jhs145:allekirjoituslkm> <!-- suomenkielinen lomake --> 7/9
<jhs145:asiointilomake> <jhs145:urltunnus>http://lomake.fi/forms/xml/pol/rikosilm/fi</jhs145:urltunnus> <jhs145:tiedostotyyppikoodi>text/html</jhs145:tiedostotyyppikoodi> <jhs145:nimeketeksti cdt:kielikoodi="fi">rikosilmoitus</jhs145:nimeketeksti> <jhs145:kielikoodi>fi</jhs145:kielikoodi> </jhs145:asiointilomake> <!-- ruotsinkielinen lomake --> <jhs145:asiointilomake> <jhs145:urltunnus>http://lomake.fi/forms/xml/pol/rikosilm/se</jhs145:urltunnus> <jhs145:tiedostotyyppikoodi>text/html</jhs145:tiedostotyyppikoodi> <jhs145:nimeketeksti cdt:kielikoodi="sv">brottsanmälan</jhs145:nimeketeksti> <jhs145:kielikoodi>sv</jhs145:kielikoodi> </jhs145:asiointilomake> </jhs145:sahkoinenasiointipalvelu> 4.5 Listaus palveluista Tässä esimerkissä on kuvattu palvelu Veneily sekä sen alapalvelut Ulkoilusaaret ja Veneiden talvisäilytys. Esimerkin tiedot perustuvat Pääkaupunkiseudun Palvelukartan REST-rajapintaan. <jhs145:palvelu> <jhs145:palvelutunnus>25606</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">veneily</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">båtsport</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="en">boating</jhs145:nimi> <jhs145:palvelutyyppikoodi>http://www.yso.fi/onto/jupo/p386</jhs145:palvelutyyppikoodi> <jhs145:toteutustapakoodi>http://www.yso.fi/onto/jupo/p2174</jhs145:toteutustapakoodi> <jhs145:alatasonpalvelu> <jhs145:palvelutunnus>25612</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">ulkoilusaaret</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">friluftsöar</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="en">recreational islands</jhs145:nimi> <jhs145:palvelutyyppikoodi>http://www.yso.fi/onto/jupo/p1478</jhs145:palvelutyyppikoodi> <jhs145:toteutustapakoodi>http://www.yso.fi/onto/jupo/p2174</jhs145:toteutustapakoodi> </jhs145:alatasonpalvelu> <jhs145:alatasonpalvelu> <jhs145:palvelutunnus>25608</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">veneiden talvisäilytys</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">vinterförvaring av båtar</jhs145:nimi> 8/9
<jhs145:nimi cdt:kielikoodi="en">winter storage for boats</jhs145:nimi> <jhs145:palvelutyyppikoodi>http://www.yso.fi/onto/jupo/p2191</jhs145:palvelutyyppikoodi> <jhs145:toteutustapakoodi>http://www.yso.fi/onto/jupo/p2174</jhs145:toteutustapakoodi> </jhs145:alatasonpalvelu> </jhs145:palvelu> 4.6 Listaus verkkosivuista Tässä esimerkissä on kuvattu Kirkkonummen pääkirjastosta kertova verkkosivu ja ilmaistu, mistä palvelusta sivu kertoo. Tiedot perustuvat Kirkkonummen kunnan verkkosivuihin. xmlns:jhs="http://skeemat.jhs-suositukset.fi/yhteiset/2009/10/19" <jhs145:verkkosivu> <jhs145:urltunnus>http://www.kirkkonummi.fi/kirjasto/paakirjasto</jhs145:urltunnus> <jhs145:nimeketeksti cdt:kielikoodi="fi">pääkirjasto</jhs145:nimeketeksti> <jhs:kielikoodi>fi</jhs:kielikoodi> <jhs145:kuvattupalvelu> <jhs145:palvelutunnus>kirjasto</jhs145:palvelutunnus> <jhs145:nimi cdt:kielikoodi="fi">kirjasto</jhs145:nimi> <jhs145:nimi cdt:kielikoodi="sv">bibliotek</jhs145:nimi> <!-- palvelutyyppi: kirjastopalvelut --> <jhs145:palvelutyyppikoodi>http://www.yso.fi/onto/jupo/p803</jhs145:palvelutyyppikoodi> <!-- kohderyhmä: kaikki --> </jhs145:kuvattupalvelu> </jhs145:verkkosivu> 9/9