Terminslot löschen (Slot Delete)

Inhalt

1. Beschreibung und fachlicher Kontext
2. Request
   • Request Header
   • Request Body
   • Beispiele
3. Response
   • Response Header
   • Response Body
   • Beispiele

Beschreibung und fachlicher Kontext

Beim Löschen eines Terminslots handelt es sich um die FHIR-Standardinteraktion delete.

Diese Interaktion ermöglicht das Löschen eines Terminslots, der dem 116117 Terminservice gemeldet wurde. Nach der Löschung ist der Terminslot nicht mehr für die Buchung durch den 116117 Terminservice verfügbar. Das bedeutet, wenn jemand (bspw. ein TSS-Mitarbeiter oder ein Patient) über den 1116117 Terminservice freie Termine sucht, wird der gelöschte Terminslot nicht mehr angezeigt und kann daher auch nicht gebucht werden.

Ein Terminslots darf nur dann gelöscht werden, wenn der Status des Terminslots NICHT gebucht oder reserviert ist. Andernfalls geben die Systeme des 116117 Terminservices einen Fehler zurück.

Das Löschen eines Terminslots ist zudem versionsabhängig. Das bedeutet, dass das TVS die Version des Terminslots in der Lösch-Anfrage an den 116117 Terminservice übermitteln muss. Stimmt die Version nicht mit der Version überein, die im 116117 Terminservice für diesen Terminslot hinterelegt ist, bekommt der Anfragende einen Fehler zurück.

Request

Das Löschen eines Terminslots erfordert einen DELETE-Request.

Die ID des zu löschenden Terminslots muss in der URL übergeben werden. In der folgenden Tabelle ist für die Terminslot-ID der Platzhalter [id] in der Zeile URL eingetragen. Die Terminslot-ID ist im Feld Slot.id der Slot-Ressource zu finden.

Die aktuelle Version des zu löschenden Terminslots muss als Request Header übergeben werden. In der folgenden Tabelle ist für die Version des Terminslots der Platzhalter [version] in der Zeile Request Header eingetragen. Die Version des Terminslots ist im Feld Slot.meta.versionId der Slot-Ressource zu finden.

Request Header

Folgende Request Header werden von den Systemen des 116117 Terminservices unterstützt und verarbeitet:

Request Body

Ein Request Body ist NICHT erforderlich.

Beispiele

# Lösche den Terminslot mit der ID "1ec4f924-cd75-45eb-97df-8848ff792fd5" und der aktuelle Version "3"
DELETE https://terminsynchronisation.eterminservice.kv-safenet.de/tvs​/terminsynchronisation/api/Slot/1ec4f924-cd75-45eb-97df-8848ff792fd5
If-Match: 3

Response

Für das Löschen eines Terminslots wird im Erfolgsfall der HTTP-Statuscode 204 No Content zurückgegeben. Wurde der Terminslot bereits zu einem früheren Zeitpunkt gelöscht, wird ebenfalls der HTTP-Statuscode 204 No Content zurückgegeben.

Im Fehlerfall wird ein dem Fehler entsprechender HTTP-Statuscode (bspw. 400 Bad Request oder 500 Internal Server Error) sowie ein OperationOutcome im Response Body zurückgegeben. Dieses OperationOutcome enthält Details zum aufgetretenen Fehler.

Response Header

Es werden KEINE Response Header von den Systemen des 116117 Terminservices gesetzt und an den Anfragenden zurückgesendet.

Response Body

Im Erfolgsfall wird KEIN Response Body zurückgegeben.

Im Fehlerfall ist im Response Body ein OperationOutcome enthalten. Details hierzu sind unter Profil: Fehler (OperationOutcome) zu finden.

Beispiele

Alle Beispiele für den Fehlerfall sind hier im vorliegenden Projekt zu finden.

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="cc8e9f90-31ad-4021-9639-e5b940a88a94" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_OperationOutcome_Error|1.0.0" />
    </meta>
    <text>
        <status value="extensions" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <issue>
        <severity value="fatal" />
        <code value="value" />
        <details>
            <coding>
                <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Errors" />
                <code value="TVSTS0000" />
                <display value="Sonstiger Fehler. Unter diagnostics finden Sie n&#228;here Informationen zum Fehler." />
            </coding>
        </details>
        <diagnostics value="Ung&#252;ltiger Input-Parameter" />
    </issue>
</OperationOutcome>

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="81758936-362c-411f-9d95-7fac5b19deb6" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_OperationOutcome_Error|1.0.0" />
    </meta>
    <text>
        <status value="extensions" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <issue>
        <severity value="fatal" />
        <code value="value" />
        <details>
            <coding>
                <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Errors" />
                <code value="TVSTS0018" />
                <display value="Die Dringlichkeit ist ung&#252;ltig." />
            </coding>
        </details>
    </issue>
</OperationOutcome>