Virhekoodit

Virhetilanteissa vastauksena palautuu HTTP virhestatuskoodi sekä HTTP bodyssa OperationOutcome resurssi-instanssi, jolla ilmaistaan tarkempi virhe. HRP-palvelussa käytettävää OperationOutcome-resurssia ei ole profiloitu. HTTP bodya ja OperationOutcome resurssi-instanssia ei kuitenkaan palauteta, mikäli hakusanoma on muodollisesti epävalidi tai auktorisointi on epäonnistunut esimerkiksi virheellisen tokenin takia. Näissä tapauksissa palautetaan pelkkä HTTP virhestatuskoodi.

HTTP virhestatuskoodit ovat standardin mukaisia REST-rajapinnan virhekoodeja (ks. tarkemmin FHIR RESTful API). Tämän rajapinnan palauttamat virhekoodit on kuvattu seuraavassa taulukossa:

HTTP virhestatuskoodi Kuvaus Tilanne ja tarvittavat toimenpiteet
400 Bad Request Palvelua kutsuvan järjestelmän hakusanoma on virheellinen. Vaatii palvelua kutsuvan järjestelmän toimenpiteitä.
401 Unauthorized Käyttöoikeusvirhe. Ongelma mahdollisesti kutsuvan järjestelmän välittämässä tokenissa.
500 Internal Server Error Palvelun sisäinen tekninen virhe. Ei aiheuta toimenpiteitä palvelua kutsuvan järjestelmän päässä.

OperationOutcome-resurssissa palautuvat virhekoodit ovat kansallisen koodiston KanTa-palvelut - Prosessivirheet ja huomautukset (1.2.246.537.5.40112.2006) mukaisia. Tämän rajapinnan palauttamat virhekoodit on kuvattu seuraavassa taulukossa:

Virhekoodi Kuvaus Tilanne ja tarvittavat toimenpiteet
5Y00009 Käyttöoikeusvirhe. Palvelua kutsuvan järjestelmän välittämä access token ei ole validi. Vaatii palvelua kutsuvan järjestelmän toimenpiteitä.
4Y00007 Virhe sanoman eheydessä. Palvelua kutsuvan järjestelmän hakusanoma on virheellinen. Esim. jokin hakuparametri virheellinen. Virhekuvauksen lisäksi palautetaan myös tarkempi virheen syy.

Vaatii palvelua kutsuvan järjestelmän toimenpiteitä.

Tarkasta hakusanoman oikeellisuus, erityisesti virhekuvauksessa mainittu parametri.
2T02001 Sisäinen tekninen virhe. Palvelun sisäinen tekninen virhe. Ei aiheuta toimenpiteitä palvelua kutsuvan järjestelmän päässä.

Kanta-palvelujen yhteisessä FHIR- ja REST-soveltamisoppaassa sivulla Kanta rajapinnan virhevastaus on kuvattu tarkemmin, miten Kanta-palvelut palauttaa virheilmoitukset OperationOutcome-resussilla.