Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Aanpassen eis voor volgorde van controles
Expand
titleVersiegeschiedenis

Versie

Datum

Status

Wijzigingen

0.2.0

 

concept

Herschreven op verzoek.

  • Individuele status codes verwijderd. 

  • Meer referenties naar de FHIR API

  • Code ranges toegelicht.

0.1.0

 

concept

Delete response code aangepast

...

Binnen koppeltaal maken we duidelijk onderscheid tussen de type fouten die kunnen voorkomen. In het geval van autorisatie fouten moet de FHIR resource service terughoudend zijn met het geven van informatie. In de meldingen van fouten die zich voordoen na de autorisatie kan de FHIR service uitgebreider zijn in de meldingen. Het is daarom van belang eerst te controleren op autorisatie/authenticatie en daarna de resource te controleren op fouten.

Code ranges

De FHIR api geeft in het response een status code mee. Deze status codes staan niet vast, de FHIR resource service mag tot bepaalde hoogte zelf bepalen welke code in welke situatie van toepassing is. Het is dan ook te adviseren de status code van het antwoord van de FHIR resource service op range niveau te checken, de uitzondering hierop zijn de 401 en 403 status codes. De volgende ranges zijn van toepassing:

...

De tabel hieronder geeft een overzicht van de situaties die zich kunnen voordoen.

Autorisatie

Authenticatie 

HTTP Statuscode

x

x

401 Unauthorized

x

403 Forbidden

Overige fouten en status codes

De tabel hieronder geeft een niet uitputtend overzicht van de status codes (groen) en foutcodes (rood). Sommige rijen hebben meerdere status codes, omdat in dat geval meerdere status codes goed zijn. Deze tabel geeft een informatief overzicht en is niet normatief.

Actie

Beschrijving

Resource state

HTTP Statuscode

GET /Resource

Read all van type <Resource>

Nul of meer resources bestaan

200 OK

GET /Resource/<id>

Read van één resource

Resource bestaat

200 OK

GET /Resource/<id>

Read van één resource

Resource bestaat NIET

404 Not Found

GET /Resource/<id>

Read van één resource

Resource is soft-deleted

410 Gone

POST /Resource

Aanmaken van een resource

Resource is valide

200 OK

201 Created

POST /Resource

Aanmaken van een resource

Resource is NIET valide

422 Unprocessable Entity

PUT /Resource/<id>

Updaten van een resource

Resource is valide, bestaat en If-Match header bevat de laatste versie 

200 OK

PUT /Resource/<id>

Updaten van een resource

Resource is NIET valide 

422 Unprocessable Entity

PUT /Resource/<id>

Updaten van een resource

Resource bestaat NIET 

404 Not Found

PUT /Resource/<id>

Updaten van een resource

Resource is valide, bestaat en If-Match header bevat NIET de laatste versie 

409 Conflict

412 Precondition Failed

DELETE /Resource

Deleten van een resource

Resource bestaat

200 (met OperationOutcome)

204 (zonder OperationOutcome)

DELETE /Resource

Deleten van een resource

Resource bestaat NIET

404 Not Found


De OperationOutcome resource

...

De OperationOutcome resource bevat minimaal de volgende velden, beginnend met minimaal 1 issue en een severity die het type response aangeeft: fatal (fataal), error (fout) , warning (waarschuwing) of information (informatie)



OperationOutcome

{
   "resourceType": "OperationOutcome",
   "issue": [
       {
           "severity": "error",
           "code": "processing",
           "diagnostics": "Invalid request: The FHIR endpoint on this server does not know how to handle GET operation[Patient] with parameters [[wrong_parameter]]",
           "expression": ["Patient.identifier[2].value"]
       }
   ]
}


Links naar gerelateerde onderwerpen

...