Kuittaa välitys

Yleiskuvaus

Käyttötapaus kuvaa tilannetta, jossa viranomainen tai jokin muu sosiaali- ja terveydenhuollon ulkopuolinen organisaatio kuittaa Kysely- ja välityspalvelulle sen kautta hakemansa asiakirjat vastaanotetuiksi.

Vastaanotettuaan hakemansa asiakirjat järjestelmä lähettää Kysely- ja välityspalvelulle kuittauspyynnön kustakin vastaanotetusta asiakirjasta. Kuittauspyynnöllä on myös mahdollista ilmoittaa tilanteesta, jossa vastaanotetun asiakirjan käsittely on epäonnistunut.

Jos haetun asiakirjan vastaanotto hakevassa järjestelmässä on epäonnistunut, kuittausta ei tehdä. Tällöin asiakirja voidaan hakea uudelleen Kysely- ja välityspalvelulta. Voit lukea lisätietoja käyttötapauksista Hae asiakirjoja henkilötunnuksen perusteella ja Hae organisaatiolle osoitetut asiakirjat.

Kun välitys on onnistuneesti kuitattu Kysely- ja välityspalvelulle, asiakirjaa ei voi enää hakea uudelleen.

Käyttäjäroolit

  • Kysely- ja välityspalvelu, myöhemmin KVP
  • Asiakirjoja hakeva järjestelmä

Esiehdot

  • Asiakirjoja hakeva organisaatio on ottanut käyttöön Kansallisen palveluväylän.
  • Asiakirjoja hakeva organisaatio on liittynyt vastaanottajarekisteriin. [LT1]
  • Asiakirjoja hakeva organisaatio on vastaanottanut hakemansa sille osoitetun asiakirjan Kysely- ja välityspalvelusta. [LT2]

Normaali tapahtumakulku

  1. Asiakirjoja hakeva järjestelmä muodostaa kuvauksen Välityksen kuittaus mukaisen pyyntösanoman. [LT3]
  2. Asiakirjoja hakeva järjestelmä lähettää pyyntösanoman Kansallisen palveluväylän kautta KVP:lle.
  3. KVP käsittelee kuittauspyynnön. [V1] [LT1] [LT2] [LT3]
  4. KVP palauttaa kuvauksen Kuittauksen vastaus mukaisen vastaussanoman. [V1]
  5. Asiakirjoja hakeva järjestelmä vastaanottaa vastaussanoman Kansallisen palveluväylän kautta. Käyttötapaus päättyy.

Virheet

V1. Hakusanoma on virheellinen tai kuittauspyynnön käsittely aiheuttaa virheen. KVP palauttaa kutsuvalle järjestelmälle kuvauksen Vastaussanoma virhetilanteessa mukaisen virhevastauksen. Käyttötapaus päättyy.

Lisätiedot

LT1. KVP tarkistaa, että kuittauspyynnön lähettänyt organisaatio on sama kuin kuittaukseen liittyvän välityspyynnön vastaanottava organisaatio.

LT2. Järjestelmä tarvitsee kuittauspyynnön muodostamista varten asiakirjan hakupyynnön vastaussanomassa (ks. Asiakirjahakujen vastaus) palautuvan Välitys-resurssi-instanssin tiedot. Kuittauspyynnön Välitys-resurssi-instanssissa voi ja tulee käyttää samoja tietoja seuraavin poikkeuksin:

  • payload jätetään tyhjäksi.
  • Jos asiakirjan lopullinen vastaanottaja poikkeaa välityspyynnöllä ilmoitetusta alkuperäisestä vastaanottajasta, päivitetään recipient-kenttään asiakirjan lopullinen vastaanottaja.
  • Välityksen tilaksi asetetaan status=completed, jos asiakirja on onnistuneesti vastaanotettu ja käsitelty.
  • Välityksen tilaksi asetetaan status=stopped, jos haetun asiakirjan käsittely on epäonnistunut, eikä asiakirjaa ole enää aiheellista hakea uudelleen. Tässä tilanteessa asetetaan myös statusReason, johon kuvataan virheen syy lyhyesti (enintään 255 merkkiä).

LT3. KVP tarkistaa, että asiakirja, jonka välitystä kuittauspyyntö koskee, on onnistuneesti haettu KVP:n kautta.