Asiakirjojen haku henkilötunnuksen perusteella

Sosiaali- ja terveydenhuollon ulkopuolisen toimijan asiointipalvelu voi tehdä yhdistetyn haku- ja välityspyynnön. Voit lukea tästä lisää käyttötapauksesta: Hae asiakirjoja henkilötunnuksen perusteella.

Asiakirjahaun HTTP-pyyntö

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

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

Esimerkki

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

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
patient Token Pakollinen 1..1 Henkilö jonka asiakirjoja haetaan. Muoto: henkilötunnus OID-muodossa.
viewCode Token Pakollinen 1..1 Asiakirjan tyyppi.
reasonCode Token Pakollinen 1..1 Välitysperuste.
startDate date Ei pakollinen 0..1 Asiakirjan luontiajan alkupäivä. Päivämäärä sisältyy aikaväliin.
endDate date Ei pakollinen 0..1 Asiakirjan luontiajan loppupäivä. Päivämäärä sisältyy aikaväliin.

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

{
"resourceType": "Parameters",
"parameter": [
{
"name": "patient",
"valueString": "urn:oid:1.2.246.21|030559-914N"
},
{
"name": "viewCode",
"valueString": "urn:oid:1.2.246.537.6.12.2002|151"
},
{
"name": "reasonCode",
"valueString": "urn:oid:1.2.246.537.6.40192.2012|1"
},
{
"name": "startDate",
"valueString": "2025-10-01"
},
{
"name": "endDate",
"valueString": "2025-10-15"
}
]
}

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.