Hakuoperaatioiden HTTP vastaus (response)

Hakuoperaation vastaus koostuu HTTP header-osuudesta ja body-osuudesta. Vastauksessa palautettavat Kanta-lääkityslistan hakujen tiedot ovat HTTP body-osuudessa, samoin mahdolliset virheilmoitukset ovat HTTP body-osuudessa.

Vastauksen HTTP header

HTTP-vastauksen header-osuus noudattaa Kanta-palveluiden yhteisiä Kanta FHIR HTTP header määrittelyitä.

Vastauksen HTTP body

Onnistuneen pyynnön vastaukset

Onnistuneen hakuoperaation vastauksena palautuu Bundle resurssi-instanssi, joka on tyypiltään searchset (type). Bundle resurssin tiedoissa ilmaistaan hakutulosten määrä (total) sekä varsinaiset Kanta-lääkityslista hauissa palautettavat tiedot MedicationRequest, MedicationDispense ja Provenance resurssi-instansseissa.

Hakuoperaatio on onnistunut myös silloin, jos vastauksena ei palaudu yhtään resurssi-instanssia. Tällöin hakutulosten määrä (total) on nolla.

Esimerkki Bundle resurssi-instanssista, jonka hakutulos on nolla (esim. ei ole löytynyt hakuehtoja täyttäviä lääkitystietoja):

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

Esimerkki Perushaun Bundle resurssi-instanssista, jonka sisällä palautuu 5 resurssi-instanssia.

{
    "resourceType": "Bundle",
    "id": "92685db0-1b58-4cea-b1fa-289e8ab58892",
    "type": "searchset",
    "total": 5,
    "entry": [
        {
            "resource": {
                "resourceType": "MedicationRequest",
                ...
            }
        },
        {
            "resource": {
                "resourceType": "Provenance",
                ...
            }
        },
        {
            "resource": {
                "resourceType": "MedicationDispense",
                ...
            }
        },
        {
            "resource": {
                "resourceType": "Provenance",
                ...
            }
        },
        {
            "resource": {
                "resourceType": "List",
                ...
            }
        }
    ]
}