Virhetilanteeseen päätyneen pyynnön vastaus

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

OperationOutcome resurssista puuttuu vielä profiili. Seuraavaa kuvausta lukiessa kannattaa avata OperationOutcome-resurssi FHIR määrittelystä.

Yksittäinen virhe ilmoitetaan issue-elementissä. Severity-elementin arvo on virheissä ”error”, Code-elementtiin annetaan sopiva arvo FHIR koodistosta Issue Type ja varsinainen virhe ilmoitetaan Details-elementissä koodattuna. Details-elementin tietotyyppi on CodeableConcept, kyseinen tietotyyppi rakentuu Coding-tietotyypistä ja text-elementistä. Coding-tietotyypin elementeissä tiedot annetaan seuraavasti:

  • system elementissä ilmoitetaan käytettävä koodisto
  • code elementissä varsinainen virhekoodi
  • display elementissä virhekoodia vastaava selite.

CodeableConcept tietotyypin text elementissä annetaan virheen tarkempi selite.

Esimerkki virheilmoituksesta, joka palautuu OperationOutcome resurssi-instanssissa (huom. alla olevaa virheiden koodistoa ei ole vielä lopullisesti sovittu eikä profiloitu OperationOutcome resurssiin):

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "processing",
            "details": {
                "coding": [
                    {
                        "system": "http://resepti.kanta.fi/fhir/prescription-errorcodes",
                        "code": "101015",
                        "display": "Virheellinen pakollinen tieto"
                    }
                ],
                "text": "clinicalDocument.code puuttuu"
            }
        }
    ]
}