Hakuoperaatioiden HTTP pyyntö (request)
Hakuoperaatiot välitetään palvelulle HTTP pyyntönä (request) POST-metodilla. HTTP pyynnön tiedot välittyvät HTTP header- ja body-osuuksiin jaettuna.
Pyynnön HTTP header
HTTP-pyynnön header-osuus noudattaa Kanta-palveluiden yhteisiä Kanta FHIR HTTP header ja Kanta JSON Web Token määrittelyitä.
Kanta FHIR HTTP header määrittely kuvaa FHIR rajapinnoissa tarvittavat HTTP-pyynnön tiedot ja Kanta JSON Web Token määrittely kuvaa FHIR rajapinnoissa tarvittavat pääsynhallinnan tiedot.
Kyselyn syy tieto annetaan Sähköinen lääkemääräys - Reseptikyselyn syy -koodiston mukaisin arvoin ja kyselyn syy tieto välitetään Kanta JSON Web Token määrittelyn mukaan.
Alla olevissa taulukoissa on listattu kaikki Kanta lääkityslista FHIR-rajapinnan kautta tapahtuvat haut ja niissä sallitut kyselyn syyt potilas- ja apteekkitietojärjestelmille.
Kyselyn syyt, joita Potilastietojärjestelmät voivat käyttää eri hauissa (hakuoperaatioissa) on kuvattu alla olevassa taulukossa. Kyselyn syistä on kerrottu myös toiminnallisten määrittelyiden liitedokumentissa Reseptien haku Reseptikeskuksesta - Terveydenhuolto.
| Hakuoperaatio | Kyselyn syy (Kanta JSON Web Token parametri request_purpose) |
|---|---|
| $get-medicationlist (Lääkityslistan perushaku) | 1, 2, 3, 4, 8, 21, 23, 25, 27 |
| $get-discontinued-medications (Lopetettujen lääkkeiden haku) | 1, 2, 3, 4, 8, 21, 23, 25, 27 |
| $get-history-medications (Lääkkeen historiahaku) | 1, 2, 3, 4, 8, 21, 23, 25, 27 |
| $get-old-prescriptions (Historiahaku ilman käytössä olevan lääkkeen tunnisteita) | 1, 2, 3, 4, 8, 21, 23, 25, 27 |
| $get-custom-data (Lääkityslistan erikoishaku), PKV- ja huumausainelääkemääräykset | 20 |
| $get-custom-data (Lääkityslistan erikoishaku), Lääkkeen määrääjän itse laatimat lääkemääräykset | 39 |
| $get-custom-data (Lääkityslistan erikoishaku), Tietyllä ATC-koodilla olevat lääkemääräykset | 8 |
| $get-printout (Lääkityslistan tulostehaku) Lääkityslistan yhteenveto (kooste) | 38 |
| $get-printout (Lääkityslistan tulostehaku) Potilasohje | 10 |
| $get-printout (Lääkityslistan tulostehaku) Ulkomaan matkaa varten annettava jäljennös | 23 |
| $get-printout (Lääkityslistan tulostehaku) Ulkomailla ostoa varten annettava jäljennös | 22 |
Kyselyn syyt, joita Apteekkijärjestelmät voivat käyttää eri hauissa (hakuoperaatioissa) on kuvattu alla olevassa taulukossa. Kyselyn syistä on kerrottu myös toiminnallisten määrittelyiden liitedokumentissa Reseptien haku Reseptikeskuksesta - Apteekkijärjestelmät.
| Hakuoperaatio | Kyselyn syy (Kanta JSON Web Token parametri request_purpose) |
|---|---|
| $get-medicationlist (Lääkityslistan perushaku) | 3, 4, 6, 7, 8, 23, 24, 25, 34 |
| $get-discontinued-medications (Lopetettujen lääkkeiden haku) | 3, 4, 6, 7, 8, 23, 25, 34 |
| $get-history-medications (Lääkkeen historiahaku) | 3, 4, 6, 7, 8, 23, 25, 34 |
| $get-old-prescriptions (Historiahaku ilman käytössä olevan lääkkeen tunnisteita) | 3, 4, 6, 7, 8, 23, 25, 34 |
| $get-custom-data (Lääkityslistan erikoishaku), Uusimispyyntöjen käsittelyn tilanne | 11 |
| $get-custom-data (Lääkityslistan erikoishaku), Apteekin uudet ja muuttuneet annosjakelulääkemääräykset | 37 |
| $get-custom-data (Lääkityslistan erikoishaku), Tietyllä ATC-koodilla olevat lääkemääräykset | 8 |
| $get-printout (Lääkityslistan tulostehaku) Lääkityslistan yhteenveto (kooste) | 38 |
| $get-printout (Lääkityslistan tulostehaku) Ulkomaan matkaa varten annettava jäljennös | 23 |
Pyynnön HTTP body
HTTP pyynnön body-osuus sisältää pyynnössä käytettävät hakuparametrit. Alla on linkit Kanta-lääkityslistan hakuoperaatioihin, niistä löytyvät Kanta-lääkityslista eri hakujen (hakuoperaatioiden) hakuparametrit. Parametrit välitetään HTTP pyynnön body-osassa Parameters resurssin avulla. Tämän oppaan osiossa Hakuparametri esimerkkejä (Pyynnön HTTP body) on kuvattu esimerkein kuinka voidaan eri haussa Pyynnön HTTP body hakuparametreja antaa.
Hakuparametreissa tulee aina olla arvot, tyhjinä annetuista hakuparametreista palautuu virhe.