Operaatio $get-prescriptions-metadata

Lääkemääräyksen yksilöintitietojen hakuoperaation (ks. kuva alla) pyynnössä välitetään kyselyparametrit Parameters resurssissa ja vastauksessa palautetaan Bundle resurssi, joka sisältää lääkemääräyksen yksilöintitietoja sisältäviä MedicationRequest resursseja reseptikohtaisesti (yksi MedicationRequest resurssi sisältää yhden lääkemääräyksen yksilöintitiedot).

OK REST haku

Lääkemääräyksen yksilöintitietojen hakuoperaatio $get-prescriptions-metadata on FHIR RESTful määritysten mukainen operaatio (ks. tarkemmin FHIR RESTful API ja Extended Operations on the RESTful API). Hakuoperaatio ei tue kaikkia FHIR RESTful API ominaisuuksia, vain tässä soveltamisoppaassa kuvatut ominaisuudet ovat tuettuna.

Operaation osoite (URL)

Operaation URL:in muoto noudattaa FHIR määrittelyjä (Style Guide) ja on seuraavan muotoinen:

http://example.org/baseR4/MedicationRequest/$get-prescriptions-metadata

  • example.org = palvelun endpointin (base) juuri, eri ympäristöjen käytettävät juuret ilmoitetaan aina erikseen ja ei julkisteta tässä implementointioppaassa (ks. alla ohjeistus asiakastestiympäristön osalta)
  • baseR4 = FHIR versio joka käytössä, versio osa endpointtia
  • MedicationRequest = resurssityyppi, jota operaatio palauttaa (huom. vastauksessa palautuu myös resurssista viittattuja resursseja mutta pääresurssina on MedicationRequest)
  • $get-prescriptions-metadata = operaation nimi

Resepti-palvelun asiakastesti-ympäristön juuri on vastaava, jota käytetään HL7 V3 MR asiakastesteissä. Tämä juuri sijoitetaan ed. kuvatun esimerkkiosoitteen http://example.org tilalle. Oikeus operaation käyttöön määräytyy asiakastesti-ympäristön HL7 V3 MR määrittelyjen metatietohaku sanoman (RCMR_IN000029FI01) oikeuksien pohjalta. Lisätietoja Kanta liittymismalleista löytyy kanta.fi palvelusta.

FHIR versio

Operaatio ja siinä käytettävät FHIR resurssit noudattavat FHIR R4 (4.0.1) versiota.

Tuettu formaatti

Operaatiossa tuetaan vain JSON formaattia (HTTP header sekä HTTP pyynnön body-osa ja vastauksen body-osa), FHIR standardin tukemia XML- tai RDF-muotojaa ei tueta.

HTTP metodi

Hakuoperaatio välitetään palvelulle HTTP pyyntönä (request) POST-metodilla.