Page Comparison

001. Foutafhandeling moet informatie bevatten die geschikt is voor de volgende doelgroepen:

a. de eindgebruiker die een korte beschrijvend bericht nodig heeft;

b. de applicatie ontwikkelaar die gedetailleerde informatie nodig heeft om de applicatie te kunnen debuggen;

c. de applicatie gebruiker die een foutcode (HTTP-statuscode) nodig heeft voor eventuele foutherstelacties en;

d. de ondersteuning die gedetailleerde informatie en/of trefwoorden nodig heeft uit de berichten of interactie, waarop ondersteuning kan worden gegeven

002. Voeg geen stack-traces toe in meldingen.

003. Gebruik bestaande HTTP-statuscode op een correcte manier:

a. retourneer NIET alleen de HTTP-statuscode 200 (OK), ongeacht of het succesvol dan wel een fout betreft

b. gebruik de range 2xx, wanneer een aanvraag (volledig) verwerkt en geslaagd is.

c. gebruik de range 3xx, wanneer de client aanvullende acties moet ondernemen (omleiding) om een bepaalde aanvraag te voltooien. De vereiste actie kan worden uitgevoerd zonder interactie met de gebruiker, als het tweede verzoek een GET of HEAD is.

d. gebruik de range 4xx, wanneer de aanvraag niet (volledig) slaagt en de client deze aanvraag kan laten slagen door de aanvraag aan de client kant aan te laten passen.

e. gebruik de range 5xx, wanneer de aanvraag niet (volledig) slaagt door een interne foutmelding aan de server kant

004. Bij authenticatie-, autorisatie-, verificatie en omleiding fouten moet de dienstverlener zo min mogelijk informatie weggeven. Het retourneren van te veel informatie kan details over de toegang blootleggen die NIET naar cliënten gecommuniceerd mogen worden.

005.Als de fout niet onder het vorige punt (4) valt, neem zoveel mogelijk context op in de melding en wees beschrijvend.

006. FHIR definieert de OperationOutcome resource die gebruikt wordt om specifieke gedetailleerde  verwerkbare (fout) informatie over te brengen. De OperationOutcome kan worden geretourneerd met elke HTTP 4xx- of 5xx-reactie, maar dit is niet vereist - veel van deze fouten kunnen worden gegenereerd door een generieke server dat ten grondslag ligt aan een FHIR-server. De volgende attributen van OperationOutcome worden hierin gebruikt:

a. issue.severity (verplicht)

b. issue.code (verplicht)

c. issue.details (optioneel in FHIR, maar indien aangegeven in onderstaande tabel verplicht te vullen conform de aangegeven valueset)

d. issue.diagnostics (optioneel in FHIR, optioneel binnen Koppeltaal, waarbij altijd de beveiliging van de FHIR Resource Provider in ogenschouw moet worden genomen).

e. issue.expression (optioneel in FHIR, optioneel binnen Koppeltaal. Bevat FHIRPath elementen gerelateerd aan de issue).