Parámetros de búsqueda FHIR
Consulte los recursos de DDFS FHIR R4 y R6 con los nombres de parámetros, la sintaxis de valores y los controles de resultados anunciados para el punto final desplegado.
DDFS proporciona puntos finales de búsqueda específicos de la versión para las boletas FHIR R4 (4.0.1) y FHIR R64 (6.0.0-ballot4). Utilice el punto final para la versión seleccionada:
- FHIR R4:
GET https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/{Resource} - Boleta electoral de FHIR R64:
GET https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/{Resource}
Para un tipo de recurso soportado, una búsqueda correcta devuelve un valor FHIR Bundle cuyo valor type es searchset.
El soporte de búsqueda puede variar según la versión y el recurso. Antes de agregar un filtro, confírmelo en el CapabilityStatement devuelto por el punto final de metadatos desplegado y en la definición de SearchParameter publicada aplicable. Consulte también Parámetros de Control y Búsqueda Soportados.
Controles de búsqueda comunes
Utilice un control solo cuando se publique para el recurso de destino:
| Parámetro | Tipo | Descripción |
|---|---|---|
_count | control de número o resultado | Solicita el tamaño máximo de página. Una página devuelta puede contener menos coincidencias. |
_total | control de resultados | Solicita un modo de manejo total soportado. Bundle.total sigue siendo opcional, por lo que los clientes deben manejar su ausencia. |
_id | token | Filtra por ID de recurso lógico. |
_lastUpdated | fecha | Filtra por el último instante actualizado del recurso. |
_profile | uri (R4); referencia (R6) | Filtros por URL de perfil canónico. El tipo de parámetro de búsqueda anunciado difiere según la versión de FHIR. |
_tag | token | Filtra por un token de etiqueta de recurso. |
Para la paginación, siga la URL en Bundle.link cuya relación es next literalmente. No cree una URL de paginación ni modifique la consulta proporcionada por el servidor.
Resultados de búsqueda vacíos
Una búsqueda correcta sin entradas devuelve un Bundle con type=searchset. La respuesta omite entry en lugar de devolver una matriz vacía. Los clientes deben manejar un entry ausente como una recopilación vacía.
El siguiente extracto de respuesta muestra el resultado vacío. Se omiten otros campos de respuesta del extracto.
{
"resourceType": "Bundle",
"type": "searchset"
}
Bundle.total es opcional. Su presencia depende del modo de manipulación total soportado; no es necesario que procese un resultado vacío.
Tipos de valor y sintaxis
Utilice la unidad de valor definida para el parámetro de búsqueda anunciado.
| Tipo | Sintaxis | Ejemplo |
|---|---|---|
| fecha | Una fecha FHIR, fecha/hora o instantánea, precedida opcionalmente por un comparador compatible. | birthdate=ge2020-01-01 |
| cadena | Una cadena, seguida opcionalmente por un modificador admitido en el nombre del parámetro. | name:exact=smith |
| token | code o system|code. | status=active |
| reference | Una referencia FHIR, un modificador de referencia admitido o una cadena admitida. | patient=Patient/{rid} |
| URI | Un valor de URI. | url=https://example.com/topic |
| número | Valor numérico. | _count=20 |
Buscar componentes de dirección
El parámetro address busca Organization.address y Location.address en R4 y Location.address en la boleta 4 de R6. Se excluyen las direcciones de contacto de la organización.
Cada línea de dirección, ciudad, distrito, estado, país, código postal o valor de texto coincide por separado. Los valores no se concatenan en una dirección apta para búsqueda. Se excluyen el uso, el tipo y el período de la dirección.
- La coincidencia por defecto utiliza un prefijo no sensible a mayúsculas/minúsculas y acentos. Por ejemplo,
address=Austpuede coincidir con la ciudadAustin. address:exactutiliza la coincidencia sensible a mayúsculas/minúsculas y acentos en todo el componente. Por ejemplo,address:exact=Austincoincide con ese valor de componente completo.- Solo se admite el modificador
:exact. Valores de búsqueda de codificación URL al crear una solicitud.
GET /api/fhir/r4/Organization?address=Aust
GET /api/fhir/r4/Location?address:exact=Austin
GET /api/fhir/r6-ballot4/Location?address=Aust
Consulte las definiciones específicas de la versión en R4 address y R6 address, y las tablas de parámetros de búsqueda soportadas.
Comparadores, modificadores y cadenas
Utilice solo los comparadores, modificadores y cadenas anunciados para la versión de parámetro, recurso y FHIR.
- Un parámetro de fecha puede dar a conocer comparadores como
eq,ne,gt,lt,ge,le,sa,ebyap. - Un parámetro de cadena puede anunciar un modificador soportado, como
:exact. - Un parámetro de referencia puede anunciar
:identifiero cadenas comopatient.identifier,device.manufactureropractitioner.name. - Cuando el punto final permita un rango delimitado, repita el nombre del parámetro real, por ejemplo,
date=ge2026-01-01&date=le2026-12-31.
Ejemplos
GET /api/fhir/r4/Patient?birthdate=ge2020-01-01&birthdate=le2025-12-31
Accept: application/fhir+json
GET /api/fhir/r6-ballot4/Observation?patient=Patient/{rid}&code=http%3A%2F%2Floinc.org%7C8867-4&_count=20
Accept: application/fhir+json
GET /api/fhir/r6-ballot4/Observation?device.manufacturer=Acme
Accept: application/fhir+json
GET /api/fhir/r6-ballot4/Observation?_count=20
Accept: application/fhir+json
Mantener valores de búsqueda confidenciales fuera de la URL
Utilice GET para búsquedas ordinarias. Cuando los valores de búsqueda confidenciales no deben aparecer en la URL de solicitud, utilice el punto final /_search de POST del recurso soportado. Envíe los parámetros de búsqueda en el cuerpo de la solicitud con Content-Type: application/x-www-form-urlencoded.
La colocación de valores de búsqueda en un cuerpo POST los mantiene fuera de la URL de solicitud, pero no protege PHI por sí sola. Siga usando HTTPS y aplique las salvaguardas de registro, control de acceso y retención en la siguiente sección.
Utilice la búsqueda POST solo para los tipos de recursos y los parámetros de búsqueda soportados en la superficie de la API de FHIR seleccionada. Los siguientes ejemplos buscan un paciente en la superficie de la API R4. El token de acceso debe otorgar permiso de búsqueda de paciente. Al configurar la solicitud de token y permiso de cliente, utilice ddfssystem/Patient.s para el acceso de solo búsqueda o ddfssystem/Patient.rs para el acceso de búsqueda y lectura del paciente. Consulte Creación de aplicaciones integradas para OAuth de DDFS para la configuración de OAuth y Autenticación y ámbitos para obtener la sintaxis del ámbito. Una solicitud correcta devuelve 200 OK con un paquete searchset.
curl -sS -X POST \ -H "Authorization: Bearer <access-token>" \ -H "Accept: application/fhir+json" \ -H "Content-Type: application/x-www-form-urlencoded" \ --data-urlencode "identifier=<identifier-system>|<identifier-value>" \ "https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Patient/_search"$headers = @{ Authorization = "Bearer <access-token>" Accept = "application/fhir+json" } $body = @{ identifier = "<identifier-system>|<identifier-value>" } Invoke-RestMethod ` -Method Post ` -Uri "https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Patient/_search" ` -Headers $headers ` -ContentType "application/x-www-form-urlencoded" ` -Body $body
Protección de datos de búsqueda confidenciales
Las cadenas de consulta de búsqueda FHIR pueden contener identificadores, nombres, fechas, códigos, referencias y otra información de salud protegida (PHI). Trate toda la URL como datos confidenciales.
- Utilice valores de parámetros HTTPS y de porcentaje de código con una biblioteca de URL compatible con estándares. No codifique los separadores de parámetros agregados por la biblioteca por segunda vez.
- No registre URL de búsqueda completas ni cuerpos de búsqueda POST en logs de aplicación, proxy, acceso, análisis o soporte. Redactar u omitir valores de búsqueda antes de registrar.
- No pegue direcciones URL de búsqueda no modificadas en tickets, chat ni diagnósticos. Comparta solo los datos mínimos necesarios para investigar una solicitud.
- Aplique controles de acceso y requisitos de retención a cualquier dato de diagnóstico aprobado que pueda contener PHI.