Pyynnön HTTP header

Operaation pyynnön HTTP header sisältää HTTP authorization header-osuudessa palvelua käyttävän tahon tunnistautumiseen ja valtuuttamiseen liittyvät tiedot sekä muita yleisiä HTTP header tietoja.

HTTP authorization header-tiedot

Header-osuuden tekninen muoto

Header-osuuden tekninen muoto on seuraava:

  • HTTP authorization header-osuuden sisältö Base64-enkoodataan ennen liittämistä HTTP headeriin
  • Käytettävä merkistö (charset): UTF-8
  • Rivivaihdon erotin (newline separator): LF (Unix)

HTTP authorization header-osuuden tietosisältö

HTTP authorization header-osuudessa välitetään alla olevassa taulukossa kuvatut tiedot.

P=Pakollinen, EP=Ehdollisesti pakollinen, V=Valinnainen

Header-osa Kenttä Pakollisuus Selite
system P Pyynnön tehnyt järjestelmä
id P Pyynnön tehneen tietojärjestelmän tunniste
name P Pyynnön tehneen tietojärjestelmän nimi
user P Pyynnön tehnyt käyttäjä
id P Pyynnön tehneen käyttäjän tunniste
name P Pyynnön tehneen käyttäjän nimi
authenticationMethod P Tunnistautumismenetelmä (KanTa-palvelut - tunnistautumistapa -koodiston mukainen arvo)
serviceSubscriber P Liittyjän organisaation tiedot (palvelunantaja tai yhteisliittymismallin isäntä)
id P Liittyjän tunniste
name P Liittyjän nimi
unitId V vai EP Liittyjän organisaation palveluyksikön tunniste
unitName V vai EP Liittyjän organisaation palveluyksikön nimi
serviceRequester P Pyynnön tehneen organisaation tiedot: palvelunantajan tai yhteisliittymismallin vuokralaisen tiedot
id P Pyynnön tehneen organisaation tunniste
name P Pyynnön tehneen organisaation nimi
unitId V vai EP Pyynnön tehneen palveluyksikön tunniste
unitName V vai EP Pyynnön tehneen palveluyksikön nimi

Authorization header esimerkki (suoraan liittynyt, ei yhteisliittymistä):

{
    "system": {
        "id": "123-XYZ",
        "name": "Burana softa"
    },
    "user": {
        "id": "1.2.246.537.25.000018",
        "name": "Vilhelmiina Adelmiina Heinänenä",
        "authenticationMethod": "1"
   },
    "serviceSubscriber": {
        "id": "1.2.246.10.10694591.10.0",
        "name": "Lääkärikeskus Oy"
    },
    "serviceRequester": {
        "id": "1.2.246.10.10694591.10.0",
        "name": "Lääkärikeskus Oy"
    }
}

Authorization header esimerkki2 (yhteisliittyminen):

{
    "system": {
        "id": "123-XYZ",
        "name": "Burana softa"
    },
    "user": {
        "id": "1.2.246.537.25.000018",
        "name": "Vilhelmiina Adelmiina Heinänenä",
        "authenticationMethod": "1"
   },
    "serviceSubscriber": {
        "id": "1.2.246.10.10694591.10.0",
        "name": "Lääkärikeskus Oy",
        "unitId": "1.2.246.10.10694591.10.1",
        "unitName": "Lääkärikeskus, palveluyksikkö"
    },
    "serviceRequester": {
        "id": "1.2.246.10.10694480.10.0",
        "name": "Vuokralainen",
        "unitId": "1.2.246.10.10694480.10.1",
        "unitName": "Vuokralaisen palveluyksikkö"
    }
}

Esimerkki tietosisällön Base64-enkoodattu muodosta:

ew0KICAgICJzeXN0ZW0iOiB7DQogICAgICAgICJpZCI6ICIxMjMtWFlaIiwNCiAgICAgICAgIm5hbWUiOiAiQnVyYW5hIHNvZnRhIg0KICAgIH0sDQogICAgInVzZXIiOiB7DQogICAgICAgICJpZCI6ICIxLjIuMjQ2LjUzNy4yNS4wMDAwMTgiLA0KICAgICAgICAibmFtZSI6ICJWaWxoZWxtaWluYSBBZGVsbWlpbmEgSGVpbsOkbmVuw6QiLA0KICAgICAgICAiYXV0aGVudGljYXRpb25NZXRob2QiOiAiMSINCiAgIH0sDQogICAgInNlcnZpY2VTdWJzY3JpYmVyIjogew0KICAgICAgICAiaWQiOiAiMS4yLjI0Ni4xMC4xMDY5NDU5MS4xMC4wIiwNCiAgICAgICAgIm5hbWUiOiAiTMOkw6Rrw6RyaWtlc2t1cyBPeSIsDQogICAgICAgICJ1bml0SWQiOiAiMS4yLjI0Ni4xMC4xMDY5NDU5MS4xMC4xIiwNCiAgICAgICAgInVuaXROYW1lIjogIkzDpMOka8OkcmlrZXNrdXMsIHBhbHZlbHV5a3Npa2vDtiINCiAgICB9LA0KICAgICJzZXJ2aWNlUmVxdWVzdGVyIjogew0KICAgICAgICAiaWQiOiAiMS4yLjI0Ni4xMC4xMDY5NDQ4MC4xMC4wIiwNCiAgICAgICAgIm5hbWUiOiAiVnVva3JhbGFpbmVuIiwNCiAgICAgICAgInVuaXRJZCI6ICIxLjIuMjQ2LjEwLjEwNjk0NDgwLjEwLjEiLA0KICAgICAgICAidW5pdE5hbWUiOiAiVnVva3JhbGFpc2VuIHBhbHZlbHV5a3Npa2vDtiINCiAgICB9DQp9

Yleiset HTTP header-tiedot

Pyynnön yleiset HTTP header-tiedot ovat seuraavat

  • Content-Type (pakollinen): pyyntösanoman muoto: application/fhir+json
  • X-Request-Id (pakollinen): pyyntösanoman yksilöivä tunniste. esim.: 2a844596-bee7-4173-b469-cef15b1554c0
  • X-ConsentCode (pakollinen): suostumustyyppi. esim. 1

Lisätiedot X-alkuisista FHIR custom headereista: FHIR custom headers

HTTP header-tietoihin siirretyt HL7 V3 MR parametrit

Seuraavat tiedot on HL7 V3 MR rajapinnassa esitetty kyselyparametreina tai kontrollikehyksessä. Ne ovat siirretty FHIR rajapinnassa HTTP header-tiedoiksi. Näitä tietoja ovat:

  • X-ActiveServiceEventId (ehdollisesti pakollinen): Palvelutapahtuman tunniste, jonka toteuttamiseen reseptikeskuksesta haettavia tietoja käytetään. Vastaa HL7 V3 MR tietoa activeEncompassingEncounterId, ehdollisesti pakollinen samalla ehdolla kun MR rajapinnassa (MR-ehto: Tämä kenttä on pakollinen potilastietojärjestelmän tehdessä hakuja, jos haku tehdään palvelutapahtuman yhteydessä)
  • X-Purpose (pakollinen): Kyselyn syy (1.2.246.537.5.40110.2006 - koodiston koodit). Vastaa HL7 V3 MR kontrollikehys tietoa reasonCode.
  • X-Extent (optionaalinen): Palautettavien tietojen laajuus (1.2.246.537.5.40160.2008 - koodiston koodit. Vastaa HL7 V3 MR kontrollikehys tietoa reasonCode.
  • X-ConsentCode (pakollinen): Suostumustyyppi (1.2.246.537.5.40119.2006 - koodiston koodit). Vastaa HL7 V3 MR kontrollikehys tietoa detectedIssueManagement.

Pyynnön HTTP header esimerkki

POST http://example.org/baseR4/MedicationRequest/$get-prescriptions-metadata HTTP/1.1
Content-Type: application/json+fhir
Authorization: Kanta-Rx ew0KICAgImxpaXR0eWphIjp7DQogICAgICAidHVubmlzdGUiOiIxLjIuMjQ2LjEwLjIy...
X-Request-Id: 2a844596-bee7-4173-b469-cef15b1554c0
X-Purpose: 1
X-ConsentCode: 1