Suchparameter: ANR (SearchParameter)

Fachlicher Kontext

Der Suchparameter dient zur Eingrenzung der Suchergebnisse auf bestimmte Ärzte anhand ihrer Arztnummer (ANR). Es können dabei entweder alle neun Stellen der ANR oder nur die ersten sieben Stellen der ANR angegeben werden. Weitere Details zur ANR sind unter Profil: Arzt (Practitioner) im Abschnitt Fachlicher Kontext zu finden.

Wird der Parameter nicht angegeben, werden die Ergebnisse für alle Ärzte ausgegeben, die in allen Praxen / medizinischen Einrichtungen tätig sind, für die der Anfragende authentifiziert ist.

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

Wird anhand einer ANR eines Arztes gesucht, der in einer der Praxen / medizinischen Einrichtungen tätig ist, für die KEINE Authentifizierung vorliegt, ist die Suche an sich erfolgreich. Es werden jedoch keine Suchergebnisse zurückgegeben. Das bedeutet, dass in diesem Fall kein Fehler als Antwort (Response) auf die Suchanfrage zurückkommt.

Wird anhand einer ANR gesucht, die keinem Arzt zugewiesen ist, wird ein Fehler als Antwort (Response) auf die Suchanfrage zurückgegeben.

FHIR-Profil

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

Invocations

[base]/Appointment?anr=[text]

[base]/Schedule?anr=[text]

[base]/Practitioner?anr=[text]

[base]/PractitionerRole?anr=[text]

[base]/Slot?anr=[text]

Details

Resource	Code	Type	FhirPath
Appointment, Schedule, Practitioner, PractitionerRole, Slot	anr	string

<SearchParameter xmlns="http://hl7.org/fhir">
    <id value="KBV-SP-116117-TERMINSERVICE-TVS-TSYNCH-SearchParameter-ANR" />
    <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_ANR" />
    <version value="1.0.0" />
    <name value="KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_ANR" />
    <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 ANRs" />
    <code value="anr" />
    <base value="Appointment" />
    <base value="Schedule" />
    <base value="Practitioner" />
    <base value="PractitionerRole" />
    <base value="Slot" />
    <type value="string" />
    <multipleOr value="true" />
</SearchParameter>

{
    "resourceType": "SearchParameter",
    "id": "KBV-SP-116117-TERMINSERVICE-TVS-TSYNCH-SearchParameter-ANR",
    "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_ANR",
    "version": "1.0.0",
    "name": "KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_ANR",
    "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 ANRs",
    "code": "anr",
    "base":  [
        "Appointment",
        "Schedule",
        "Practitioner",
        "PractitionerRole",
        "Slot"
    ],
    "type": "string",
    "multipleOr": true
}

KBV_SP_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_SearchParameter_ANR

Anmerkungen

Der Suchparameter ANR kann innerhalb der Schnittstelle TSS Abrechnungsinformationen – PVS für folgende Interaktionen verwendete werden:

Terminbuchungen abrufen (Appointment Search)

Alle anderen Interaktionen sind nur für Benutzer der erweiterten Schnittstelle zur Terminsynchronisation aufrufbar.

Beispiele

Request

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

# Suche alle Terminprofile, die dem Arzt zugeordnet sind, dessen ANRs mit den Ziffern 1234567 beginnen
POST https://abrechnungsinformation.eterminservice.kv-safenet.de/pvs/abrechnungsinformation/api/Schedule/_search
Content-Type: application/x-www-form-urlencoded
anr=1234567

# Suche alle Terminbuchungen, die von den Ärzten mit der ANR 123456789 oder 111222333 durchgeführt werden
POST https://abrechnungsinformation.eterminservice.kv-safenet.de/pvs/abrechnungsinformation/api/Appointment/_search
Content-Type: application/x-www-form-urlencoded
anr=123456789,111222333

Alle Beispiele hierzu sind auf den jeweiligen Unterseiten zu den 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, bei denen die einzelnen Suchergebnisse (im Element Bundle.entry) ausgelassen wurden, damit einfacher zu erfassen ist, wo der Suchparameter angegeben wird.

Beispiel 1: Response mit einer ANR 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="11" />
    <link>
        <relation value="self" />
        <url value="https://fhir.kbv.de/Appointment?anr=1234567&_count=10" />
    </link>
    <link>
        <relation value="next" />
        <url value="https://fhir.kbv.de/Appointment?anr=1234567&_count=10&page=2" />
    </link>
    <entry>
        ...
    </entry>
</Bundle>

Beispiel 2: Response mit zwei ANRs 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="11" />
    <link>
        <relation value="self" />
        <url value="https://fhir.kbv.de/Appointment?anr=123456789,111222333&_count=10" />
    </link>
    <link>
        <relation value="next" />
        <url value="https://fhir.kbv.de/Appointment?anr=123456789,111222333&_count=10&page=2" />
    </link>
    <entry>
        ...
    </entry>
</Bundle>

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