Parámetros de búsqueda seleccionables (versión preliminar)
Importante
La funcionalidad de parámetro de búsqueda seleccionable está disponible para la versión preliminar. Las API y los SDK de versión preliminar se proporcionan sin un acuerdo de nivel de servicio (SLA). Se recomienda no usarlos para las cargas de trabajo de producción. Es posible que algunas características no sean compatibles o que sus funcionalidades estén limitadas. Para más información, consulte Términos de uso complementarios de las Versiones Preliminares de Microsoft Azure.
La búsqueda de recursos es fundamental para el servicio FHIR®. Cada recurso del servicio FHIR incluye información como un conjunto de elementos. Los parámetros de búsqueda funcionan para consultar la información de estos elementos. Cuando se implementa el servicio FHIR, los parámetros de búsqueda integrados están habilitados de forma predeterminada. El servicio FHIR realiza búsquedas eficaces mediante la extracción e indexación de propiedades específicas de recursos de FHIR durante la ingesta de datos.
Los parámetros de búsqueda seleccionables permiten habilitar o deshabilitar parámetros de búsqueda integrados. Esta funcionalidad le ayuda a almacenar más recursos en el espacio de almacenamiento asignado y a mejorar el rendimiento habilitando solo los parámetros de búsqueda que necesita.
Para realizar actualizaciones de estado en los parámetros de búsqueda, siga estos pasos principales:
- Obtiene el estado de los parámetros de búsqueda.
- Actualice el estado de los parámetros de búsqueda.
- Ejecute un trabajo de reindexación.
En este artículo, se muestra la sintaxis de búsqueda de FHIR en llamadas API de ejemplo con el marcador de posición {{FHIR_URL}} para representar la dirección URL del servidor FHIR.
Obtener el estado de los parámetros de búsqueda
Se proporciona un punto de conexión de API ("$status") para ver el estado de los parámetros de búsqueda. Hay cuatro estados para la respuesta:
| Estado | Descripción |
|---|---|
| Compatible | El servicio FHIR admite el parámetro de búsqueda y ha enviado solicitudes para habilitar el parámetro de búsqueda. Ejecute la operación de reindexación para que se ejecute desde compatible a habilitada. |
| Habilitado | El parámetro de búsqueda está habilitado para la búsqueda. Este estado es el siguiente paso después del estado admitido. |
| PendienteDisable | Deshabilitar el parámetro de búsqueda está pendiente después de la ejecución de la operación de reindexación. |
| Deshabilitado | El parámetro de búsqueda está deshabilitado. |
Para obtener el estado en todos los parámetros de búsqueda, use la siguiente solicitud. Esta solicitud devuelve una lista de todos los parámetros de búsqueda y su estado. Desplácese por la lista para encontrar el parámetro de búsqueda que necesita.
GET {{FHIR_URL}}/SearchParameter/$status
Para identificar el estado de un elemento individual o un subconjunto de parámetros de búsqueda, use estos filtros:
- Nombre. Para identificar el estado del parámetro de búsqueda por nombre, use esta solicitud:
GET {{FHIR_URL}}/SearchParameter/$status?code=<name of search parameter/ sub string>
- Dirección URL. Para identificar el estado del parámetro de búsqueda por su identificador canónico, use esta solicitud:
GET {{FHIR_URL}}/SearchParameter/$status?url=<SearchParameter url>
- Tipo de recurso. En FHIR, los parámetros de búsqueda se habilitan en el nivel de recurso individual para permitir el filtrado y la recuperación de un subconjunto específico de recursos. Para identificar el estado de todos los parámetros de búsqueda asignados a un recurso, use esta solicitud:
GET {{FHIR_URL}}/SearchParameter/$status?resourcetype=<ResourceType name>
En respuesta a la solicitud GET para $status punto de conexión, el tipo de recurso parameters se devuelve con el estado del parámetro de búsqueda. Vea la respuesta de ejemplo:
{
"resourceType" : "Parameters",
"parameter" : [
"name" : "searchParameterStatus",
"part" : {
{
"name" : "url",
"valueString" : "http://hl7.org/fhir/SearchParameter/Account-identifier"
},
{
"name" : "status",
"valueString" : "supported"
}
}
]
}
Actualización del estado de los parámetros de búsqueda
Después de obtener el estado de los parámetros de búsqueda, actualice el estado de los parámetros de búsqueda a Supported o Disabled.
Nota:
Para actualizar el estado de los parámetros de búsqueda, necesita el rol RBAC de Azure RBAC de Search Parameter Manager .
El estado del parámetro de búsqueda se puede actualizar para un único parámetro de búsqueda o de forma masiva.
Actualización de un único estado de parámetro de búsqueda
Para actualizar el estado de un único parámetro de búsqueda, use esta solicitud 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"
}
]
}
]
}
En función de su caso de uso, puede mantener el valor de estado en "Supported" o "Disabled" para un parámetro de búsqueda. Al enviar el estado Disabled en la solicitud, la respuesta devuelve como PendingDisable porque un trabajo de reindexación debe ejecutarse para quitar completamente las asociaciones.
Si recibe un código de estado HTTP 400 en la respuesta, significa que no hay ninguna coincidencia única para el parámetro de búsqueda identificado. Compruebe el identificador del parámetro de búsqueda.
Actualización del estado de los parámetros de búsqueda en masa
Para actualizar el estado de los parámetros de búsqueda de forma masiva, la solicitud "PUT" debe tener la lista de recursos "Parameters" en el cuerpo de la solicitud. La lista debe contener los parámetros de búsqueda individuales que deben actualizarse.
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"
}
},
...
]
}
Ejecución de un trabajo de reindexación
Después de actualizar el estado del parámetro de búsqueda a Supported o Disabled, el siguiente paso es ejecutar un trabajo de reindexación.
Hasta que se indexe el parámetro de búsqueda, el Enabled estado y Disabled de los parámetros de búsqueda no se activan. La ejecución del trabajo de reindexación actualiza el estado de Supported a Enabled o PendingDisable a Disabled.
Un trabajo de reindexación se puede ejecutar en toda la base de datos del servicio FHIR o en parámetros de búsqueda específicos. Un trabajo de reindexación puede ser intensivo en el rendimiento. Para obtener más información, consulte Ejecución de un trabajo de reindexación.
Nota:
Un documento de instrucción de funcionalidad es un conjunto de comportamientos para un servidor FHIR. Hay disponible una instrucción de funcionalidad para el punto de conexión /metadata. Enabled Los parámetros de búsqueda se muestran en la instrucción de funcionalidad del servicio FHIR.
Preguntas más frecuentes
¿Cuál es el comportamiento si la consulta incluye un parámetro de búsqueda con el estado "Supported"?
El parámetro de búsqueda en el estado "Supported" debe volver a indexarse. Hasta entonces, el parámetro de búsqueda no se activa. En caso de que una consulta se ejecute en un parámetro de búsqueda no activo, el servicio FHIR representará una respuesta sin tener en cuenta ese parámetro de búsqueda. En la respuesta, habrá un mensaje de advertencia que indica que el parámetro de búsqueda no se indizó y, por tanto, no se usó en la consulta. Para representar un error en tales situaciones, use el encabezado "Prefer: handling" con el valor "strict". Al establecer este encabezado, las advertencias se notificarán como errores.
Pasos siguientes
Definición de parámetros de búsqueda personalizados
Nota:
FHIR® es una marca registrada de HL7 y se usa con su permiso.
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente las Cuestiones de GitHub como mecanismo de retroalimentación para el contenido y lo sustituiremos por un nuevo sistema de retroalimentación. Para más información, consulta: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de