Välityksen tilan kysely
Välityksen tilan kyselyssä 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älityksen tilan kyselyn HTTP-pyyntö
Välityksen tilan kysely lähetetään Kysely- ja välityspalvelulle HTTP POST-pyyntönä:
POST [base]/CommunicationRequest/_search
Content-Type: application/x-www-form-urlencoded
Esimerkki
POST https://example.org/baseR4/CommunicationRequest/_search
Content-Type: application/x-www-form-urlencoded
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ää Kanta 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ö tehdään FHIR POST Searchin mukaisesti, joten seuraava header tulee olla pyynnössä mukana:
Content-Type: application/x-www-form-urlencoded. - Vastaussanoma on FHIR OperationOutcome-resurssi, mistä syystä
Accept: application/fhir+json.
HTTP-pyynnön header-esimerkki
POST [base]/CommunicationRequest/_search HTTP/1.1
Accept: application/fhir+json
Authorization: Bearer eyJraWQiOiJyc2ExIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhMTcxYjFmNC04ZDkwLT...
X-Request-Id: 9a2f1c4e-7d3b-4f6e-8b2a-1c9d5f3e2a7b
Content-Type: application/x-www-form-urlencoded
HTTP-pyynnön body
Välityksen tilan kyselyssä käytettävät hakuparametrit välitetään HTTP pyynnön body-osuudessa.
Haussa käytetyt hakuparametrit
| FHIR-hakuparametri | Hakuparametrin tyyppi | Pakollisuus | Toistuvuus | Kuvaus |
|---|---|---|---|---|
| patient:identifier | reference | Pakollinen | 1..1 | Potilaan henkilötunnus - hakuparametrin modifier :identifier on pakollinen. Parametrin system- ja code-osat ovat molemmat pakollisia. |
| recipient:identifier | reference | Optionaalinen | 0..1 | Asiakirjan vastaanottava organisaatio - hakuparametrin modifier :identifier on pakollinen. Parametrissa käytettävä Sanoman vastaanottaja annettuja arvoja. |
| payload:identifier | reference | Pakollinen | 1..1 | Välitettävän asiakirjan tunniste - hakuparametrin modifier :identifier on pakollinen. |
Voit lukea lisää hakuparametrien käytöstä FHIR-standardista.
Esimerkki hakusanoman HTTP-bodysta
patient%3Aidentifier=urn:oid:1.2.246.21|030559-914N&recipient%3Aidentifier=urn:oid:1.2.246.10.10317159&payload%3Aidentifier=urn:oid:1.2.246.10.1.20241104154710.93.2009.1154133728045186
Vastaussanoma
Välityksen tilan onnistuneen kyselyn vastaussanoma on kuvattu sivulla Välityksen tilan kyselyn vastaus.
Virhetilanteissa vastauksena palautuu kuvauksen Vastaussanoma virhetilanteessa mukainen virhesanoma.