Asiakirjojen haku henkilötunnuksen perusteella

Sosiaali- ja terveydenhuollon ulkopuolisen toimijan asiointipalvelu voi asiakirjojen hakupyynnön henkilötunnuksen perusteella. 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: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.

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.

Parametri Hakuparametrin tyyppi Pakollisuus Toistuvuus Kuvaus
patient Identifier Pakollinen 1..1 Henkilö jonka asiakirjoja haetaan. Muoto: henkilötunnus OID-muodossa. Pakolliset kentät use, system ja value. Jos haku on virallisella henkilötunnuksella, use arvon tulee olla official ja system urn:oid:1.2.246.21. Väliaikaisen henkilötunnuksen use-kentän arvo pitää olla temp. Vain official ja temp ovat sallittuja use-kentässä. Parametrin säännöt perustuvat KVPPatient-profiilin Patient.identiferin määrittelyihin.
viewCode Coding Pakollinen 1..1 Asiakirjan näkymätunnus. Parametrissa käytettävä Näkymätunnus mukaisia koodistoja ja niiden arvoja.
reasonCode Coding Pakollinen 1..1 Välitysperuste. Parametrissa käytettävä Välitysperuste mukaisia koodistoja ja niiden arvoja.
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.

HTTP-pyynnön body esimerkki

{
"resourceType": "Parameters",
"parameter": [
{
"name": "patient",
"valueIdentifier": {
"use": "official",
"system": "urn:oid:1.2.246.21",
"value": "030559-914N"
}
},
{
"name": "viewCode",
"valueCoding": {
"system": "urn:oid:1.2.246.537.6.12.2002",
"code": "151"
}
},
{
"name": "reasonCode",
"valueCoding": {
"system": "urn:oid:1.2.246.537.6.40192.2012",
"code": "1"
}
},
{
"name": "startDate",
"valueDate": "2025-10-01"
},
{
"name": "endDate",
"valueDate": "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.