Funciones avanzadas de búsqueda de FHIR

En esta página, se explica cómo buscar recursos FHIR con una funcionalidad de consulta más avanzada disponible a través del método projects.locations.datasets.fhirStores.fhir.search. En esta guía, se supone que ya conoces el contenido de Búsqueda de recursos de FHIR.

Modificadores de búsqueda de strings

Una búsqueda de string se establece de manera predeterminada en una coincidencia de prefijo que no distingue entre mayúsculas y minúsculas ni acentos mediante el plegado al formulario estándar de NFC Unicode. Se ignoran los signos de puntuación y los espacios en blanco adicionales.

Los siguientes modificadores están disponibles:

  • :contains hace coincidir los recursos con el valor especificado en cualquier parte de la string, por ejemplo, name:contains=eve coincide con Evelyn y Severine.
  • :exact coincide con toda la string, incluidos las mayúsculas y minúsculas y los acentos, por ejemplo, name:exact=Eve no coincide con eve o Evelyn.

Comparadores y precisión de números, fechas y cantidades

Los valores usados en una búsqueda numérica o de fecha dependen de la precisión del valor del parámetro. Por ejemplo, el número 7.00 tiene un rango implícito de 6.995 que incluye 7.005 exclusive. La fecha 2015-08-12 tiene un rango de 2015-08-12T00:00:00 inclusive a 2015-08-13T00:00:00 exclusive.

La precisión afecta los resultados que se muestran para las comparaciones de igualdad. Por ejemplo, un valor de 7.03 en un recurso coincidiría con una búsqueda de value=7.0, pero no con una búsqueda de value=7.00.

Todos los valores de punto flotante significativos a nivel clínico en FHIR se representan mediante tipos como Decimal y Cantidad que registran la precisión del valor almacenado. Como excepción, hay algunos campos que usan números enteros simples, por ejemplo, para representar una posición en una secuencia, y las búsquedas en esos campos son coincidencias numéricas exactas.

Los siguientes prefijos se aplican a las comparaciones numéricas con un valor singleton. Si no se especifican prefijos, el valor predeterminado es eq.

  • eq: es igual, el valor almacenado exacto dentro del rango definido por la precisión del valor del parámetro
  • ne: no es igual, lo opuesto a eq
  • gt: el valor almacenado exacto es mayor que el valor exacto del parámetro
  • lt: el valor almacenado exacto es menor que el valor exacto del parámetro
  • ge: el valor almacenado exacto es mayor o igual que el valor exacto del parámetro
  • le: el valor almacenado exacto es menor o igual que el valor exacto del parámetro

Los valores de fecha tienen un intervalo implícito según el nivel de especificidad del valor (un año, un mes, un día). Otros tipos de datos, como Rango y Punto, contienen límites superiores e inferiores explícitos. Los siguientes prefijos se aplican a las comparaciones de rangos. Si no se especifican prefijos, el valor predeterminado es eq.

  • eq: es igual, el rango del valor del parámetro que contiene por completo el rango del objetivo
  • ne: no es igual, lo opuesto a eq
  • gt: mayor que, el rango por encima del valor del parámetro se superpone con el rango del objetivo
  • lt: menor que, el rango por debajo del valor del parámetro se superpone con el rango del objetivo
  • ge: Mayor o igual que
  • le: Menor o igual que
  • sa: el rango del valor del parámetro comienza después del rango de destino
  • eb: el rango del valor del parámetro termina antes del rango de destino

Los parámetros de búsqueda de tokens se aplican a casos en los que un valor no es una string arbitraria, sino una entidad en un sistema de nombres. La coincidencia de string en un parámetro de token es exacta.

La mayoría de las búsquedas de tokens se aplican a tipos de datos complejos que contienen un system que es un URI que indica el sistema de nombres del que se toma el valor code. Estas búsquedas admiten las siguientes sintaxis de valores:

  • [parameter]=[code] coincide con el valor code, independientemente de system
  • [parameter]=[system]|[code] debe coincidir con la system y la code especificadas
  • [parameter]=|[code] coincide con code cuando el valor system está vacío
  • [parameter]=[system]| coincide con cualquier code con el valor system dado

Existen varios modificadores que activan la funcionalidad de búsqueda de token alternativa:

  • :not anula las condiciones coincidentes de una búsqueda de token
  • :text realiza una búsqueda de strings (no coincidencia exacta) en el campo text o display asociado con el código, en lugar del valor del código
  • :above toma un parámetro solo con el formato [system]|[code] y coincide con los recursos en los que el código del recurso incluye los parámetros de búsqueda. Para usar este modificador, el system especificado debe existir en el almacén de FHIR como un recurso CodeSystem.
  • :below es como :above, pero coincide si el parámetro de búsqueda incluye el código del recurso.
  • :in toma un solo parámetro con la sintaxis del parámetro de referencia, por ejemplo, code:in=ValueSet/1234. La referencia debe hacer referencia a un recurso ValueSet dentro del mismo almacén FHIR. El modificador coincide con cualquier código que se encuentre en el ValueSet al que se hace referencia.
  • :not-in anula las condiciones de :in

Las búsquedas de tokens también se aplican a los campos booleanos y de URI y a ciertos campos de string en los que solo se permite la coincidencia exacta. En estos casos, el único formato de parámetro es [parameter]=[value].

Búsqueda de valores faltantes

El modificador de búsqueda :missing se puede usar en cualquier parámetro de búsqueda para que coincida según la presencia o la ausencia de cualquier valor en el campo especificado. Por ejemplo, Patient?gender=unknown coincide con los recursos que contienen explícitamente el valor de enumeración unknown para el género, pero como este campo no es obligatorio, es posible que haya otros recursos que no completen el campo. Patient?gender:missing=true puede hacer coincidir esos recursos. Por otro lado, Patient?gender:missing=false coincide con cualquier recurso que propague explícitamente este campo.

El parámetro de búsqueda especial _content realiza una coincidencia de texto en todos los campos que son el objetivo de cualquier parámetro de búsqueda en cualquier recurso. De forma predeterminada, coincide con los recursos que contienen todas las palabras de la consulta, con compatibilidad para operadores adicionales:

  • | es el operador OR, por ejemplo, abc | def | ghi xyz coincidirá con un recurso que contiene xyz y uno o más de abc def ghi.
  • - es el operador NOT, por ejemplo, abc -def coincidirá con un recurso que contiene abc, pero no contiene def.

El parámetro _text realiza el mismo tipo de coincidencia solo en el campo Narrativa que está destinado a contener un resumen legible del contenido de los recursos. La API de Cloud Healthcare no genera automáticamente este resumen, pero admite el parámetro de búsqueda _text si el cliente propagó estos datos cuando creó o actualizó el recurso.

Parámetros de búsqueda compuestos

Cuando se realizan búsquedas con varios parámetros de consulta, hay casos en los que los parámetros de búsqueda individuales combinados con AND coinciden con los resultados no deseados. Los parámetros de búsqueda compuestos son un tipo especial de parámetro de búsqueda que resuelve este problema.

Por ejemplo, el recurso Observation puede contener varios valores en el campo component, cada uno de los cuales contiene un par de code y value. Una búsqueda de Observation?component-code=8867-4&component-value-quantity=lt50 coincidiría con un recurso que tenía un componente que contiene un code de 8867-4 y un componente diferente que contiene un value menor que 50. Esta búsqueda no se puede usar para restringir a una coincidencia de estos dos valores dentro del mismo componente.

Los parámetros de búsqueda compuestos definen un parámetro nuevo que combina otros dos parámetros de búsqueda y define un nivel de anidación dentro del cual ambos deben coincidir. En la consulta, $ une los dos valores. Por ejemplo, Observation tiene un parámetro compuesto component-code-value-quantity que puede restringir el ejemplo anterior a un solo componente mediante la búsqueda de Observation?component-code-value-quantity=8867-4$lt50. La especificación FHIR define estos parámetros y no existen para todas las combinaciones de parámetros de búsqueda.

Los parámetros de búsqueda compuestos no permiten modificadores.

Al igual que con todos los parámetros de búsqueda, puedes encontrar información sobre los parámetros compuestos que admite la API de Cloud Healthcare en la declaración de capacidad o la declaración de cumplimiento FHIR.

Una búsqueda en cadena permite que una búsqueda recorra referencias dentro del contexto de una consulta. La sintaxis básica para una búsqueda en cadena es la siguiente:

[reference parameter]:[resource type].[inner search parameter]=[inner value]

Si el parámetro de referencia solo hace referencia a un tipo de recurso, se puede omitir :[resource type], lo que da como resultado:

[reference parameter].[inner search parameter]=[inner value]

Por ejemplo, Observation tiene un parámetro de búsqueda de referencia subject que puede apuntar a Group, Device, Patient o Location. Para buscar Observations que tengan un subject, que es un Patient que tiene un nombre que comienza con "Joe", puedes buscar Observation?subject:Patient.name=Joe.

Las búsquedas en cadena pueden tener más de un nivel, por ejemplo, Observation?subject:Patient.organization:Organization.name=Acme. En este ejemplo, se puede omitir :Organization porque el parámetro de búsqueda de la organización solo puede apuntar a recursos Organization, lo que da como resultado Observation?subject:Patient.organization.name=Acme.

Si la consulta tiene varios parámetros encadenados, cada cadena se evalúa por separado. Por ejemplo, Patient?general-practitioner.name=Joe&general-practitioner.address-country=Canada coincidiría con un Patient que tenía dos referencias general-practitioner, una llamada "Joe" y la otra con una dirección en Canadá. No hay sintaxis para agrupar estas cláusulas de modo que coincidan solo con Joe de Canadá.

Una búsqueda en cadena inversa coincide con los recursos en función de otros recursos que hacen referencia a ellos. La sintaxis de una búsqueda en cadena inversa es la siguiente:

_has:[resource type]:[reference parameter]:[search parameter]=[value]

Por ejemplo, el recurso Appointment tiene un parámetro de búsqueda patient que hace referencia a un recurso Patient. Para encontrar todos los recursos Patient a los que hace referencia un recurso Appointment con una fecha de 2020-04-01, usa Patient?_has:Appointment:patient:date=eq2020-04-01.

Las cadenas invertidas pueden ser recurrentes, por ejemplo, Practitioner?_has:Encounter:practitioner:_has:Claim:encounter:created=eq2020-04-01 coincidiría con una Practitioner P si hay una Encounter E y una Claim C tal que C tenga una fecha creada de 2020-04-01, C se refiere a E a través de su referencia de encounter y E se refiere a P a través de su referencia de practitioner.

Incluye recursos adicionales en los resultados de la búsqueda

Los parámetros _include y _revinclude solicitan que los resultados de la búsqueda incluyan recursos adicionales ("recursos incluidos") relacionados con los recursos que coinciden directamente con la consulta ("resultados principales"). Usar estos parámetros es más eficiente que realizar una serie de solicitudes para recuperar estos recursos adicionales por separado. En el paquete searchset que muestra la búsqueda, los recursos agregados por estos parámetros se marcarán con entry.search.mode = include para distinguirlos de los resultados principales que tendrán entry.search.mode = match.

La inclusión directa con _include agrega recursos a los que hacen referencia los resultados principales, y la inclusión inversa con _revinclude agrega recursos que hacen referencia a los resultados principales. La referencia a seguir se especifica mediante el nombre de un parámetro de búsqueda, y solo los campos de referencia que están disponibles como parámetros de búsqueda se pueden usar de esta manera.

Los formatos de parámetros para _include y _revinclude son los mismos, con dos o tres valores delimitados por :. El primer valor es el tipo de recurso del que proviene la referencia, el segundo es el nombre del parámetro de búsqueda y el tercer valor opcional limita el tipo de recurso en casos en los que la referencia puede apuntar a más de un tipo.

Por ejemplo:

  • MedicationRequest?_include=MedicationRequest:subject busca en recursos MedicationRequest y, para cada recurso que se muestra, también se muestra el objetivo de la referencia subject, que puede ser Group o Patient, según se define en la especificación FHIR.
  • MedicationRequest?_include=MedicationRequest:subject:Patient es similar, pero solo muestra referencias subject a los recursos Patient.
  • MedicationRequest?_revinclude=Provenance:target busca en recursos MedicationRequest y para cada recurso que se muestra, también se muestra cualquiera de los recursos Provenance en los que la referencia target en Provenance se refiere al recurso coincidente.

El modificador :iterate hace que se evalúe _include o _revinclude de forma iterativa. Este modificador puede seguir una capa adicional de referencias de los resultados incluidos o seguir estructuras recurrentes como Observation:derived-from que hacen referencia a otro Observation. La complejidad de la recursión es limitada.

Por ejemplo:

  • Observation?_include:iterate=Observation:derived-from:Observation busca en recursos Observation y sigue la referencia derivada de los recursos Observation coincidentes y, luego, de los recursos incluidos, y así sucesivamente.
  • MedicationRequest?_revinclude=Provenance:target&_include:iterate=Provenance:agent buscará en MedicationRequest, incluirá recursos Provenance con un target que esté en este conjunto de resultados y, luego, incluirá recursos a los que se hace referencia a través del parámetro agent de esos recursos Provenance.

Se anularán los duplicados de los recursos incluidos para que solo se muestre una copia de un recurso en una página de resultados, incluso si se encuentra a través de varias referencias. Se mostrará el mismo recurso incluido en cada página de resultados donde resultado principal se relacione a él.

Limita los campos que se muestran en los resultados de la búsqueda

El parámetro _elements permite que el cliente solicite que solo se muestre un subconjunto de campos para cada resultado de la búsqueda para reducir el tamaño de la respuesta mediante la omisión de datos innecesarios. El parámetro acepta una lista separada por comas de nombres de elementos básicos en el recurso, por ejemplo, Patient?_elements=identifier,contact,link. Solo estos campos y sus elementos secundarios se incluirán en los recursos mostrados. Los recursos en la respuesta que se modificaron con este parámetro contendrán un valor meta.tag de SUBSETTED para indicar que están incompletos.

La API de Cloud Healthcare tiene compatibilidad limitada con el parámetro _summary, que proporciona subconjuntos predefinidos de campos de recursos similares a _elements:

  • _summary=text muestra solo los campos de nivel superior text, id y meta.
  • _summary=data quita el campo text y muestra todos los demás campos