Vastaussanoma virhetilanteessa

FHIR-standardin mukaisesti Kysely- ja välityspalvelu palauttaa kaikkien virheeseen päättyneiden operaatioiden ja pyyntöjen vastaussanomassa HTTP-virhestatuskoodin sekä HTTP-bodyssa OperationOutcome -resurssi-instanssin. Kysely- ja välityspalvelun Käyttämää OperationOutcome -resurssia ei ole profiloitu.

OperationOutcome-resurssi sisältää aina vähintään yhden issue-objektin, jossa on Kanta-palvelut - Prosessivirheet ja huomautukset -virhekoodiston mukainen virhekoodi.

Kysely- ja välityspalvelu voi palauttaa kerralla useampia virheitä. Usean virheilmoituksen palauttaminen tehdään toistamalla OperationOutcomen issue-rakennetta.

Issuelle asetettu severity: "error" kertoo, että kyseessä on virhe.

details-elementin tietotyyppi on CodeableConcept ja se rakentuu Coding-tietotyypistä ja text-elementistä. Text-elementtiä ei käytetä virhevastauksessa. Coding-tietotyypin elementeissä tiedot annetaan seuraavasti:

  • system-elementissä ilmoitetaan virheiden ilmoittamisessa käytettävä koodisto. Arvo on kiinteä (1.2.246.537.5.40112.2006) ja viittaa virhekoodistoon Kanta-palvelut - Prosessivirheet ja huomautukset
  • code-elementissä ilmoitetaan kyseisen koodiston virhekoodi
  • display-elementissä ilmoitetaan virhekoodia vastaava selite

diagnostics-elementillä palautetaan virheen tarkempi kuvaus.

Esimerkki vastaussanomasta virhetilanteessa

{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "exception",
"details": {
"coding": [
{
"system": "urn:oid:1.2.246.537.5.40112.2006",
"code": "5Y00023",
"display": "Pyydettyyn palveluun ei ole oikeuksia."
}
]
},
"diagnostics": "Annettu välitysperuste ei ole sallittu."
}
]
}