Välityksen tilan kyselyn vastaus

HTTP vastauksen tiedot palautetaan HTTP header- ja body-osuuksiin jaettuna. Tällä sivulla kuvataan nämä osuudet tarkemmin.

HTTP-vastauksen header

HTTP-vastauksen header-tiedot on kuvattu Kanta-palvelujen yhteisessä FHIR- ja REST-soveltamisoppaassa sivulla Kanta HTTP header-tiedot FHIR-rajapinnassa.

HTTP-vastauksen header-esimerkki

Status code: 200
x-request-id: cfaafd43-9234-4501-8508-8d840fc374a0
expires: 0
cache-control: no-cache, no-store, max-age=0, must-revalidate
x-xss-protection: 0
pragma: no-cache
x-frame-options: DENY
date: Mon, 12 Aug 2024 07:31:10 GMT
vary: Origin, Access-Control-Request-Method, Access-Control-Request-Headers
x-content-type-options: nosniff
strict-transport-security: max-age=31536000 ; includeSubDomains
transfer-encoding: chunked
content-type: application/fhir+json

HTTP-vastauksen body

Onnistuneen hakuoperaation vastauksena palautuu Bundle resurssi-instanssi, joka on tyypiltään searchset. Bundle-resurssin entryn CommunicationRequest-resurssissa palautuvat välityspyynnön tiedot. Jos hakuehdoilla löytyy useampi välityspyyntö, niiden kaikkien tiedot palautuvat omina resursseinaan entry-listassa.

Esimerkki Bundle resurssi-instanssista, jossa palautuu CommunicationRequest-resurssi:

{
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [
        {
            "resource": {
                "resourceType": "CommunicationRequest",
                "id": "eed2a7e8-014a-47ea-ac4d-799f44eee4a7",
                "meta":          {
                    "lastUpdated": "2025-09-16T10:56:45.797+00:00",
                    "profile": ["https://kvp.kanta.fi/fhir/StructureDefinition/valityspyynto"]
                }
                ...
            }
        } 
    ]
}

CommunicationRequest -rakenne, jonka sisältä välityksen tila löytyy, on kuvattu sivulla Välityspyynnön tekeminen. Järjestelmä voi päätellä välityksen tilatiedon CommunicationRequest.status-elementistä.

Hakuoperaatio on onnistunut myös silloin, jos vastauksena ei palaudu välityspyyntöä. Tällöin Kysely- ja välityspalvelu palauttaa HTTP-statuskoodin 200 OK ja Bundle-resurssin, jossa hakutulosten määrä total = 0.

Esimerkki Bundle-resurssista, jossa ei palaudu lainkaan hakutuloksia:

{
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 0
}

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.