Buscar vacunas
Busque vacunas usando FHIR R4 4.0.1.
Recurso category: inmunización.
Punto final
| Método | Punto final |
|---|---|
GET | /api/fhir/r4/Immunization |
POST | /api/fhir/r4/Immunization/_search |
Utilice la URL base R4 de la instancia de DDFS. Envíe Authorization: Bearer <access-token> y acepte application/fhir+json.
GET utiliza parámetros de consulta. La búsqueda POST utiliza los mismos parámetros soportados en un cuerpo application/x-www-form-urlencoded y necesita el mismo permiso de búsqueda. Siga la URL Bundle.link proporcionada por el servidor con la relación next sin cambios. Consulte controles de búsqueda compartida.
Parámetros
| Parámetro | Ubicación | Necesario | Tipo | Descripción |
|---|---|---|---|---|
identifier | Cuerpo de la pantalla o consulta | Nº | token | Coincide con los identificadores de nivel superior del recurso mediante el valor system|value, |value (sin sistema) o system|. Solo admite un token no modificado: multipleAnd=false y multipleOr=false. No se admiten modificadores. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/clinical-identifier. |
_count | Consulta o cuerpo del formulario | Nº | número | Limitar el número de coincidencias devueltas por página. Consulte los controles de búsqueda compartida para ver los valores soportados y el comportamiento de solo recuento. |
_total | Consulta o cuerpo del formulario | Nº | token | La solicitud admite la manipulación total; el nombre de control no implica compatibilidad con todos los modos totales de FHIR. |
_id | Cuerpo de la pantalla o consulta | No | token | Filtrar por ID de recurso lógico. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Resource-id. |
_lastUpdated | Cuerpo de consulta o formulario | Nº | date | Filtre por _lastUpdated mediante la semántica de búsqueda date soportada. Definición: ddfs-r4-last-updated-date.json. |
_profile | Cuerpo de la pantalla o consulta | Nº | URI | Filtrar por URI de perfil. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Resource-profile. |
_tag | Cuerpo de la pantalla o consulta | Nº | token | Filtrar por una etiqueta de metadatos de recurso. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Resource-tag. |
patient | Cuerpo de la pantalla o consulta | Nº | reference | Filtre por patient mediante la semántica de búsqueda de referencia soportada. Definición: ddfs-r4-patient-reference-identifier-modifier.json. |
status | Cuerpo de la pantalla o consulta | Nº | token | Filtre por status mediante la semántica de búsqueda de token soportada. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Immunization-status. |
vaccine-code | Cuerpo de la pantalla o consulta | Nº | token | Filtre por vaccine-code mediante la semántica de búsqueda de token soportada. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code. |
date | Cuerpo de la pantalla o consulta | No | date | Filtre por date mediante la semántica de búsqueda date soportada. Definición: ddfs-r4-date-date.json. |
_revinclude | Cuerpo de la pantalla o consulta | Nº | especial | Valores permitidos: Provenance:target. El permiso de lectura de proveniencia coincidente también es necesario. |
Autorización
| Contexto | Ámbito de recurso |
|---|---|
| Definición de servidor de recursos/token emitido | system/Immunization.s |
| Solicitud de token/otorgamiento de cliente | ddfssystem/Immunization.s |
Se siguen aplicando restricciones de recursos. Utilice el privilegio mínimo necesario para esta operación; consulte authentication and scope configuration.
Comportamiento
Devolver recursos de vacunación coincidentes en un paquete searchset. Los filtros y las restricciones del emisor de llamada determinan qué coincidencias se pueden devolver. No infiera modificadores, cadenas, valores repetidos o modos de control de resultados no admitidos de la especificación FHIR base.
- Comportamiento de búsqueda compartida: semántica de operación compartida.
- Guía de recursos de inmunización: requisitos y restricciones específicos de los recursos.
- R4 CapabilityStatement y metadatos R4: capacidades soportadas.
Ejemplo de solicitud
Sustituya los ID lógicos de ejemplo, los ID de versión y los valores de conexión por valores para el flujo de trabajo.
GET /api/fhir/r4/Immunization?patient=Patient/example&vaccine-code=http://hl7.org/fhir/sid/cvx%7C207&status=completed&date=ge2026-01-01&date=lt2027-01-01
Respuestas
| Estado correcto | Significado |
|---|---|
| 200 | Un paquete de searchset. |
Para conocer los estados de error comunes y los cuerpos de error con formato FHIR, consulte OperationOutcome errors. Las respuestas de autenticación/autorización siguen la política compartida; un recurso protegido se puede ocultar como 404. Consulte también respuestas de interacción.
Definición de FHIR
Definición de FHIR R4: https://hl7.org/fhir/R4/immunization.html. Perfil canónico URI: http://hl7.org/fhir/StructureDefinition/Immunization.