Seçilebilir arama parametreleri (Önizleme)

Makale
02/09/2024

Önemli

Seçilebilir arama parametresi özelliği önizleme için kullanılabilir. Önizleme API'leri ve SDK'ları hizmet düzeyi sözleşmesi (SLA) olmadan sağlanır. Bunları üretim iş yükleri için kullanmamanızı öneririz. Bazı özellikler desteklenmeyebilir veya kısıtlı özelliklere sahip olabilir. Daha fazla bilgi için bkz. Microsoft Azure Önizlemeleri Ek Kullanım Koşulları.

Kaynak aramak, FHIR® hizmetinin temelidir. FHIR hizmetindeki her kaynak, bilgileri bir öğe kümesi olarak taşır. Arama parametreleri, bu öğelerdeki bilgileri sorgulamak için çalışır. FHIR hizmeti dağıtıldığında, yerleşik arama parametreleri varsayılan olarak etkinleştirilir. FHIR hizmeti, verilerin alımı sırasında FHIR kaynaklarından belirli özellikleri ayıklayıp dizine alarak verimli aramalar gerçekleştirir.

Seçilebilir arama parametreleri, yerleşik arama parametrelerini etkinleştirmenize veya devre dışı bırakmanıza olanak tanır. Bu özellik, ayrılmış depolama alanında daha fazla kaynak depolamanıza ve yalnızca ihtiyacınız olan arama parametrelerini etkinleştirerek performansı artırmanıza yardımcı olur.

Arama parametrelerinde durum güncelleştirmeleri gerçekleştirmek için şu ana adımları izleyin:

Arama parametrelerinin durumunu alın.
Arama parametrelerinin durumunu güncelleştirin.
Reindex işi yürütme.

Bu makalede, FHIR sunucu URL'sini temsil eden {{FHIR_URL}} yer tutucusuyla örnek API çağrılarında FHIR arama söz dizimini göstereceğiz.

Arama parametrelerinin durumunu alma

Arama parametrelerinin durumunu görüntülemek için bir API uç noktası ('$status') sağlanır. Yanıt için dört durum vardır:

Çalıştırma Durumu	Açıklama
Desteklenir	Arama parametresi FHIR hizmeti tarafından desteklenir ve arama parametresini etkinleştirmek için istekler gönderdiniz. Desteklenenden etkine kadar çalıştırmak için reindex işlemini yürütür.
Etkin	Arama parametresi arama için etkinleştirilir. Bu durum, desteklenen durumdan sonraki adımdır.
PendingDisable	Reindex işlemi yürütüldikten sonra arama parametresinin devre dışı bırakılması bekleniyor.
Devre dışı	Arama parametresi devre dışı bırakıldı.

Tüm arama parametrelerinde durumu almak için aşağıdaki isteği kullanın. Bu istek, tüm arama parametrelerinin ve durumlarının listesini döndürür. İhtiyacınız olan arama parametresini bulmak için listeyi kaydırın.

GET {{FHIR_URL}}/SearchParameter/$status

Arama parametrelerinin tek tek veya bir alt kümesinin durumunu belirlemek için şu filtreleri kullanın:

Adı. Arama parametresi durumunu ada göre tanımlamak için şu isteği kullanın:

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

URL. Arama parametresi durumunu kurallı tanımlayıcısıyla tanımlamak için şu isteği kullanın:

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

Kaynak türü. FHIR'de arama parametreleri, belirli bir kaynak alt kümesinin filtrelenmesine ve alınmasına izin vermek için tek tek kaynak düzeyinde etkinleştirilir. Bir kaynağa eşlenen tüm arama parametrelerinin durumunu belirlemek için şu isteği kullanın:

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

$status uç noktasına GET isteğine yanıt olarak, parametre kaynak türü arama parametresinin durumuyla döndürülür. Örnek yanıta bakın:

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

Arama parametrelerinin durumunu güncelleştirme

Arama parametrelerinin durumunu aldıktan sonra, arama parametrelerinin durumunu veya Disabledolarak Supported güncelleştirin.

Not

Arama parametrelerinin durumunu güncelleştirmek için Arama Parametresi Yöneticisi Azure RBAC rolüne ihtiyacınız vardır.

Arama parametresi durumu tek bir arama parametresi için veya toplu olarak güncelleştirilebilir.

Tek bir arama parametresi durumunu güncelleştirme

Tek bir arama parametresinin durumunu güncelleştirmek için şu API isteğini kullanın:

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

Kullanım örneğine bağlı olarak, bir arama parametresi için durum durumu değerini 'Destekleniyor' veya 'Devre Dışı' olarak tutabilirsiniz. İstekteki durumu Disabled gönderdiğinizde, yeniden dizin oluşturma işinin ilişkilendirmeleri tamamen kaldırmak için çalışması gerektiğinden yanıt olarak PendingDisable döndürülüyor.

Yanıtta 400 HTTP durum kodu alırsanız, tanımlanan arama Parametresi için benzersiz eşleşme olmadığı anlamına gelir. Arama parametresi kimliğini denetleyin.

Arama parametresi durumunu toplu olarak güncelleştirme

Arama parametrelerinin durumunu toplu olarak güncelleştirmek için 'PUT' isteğinin istek gövdesinde 'Parametreler' kaynak listesi olmalıdır. Listenin güncelleştirilmesi gereken tek tek arama parametrelerini içermesi gerekir.

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

Reindex işi yürütme

Arama parametresi durumunu Supported veya Disabledolarak güncelleştirdikten sonra, sonraki adım bir reindex işi yürütmektir.

Arama parametresi dizine alınana Enabled kadar, arama parametrelerinin ve Disabled durumu etkinleştirilmez. İş yürütmeyi yeniden dizine alma işlemi, veya olarak SupportedEnabledPendingDisableDisableddurumunu güncelleştirir.

Bir reindex işi tüm FHIR hizmet veritabanında veya belirli arama parametrelerinde yürütülebilir. Reindex işi performans açısından yoğun olabilir. Daha fazla bilgi için bkz . Yeniden dizin oluşturma işi çalıştırma.

Not

Yetenek deyimi belgesi, FHIR sunucusu için bir davranış kümesidir. /metadata uç noktası için bir yetenek deyimi kullanılabilir. Enabled arama parametreleri FHIR hizmetinizin yetenek deyiminde listelenir.

Sık Sorulan Sorular

Sorgu 'Destekleniyor' durumuna sahip bir arama parametresi içeriyorsa davranış nedir?

'Desteklenen' durumundaki arama parametresinin yeniden dizine alınması gerekir. O zamana kadar arama parametresi etkinleştirilmez. Etkin olmayan bir arama parametresinde bir sorgunun yürütülmesi durumunda FHIR hizmeti bu arama parametresini dikkate almadan bir yanıt işler. Yanıtta, arama parametresinin dizine alınmadığını ve bu nedenle sorguda kullanılmadığını belirten bir uyarı iletisi olacaktır. Böyle durumlarda hata işlemek için 'Prefer: handling' üst bilgisini 'strict' değeriyle kullanın. Bu üst bilgi ayarlandığında, uyarılar hata olarak bildirilir.

Sonraki adımlar

Özel arama parametreleri tanımlama

Not

FHIR®, HL7'nin tescilli ticari markasıdır ve HL7'nin izniyle kullanılır.

Aracılığıyla paylaş