Execução de um trabalho de reindexação na API do Azure para FHIR

Há cenários em que você pode ter parâmetros de pesquisa ou classificação na API do Azure para FHIR® que ainda não foram indexados. Esse cenário é relevante quando você define seus próprios parâmetros de pesquisa. Até que o parâmetro de pesquisa seja indexado, não poderá ser usado na pesquisa. Este artigo aborda como executar um trabalho de reindexação para indexar parâmetros de pesquisa no banco de dados do serviço FHIR.

Como executar um trabalho de reindexação

Um trabalho de reindexação pode ser executado em todo o banco de dados do serviço FHIR e em parâmetros de pesquisa personalizados específicos.

Executar trabalho de reindexação em todo o banco de dados de serviço FHIR

Para executar um trabalho de reindexação, use a chamada a seguir POST com o recurso formatado Parameters em JSON no corpo da solicitação.

POST {{FHIR URL}}/$reindex 

{ 

“resourceType”: “Parameters”,  

“parameter”: [] 

}

Deixe o "parameter": [] campo em branco (como mostrado) se você não precisar ajustar os recursos alocados para o trabalho de reindexação.

Se a solicitação for bem-sucedida, você receberá um código de status 201 Created além de um Parameters recurso na resposta, como no exemplo a seguir.

HTTP/1.1 201 Created 
Content-Location: https://{{FHIR URL}}/_operations/reindex/560c7c61-2c70-4c54-b86d-c53a9d29495e 

{
  "resourceType": "Parameters",
  "id": "560c7c61-2c70-4c54-b86d-c53a9d29495e",
  "meta": {
    "versionId": "\"4c0049cd-0000-0100-0000-607dc5a90000\""
  },
  "parameter": [
    {
      "name": "id",
      "valueString": "560c7c61-2c70-4c54-b86d-c53a9d29495e"
    },
    {
       "name": "lastModified",
       "valueDateTime": "2023-06-08T04:52:44.0974408+00:00"
    },
    {
       "name": "queuedTime",
       "valueDateTime": "2023-06-08T04:52:44.0974406+00:00"
    },
    {
       "name": "totalResourcesToReindex",
       "valueDecimal": 0.0
    },
    {
       "name": "resourcesSuccessfullyReindexed",
       "valueDecimal": 0.0
    },
    {
       "name": "progress",
       "valueDecimal": 0.0
    },
    {
       "name": "status",
       "valueString": "Queued"
    },
    {
       "name": "maximumConcurrency",
       "valueDecimal": 3.0
    },
    {
        "name": "queryDelayIntervalInMilliseconds",
        "valueDecimal": 500.0
    },
    {
        "name": "maximumNumberOfResourcesPerQuery",
        "valueDecimal": 100.0
    }
  ]
}

Executar trabalho de reindexação em relação a um parâmetro de pesquisa personalizado específico

Para executar um trabalho de reindexação em um parâmetro de pesquisa personalizado específico, use a chamada a seguir POST com o recurso formatado Parameters em JSON no corpo da solicitação.

POST {{FHIR_URL}}/$reindex 
content-type: application/fhir+json
{ 

"resourceType": "Parameters",  

"parameter": [
    {
      "name": "targetSearchParameterTypes",
      "valueString": "{url of custom search parameter. In case of multiple custom search parameters, url list can be comma separated.}"
    }
] 

}

Como verificar o status de um trabalho de reindexação

Depois de iniciar um trabalho de reindexação, você pode verificar o status do trabalho usando a chamada a seguir.

GET {{FHIR URL}}/_operations/reindex/{{reindexJobId}

Veja um exemplo de resposta.

{
    "resourceType": "Parameters",
    "id": "560c7c61-2c70-4c54-b86d-c53a9d29495e",
    "meta": {
        "versionId": "138087"
    },
    "parameter": [
        {
            "name": "id",
            "valueString": "560c7c61-2c70-4c54-b86d-c53a9d29495e"
        },
        {
            "name": "startTime",
            "valueDateTime": "2023-06-08T04:54:53.2943069+00:00"
        },
        {
            "name": "endTime",
            "valueDateTime": "2023-06-08T04:54:54.4052272+00:00"
        },
        {
            "name": "lastModified",
            "valueDateTime": "2023-06-08T04:54:54.4053002+00:00"
        },
        {
            "name": "queuedTime",
            "valueDateTime": "2023-06-08T04:52:44.0974406+00:00"
        },
        {
            "name": "totalResourcesToReindex",
            "valueDecimal": 2.0
        },
        {
            "name": "resourcesSuccessfullyReindexed",
            "valueDecimal": 2.0
        },
        {
            "name": "progress",
            "valueDecimal": 100.0
        },
        {
            "name": "status",
            "valueString": "Completed"
        },
        {
            "name": "maximumConcurrency",
            "valueDecimal": 3.0
        },
        {
            "name": "resources",
            "valueString": "{{LIST_OF_IMPACTED_RESOURCES}}"
        },
        {
            "name": "resourceReindexProgressByResource (CountReindexed of Count)",
            "valueString": "{{RESOURCE_TYPE:REINDEXED_COUNT OF TOTAL_COUNT}}"
        },
        {
            "name": "searchParams",
            "valueString": "{{LIST_OF_SEARCHPARAM_URLS}}h"
        },
        {
            "name": "queryDelayIntervalInMilliseconds",
            "valueDecimal": 500.0
        },
        {
            "name": "maximumNumberOfResourcesPerQuery",
            "valueDecimal": 100.0
        }
    ]
}

As informações a seguir são mostradas na resposta.

• totalResourcesToReindex: inclui o número total de recursos que estão sendo reindexados neste trabalho.

• resourcesSuccessfullyReindexed: o número total de recursos que já foram reindexados neste trabalho.

• progress: Reindexar a porcentagem concluída do trabalho. Calculado como resourcesSuccessfullyReindexed/totalResourcesToReindex x 100.

• status: indica se o trabalho de reindexação está enfileirado, em execução, concluído, com falha ou cancelado.

• resources: lista todos os tipos de recursos afetados pelo trabalho de reindexação.

• resourceReindexProgressByResource (CountReindexed of Count): Fornece uma contagem reindexada da contagem total, por tipo de recurso. Nos casos em que a reindexação para um tipo de recurso específico é enfileirada, somente Count é fornecido.

• searchParams: lista a url dos parâmetros de pesquisa afetados pelo trabalho de reindexação.

Excluir um trabalho de reindexação

Se você precisar cancelar um trabalho de reindexação, use uma chamada de exclusão e especifique a ID do trabalho de reindexação:

Delete {{FHIR URL}}/_operations/reindex/{{reindexJobId}

Considerações sobre o desempenho

Um trabalho de reindexação pode exigir alto desempenho. Implementamos alguns controles de limitação para ajudá-lo a gerenciar como um trabalho de reindexação é executado em seu banco de dados.

A seguir está uma tabela que descreve os parâmetros disponíveis, os padrões e os intervalos recomendados. Você pode usar esses parâmetros para acelerar o processo (usar mais computação) ou retardar o processo (usar menos computação). Por exemplo, você pode executar o trabalho de reindexação em um momento de tráfego baixo e aumentar sua computação para fazê-lo mais rapidamente. Você também pode usar as configurações para garantir um baixo uso de computação e executá-la por dias em segundo plano.

Se você quiser usar qualquer um dos parâmetros anteriores, poderá passá-los para o recurso Parameters ao iniciar o trabalho de reindexação.

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "maximumConcurrency",
      "valueInteger": "3"
    },
    {
      "name": "targetDataStoreUsagePercentage",
      "valueInteger": "20"
    },
    {
      "name": "queryDelayIntervalInMilliseconds",
      "valueInteger": "1000"
    },
    {
      "name": "maximumNumberOfResourcesPerQuery",
      "valueInteger": "1"
    }
  ]
}

Próximas etapas

Neste artigo, você aprendeu como iniciar um trabalho de reindexação. Para saber como definir novos parâmetros de pesquisa que exigem o trabalho de reindexação, confira