Termin buchen

Beschreibung und fachlicher Kontext

Mit dieser Operation kann im Anschluss an eine Terminsuche über den 116117 Terminservice ein freier Terminslot für telemedizinische Leistungen (Videosprechstunden) gebucht werden.

Voraussetzung ist eine gültige ID eines freien Videosprechstunden-Terminslots sowie ein gültiger und ungebuchter Vermittlungscode; d.h., der Vermittlungscode darf nicht abgelaufen sein und muss den Status draft (frei) haben. Die ID eines Terminslots lässt sich über die Terminsuche ermitteln. Sind diese Voraussetzungen nicht erfüllt, gibt die Operation einen Fehler (OperationOutcome) zurück.

War die Terminbuchung erfolgreich, hat der Vermittlungscode den Status active (gebucht). Mit diesem Vermittlungscode darf keine weitere Terminbuchung ausgeführt werden, es sei denn, die vorige Terminbuchung wurde bereits abgesagt (siehe Terminbuchung absagen).

FHIR-Operation

Name	KBV_OD_KV_DIGITAL_TS_DRITTE_Slot_Booking
Type	OperationDefinition
Kind	`operation`
Code	`termin_buchen`
Canonical URL	https://fhir.kbv.de/OperationDefinition/KBV_OD_KV_DIGITAL_TS_DRITTE_Slot_Booking

Invocations

URL: [base]/$termin_buchen

Parameters (In)

Name	Cardinality	Type	Documentation
vermittlungscode	1..1	canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode)	Vermittlungscode des Patienten, für den ein Videosprechstundentermin gebucht werden soll. Der Vermittlungscode ist ohne Bindestriche zu übergeben. Auch für überweisungsfreie Termine ist ein Vermittlungscode notwendig.
slotId	1..1	uuid	Die UUID des (Zeit-) Slots, in dem der gewünschte Termin liegt.
patientendaten	1..1	canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Patient)	Die Daten eines Patienten, für den der Termin gebucht werden soll.

BITTE BEACHTEN: Diese Operation hat keinen Output-Parameter. Somit kommt bei erfolgreicher Terminbuchung eine leere Response zurück (d.h., der Response Body enthält keinerlei Daten). Entscheidend ist daher der HTTP-Status-Code: wenn der Status 201 Created zurückkommt, war die Terminbuchung erfolgreich.

Anmerkungen

Im Fehlerfall wird ein Fehler (OperationOutcome) mit Details zum aufgetretenen Fehler zurückgegeben.

In der folgenden Tabelle finden sich zudem weitere Anmerkungen zu einzelnen Parametern:

Parameter	Art	Anmerkung
`vermittlungscode`	`in`	Der Vermittlungscode ist ohne Bindestriche anzugeben, d.h., er muss aus exakt 12 alphanumerischen Zeichen. Erlaubt sind alle Großbuchstaben (A-Z) und Zahlen (0-9) mit folgenden Ausnahmen: `O 0 I 1 E 3`
`patientendaten`	`in`	Details zu den einzelnen Feldern der Ressource, deren Validierung etc. sind auf der Seite Patient (Patient) unter FHIR-Profil: Anmerkungen zu finden.

Beispiele

Alle Beispiele für den Request Body (Parameter) finden sich hier im vorliegenden Projekt.

Beispiele für eine Patienten-Ressource sind auf der Seite Patient (Patient) zu finden.

Beispiele für den Fehlerfall sind auf der Seite Fehler (OperationOutcome) zu finden.

Request Body

<Parameters xmlns="http://hl7.org/fhir">
    <parameter>
        <name value="vermittlungscode" />
        <valueIdentifier>
            <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_KV_DIGITAL_TS_DRITTE_Vermittlungscode" />
            <value value="XN6XF4UPZ5KP" />
        </valueIdentifier>
    </parameter>
    <parameter>
        <name value="slotId" />
        <valueUuid value="urn:uuid:05f8e6d3-c289-4101-aec1-7d5e6f402bb8" />
    </parameter>
    <parameter>
        <name value="patientendaten" />
        <resource>
            <Patient>
                <id value="02df27c6-acdc-4067-b393-93416a1cc511" />
                <meta>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Patient|1.0.0" />
                </meta>
                <name>
                    <use value="official" />
                    <family value="Mustermensch" />
                    <given value="Maxie" />
                </name>
                <telecom>
                    <system value="phone" />
                    <value value="030123456789" />
                </telecom>
                <telecom>
                    <system value="email" />
                    <value value="m.mustermensch@gmail.com" />
                </telecom>
                <gender value="female" />
                <birthDate value="2023-11-11" />
                <address>
                    <type value="both" />
                    <line value="Musterstr. 1">
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
                            <valueString value="1" />
                        </extension>
                        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
                            <valueString value="Musterstr." />
                        </extension>
                    </line>
                    <city value="Darmstadt" />
                    <postalCode value="64283" />
                </address>
            </Patient>
        </resource>
    </parameter>
</Parameters>