Välityspyynnön tekeminen
Välityspyynnön tekemiseen käytettävän HTTP-pyynnön tiedot välittyvät HTTP header- ja body-osuuksiin jaettuna. Tällä sivulla kuvataan nämä osuudet tarkemmin.
Välityspyynnön HTTP-pyyntö
Välityspyyntö lähetetään Kysely- ja välityspalvelulle HTTP POST-pyyntönä operaatiolla
$relay-request
FHIR-palvelun endpointin juureen:
POST [base]/baseR4/CommunicationRequest/$relay-request
Esimerkki
POST http://example.org/baseR4/CommunicationRequest/$relay-request
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.
Välityspyynnön parametrit
Parametri | Hakuparametrin tyyppi | Pakollisuus | Toistuvuus | Kuvaus |
---|---|---|---|---|
requestCommunication | CommunicationRequest | Pakollinen | 1..1 | Välityspyyntö |
HTTP-pyynnön header
HTTP-pyyntöjen header-osuudet noudattavat Kanta-palveluiden yhteisiä Kanta FHIR HTTP header ja Kanta JSON Web Token määrittelyjä ja näissä kuvattuja tietoja ja tietojen pakollisuuksia. Pakollisuudet KVP:n tapauksessa käyvät ilmi kummankin dokumentin taulukoissa KVP:n omasta sarakkeesta.
Huomioi headereissa erityisesti seuraavat:
Authorization
-header sisältää JWT:n ja on määritelty yllä mainituissa dokumenteissa.X-Request-Id
-header yksilöi pyyntösanoman ja sen arvon on oltava yksilöllinen jokaiselle http-pyynnölle.- Pyyntösanoma on FHIR CommunicationRequest-resurssi, joten
Content-Type: application/fhir+json
. - Vastaussanoma on FHIR OperationOutcome-resurssi, mistä syystä
Accept: application/fhir+json
.
HTTP-pyynnön header-esimerkki
POST [base][api] HTTP/1.1
Accept: application/fhir+json
Authorization: Bearer eyJraWQiOiJyc2ExIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhMTcxYjFmNC04ZDkwLT...
X-Request-Id: e3f7c2a1-9b4d-4c8f-9f1e-2a6d9e3c4b7f
Content-Type: application/fhir+json
HTTP-pyynnön body
Välityspyynnön tiedot välitetään HTTP-pyynnön body-osuudessa Parameters-resurssin avulla. Parameters-resurssin parameter
-listaan sijoitetaan parametrina käytettävät resurssit. Tässä tapauksessa parametreja on yksi, requestCommunication
, johon asetetaan välityspyynnön tiedot sisältävä CommunicationRequest -resurssi. Parameters -resurssista ei hyödynnetä muita tietoja.
Voit lukea lisää Parameters-resurssista FHIR-standardista.
Välityspyyntö kuvataan FHIR standardin mukaisena profiloituna CommunicationRequest-resurssina. Voit lukea CommunicationRequest-resurssista lisää FHIR-standardista.
Esimerkki HTTP-pyynnön bodysta löytyy sivulta Tee välityspyyntö -sanoman body.
Sekvenssikaavio
Vastaussanoma
Operaation vastauksena palautuu vastaussanoman bodyssa OperationOutcome -resurssi-instanssi. Onnistuneen operaation vastaussanoma on kuvauksen Välityspyynnön vastaus mukainen. Virhetilanteissa vastauksena palautuu kuvauksen Vastaussanoma virhetilanteessa mukainen virhesanoma.