Buchungsinformationen abrufen

Beschreibung und fachlicher Kontext

Mit dieser Operation lassen sich im Anschluss an eine Terminbuchung über den 116117 Terminservice Informationen über die Terminbuchung abrufen, die zu dem angegebenen Vermittlungscode gehört, also mit diesem Vermittlungscode vorgenommen wurde.

Voraussetzung ist ein gültiger Vermittlungscode mit dem Status active (gebucht), d.h., es muss eine nicht abgesagte Buchung zu diesem Vermittlungscode vorliegen. Andernfalls gibt die Operation einen Fehler (OperationOutcome) zurück.

Durch das Abrufen der Terminbuchungsinformationen ändert sich der Status des Vermittlungscodes nicht.

FHIR-Operation

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

Invocations

URL: [base]/$buchungsinformationen_abrufen

Parameters (In)

Name	Cardinality	Type	Documentation
vermittlungscode	1..1	canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode)	Der Vermittlungscode des Patienten, für den die Buchungsinformationen abgerufen werden sollen, ist eine 12-stellige alphanumerische Folge (ohne Bindestriche).

Return Values (Out)

Name	Cardinality	Type	Documentation
suchergebnis	0..1	canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Bundle_Operation_Result)	Bundle mit den Details zum Termin, dem zugehörigen Terminprofil und der Praxis (inkl. Geokoordinaten derer)

Anmerkungen

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

Allgemeine Anmerkungen zu dem zurückgegebenen Bundle (die für alle Operationen gelten, die dieses Bundle zurückgeben) sind auf der Seite Result Bundle (Bundle) unter dem Punkt FHIR-Profil: Anmerkungen zu finden.

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

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`
`Bundle.entry.resource`	`out`	Hierbei handelt es sich um folgende Ressourcen, die jeweils genau 1x im Bundle enthalten sind: Terminbuchung (Appointment) Terminprofil (Schedule), auf dem der Termin basiert Praxis / medizinische Einrichtung (Organization), die den Termin anbietet Standort (Location), an dem sich die Praxis / medizinische Einrichtung befindet Wenn geprüft werden soll, ob das richtige Terminprofil, die richtige Praxis / medizinische Einrichtung sowie der korrekte Standort zurückgegeben wurde, kann dies anhand der Referenzen der Profile untereinander validiert werden (siehe: Profile unter dem Punkt Referenzierung zwischen Profilen).

Bundle.entry.resource

out

Hierbei handelt es sich um folgende Ressourcen, die jeweils genau 1x im Bundle enthalten sind:

Terminbuchung (Appointment)
Terminprofil (Schedule), auf dem der Termin basiert
Praxis / medizinische Einrichtung (Organization), die den Termin anbietet
Standort (Location), an dem sich die Praxis / medizinische Einrichtung befindet

Wenn geprüft werden soll, ob das richtige Terminprofil, die richtige Praxis / medizinische Einrichtung sowie der korrekte Standort zurückgegeben wurde, kann dies anhand der Referenzen der Profile untereinander validiert werden (siehe: Profile unter dem Punkt Referenzierung zwischen Profilen).

Beispiele

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

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

Request Body
Response 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>
</Parameters>

<Bundle xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Bundle_Operation_Result|1.0.0" />
    </meta>
    <type value="searchset" />
    <timestamp value="2023-11-09T12:34:56Z" />
    <entry>
        <fullUrl value="urn:uuid:7c11ddd5-0ac4-4d9a-b5bd-2a90e1487934" />
        <resource>
            <Appointment>
                <id value="7c11ddd5-0ac4-4d9a-b5bd-2a90e1498621" />
                <meta>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment|1.0.0" />
                </meta>
                <status value="booked" />
                <specialty>
                    <coding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BPL_ARZTGRUPPE" />
                        <code value="09" />
                        <display value="Kinder- und Jugend&#228;rzte" />
                    </coding>
                </specialty>
                <appointmentType>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
                        <code value="VR" />
                        <display value="virtual" />
                    </coding>
                </appointmentType>
                <start value="2024-01-27T10:15:00Z" />
                <end value="2024-01-27T10:30:00Z" />
                <created value="2024-01-05T11:34:15Z" />
                <participant>
                    <actor>
                        <reference value="urn:uuid:aae373f1-5bfb-4fb4-92ce-8e5322f4d429" />
                    </actor>
                    <status value="accepted" />
                </participant>
            </Appointment>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:3b6b4224-8ba0-4e8a-8dae-6f0a772d5cb4" />
        <resource>
            <Schedule>
                <id value="3b6b4224-8ba0-4e8a-8dae-6f0a772d5cb4" />
                <meta>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile|1.0.0" />
                </meta>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Foreign_Languages_For_Diagnostic_Outcome">
                    <valueCoding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" />
                        <code value="83" />
                        <display value="Thai (Thailand)" />
                    </valueCoding>
                </extension>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Foreign_Languages_For_Diagnostic_Outcome">
                    <valueCoding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" />
                        <code value="107" />
                        <display value="Schottisch-G&#228;lisch" />
                    </valueCoding>
                </extension>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Slot_Profile_Name">
                    <valueString value="Videosprechstunde auf Thai oder Schottisch-G&#228;lisch" />
                </extension>
                <identifier>
                    <system value="urn:ietf:rfc:4122" />
                    <value value="4ea7f4eb-401c-48d4-bfcf-f43c0505d835" />
                </identifier>
                <actor>
                    <reference value="urn:uuid:aae373f1-5bfb-4fb4-92ce-8e5322f4d429" />
                </actor>
                <comment value="Bitte n&#252;chtern kommen." />
            </Schedule>
        </resource>
        <search>
            <mode value="include" />
        </search>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:02df27c6-acdc-4067-b393-93416a1cc502" />
        <resource>
            <Organization>
                <id value="02df27c6-acdc-4067-b393-93416a1cc502" />
                <meta>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Organization|1.0.0" />
                </meta>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_Base_Additional_Comment">
                    <valueString value="Nur Diabetes-Behandlung!" />
                </extension>
                <name value="Praxis Dr. med. Hans Topp-Gl&#252;cklich 20" />
                <telecom>
                    <system value="phone" />
                    <value value="030123456789" />
                </telecom>
                <telecom>
                    <system value="url" />
                    <value value="https://www.praxis-topp-gluecklich.de" />
                </telecom>
                <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>
            </Organization>
        </resource>
        <search>
            <mode value="include" />
        </search>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:aae373f1-5bfb-4fb4-92ce-8e5322f4d429" />
        <resource>
            <Location>
                <id value="aae373f1-5bfb-4fb4-92ce-8e5322f4d429" />
                <meta>
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Location|1.0.0" />
                </meta>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Location_Characteristic">
                    <valueCodeableConcept>
                        <coding>
                            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_BARRIEREFREIHEIT" />
                            <code value="02" />
                            <display value="Stufenloser Eingang/Zugang" />
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Location_Characteristic">
                    <valueCodeableConcept>
                        <coding>
                            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_BARRIEREFREIHEIT" />
                            <code value="08" />
                            <display value="Orientierungshilfen f&#252;r Sehbehinderte" />
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <position>
                    <longitude value="8.651177" />
                    <latitude value="49.872775" />
                </position>
                <managingOrganization>
                    <reference value="urn:uuid:02df27c6-acdc-4067-b393-93416a1cc502" />
                </managingOrganization>
            </Location>
        </resource>
        <search>
            <mode value="include" />
        </search>
    </entry>
</Bundle>