Haku
Haun HTTP pyyntö (request)
Haku välitetään palvelulle HTTP POST-pyyntönä (request).
Sote-luovutuslupien viimeisimmät versiot haetaan search-interaktiolla: POST: [base]/Consent/_search
Esim. POST http://example.org/baseR4/Consent/_search
Sote-luovutusluvan kaikki versiot haetaan history-interaktiolla: POST: [base]/Consen/_history
Esim. POST http://example.org/baseR4/Consent/_history
Pyynnön URL:in muoto noudattaa FHIR määrittelyjä (Style Guide). Eri ympäristöjen käytettävät juuret ilmoitetaan erikseen eikä niitä julkisteta tässä implementointioppaassa.
Hakuparametreja ei saa lisätä pyynnön URLiin. Perusteena tälle on, että URLin osana hakuparametrien arvot voivat jäädä esimerkiksi verkkolaitteiden lokitietoihin.
HTTP pyynnön header
Haun HTTP-pyynnön header-osuus noudattaa Kanta-palveluiden yhteisiä Kanta FHIR HTTP header ja Kanta JSON Web Token määrittelyitä ja näissä kuvattuja tietoja ja tietojen pakollisuuksia.
HTTP pyynnön body
Sote-luovutuslupien haussa käytettävät hakuparametrit välitetään HTTP pyynnön body-osuudessa.
Sote-luovutuslupien haussa on käytettävisssä seuraavat hakuparametrit.
FHIR-hakuparametri | Hakuparametrin tyyppi | Pakollisuus | FHIR-resurssi ja elementti |
---|---|---|---|
identifier | token | Vapaaehtoinen 0..1 | Consent.identifier - Sote-luovutusluvan tunniste |
patient:identifier | reference | Pakollinen 1..1 | patient.identifier - Asiakkaan tunniste |
category | token | Vapaaehtoinen 0..1 | Consent.category - Haettavan luvan tyyppi. Jos halutaan rajata haku koskemaan vain toista lupaa (te-so tai so-te), se tehdään tämän parametrin avulla. Mahdolliset arvot 1 (Luovutuslupa te-so) ja 2 (Luovutuslupa so-te). |
Esimerkkejä hakuparametrien käytöstä
Yhteen hakuun voidaan liittää useita kyselyparametreja, alla esimerkkejä hakulauseista.
Potilaan uusimpien sote-luovutuslupien haku potilaan tunnisteen perusteella:
POST [base]/Consent/_search
Content-Type: application/x-www-form-urlencoded
patient:identifier={system|value}
Esim. patient:identifier=urn:oid:1.2.246.21|300111A9001