Välityksen tilan kyselyn vastaus

Välityksen tilan kyselyn HTTP vastaus (response)

HTTP vastauksen tiedot palautetaan HTTP header- ja body-osuuksiin jaettuna.

Vastauksen HTTP header

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

Vastauksen HTTP 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/json

Vastauksen HTTP body

Onnistuneen hakuoperaation vastauksena palautuu Bundle resurssi-instanssi, joka on tyypiltään searchset (type). Bundle-resurssin entryn CommunicationRequest-resurssissa palautuvat välityspyynnön tiedot.

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

{
    "resourceType": "Bundle",
    "id": "073ce2b1-4c39-4cae-a479-ca59c8f74fef",
    "meta": {"lastUpdated": "2024-04-11T15:07:09"},
    "type": "searchset",
    "entry": [
        {
            "resource": {
                "resourceType": "CommunicationRequest",
                ...
            }
        } 
    ]
}

CommunicationRequest -rakenne, jonka sisällä välityksen tila löytyy, on kuvattu sivulla Kirjaa välityspyyntö. Hakuoperaatio on onnistunut myös silloin, jos vastauksena ei palaudu yhtään välityspyyntöä. Tällöin hakutulosten määrä (total) on nolla.

Esimerkki bundle-resurssista, jonka hakutulos on nolla.

{
    "resourceType": "Bundle",
    "id": "073ce2b1-4c39-4cae-a479-ca59c8f74fef",
    "type": "searchset",
    "total": 0,
}