Sökparametrar som kan väljas

Att söka efter resurser är grundläggande för FHIR-tjänsten®. Varje resurs i FHIR-tjänsten innehåller information som en uppsättning element. Sökparametrar fungerar för att fråga efter informationen i dessa element. När du distribuerar FHIR-tjänsten aktiveras inbyggda sökparametrar som standard. FHIR-tjänsten utför effektiva sökningar genom att extrahera och indexera specifika egenskaper från FHIR-resurser under datainmatningen.

Valbara sökparametrar hjälper dig att söka FHIR-resurser® mer effektivt i Azure Health Data Services. Denna artikel förklarar hur man aktiverar eller inaktiverar inbyggda sökparametrar för att spara lagringsutrymme och förbättra sökprestandan.

Följ dessa steg för att utföra statusuppdateringar på sökparametrar:

  1. Hämta status för sökparametrar.
  2. Uppdatera status för sökparametrar.
  3. Kör ett omindexera jobb.

I denna artikel demonstrerar exemplen på API-anrop FHIR-söksyntax genom att använda platshållaren {{FHIR_URL}} för att representera FHIR-serverns URL.

Hämta status för sökparametrar

En API-endpoint ($status) finns tillgänglig för att se status för sökparametrar. Svaret innehåller fyra statuspunkter:

Status beskrivning
Stöds FHIR-tjänsten stödjer sökparametern, och du skickade in förfrågningar om att aktivera sökparametern. Kör omindexeringen för att köra från som stöds till aktiverad.
Aktiverat Sökparametern är aktiverad för sökning. Den här statusen är nästa steg efter statusen som stöds.
PendingDisable Inaktivering av sökparametern väntar efter körningen av omindexeringsåtgärden.
Inaktiverad Sökparametern är inaktiverad.
VäntarTa bort Sökparameterresursen är mjukt raderad; Indexerad data finns fortfarande i söktabeller och väntar på rensning av ett omindexeringsjobb.
PendingHardDelete Sökparameterresursen raderas hårdt genom att vidarebefordra hardDelete=true DELETE-frågan; indexerad data finns fortfarande i söktabeller och väntar på rensning av ett omindexeringsjobb.
Deleted Reindexeringsjobbet slutförde saneringen av all indexerad data; sökparametern är helt borttagen och i sitt terminaltillstånd.

För att få status över alla sökparametrar, använd följande begäran. Den returnerar en lista över alla sökparametrar och deras status. Bläddra igenom listan för att hitta sökparametern du behöver.

GET {{FHIR_URL}}/SearchParameter/$status

Använd följande filter för att identifiera status för enskilda eller en delmängd av sökparametrar.

  • Namn. Använd den här begäran om du vill identifiera sökparameterstatus efter namn.
   GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
  • URL. Om du vill identifiera status för sökparametern med dess kanoniska identifierare använder du den här begäran.
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
  • Resurstyp. I FHIR aktiverar du sökparametrar på individuell resursnivå för att möjliggöra filtrering och hämtning av en specifik delmängd av resurser. Använd den här begäran om du vill identifiera statusen för alla sökparametrar som mappats till en resurs.
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>

Som svar på GET-förfrågan till $status slutpunkten returneras parameterns resurstyp med statusen för sökparametern. Här är ett exempelsvar.

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

Uppdatera status för sökparametrar

När du fått statusen för sökparametrarna, uppdatera statusen till Supported eller Disabled.

Kommentar

Om du vill uppdatera statusen för sökparametrar behöver du rollen Search Parameter Manager Azure RBAC.

Du kan uppdatera sökparameterstatusen för en enda sökparameter eller i bulk.

Uppdatera status för en enskild sökparameter

Om du vill uppdatera statusen för en enskild sökparameter använder du följande API-begäran.

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

Beroende på ditt användningsfall, behåll statusstatusvärdet som antingen Supported eller Disabled för en sökparameter. När du skickar tillståndet Disabled i begäran returneras svaret som PendingDisable eftersom ett omindexeringsjobb måste köras för att helt ta bort associationer.

Om du får en 400 HTTP-statuskod i svaret betyder det att det inte finns någon unik träff för den identifierade sökparametern. Kontrollera sökparameterns ID.

Uppdatera sökparameterstatus i bulk

För att uppdatera statusen för sökparametrar i bulk, inkludera Parameters resurslistan i begärandets kropp PUT . Listan måste innehålla de individuella sökparametrar du vill uppdatera.

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

Köra ett omindexera jobb

När du har uppdaterat sökparameterns status till Supported eller Disabledär nästa steg att köra ett omindexeringsjobb.

Tills sökparametern har indexerats aktiveras Enabled inte sökparametrarnas status och Disabled . Omindexera jobbkörning uppdaterar statusen från Supported till Enabled eller PendingDisable till Disabled.

Ett omindexeringsjobb kan köras mot hela FHIR-tjänstdatabasen eller mot specifika sökparametrar. Ett omindexera jobb kan vara prestandaintensivt. Mer information finns i Kör ett omindexeringsjobb.

Kommentar

Ett funktionsuttrycksdokument är en uppsättning beteenden för en FHIR-server. Enabled sökparametrar visas i funktionssatsen för din FHIR-tjänst. En funktionssats är tillgänglig för slutpunkten /metadata.

Vanliga frågor och svar

Vad är beteendet om frågan innehåller en sökparameter med statusen "Stöds"?

Sökparametern i tillståndet "Stöds" måste indexeras om. Fram till dess aktiveras inte sökparametern. Om en fråga körs på en icke-aktiv sökparameter, renderar FHIR-tjänsten ett svar utan att ta hänsyn till den sökparametern. I svaret finns ett varningsmeddelande som indikerar att sökparametern inte indexerades och inte användes i frågan. Om du vill återge ett fel i sådana situationer använder du rubriken "Prefer: handling" med värdet "strict". Genom att ange det här huvudet rapporteras varningar som fel.

Nästa steg

Definiera anpassade sökparametrar

Kommentar

FHIR® är ett registrerat varumärke som tillhör HL7 och används med tillstånd av HL7.

  • Last updated on