Vermittlungscodestatus abrufen
Inhalt
Beschreibung und fachlicher Kontext
Beim Abrufen des Vermittlungscodestatus' handelt es sich um eine custom operation in FHIR.
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)
- ggf. wer die Terminbuchung abgesagt hat, wenn ein mit diesem Vermittlungscode gebuchter Termin wieder abgesagt wurde
- Zeitpunkt der letzten Statusänderung
- Leistungsmerkmalszuweisung
Durch das Abrufen des Vermittlungscodestatus' ändert sich der Status des Vermittlungscodes nicht.
FHIR-Operation
| Name | KBV_OD_KV_DIGITAL_TS_KVEN_Vermittlungscode_Status_Request |
|---|---|
| Type | OperationDefinition |
| Kind | operation |
| Code | vermittlungscodestatus_abrufen |
| Canonical URL | https://fhir.kbv.de/OperationDefinition/KBV_OD_KV_DIGITAL_TS_KVEN_Vermittlungscode_Status_Request |
Invocations
URL: [base]/$vermittlungscodestatus_abrufen
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| vermittlungscode | 1..1 | canonical(KBV_PR_KV_DIGITAL_TS_KVEN_Identifier_Vermittlungscode) | Der Vermittlungscode, dessen Status abgefragt werden soll, ist eine 12-stellige alphanumerische Folge. |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| suchergebnis | 1..1 | canonical(KBV_PR_KV_DIGITAL_TS_KVEN_Bundle_Operation_Result) | Das Suchergebnis enthält Informationen zum Vermittlungscode: den Status (bspw. frei, gebucht, abgelaufen), die Dringlichkeit, den Zeitpunkt der letzten Statusänderung und ob Leistungsmerkmale mit diesem Vermittlungscode verknüpft sind. |
Request
Die FHIR-Operation zum Abrufen des Vermittlungscodestatus' erfordert einen POST-Request.
Der Eingabeparameter für diese FHIR-Operation muss als Parameters-Ressource im Request Body übergeben werden (siehe hierzu Abschnitt Request Body
).
| HTTP Method | POST |
| URL | https://terminefuerkven.eterminservice.kv-safenet.de/terminefuerkven/api/v1/$vermittlungscodestatus_abrufen |
| Request Body | [parameters] |
Request Header
Folgende Request Header werden von den Systemen des 116117 Terminservices unterstützt und verarbeitet:
| Header | Verpflichtend? | Beschreibung | Wert |
|---|---|---|---|
Authorization |
ja | Im Authentisierungsverfahren erhaltener ACCESS_TOKEN als Bearer Token | Bearer ey... |
Content-Type |
nein | Gibt den ursprünglichen Medien- bzw. Dateitypen der Ressource an.
|
application/fhir+xml |
Request Body
Der Request Body muss eine Parameters-Ressource mit dem Eingabeparameter vermittlungscode enthalten.
Der Vermittlungscode ist ohne Bindestriche anzugeben. Das heißt, er muss aus exakt 12 alphanumerischen Zeichen bestehen. Erlaubt sind alle Großbuchstaben (A-Z) und Zahlen (0-9) mit folgenden Ausnahmen: O 0 I 1 E 3
Eine ausführliche Beschreibung des Parameters-Profils ist hier in der offiziellen HL7-Dokumentation zu finden.
Beispiel
Alle Beispiele für den Request Body (Parameters-Ressource) sind hier im vorliegenden Projekt zu finden.
# Request
POST https://terminefuerkven.eterminservice.kv-safenet.de/terminefuerkven/api/v1/$vermittlungscodestatus_abrufen
Content-Type: application/fhir+xml
Response
Die FHIR-Operation gibt bei Erfolg den HTTP-Statuscode 200 OK sowie ein Bundle im Response Body zurück.
Im Fehlerfall wird ein dem Fehler entsprechender HTTP-Statuscode (bspw. 400 Bad Request oder 500 Internal Server Error) und ggf. ein OperationOutcome im Response Body zurückgegeben. Das OperationOutcome enthält Details zum aufgetretenen Fehler.
Response Header
Folgende Response Header werden von den Systemen des 116117 Terminservices gesetzt und an den Anfragenden zurückgesendet:
| Header | Beschreibung | Wert |
|---|---|---|
Content-Type |
Gibt den ursprünglichen Medien- bzw. Dateitypen der Ressource an. | application/fhir+xml |
Response Body
Im Erfolgsfall ist im Response Body ein Bundle enthalten, welches die Informationen zu dem übergebenen Vermittlungscode als ServiceRequest-Ressource (im Element Bundle.entry) enthält. Details zum Bundle sind auf der Seite Result Bundle (Bundle) zu finden.
Im Fehlerfall kann im Response Body ein OperationOutcome enthalten sein. Details hierzu sind auf der Seite Fehler (OperationOutcome) zu finden.
Bitte beachten: Es gibt HTTP-Statuscodes, bei denen im Response Body kein OperationOutcome enthalten ist. Nähere Informationen dazu sind auf der Seite FAQ zu finden.
Beispiele
Alle Beispiele für den Response Body im Erfolgsfall (Bundle-Ressource) sind hier im vorliegenden Projekt zu finden.
Alle Beispiele für den Response Body im Fehlerfall (OperationOutcome-Ressource) sind hier im vorliegenden Projekt zu finden.