Organisaatiolle osoitettujen asiakirjojen haku

Sosiaali- ja terveydenhuollon ulkopuolinen organisaatio voi hakea sille osoitettuja asiakirjoja. Voit lukea tästä lisää käyttötapauksesta: Hae organisaatiolle osoitetut asiakirjat.

Asiakirjahaun HTTP-pyyntö

Asiakirjahaku lähetetään Kysely- ja välityspalvelulle HTTP POST-pyyntönä operaatiolla $get-all-documents FHIR-palvelun endpointin juureen:

POST [base]/Communication/$get-all-documents

Esimerkki

POST https://example.org/baseR4/Communication/$get-all-documents

Mikäli välitettäviä asiakirjoja on paljon (yli sata), eivät kaikki välitettävät asiakirjat välttämättä mahdu yhteen vastaukseen. Tällöin vastauksessa ilmoitetaan jatkohaun endpoint. Vastauksen rakenteesta ja haun jatkamisesta on kerrottu tarkemmin Asiakirjahakujen vastaus- sivulla.

Esimerkki

POST https://example.org/baseR4/Communication/$get-all-documents&result_set_key=f352577a-b4e8-4b8b-99dd-90f7fb018555

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.

Asiakirjahaun parametrit

Parametri	Hakuparametrin tyyppi	Pakollisuus	Toistuvuus	Kuvaus
organization	Token	Pakollinen	1..1	Organisaatio, jolle osoitettuja asiakirjoja haetaan. Muoto: y-tunnus OID-muodossa.
viewCode	Token	Pakollinen	1..1	Asiakirjan tyyppi.
startDate	date	Ei pakollinen	0..1	Asiakirjan välityspyynnön luontiajan alkupäivä. Päivämäärä sisältyy aikaväliin.
endDate	date	Ei pakollinen	0..1	Asiakirjan välityspyynnön luontiajan loppupäivä. Päivämäärä sisältyy aikaväliin.
reload	Token	Ei pakollinen	0..1	Palauta uudelleen jo haetut mutta kuittaamattomat asiakirjat.

Asiakirjan välityspyynnön luontiajalla tarkoitetaan päivämäärää, jona Kysely- ja välityspalvelu on vastaanottanut potilastietojärjestelmältä pyynnön asiakirjan välittämisestä. Käyttämällä parametreja startDate ja endDate voidaan tulosjoukkoa tarvittaessa rajata.

FHIR-standardin hakua ohjaavia parametreja _count ja _offset ei tueta, eikä niiden käytöllä ole vaikutusta vastaukseen.

HTTP-pyynnön header

HTTP-pyynnön header-tiedot on kuvattu Kanta-palvelujen yhteisessä FHIR- ja REST-soveltamisoppaassa. Voit lukea lisää oppaan sivulla Kanta HTTP header-tiedot FHIR-rajapinnassa

Kannattaa kuitenkin huomioida erityisesti headerin kenttä X-Request-Id, jonka arvo on oltava yksilöllinen jokaiselle http-pyynnölle. Tehtäessä kutsua palveluväylän kautta myös X-Road-Client kenttä on pakollinen.

HTTP-pyynnön header esimerkki

POST [base][api] HTTP/1.1 
Accept: application/fhir+json
X-Road-Client: FI-TEST/GOV/0246246-0/AsiakirjojenHakuTestClient
X-Request-Id: 1.2.246.10.1.20241208102307.93.2023.11023072024880604629
Content-Type: application/fhir+json

HTTP-pyynnön body

Operaation parametrit välitetään HTTP pyynnön body-osuudessa Parameters-resurssin avulla. Voit lukea lisää Parameters-resurssista FHIR-standardista.

HTTP-pyynnön body esimerkki

Sekvenssikaavio

Vastaussanoma virhetilanteessa

Virhetilanteissa vastauksena palautuu HTTP-virhestatuskoodi sekä HTTP-bodyssa OperationOutcome resurssi-instanssi, jolla ilmaistaan tarkempi virhe.

Vastaussanoma virhetilanteessa-sivulla on kuvattu tarkemmin, miten Kysely- ja välityspalvelu palauttaa virheilmoitukset OperationOutcome-resurssilla.