Wybrane parametry wyszukiwania (wersja zapoznawcza)

Ważne

Możliwość wybierania parametru wyszukiwania jest dostępna w wersji zapoznawczej. Interfejsy API i zestawy SDK w wersji zapoznawczej są udostępniane bez umowy dotyczącej poziomu usług (SLA). Zalecamy, aby nie używać ich w przypadku obciążeń produkcyjnych. Niektóre funkcje mogą nie być obsługiwane lub mogą mieć ograniczone możliwości. Aby uzyskać więcej informacji, zobacz Uzupełniające warunki korzystania z wersji zapoznawczych platformy Microsoft Azure.

Wyszukiwanie zasobów jest fundamentalne dla usługi FHIR®. Każdy zasób w usłudze FHIR zawiera informacje jako zestaw elementów. Parametry wyszukiwania działają w celu wykonywania zapytań dotyczących informacji w tych elementach. Po wdrożeniu usługi FHIR wbudowane parametry wyszukiwania są domyślnie włączone. Usługa FHIR wykonuje wydajne wyszukiwania przez wyodrębnianie i indeksowanie określonych właściwości z zasobów FHIR podczas pozyskiwania danych.

Wybrane parametry wyszukiwania umożliwiają włączanie lub wyłączanie wbudowanych parametrów wyszukiwania. Ta funkcja ułatwia przechowywanie większej ilości zasobów w przydzielonym miejscu do magazynowania i poprawianie wydajności przez włączenie tylko potrzebnych parametrów wyszukiwania.

Aby wykonać aktualizacje stanu parametrów wyszukiwania, wykonaj następujące główne kroki:

1. Pobierz stan parametrów wyszukiwania.
2. Zaktualizuj stan parametrów wyszukiwania.
3. Wykonaj zadanie ponownego indeksu.

W tym artykule przedstawiono składnię wyszukiwania FHIR w przykładowych wywołaniach interfejsu API z symbolem zastępczym {{FHIR_URL}} reprezentującym adres URL serwera FHIR.

Pobieranie stanu parametrów wyszukiwania

Punkt końcowy interfejsu API ('$status') jest udostępniany w celu wyświetlenia stanu parametrów wyszukiwania. Odpowiedź ma cztery stany:

Stan	opis
Obsługiwane	Parametr wyszukiwania jest obsługiwany przez usługę FHIR i przesłano żądania włączenia parametru wyszukiwania. Wykonaj operację ponownego indeksowania, aby uruchomić polecenie z obsługiwanej do włączonej.
Włączona	Parametr wyszukiwania jest włączony do wyszukiwania. Ten stan jest następnym krokiem po obsługiwanym stanie.
PendingDisable	Wyłączenie parametru wyszukiwania jest oczekujące po wykonaniu operacji ponownego indeksowania.
Disabled	Parametr wyszukiwania jest wyłączony.

Aby uzyskać stan dla wszystkich parametrów wyszukiwania, użyj następującego żądania. To żądanie zwraca listę wszystkich parametrów wyszukiwania i ich stan. Przewiń listę, aby znaleźć potrzebny parametr wyszukiwania.

GET {{FHIR_URL}}/SearchParameter/$status

Aby zidentyfikować stan poszczególnych lub podzestaw parametrów wyszukiwania, użyj następujących filtrów:

• Name. Aby zidentyfikować stan parametru wyszukiwania według nazwy, użyj następującego żądania:

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

• URL. Aby zidentyfikować stan parametru wyszukiwania według jego identyfikatora kanonicznego, użyj tego żądania:

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

• Typ zasobu. W środowisku FHIR parametry wyszukiwania są włączone na poziomie poszczególnych zasobów, aby umożliwić filtrowanie i pobieranie określonego podzestawu zasobów. Aby zidentyfikować stan wszystkich parametrów wyszukiwania zamapowanych na zasób, użyj następującego żądania:

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

W odpowiedzi na żądanie GET w celu $status punktu końcowego zwracany jest typ zasobu parametrów ze stanem parametru wyszukiwania. Zobacz przykładowa odpowiedź:

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

Aktualizowanie stanu parametrów wyszukiwania

Po otrzymaniu stanu parametrów wyszukiwania zaktualizuj stan parametrów wyszukiwania na Supported lub Disabled.

Uwaga

Aby zaktualizować stan parametrów wyszukiwania, potrzebna jest rola RBAC Menedżera parametrów wyszukiwania platformy Azure.

Stan parametru wyszukiwania można zaktualizować dla pojedynczego parametru wyszukiwania lub zbiorczo.

Aktualizowanie stanu pojedynczego parametru wyszukiwania

Aby zaktualizować stan pojedynczego parametru wyszukiwania, użyj tego żądania interfejsu API:

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"
                }
            ]
        }
    ]
}

W zależności od przypadku użycia można zachować wartość stanu stanu na wartość "Supported" lub "Disabled" dla parametru wyszukiwania. Po wysłaniu stanu Disabled w żądaniu odpowiedź jest zwracana jako PendingDisable , ponieważ zadanie ponownego indeksowania musi zostać uruchomione, aby w pełni usunąć skojarzenia.

Jeśli otrzymasz kod stanu HTTP 400 w odpowiedzi, oznacza to, że nie ma unikatowego dopasowania do zidentyfikowanego parametru wyszukiwania. Sprawdź identyfikator parametru wyszukiwania.

Zbiorcze aktualizowanie stanu parametru wyszukiwania

Aby zaktualizować stan parametrów wyszukiwania zbiorczo, żądanie "PUT" powinno mieć listę zasobów "Parametry" w treści żądania. Lista musi zawierać poszczególne parametry wyszukiwania, które należy zaktualizować.

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"
     }
    },
    ...
  ]
}

Wykonywanie zadania ponownego indeksu

Po zaktualizowaniu stanu parametru wyszukiwania do Supported lub Disablednastępnym krokiem jest wykonanie zadania ponownego indeksowania.

Dopóki parametr wyszukiwania nie zostanie zaindeksowany, Enabled stan i Disabled parametrów wyszukiwania nie zostanie aktywowany. Ponowne indeksowanie wykonania zadania aktualizuje stan z Supported do lub PendingDisableEnabled do Disabled.

Zadanie ponownego indeksowania można wykonać względem całej bazy danych usługi FHIR lub względem określonych parametrów wyszukiwania. Zadanie ponownego indeksu może intensywnie obciążać wydajność. Aby uzyskać więcej informacji, zobacz Uruchamianie zadania ponownego indeksu.

Uwaga

Dokument instrukcji możliwości to zestaw zachowań serwera FHIR. Instrukcja capability jest dostępna dla punktu końcowego /metadata. Enabled Parametry wyszukiwania są wymienione w instrukcji capability dla usługi FHIR.

Często zadawane pytania

Jakie jest zachowanie, jeśli zapytanie zawiera parametr wyszukiwania ze stanem "Obsługiwane"?

Parametr wyszukiwania w stanie "Obsługiwane" musi zostać ponownie zindeksowany. Do tego czasu parametr wyszukiwania nie jest aktywowany. Jeśli zapytanie jest wykonywane na nieaktywnych parametrach wyszukiwania, usługa FHIR będzie renderować odpowiedź bez uwzględniania tego parametru wyszukiwania. W odpowiedzi zostanie wyświetlony komunikat ostrzegawczy wskazujący, że parametr wyszukiwania nie został indeksowany i dlatego nie jest używany w zapytaniu. Aby wyrenderować błąd w takich sytuacjach, użyj nagłówka "Preferuj obsługę" z wartością "strict". Ustawiając ten nagłówek, ostrzeżenia będą zgłaszane jako błędy.

Następne kroki

Definiowanie niestandardowych parametrów wyszukiwania

Uwaga

FHIR® jest zastrzeżonym znakiem towarowym HL7 i jest używany z uprawnieniem HL7.