Vermittlungscodestatus abrufen


Beschreibung und fachlicher Kontext

Mit dieser Operation lässt sich im 116117 Terminservice der Status eines Vermittlungscodes abrufen. Der als Eingabeparameter übergebene Vermittlungscode muss existieren, darf aber auch abgelaufen sein.

Es werden folgende Informationen über den Vermittlungscode zurückgegeben:

  • Dringlichkeit
  • Status (bspw. ungebucht oder abgelaufen)
  • Zeitpunkt der letzten Statusänderung
  • Leistungsmerkmalszuweisung

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


FHIR-Operation

Name KBV_OD_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Status_Request
Type OperationDefinition
Kind operation
Code vermittlungscodestatus_abrufen
Canonical URL https://fhir.kbv.de/OperationDefinition/KBV_OD_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Status_Request

Invocations

URL: [base]/$vermittlungscodestatus_abrufen

Parameters (In)

NameCardinalityTypeDocumentation
vermittlungscode1..1canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Identifier_Vermittlungscode)

Der Vermittlungscode, dessen Status abgefragt werden soll, ohne Bindestriche

Return Values (Out)

NameCardinalityTypeDocumentation
suchergebnis1..1canonical(KBV_PR_KV_DIGITAL_TS_DRITTE_Bundle_Operation_Result)

Das Suchergebnis enthält Informationen zum Status des Vermittlungscodes: den Status (bspw. frei, gebucht, abgelaufen), den Zeitpunkt der letzten Statusänderung und ob Leistungsmerkmale mit diesem Vermittlungscode verknüpft sind


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
Bundle.entry.resource out Hier ist genau eine Ressource enthalten: Vermittlungscode (ServiceRequest).

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.


<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-12-20T14:44:31Z" />
    <entry>
        <fullUrl value="urn:uuid:92e1a061-4dea-4064-9504-04680968e4b8" />
        <resource>
            <ServiceRequest>
                <id value="42814323-80ae-40e8-9eee-a0bc4257a039" />
                <meta>
                    <lastUpdated value="2024-02-02T08:17:48Z" />
                    <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_ServiceRequest_Vermittlungscode|1.0.0" />
                </meta>
                <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Specialty_Assignment">
                    <valueCoding>
                        <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_KV_DIGITAL_TS_DRITTE_Vermittlungscode_Specialty_Assignment" />
                        <code value="​gebunden" />
                        <display value="Es sind Leistungsmerkmale mit dem Vermittlungscode assoziiert." />
                    </valueCoding>
                </extension>
                <identifier>
                    <system value="https://fhir.kbv.de/NamingSystem/KBV_NS_KV_DIGITAL_TS_DRITTE_Vermittlungscode" />
                    <value value="XN6XF4UPZ5KP" />
                </identifier>
                <status value="active" />
                <intent value="order" />
                <priority value="urgent" />
                <subject>
                    <reference>
                        <extension url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
                            <valueCode value="masked" />
                        </extension>
                    </reference>
                </subject>
            </ServiceRequest>
        </resource>
        <search>
            <mode value="match" />
        </search>
    </entry>
</Bundle>