REST-API

Es gelten grundsätzlich die Allgemeinen Hinweise zur REST API aus dem Basismodul.

Abweichend hiervon bzw. ergänzend hierzu gilt:

  • Das Erstellen einer Ressource per HTTP POST (Create-Interaktion) MUSS unterstützt werden.

  • Das Update einer Ressource per HTTP PUT (Update-Interaktion) MUSS unterstützt werden.

  • Das Löschen einer Ressource per HTTP DELETE (Delete-Interaktion, vgl. FHIR RESTful API - Delete) KANN unterstützt werden, ist aber nicht Gegenstand weiterer Ausarbeitung dieses Implementierungsleitfadens. Als Alternative zur Delete-Interaktion kann das Setzen eines entsprechenden Ressourcen-Status (beispielsweise "entered-in-error") dienen.

Transaktionen

FHIR-Transaktionen MÜSSEN unterstützt werden, vgl. FHIR RESTful API - Batch/Transaction. Es MÜSSEN die dort im Bereich "transaction" genannten Punkte unterstüzt werden. Eine reine Batch-Verarbeitung ist nicht ausreichend.

Für jede schreibende Gesamt-Interaktion (Create, Update sowie ggf. Delete), bei der mehr als eine Ressourcen-Instanz erzeugt, geändert oder gelöscht wird, MUSS ein FHIR Transaktions-Bundle, wie in diesem Leitfaden profiliert, verwendet werden.

Wird keine oder nur eine Ressourcen-Instanz modifiziert, kann ebenfalls eine Transaktion verwendet werden. Der Server MUSS auch solche Transaktionen verarbeiten. Die obigen Anforderungen bezüglich der Interaktionen außerhalb von Transaktionen bleiben unbeschadet.

Der Server MUSS als Antwort auf ein FHIR Transaktions-Bundle ein FHIR TransactionResponse-Bundle, wie in diesem Leitfaden profiliert und in der FHIR-Spezifikation beschrieben, senden.

Historie

Die Historisierung/Versionierung von FHIR Ressourcen-Instanzen (vgl. FHIR RESTful API - History) KANN unterstützt werden, ist aber nicht Gegenstand weiterer Ausarbeitung dieses Implementierungsleitfadens.