Valbara sökparametrar (förhandsversion)
Viktigt!
Funktionen för valbara sökparametrar är tillgänglig för förhandsversion. Förhandsversions-API:er och SDK:er tillhandahålls utan ett serviceavtal (SLA). Vi rekommenderar att du inte använder dem för produktionsarbetsbelastningar. Vissa funktioner kanske inte stöds, eller så kan de ha begränsade funktioner. Mer information finns i Kompletterande villkor för användning av Microsoft Azure-förhandsversioner.
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 FHIR-tjänsten distribueras 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.
Med valbara sökparametrar kan du aktivera eller inaktivera inbyggda sökparametrar. Den här funktionen hjälper dig att lagra fler resurser i allokerat lagringsutrymme och förbättra prestandan genom att endast aktivera de sökparametrar du behöver.
Följ dessa steg för att utföra statusuppdateringar på sökparametrar:
I den här artikeln visar vi FHIR-söksyntax i API-exempelanrop med platshållaren {{FHIR_URL}} för att representera FHIR-serverns URL.
Hämta status för sökparametrar
En API-slutpunkt ("$status") tillhandahålls för att visa status för sökparametrar. Det finns fyra statusar för svaret:
| Status | beskrivning |
|---|---|
| Stöds | Sökparametern stöds av FHIR-tjänsten och du har skickat begäranden 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. |
Om du vill hämta status för alla sökparametrar använder du följande begäran, som 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 aktiveras sökparametrar på enskild resursnivå för att tillåta 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-begäran till $status slutpunkt returneras resurstypen parametrar med status 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 har fått status för sökparametrar uppdaterar du statusen för sökparametrarna till Supported eller Disabled.
Kommentar
Om du vill uppdatera statusen för sökparametrar behöver du rollen Search Parameter Manager Azure RBAC.
Sökparameterstatus kan uppdateras för en enskild sökparameter eller massvis.
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 kan du behålla statustillståndsvärdet antingen "Stöds" eller "Inaktiverat" 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 innebär det att det inte finns någon unik matchning för den identifierade sökparametern. Kontrollera sökparameterns ID.
Uppdatera sökparameterstatus i bulk
Om du vill uppdatera statusen för sökparametrar i grupp bör PUT-begäran ha resurslistan Parametrar i begärandetexten. Listan måste innehålla de enskilda sökparametrar som behöver uppdateras.
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"
}
},
...
]
}
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 visas ett varningsmeddelande som anger att sökparametern inte har indexerats och inte används 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.