Versions Compared

Old Version 13

changes.mady.by.user Roland Groen

Saved on

compared with

New Version Current

changes.mady.by.user Peter Mulder

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#

Eis

FHIR Resource service

Bron-applicatie

Domein

001De FHIR resource service implementeert de FHIR API en volgt zoveel mogelijk de HTTP status codes zoals in deze API worden vastgelegd.x

002Foutcodes moeten uitgebreid en goed beschrijvend zijn, met uitzondering van fouten bij de foutstatus 401 Unauthorized  en 403 Forbidden.x

003

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. Wel moet de FHIR resource service rekening houden met de ranges: 

  • 2xx: De 200 range kan worden beschouwd als een succesvolle status code
  • 3xx: De 300 range zal niet direct van de FHIR resource service verwacht worden.
  • 4xx: deze range komen fouten voor waarvan de oorzaak bij de aanvrager ligt.
  • 5xx: deze range zou bij normaal gebruik en een stabiele FHIR resource service niet mogen voorkomen.
x

004

Uitzondering op de vorig regel zijn autorisatiefouten: hiervoor geldt:

  • Als de aanvrager niet geauthenticeerd kan worden geeft de dienst 401 Unauthorized  terug.
  • Als de aanvrager wel geauthenticeerd maar niet geautoriseerd geeft de dienst 403 Forbidden terug
x

005De FHIR OperationOutcome FHIR resource kan geretourneerd worden bij 4xx- en/of 5xx-reactie, maar dit is niet vereist.x

006Een client applicatie die FHIR resources van de FHIR resource service ophaalt (zelfstandig of na een update vanuit een abonnement) en deze niet goed kan verwerken in de eigen systemen ZOU hiervoor een AuditEvent voor moeten aanmaken. DIt AuditEvent informeert de andere applicaties in de infrastructuur dat de applicatie de gegevens niet goed heeft verwerkt.
x
007Het AuditEvent dat door de client applicatie wordt aangemaakt dient als waarde voor X-Correlation-Id (extension.correlation-id) de originele X-Request-Id in te voeren, indien aanwezig. De waarde voor de X-Trace-Id (extension.trace-id) dient overgenomen te worden van de originele X-Trace-Id.
x
008In het AuditEvent wordt onderscheid gemaakt tussen verschillende type fouten, zie onderdeel 'Het fouttype' ter referentie.
x
009Er vind eerst controle plaats op Authenticatie, daarna mag de Resource gecontroleerd worden op foutenx