Auswählbare Suchparameter (Vorschau)

Wichtig

Die auswählbare Suchparameterfunktion ist für die Vorschau verfügbar. Vorschau-APIs und SDKs werden ohne Sla (Service Level Agreement) bereitgestellt. Es wird empfohlen, diese nicht für Produktionsworkloads zu verwenden. Einige Features werden möglicherweise nicht unterstützt oder bieten nur eingeschränkte Funktionalität. Weitere Informationen finden Sie unter Zusätzliche Nutzungsbestimmungen für Microsoft Azure-Vorschauen.

Die Suche nach Ressourcen ist für den FHIR-Dienst® von grundlegender Bedeutung. Jede Ressource im FHIR-Dienst enthält Informationen als Eine Reihe von Elementen. Suchparameter funktionieren, um die Informationen in diesen Elementen abzufragen. Wenn der FHIR-Dienst bereitgestellt wird, sind integrierte Suchparameter standardmäßig aktiviert. Der FHIR-Dienst führt effiziente Suchvorgänge durch Extrahieren und Indizieren bestimmter Eigenschaften aus FHIR-Ressourcen während der Erfassung von Daten durch.

Auswählbare Suchparameter ermöglichen es Ihnen, integrierte Suchparameter zu aktivieren oder zu deaktivieren. Mit dieser Funktion können Sie mehr Ressourcen im zugewiesenen Speicherplatz speichern und die Leistung verbessern, indem Sie nur die benötigten Suchparameter aktivieren.

Führen Sie die folgenden Standard Schritte aus, um Statusaktualisierungen für Suchparameter auszuführen:

1. Rufen Sie den Status der Suchparameter ab.
2. Aktualisieren Sie den Status der Suchparameter.
3. Führen Sie einen Neuindexauftrag aus.

In diesem Artikel wird die FHIR-Suchsyntax in Beispiel-API-Aufrufen mit dem Platzhalter {{FHIR_URL}} veranschaulicht, um die FHIR-Server-URL darzustellen.

Abrufen des Status von Suchparametern

Ein API-Endpunkt ('$status') wird bereitgestellt, um den Status der Suchparameter anzuzeigen. Es gibt vier Status für die Antwort:

Status	Beschreibung
Unterstützt	Der Suchparameter wird vom FHIR-Dienst unterstützt, und Sie haben Anforderungen zum Aktivieren des Suchparameters übermittelt. Führen Sie den erneut indizierten Vorgang aus, um von der unterstützten zu aktivierten Ausführung auszuführen.
Enabled	Der Suchparameter ist für die Suche aktiviert. Dieser Status ist der nächste Schritt nach dem unterstützten Status.
Ausstehend	Das Deaktivieren des Suchparameters steht nach der Ausführung des Vorgangs zum Erneuten Indizieren aus.
Deaktiviert	Der Suchparameter ist deaktiviert.

Verwenden Sie die folgende Anforderung, um den Status für alle Suchparameter abzurufen. Diese Anforderung gibt eine Liste aller Suchparameter und deren Status zurück. Scrollen Sie durch die Liste, um den benötigten Suchparameter zu finden.

GET {{FHIR_URL}}/SearchParameter/$status

Verwenden Sie die folgenden Filter, um den Status einzelner oder einer Teilmenge von Suchparametern zu identifizieren:

• Name: Verwenden Sie diese Anforderung, um den Suchparameterstatus anhand des Namens zu identifizieren:

   GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>

• URL. Verwenden Sie diese Anforderung, um den Suchparameterstatus anhand des kanonischen Bezeichners zu identifizieren:

GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>

• Ressourcentyp: In FHIR sind Suchparameter auf einzelner Ressourcenebene aktiviert, um das Filtern und Abrufen einer bestimmten Teilmenge von Ressourcen zu ermöglichen. Um den Status aller Suchparameter zu identifizieren, die einer Ressource zugeordnet sind, verwenden Sie diese Anforderung:

GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>

Als Reaktion auf die GET-Anforderung an $status Endpunkt wird der Parameterressourcentyp mit dem Status des Suchparameters zurückgegeben. Sehen Sie sich die Beispielantwort an:

{
  "resourceType" : "Parameters",
  "parameter" : [
    "name" : "searchParameterStatus",
    "part" : {
        {
        "name" : "url",
        "valueString" : "http://hl7.org/fhir/SearchParameter/Account-identifier"
        },
        {
        "name" : "status",
        "valueString" : "supported"
        }
    }
  ]
}

Aktualisieren des Status von Suchparametern

Nachdem Sie den Status der Suchparameter abgerufen haben, aktualisieren Sie den Status der Suchparameter auf Supported oder Disabled.

Hinweis

Um den Status der Suchparameter zu aktualisieren, benötigen Sie die Azure RBAC-Rolle des Suchparameter-Managers .

Der Status des Suchparameters kann für einen einzelnen Suchparameter oder einen Massenvorgang aktualisiert werden.

Aktualisieren eines einzelnen Suchparameterstatus

Verwenden Sie diese API-Anforderung, um den Status eines einzelnen Suchparameters zu aktualisieren:

PUT {{FHIR_URL}}/SearchParameter/$status
{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "searchParameterStatus",
            "part": [
                {
                    "name": "url",
                    "valueUrl": "http://hl7.org/fhir/SearchParameter/Resource-test-id"
                },
                {
                    "name": "status",
                    "valueString": "Supported"
                }
            ]
        }
    ]
}

Je nach Anwendungsfall können Sie den Statusstatuswert entweder auf "Unterstützt" oder "Deaktiviert" für einen Suchparameter beibehalten. Wenn Sie den Status Disabled in der Anforderung senden, wird die Antwort zurückgegeben, PendingDisable da ein Neuindexauftrag ausgeführt werden muss, um Zuordnungen vollständig zu entfernen.

Wenn Sie in der Antwort einen 400 HTTP-Statuscode erhalten, bedeutet dies, dass keine eindeutige Übereinstimmung für den identifizierten Suchparameter vorhanden ist. Überprüfen Sie die Suchparameter-ID.

Aktualisieren des Suchparameterstatus in Massen

Um den Status der Suchparameter in Massen zu aktualisieren, sollte die Anforderung "PUT" die Ressourcenliste "Parameters" im Anforderungstext enthalten. Die Liste muss die einzelnen Suchparameter enthalten, die aktualisiert werden müssen.

PUT {{FHIR_URL}}/SearchParameter/$status
{
  "resourceType" : "Parameters",
  "parameter" : [
    {
     "name" : "searchParameterStatus",
     "part" :{
        "name" : "url",
        "valueString" : "http://hl7.org/fhir/SearchParameter/Endpoint-name"
     },
     "part":{ 
        "name" : "status",
        "valueString" : "supported"
     }
    },
         "name" : "searchParameterStatus",
     "part" :{
        "name" : "url",
        "valueString" : "http://hl7.org/fhir/SearchParameter/HealthcareService-name"
     },
     "part":{ 
        "name" : "status",
        "valueString" : "supported"
     }
    },
    ...
  ]
}

Ausführen eines Neuindizierungsauftrags

Nachdem Sie den Status des Suchparameters Supported auf oder Disabledaktualisiert haben, besteht der nächste Schritt darin, einen Neuindexauftrag auszuführen.

Bis der Suchparameter indiziert ist, werden der Enabled Und-Status Disabled der Suchparameter nicht aktiviert. Die Ausführung des Neuindizierungsauftrags aktualisiert den Status von Supported bis zu EnabledDisabled.PendingDisable

Ein Neuindexauftrag kann für die gesamte FHIR-Dienstdatenbank oder für bestimmte Suchparameter ausgeführt werden. Ein Neuindizierungsauftrag kann leistungsintensiv sein. Weitere Informationen finden Sie unter Ausführen eines Neuindizierungsauftrags.

Hinweis

Ein Funktionsanweisungsdokument ist eine Reihe von Verhaltensweisen für einen FHIR-Server. Eine Capability-Anweisung ist für den /metadata-Endpunkt verfügbar. Enabled Suchparameter werden in der Funktionsanweisung für Ihren FHIR-Dienst aufgeführt.

Häufig gestellte Fragen

Was ist das Verhalten, wenn die Abfrage einen Suchparameter mit dem Status "Unterstützt" enthält?

Der Suchparameter im Status "Unterstützt" muss neu indiziert werden. Bis dahin wird der Suchparameter nicht aktiviert. Wenn eine Abfrage für einen nicht aktiven Suchparameter ausgeführt wird, rendert der FHIR-Dienst eine Antwort, ohne diesen Suchparameter zu berücksichtigen. In der Antwort wird eine Warnmeldung angezeigt, die angibt, dass der Suchparameter nicht indiziert wurde und daher in der Abfrage nicht verwendet wird. Verwenden Sie zum Rendern eines Fehlers in solchen Situationen den Header "Prefer: handling" mit dem Wert "strict". Durch Festlegen dieses Headers werden Warnungen als Fehler gemeldet.

Nächste Schritte

Definieren von benutzerdefinierten Suchparametern

Hinweis

FHIR® ist eine eingetragene Marke von HL7 und wird mit Genehmigung von HL7 verwendet.