Suchparameter: BSNR (SearchParameter)

Fachlicher Kontext

Der Suchparameter dient zur Eingrenzung der Suchergebnisse auf bestimmte Praxen / medizinische Einrichtungen anhand ihrer Betriebsstättennummer (BSNR).

Wird der Parameter nicht angegeben, werden die Ergebnisse für alle Praxen / medizinischen Einrichtungen ausgegeben, für die der Anfragende authentifiziert ist.

Es ist sowohl die Angabe einer einzelnen BSNR als auch die Anfrage für mehrere BSNRs in Form einer kommaseparierten Liste möglich.

Für die angefragten BSNRs muss eine gültige Authentifizierung vorliegen. (Die Spezifikation 116117 Terminservice Authentisierung ist hier im Partnerportal der kv.digital GmbH veröffentlicht.) Der Abgleich wird durch den 116117 Terminservice anhand des Access Tokens vorgenommen. Das bedeutet, dass die BSNR immer vollständig angegeben werden muss. Eine Suche mit bspw. nur den ersten drei Ziffern der BSNR ist nicht zulässig und führt zu einem Fehler.

Werden Anfragen für BSNRs gestellt, für die keine Authentifizierung vorliegt, so wird ein Fehler zurückgegeben.

FHIR-Suchparameter

Name	KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR
Resource Type	SearchParameter
Code	`bsnr`
Type	`string`
Canonical URL	`https://fhir.kbv.de/SearchParameter/KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR`

Invocations

[base]/Appointment?bsnr=[text]

[base]/Schedule?bsnr=[text]

[base]/Practitioner?bsnr=[text]

[base]/PractitionerRole?bsnr=[text]

[base]/Slot?bsnr=[text]

[base]/Provenance?bsnr=[text]

Details

Resource	Code	Type	FhirPath
Appointment, Schedule, Practitioner, PractitionerRole, Slot, Provenance	bsnr	string

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="KBV-SP-116117-TERMINSERVICE-TVS-TSYNCH-SearchParameter-BSNR" />
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <url value="https://fhir.kbv.de/SearchParameter/KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR" />
    <version value="1.0.0" />
    <name value="KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR" />
    <status value="active" />
    <publisher value="kv.digital GmbH" />
    <contact>
        <name value="kv.digital GmbH" />
        <telecom>
            <system value="url" />
            <value value="https://www.kv.digital" />
        </telecom>
    </contact>
    <description value="SearchParameter zum Filtern von Ressourcen auf bestimmte BSNRs" />
    <code value="bsnr" />
    <base value="Appointment" />
    <base value="Schedule" />
    <base value="Practitioner" />
    <base value="PractitionerRole" />
    <base value="Slot" />
    <base value="Provenance" />
    <type value="string" />
    <multipleOr value="true" />
</SearchParameter>

{
    "resourceType": "SearchParameter",
    "id": "KBV-SP-116117-TERMINSERVICE-TVS-TSYNCH-SearchParameter-BSNR",
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "https://fhir.kbv.de/SearchParameter/KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR",
    "version": "1.0.0",
    "name": "KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR",
    "status": "active",
    "publisher": "kv.digital GmbH",
    "contact":  [
        {
            "name": "kv.digital GmbH",
            "telecom":  [
                {
                    "system": "url",
                    "value": "https://www.kv.digital"
                }
            ]
        }
    ],
    "description": "SearchParameter zum Filtern von Ressourcen auf bestimmte BSNRs",
    "code": "bsnr",
    "base":  [
        "Appointment",
        "Schedule",
        "Practitioner",
        "PractitionerRole",
        "Slot",
        "Provenance"
    ],
    "type": "string",
    "multipleOr": true
}

KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_BSNR

Operationen & Interaktionen

Bei folgende Interaktionen dient diese Ressource als Suchparameter:

Beispiele

Request

Die folgenden Beispiele zeigen jeweils eine Suche anhand einer bzw. mehrerer BSNRs:

# Suche alle Terminbuchungen, die von der Praxis mit der BSNR 123456789 angeboten werden
POST https://terminsynchronisation.eterminservice.kv-safenet.de/tvs/terminsynchronisation/api/Appointment/_search
Content-Type: application/x-www-form-urlencoded
bsnr=123456789

# Suche alle Provenances, die Änderungen an Ressourcen enthalten, die der Praxis mit der BSNR 123456789 oder 111222333 zugeordnet sind
POST https://terminsynchronisation.eterminservice.kv-safenet.de/tvs/terminsynchronisation/api/Provenance/_search
Content-Type: application/x-www-form-urlencoded
bsnr=123456789,111222333

Alle Beispiele hierzu sind auf den jeweiligen Seiten unter Operationen und Interaktionen beschrieben.

Response

In der Response werden alle genutzten Suchparameter zum Zwecke der Nachvollziehbarkeit noch einmal aufgelistet. Aufgrund der Gegebenheiten des zugrundeliegendes Bundle-Profils geschieht dies in Form eines URL-Parameters (zu finden im Element Bundle.link).

Die folgenden Beispiele sind eine vereinfachte Darstellung von Searchset Bundles. Die einzelnen Suchergebnisse (im Element Bundle.entry) wurden ausgelassen, damit einfacher zu erfassen ist, wo der Suchparameter angegeben wird.

Details zum Searchset Bundle sowie die vollständigen Beispiele sind auf der Seite Profil: Suchergebnisse (Bundle) zu finden.

Beispiel 1: Response mit einer BSNR als genutztem Suchparameter

<Bundle xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Searchset|0.2.0" />
    </meta>
    <type value="searchset" />
    <timestamp value="2024-09-01T05:51:32+02:00" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://fhir.kbv.de/Appointment?bsnr=123456789&_count=10" />
    </link>
    <link>
        <relation value="next" />
        <url value="https://fhir.kbv.de/Appointment?bsnr=123456789&_count=10&page=2" />
    </link>
    <entry>
        ...
    </entry>
</Bundle>

Beispiel 2: Response mit zwei BSNRs als genutzten Suchparametern

<Bundle xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Searchset|0.2.0" />
    </meta>
    <type value="searchset" />
    <timestamp value="2024-09-01T05:51:32+02:00" />
    <total value="1" />
    <link>
        <relation value="self" />
        <url value="https://fhir.kbv.de/Appointment?bsnr=123456789,111222333&_count=10" />
    </link>
    <link>
        <relation value="next" />
        <url value="https://fhir.kbv.de/Appointment?bsnr=123456789,111222333&_count=10&page=2" />
    </link>
    <entry>
        ...
    </entry>
</Bundle>