Delen via

Selecteerbare zoekparameters (preview)

  • Artikel

Belangrijk

De selecteerbare zoekparameterfunctie is beschikbaar voor preview. Preview-API's en SDK's worden geleverd zonder service level agreement (SLA). U wordt aangeraden deze niet te gebruiken voor productieworkloads. Sommige functies worden mogelijk niet ondersteund of hebben mogelijk beperkte mogelijkheden. Zie Aanvullende gebruiksvoorwaarden voor Microsoft Azure-previews voor meer informatie.

Het zoeken naar resources is fundamenteel voor de FHIR-service®. Elke resource in de FHIR-service bevat informatie als een set elementen. Zoekparameters werken om een query uit te voeren op de informatie in deze elementen. Wanneer de FHIR-service wordt geïmplementeerd, worden ingebouwde zoekparameters standaard ingeschakeld. De FHIR-service voert efficiënte zoekopdrachten uit door specifieke eigenschappen uit FHIR-resources te extraheren en te indexeren tijdens de opname van gegevens.

Met selecteerbare zoekparameters kunt u ingebouwde zoekparameters in- of uitschakelen. Met deze mogelijkheid kunt u meer resources opslaan in toegewezen opslagruimte en de prestaties verbeteren door alleen de zoekparameters in te schakelen die u nodig hebt.

Voer de volgende hoofdstappen uit om statusupdates uit te voeren voor zoekparameters:

  1. De status van zoekparameters ophalen.
  2. Werk de status van zoekparameters bij.
  3. Voer een herindextaak uit.

In dit artikel laten we de FHIR-zoeksyntaxis zien in voorbeeld-API-aanroepen met de tijdelijke aanduiding {{FHIR_URL}} om de FHIR-server-URL weer te geven.

De status van zoekparameters ophalen

Er wordt een API-eindpunt ('$status') opgegeven om de status van zoekparameters weer te geven. Er zijn vier statussen voor het antwoord:

-Status Beschrijving
Ondersteund De zoekparameter wordt ondersteund door de FHIR-service en u hebt aanvragen ingediend om de zoekparameter in te schakelen. Voer de herindexbewerking uit om uit te voeren van ondersteund naar ingeschakeld.
Ingeschakeld De zoekparameter is ingeschakeld voor zoeken. Deze status is de volgende stap na de ondersteunde status.
PendingDisable Het uitschakelen van de zoekparameter is in behandeling na de uitvoering van de herindexbewerking.
Uitgeschakeld De zoekparameter is uitgeschakeld.

Gebruik de volgende aanvraag om de status op te halen voor alle zoekparameters. Deze aanvraag retourneert een lijst met alle zoekparameters en hun status. Blader door de lijst om de zoekparameter te vinden die u nodig hebt.

GET {{FHIR_URL}}/SearchParameter/$status

Als u de status van afzonderlijke of een subset van zoekparameters wilt identificeren, gebruikt u deze filters:

  • Name. Gebruik deze aanvraag om de status van de zoekparameter op naam te identificeren:
   GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
  • URL. Als u de status van de zoekparameter wilt identificeren op basis van de canonieke id, gebruikt u deze aanvraag:
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
  • Resourcetype. In FHIR worden zoekparameters ingeschakeld op het niveau van de afzonderlijke resource om filteren en ophalen van een specifieke subset van resources toe te staan. Gebruik deze aanvraag om de status van alle zoekparameters te identificeren die aan een resource zijn toegewezen:
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>

Als reactie op de GET-aanvraag voor $status eindpunt, wordt het resourcetype parameters geretourneerd met de status van de zoekparameter. Bekijk het voorbeeldantwoord:

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

De status van zoekparameters bijwerken

Nadat u de status van zoekparameters hebt weergegeven, werkt u de status van zoekparameters bij naar Supported of Disabled.

Notitie

Als u de status van zoekparameters wilt bijwerken, hebt u de Azure RBAC-rol Search Parameter Manager nodig.

De status van de zoekparameter kan worden bijgewerkt voor één zoekparameter of bulksgewijs.

De status van één zoekparameter bijwerken

Als u de status van één zoekparameter wilt bijwerken, gebruikt u deze API-aanvraag:

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

Afhankelijk van uw use-case kunt u de statuswaarde behouden op 'Ondersteund' of 'Uitgeschakeld' voor een zoekparameter. Wanneer u de status Disabled in de aanvraag verzendt, wordt het antwoord geretourneerd omdat PendingDisable een herindextaak moet worden uitgevoerd om koppelingen volledig te verwijderen.

Als u een 400 HTTP-statuscode in het antwoord ontvangt, betekent dit dat er geen unieke overeenkomst is voor geïdentificeerde zoekparameter. Controleer de id van de zoekparameter.

Status van zoekparameter bulksgewijs bijwerken

Als u de status van zoekparameters bulksgewijs wilt bijwerken, moet de PUT-aanvraag de resourcelijst Parameters bevatten in de aanvraagbody. De lijst moet de afzonderlijke zoekparameters bevatten die moeten worden bijgewerkt.

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

Een herindextaak uitvoeren

Nadat u de status van de zoekparameter hebt bijgewerkt naar Supported of Disabled, is de volgende stap het uitvoeren van een taak voor opnieuw indexeren.

Totdat de zoekparameter is geïndexeerd, worden de Enabled en Disabled status van de zoekparameters niet geactiveerd. Bij het opnieuw indexeren van de taak wordt de status bijgewerkt van Supported naar Enabled of PendingDisable naar Disabled.

Een herindextaak kan worden uitgevoerd op basis van de volledige FHIR-servicedatabase of op basis van specifieke zoekparameters. Een herindextaak kan prestatie-intensief zijn. Zie Een herindextaak uitvoeren voor meer informatie.

Notitie

Een document over een mogelijkheidsinstructie is een set gedragingen voor een FHIR-server. Er is een mogelijkheidsinstructie beschikbaar voor het eindpunt /metadata. Enabled zoekparameters worden vermeld in de mogelijkheidsinstructie voor uw FHIR-service.

Veelgestelde vragen

Wat is het gedrag als de query een zoekparameter bevat met de status 'Ondersteund'?

De zoekparameter met de status Ondersteund moet opnieuw worden geïndexeerd. Tot die tijd wordt de zoekparameter niet geactiveerd. Als een query wordt uitgevoerd op een niet-actieve zoekparameter, geeft de FHIR-service een antwoord weer zonder rekening te houden met die zoekparameter. In het antwoord wordt een waarschuwingsbericht weergegeven dat aangeeft dat de zoekparameter niet is geïndexeerd en daarom niet in de query wordt gebruikt. Als u een fout in dergelijke situaties wilt weergeven, gebruikt u de header 'Voorkeur: verwerken' met de waarde 'strikt'. Door deze koptekst in te stellen, worden waarschuwingen gerapporteerd als fouten.

Volgende stappen

Aangepaste zoekparameters definiëren

Notitie

FHIR® is een geregistreerd handelsmerk van HL7 en wordt gebruikt met de machtiging HL7.