Parâmetros de pesquisa selecionáveis (Pré-visualização)
Importante
O recurso de parâmetro de pesquisa selecionável está disponível para visualização. As APIs e SDKs de visualização são fornecidos sem um contrato de nível de serviço (SLA). Recomendamos que você não os use para cargas de trabalho de produção. Alguns recursos podem não ser suportados ou podem ter recursos restritos. Para obter mais informações, veja Termos Suplementares de Utilização para Pré-visualizações do Microsoft Azure.
A procura de recursos é fundamental para o serviço FHIR®. Cada recurso no serviço FHIR carrega informações como um conjunto de elementos. Os parâmetros de pesquisa funcionam para consultar as informações nesses elementos. Quando o serviço FHIR é implantado, os parâmetros de pesquisa incorporados são habilitados por padrão. O serviço FHIR realiza pesquisas eficientes extraindo e indexando propriedades específicas dos recursos FHIR durante a ingestão de dados.
Os parâmetros de pesquisa selecionáveis permitem-lhe ativar ou desativar parâmetros de pesquisa incorporados. Esse recurso ajuda você a armazenar mais recursos no espaço de armazenamento alocado e melhorar o desempenho, habilitando apenas os parâmetros de pesquisa necessários.
Para efetuar atualizações de estado nos parâmetros de pesquisa, siga estes passos:
- Obtenha o status dos parâmetros de pesquisa.
- Atualize o status dos parâmetros de pesquisa.
- Execute um trabalho de reindexação.
Neste artigo, demonstramos a sintaxe de pesquisa FHIR em chamadas de API de exemplo com o espaço reservado {{FHIR_URL}} para representar a URL do servidor FHIR.
Obter o status dos parâmetros de pesquisa
Um ponto de extremidade da API ('$status') é fornecido para exibir o status dos parâmetros de pesquisa. Há quatro status para a resposta:
| Status | Description |
|---|---|
| Suportado | O parâmetro de pesquisa é suportado pelo serviço FHIR e você enviou solicitações para habilitar o parâmetro de pesquisa. Execute a operação de reindexação para ser executada de suportado para habilitado. |
| Ativado(a) | O parâmetro de pesquisa está habilitado para pesquisa. Esse status é a próxima etapa após o status suportado. |
| PendingDisable | A desativação do parâmetro de pesquisa está pendente após a execução da operação de reindexação. |
| Desativado | O parâmetro de pesquisa está desativado. |
Para obter o status em todos os parâmetros de pesquisa, use a solicitação a seguir, que retorna uma lista de todos os parâmetros de pesquisa e seu status. Percorra a lista para encontrar o parâmetro de pesquisa de que necessita.
GET {{FHIR_URL}}/SearchParameter/$status
Para identificar o status de um indivíduo ou de um subconjunto de parâmetros de pesquisa, use os filtros a seguir.
- Nome. Para identificar o status do parâmetro de pesquisa pelo nome, use esta solicitação.
GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
- URL. Para identificar o status do parâmetro de pesquisa por seu identificador canônico, use esta solicitação.
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
- Tipo de recurso. No FHIR, os parâmetros de pesquisa são habilitados no nível de recurso individual para permitir a filtragem e a recuperação de um subconjunto específico de recursos. Para identificar o status de todos os parâmetros de pesquisa mapeados para um recurso, use esta solicitação.
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>
Em resposta à solicitação GET para $status ponto de extremidade, o tipo de recurso de parâmetros é retornado com o status do parâmetro de pesquisa. Eis uma resposta de exemplo.
{
"resourceType" : "Parameters",
"parameter" : [
"name" : "searchParameterStatus",
"part" : {
{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/Account-identifier"
},
{
"name" : "status",
"valueString" : "supported"
}
}
]
}
Atualizar o status dos parâmetros de pesquisa
Depois de obter o status dos parâmetros de pesquisa, atualize o status dos parâmetros de pesquisa para Supported ou Disabled.
Nota
Para atualizar o status dos parâmetros de pesquisa, você precisa da função RBAC do Azure Search Parameter Manager .
O status do parâmetro de pesquisa pode ser atualizado para um único parâmetro de pesquisa ou em massa.
Atualizar o status de um único parâmetro de pesquisa
Para atualizar o status de um único parâmetro de pesquisa, use a seguinte solicitação de API.
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"
}
]
}
]
}
Dependendo do seu caso de uso, você pode manter o valor do estado de status 'Suportado' ou 'Desativado' para um parâmetro de pesquisa. Quando você envia o estado Disabled na solicitação, a resposta retorna como PendingDisable porque um trabalho de reindexação deve ser executado para remover totalmente as associações.
Se você receber um código de status HTTP 400 na resposta, isso significa que não há nenhuma correspondência exclusiva para o parâmetro de pesquisa identificado. Verifique o ID do parâmetro de pesquisa.
Atualizar o status do parâmetro de pesquisa em massa
Para atualizar o status dos parâmetros de pesquisa em massa, a solicitação 'PUT' deve ter a lista de recursos 'Parâmetros' no corpo da solicitação. A lista precisa conter os parâmetros de pesquisa individuais que precisam ser atualizados.
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"
}
},
...
]
}
Executar um trabalho de reindexação
Depois de atualizar o status do parâmetro de pesquisa para Supported ou Disabled, a próxima etapa é executar um trabalho de reindexação.
Até que o parâmetro de pesquisa seja indexado, o e Disabled o Enabled status dos parâmetros de pesquisa não são ativados. A execução do trabalho de reindexação atualiza o status de Supported para Enabled ou PendingDisable para Disabled.
Um trabalho de reindexação pode ser executado em todo o banco de dados de serviço FHIR ou em parâmetros de pesquisa específicos. Um trabalho de reindexação pode exigir muito desempenho. Para obter mais informações, consulte Executar um trabalho de reindexação.
Nota
Um documento de instrução de capacidade é um conjunto de comportamentos para um servidor FHIR. Enabled os parâmetros de pesquisa estão listados na declaração de capacidade para o seu serviço FHIR. Uma instrução de capacidade está disponível para o ponto de extremidade /metadata.
Perguntas Mais Frequentes
Qual é o comportamento se a consulta incluir um parâmetro de pesquisa com o status 'Suportado'?
O parâmetro de pesquisa no estado 'Suportado' precisa ser reindexado. Até lá, o parâmetro de pesquisa não é ativado. Se uma consulta for executada em um parâmetro de pesquisa não ativo, o serviço FHIR renderizará uma resposta sem considerar esse parâmetro de pesquisa. Na resposta, haverá uma mensagem de aviso indicando que o parâmetro de pesquisa não foi indexado e não foi usado na consulta. Para renderizar um erro em tais situações, use o cabeçalho 'Prefer: manipulação' com o valor 'strict'. Ao definir esse cabeçalho, os avisos são relatados como erros.
Próximos passos
Definir parâmetros de pesquisa personalizados
Nota
FHIR® é uma marca registada da HL7 e é utilizada com a permissão da HL7.