Attribuutti-kyselypalvelu

Transkriptio

1 Attribuutti-kyselypalvelu sivu 1/10

2 Sisällysluettelo 1 Johdanto Palvelut Ammattioikeudenrajoituslista Ammattioikeuslista Attribuutti-rajoitustietosanoma Palvelurajapinnan toteutus Tiedosto/http-palvelut SOAP/http-palvelut Skeemakuvat Ammattioikeusrajoituslista Ammattioikeuslista Attribuutti-rajoitustietosanoma Liitteet Liite 1: Skeemakuvaukset (*.xsd) Liite 2: Palvelurajapinnan kuvaukset (*.wsdl) Liite 3: Esimerkit (*.xml) Muutoshistoria sivu 2/10

3 Attribuutti-kyselypalvelun rajapintakuvaus 1 Johdanto 2 Palvelut Tässä dokumentissa kuvataan Valvira:n attribuutti-kyselypalvelun (ammattioikeustiedot) sidosryhmille tarjottava palvelurajapinta. Palveluja koskevat käyttötapaukset on kuvattu toteutusprojektin käyttötapauskuvauksissa tarkemmin. 2.1 Ammattioikeudenrajoituslista Sidosryhmän järjestelmä hakee Valvira:n palvelusta luettelon niistä rekisterinumeroista, joilla on jokin rajoitus voimassa palvelun kautta ajastetusti kerran vuorokaudessa ja mieluiten yöaikaan. Parametrit: Ei parametreja. Palautusarvo: XML-muodossa skeeman mukainen luettelo rekisterinumeroista. Ehdot: Ammattioikeuslista Poikkeukset: Ei oleellisia sovelluspoikkeuksia. Sidosryhmän järjestelmä hakee Valvira:lta luettelon rekisterinumeroista palvelun kautta ajastetusti kerran vuorokaudessa ja mieluiten yöaikaan. Parametrit: Ei parametreja. Palautusarvo: XML-muodossa skeeman mukainen luettelo lääkäreiden ja hammaslääkäreiden rekisterinumeroista. Ehdot: - Poikkeukset: Ei oleellisia sovelluspoikkeuksia. 2.3 Attribuutti-rajoitustietosanoma Sidosryhmän järjestelmä hakee Valvira:n palveluväylän kautta ajantasaisesti tiedot parametrina lähetettävän hakuehdon mukaisen henkilön henkilötiedoista, ammattioikeuksista rajoituksineen sekä tutkintotiedoista. sivu 3/10

4 Parametrit: Hakuehto. Arvona on joko rekisterinumero tai henkilötunnus. Palautusarvo: XML-muodossa skeeman mukainen rajoitustietosanoma. Ehdot: palvelua kutsutaan vain, jos henkilö on ammattioikeudenrajoituslistalla. Poikkeukset: hakuehdon mukaista henkilöä ei löydy Valvira:n tiedoista. 3 Palvelurajapinnan toteutus 3.1 Tiedosto/http-palvelut Protokolla ja suojaus: https, palvelinvarmenteet Kelan ja sidosryhmän välillä, Kela purkaa TLS-yhteyden ja ohjaa liikenteen Valvira:n palveluun. Sanomakuvaukset: tietosisältöä määrittävät skeemat. Osoitteet: (testiympäristö, ammattioikeuslista), (testiympäristö, ammattioikeusrajoituslista), (tuotantoympäristö, ammattioikeuslista), (tuotantoympäristö, ammattioikeusrajoituslista). 3.2 SOAP/http-palvelut Osoitteet Attribuutti-rajoitustietosanoma (testiympäristö) (tuotantoympäristö) Määritys: Web Service / SOAP 1.1. Protokolla ja suojaus: https, palvelinvarmenteet Kelan ja sidosryhmän välillä, Kela purkaa TLS-yhteyden ja ohjaa liikenteen Valvira:n palveluun. sivu 4/10

5 Kysely: skeeman mukainen sanoma. Vastaus: skeeman mukainen sanoma. Header: synkronisesta liikenteestä huolimatta sidosryhmän on käytettävä elementtejä sanomatunnus ja sanomavastiketunnus. Valvira hyödyntää niitä vain lokituksessa ja sidosryhmä voi itse määrätä niiden sisällön kyselyssä ja ne palautetaan vastauksessa sellaisenaan. Virhekäsittely: virheet välitetään palveluväylästä SoapFault-määrityksen mukaisesti. Esimerkki puuttuu vielä ja se toimitetaan heti, kun mahdollista. Sanoman elementissä vastausstatus kerrotaan tietokantakäsittelyn onnistuminen. Lisäksi tietosisältöön ja tietokantakäsittelyyn liittyvät virheet välitetään vastaussanoman elementissä virhetieto (vrt. dokumentti Määrittely, tiedot ): <xs:complextype name="errortype"> <xs:sequence> <xs:element name="virheluokka"> <xs:simpletype> <xs:restriction base="xs:string"> <xs:maxlength value="30"/> </xs:restriction> </xs:simpletype> </xs:element> <xs:element name="virhekoodi" minoccurs="0"> <xs:simpletype> <xs:restriction base="xs:string"> <xs:maxlength value="20"/> </xs:restriction> </xs:simpletype> </xs:element> <xs:element name="virheteksti" minoccurs="0"> <xs:simpletype> <xs:restriction base="xs:string"> <xs:maxlength value="500"/> </xs:restriction> </xs:simpletype> </xs:element> </xs:sequence> </xs:complextype> sivu 5/10

6 4 Skeemakuvat 4.1 Ammattioikeusrajoituslista 4.2 Ammattioikeuslista sivu 6/10

7 4.3 Attribuutti-rajoitustietosanoma sivu 7/10

8 sivu 8/10

9 5 Liitteet 5.1 Liite 1: Skeemakuvaukset (*.xsd). Sanomakuvaukset: TEOCommon.xsd TEORequest.xsd TEOResponse.xsd Listat: Rajoitustietolista.xsd Ammattioikeuslista.xsd 5.2 Liite 2: Palvelurajapinnan kuvaukset (*.wsdl). 5.3 Liite 3: Esimerkit (*.xml). Sanomakuvaukset; WSDL-, XSD-kuvaukset sekä esimerkkisanomat (*.xml) ovat tiedostossa Valvira_attrib_schema zip. sivu 9/10

10 Muutoshistoria Versio Päiväys Tekijä Tarkastaja Hyväksyjä Muutoshistoria 1.3 Lisätty tarkemmat palveluosoitteet Päivitetty Attribuutti-rajoitustietosanoman kuva, ytenäistetty versionumeroa. Liittyy ohjelmaversioon MMK Tarkennettu TLS VEL Marko Jalonen/Kela Lisätty listojen osoitetiedot VEL Muutettu listojen protokollaksi sftp->https Kelan palomuurin yhteensopivuuden vuoksi VEL Täydennetty skeemakuvilla ja keskeneräisten tuotosten selvityksellä VEL Ensimmäinen versio. sivu 10/10