Välityksen kuittaus

Välityksen kuittauksen HTTP-pyyntö

Välityksen kuittaus lähetetään Kysely- ja välityspalvelulle HTTP POST-pyyntönä operaatiolla $complete-communication FHIR-palvelun endpointin juureen:

POST [base]/baseR4/Communication/$complete-communication

Esimerkki

POST http://example.org//baseR4/Communication/$complete-communication

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älityksen kuittauksen parametrit

Parametri Hakuparametrin tyyppi Pakollisuus Toistuvuus Kuvaus
communication Communication Pakollinen 1..1 Kuitattavan välityksen tiedot.

HTTP-pyynnön header

HTTP-pyyntöjen header-osuudet noudattavat Kanta-palveluiden yhteisiä Kanta FHIR HTTP header määrittelyjä ja niissä kuvattuja tietoja ja tietojen pakollisuuksia.

Kannattaa kuitenkin huomioida erityisesti headerin kenttä X-Request-Id, jonka arvo on oltava yksilöllinen jokaiselle http-pyynnölle. Tehtäessä kutsua palveluväylän kautta myös X-Road-Client kenttä on pakollinen.

HTTP-pyynnön header esimerkki

POST [base][api] HTTP/1.1 
Accept: application/fhir+json
X-Road-Client: FI-TEST/GOV/0246246-0/AsiakirjojenHakuTestClient
X-Request-Id: 1.2.246.10.1.20241208102307.93.2023.11023072024880604629
Content-Type: application/fhir+json

HTTP-pyynnön body

Välityksen tiedot välitetään HTTP pyynnön body-osuudessa Parameters-resurssin avulla. Voit lukea lisää Parameters-resurssista FHIR-standardista.

Välityksen tiedot vastaavat asiakrjan haussa saatua välitysresurssia. Seuraavat kentät saavat uudet arvot:

  • Kenttä status saa arvon completed, jos haku kuitataan käsitellyksi tai arvon stopped, jos asiakirjan käsittely on epäonnistunut
  • Jos status on stopped, voi kenttään statusReason.text antaa vapaamuotoisen kuvauksen, miksi käsittely on epäonnistunut.
  • Kenttä recipient saa lopullisen vastaanottajan tiedon
  • payload jää tyhjäksi

Sekvenssikaavio

Vastaussanoma virhetilanteessa

Virhetilanteissa vastauksena palautuu HTTP-virhestatuskoodi sekä HTTP-bodyssa OperationOutcome resurssi-instanssi, jolla ilmaistaan tarkempi virhe.

Vastaussanoma virhetilanteessa-sivulla on kuvattu tarkemmin, miten Kysely- ja välityspalvelu palauttaa virheilmoitukset OperationOutcome-resurssilla.