Sdílet prostřednictvím

Vybratelné parametry hledání (Preview)

  • Článek

Důležité

Možnost výběru parametru vyhledávání je k dispozici pro verzi Preview. Rozhraní API a sady SDK verze Preview jsou poskytovány bez smlouvy o úrovni služeb (SLA). Doporučujeme je nepoužívat pro produkční úlohy. Některé funkce nemusí být podporované nebo můžou mít omezené možnosti. Další informace najdete v dodatečných podmínkách použití pro verze Preview v Microsoft Azure.

Hledání prostředků je pro službu FHIR® zásadní. Každý prostředek ve službě FHIR obsahuje informace jako sadu prvků. Parametry hledání pracují s dotazem na informace v těchto prvech. Při nasazení služby FHIR jsou ve výchozím nastavení povolené předem připravené parametry hledání. Služba FHIR provádí efektivní vyhledávání extrahováním a indexováním konkrétních vlastností z prostředků FHIR během příjmu dat.

Výběrové parametry hledání umožňují povolit nebo zakázat předem připravené parametry hledání. Tato funkce vám pomůže uložit více prostředků do přiděleného prostoru úložiště a zlepšit výkon tím, že povolí jenom parametry hledání, které potřebujete.

Pokud chcete provádět aktualizace stavu u parametrů hledání, postupujte takto:

  1. Získejte stav parametrů hledání.
  2. Aktualizujte stav parametrů hledání.
  3. Spusťte úlohu přeindexování.

V tomto článku předvedeme syntaxi vyhledávání FHIR v příkladech volání rozhraní API se zástupným symbolem {{FHIR_URL}}, který představuje adresu URL serveru FHIR.

Získání stavu parametrů hledání

Pro zobrazení stavu parametrů hledání se poskytuje koncový bod rozhraní API ($status). Odpověď má čtyři stavy:

Status Popis
Podporováno Vyhledávací parametr podporuje služba FHIR a odeslali jste požadavky na povolení parametru vyhledávání. Spusťte operaci přeindexování, která se spustí z podporované na povolenou.
Povoleno Vyhledávací parametr je povolený pro vyhledávání. Tento stav je dalším krokem po podporovaném stavu.
PendingDisable Zakázání parametru vyhledávání čeká po provedení operace přeindexování.
Zakázáno Parametr vyhledávání je zakázaný.

Pokud chcete získat stav napříč všemi parametry hledání, použijte následující požadavek, který vrátí seznam všech parametrů hledání a jejich stav. Projděte si seznam a najděte parametr hledání, který potřebujete.

GET {{FHIR_URL}}/SearchParameter/$status

K identifikaci stavu jednotlivých nebo podmnožina parametrů hledání použijte následující filtry.

  • Název. K identifikaci stavu parametru vyhledávání podle názvu použijte tento požadavek.
   GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
  • Adresa URL. K identifikaci stavu parametru vyhledávání podle jeho kanonického identifikátoru použijte tento požadavek.
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
  • Typ prostředku. V FHIR jsou vyhledávací parametry povolené na úrovni jednotlivých prostředků, aby bylo možné filtrovat a načítat konkrétní podmnožinu prostředků. K identifikaci stavu všech parametrů hledání namapovaných na prostředek použijte tento požadavek.
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>

V reakci na požadavek GET na koncový bod $status se vrátí typ prostředku parametrů se stavem parametru vyhledávání. Tady je příklad odpovědi.

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

Aktualizace stavu parametrů hledání

Po získání stavu parametrů hledání aktualizujte stav parametrů hledání na Supported hodnotu nebo Disabled.

Poznámka:

Pokud chcete aktualizovat stav parametrů hledání, potřebujete roli Správce parametrů vyhledávání v Azure RBAC.

Stav vyhledávacího parametru lze aktualizovat pro jeden parametr vyhledávání nebo hromadně.

Aktualizace stavu jednoho parametru vyhledávání

Pokud chcete aktualizovat stav jednoho parametru vyhledávání, použijte následující požadavek rozhraní 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"
                }
            ]
        }
    ]
}

V závislosti na vašem případu použití můžete u parametru hledání ponechat hodnotu stavu Podporovaná nebo Zakázaná. Když odešlete stav Disabled v požadavku, odpověď se vrátí, protože PendingDisable úloha přeindexování musí běžet, aby bylo možno plně odebrat přidružení.

Pokud v odpovědi obdržíte stavový kód HTTP 400, znamená to, že pro identifikovaný parametr vyhledávání neexistuje žádná jedinečná shoda. Zkontrolujte ID parametru vyhledávání.

Hromadná aktualizace stavu parametru vyhledávání

Pokud chcete hromadně aktualizovat stav parametrů hledání, požadavek PUT by měl mít v textu požadavku seznam prostředků Parameters. Seznam musí obsahovat jednotlivé parametry hledání, které je potřeba aktualizovat.

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

Provedení přeindexování úlohy

Po aktualizaci stavu parametru vyhledávání na Supported nebo Disabled, dalším krokem je spuštění přeindexování úlohy.

Dokud se parametr vyhledávání neindexuje, Enabled neaktivuje se stav Disabled parametrů hledání. Přeindexování provádění úlohy aktualizuje stav z Supported do Enabled nebo PendingDisable do Disabled.

Úlohu přeindexování lze spustit pro celou databázi služby FHIR nebo pro konkrétní parametry hledání. Úloha přeindexování může být náročná na výkon. Další informace naleznete v tématu Spuštění úlohy přeindexování.

Poznámka:

Dokument příkazu schopností je sada chování serveru FHIR. Enabled Parametry vyhledávání jsou uvedeny v příkazu capability pro vaši službu FHIR. Příkaz capability je k dispozici pro koncový bod /metadata.

Nejčastější dotazy

Jaké je chování, pokud dotaz obsahuje vyhledávací parametr se stavem "Podporováno"?

Parametr vyhledávání ve stavu Supported je potřeba přeindexovat. Do té doby se vyhledávací parametr neaktivuje. Pokud je dotaz proveden u neaktivovaného vyhledávacího parametru, služba FHIR vykreslí odpověď bez ohledu na tento parametr vyhledávání. V odpovědi se zobrazí zpráva s upozorněním, že parametr vyhledávání nebyl indexován a nebyl použit v dotazu. Pokud chcete v takových situacích vykreslit chybu, použijte hlavičku Prefer: handling (Prefer: handling) s hodnotou strict (striktní). Nastavením této hlavičky se upozornění hlásí jako chyby.

Další kroky

Definování vlastních parametrů hledání

Poznámka:

FHIR® je registrovaná ochranná známka HL7 a používá se s povolením HL7.