Buscar en DocumentReference

Busque DocumentReference mediante FHIR R4 4.0.1.

Recurso category: DocumentReference.

Punto final

MétodoPunto final
GET/api/fhir/r4/DocumentReference
POST/api/fhir/r4/DocumentReference/_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ámetroUbicaciónNecesarioTipoDescripción
identifierCuerpo de la pantalla o consultaNotokenCoincide con masterIdentifier y identifier mediante un token no modificado: value, system|value, |value (sin sistema) o system|. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/clinical-identifier.
_countCuerpo de la pantalla o consultaNºnúmeroLimitar 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.
_totalCuerpo de la pantalla o consultaNºtokenLa solicitud admite la manipulación total; el nombre de control no implica compatibilidad con todos los modos totales de FHIR.
_idCuerpo de la pantalla o consultaNºtokenFiltrar por ID de recurso lógico. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Resource-id.
_lastUpdatedCuerpo de la pantalla o consultaNºdateFiltre por _lastUpdated mediante la semántica de búsqueda date soportada. Definición: ddfs-r4-last-updated-date.json.
_profileCuerpo de la pantalla o consultaNoURIFiltrar por URI de perfil. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Resource-profile.
_tagCuerpo de la pantalla o consultaNºtokenFiltrar por una etiqueta de metadatos de recurso. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/Resource-tag.
categoryCuerpo de la pantalla o consultaNºtokenEl token busca en los campos DocumentReference correspondientes. Los valores de estado son actuales, sustituidos e introducidos en error. El estado tiene el sistema implícito http://hl7.org/fhir/document-reference-status; utilice un code, system|code o system|. Un token sin sistema explícito, como |current, no coincide. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/DocumentReference-category.
typeCuerpo de la pantalla o consultaNotokenEl token busca en los campos DocumentReference correspondientes. Los valores de estado son actuales, sustituidos e introducidos en error. El estado tiene el sistema implícito http://hl7.org/fhir/document-reference-status; utilice un code, system|code o system|. Un token sin sistema explícito, como |current, no coincide. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/DocumentReference-type.
statusConsulta o cuerpo del formularioNºtokenEl token busca en los campos DocumentReference correspondientes. Los valores de estado son actuales, sustituidos e introducidos en error. El estado tiene el sistema implícito http://hl7.org/fhir/document-reference-status; utilice un code, system|code o system|. Un token sin sistema explícito, como |current, no coincide. URI de parámetro canónico: http://hl7.org/fhir/SearchParameter/DocumentReference-status.
dateCuerpo de la pantalla o consultaNºdateTiempo de creación de referencia en DocumentReference.date; el valor proporcionado es un instante. Definición: ddfs-r4-date-date.json.
periodCuerpo de la pantalla o consultaNºdateServicio clínico period en DocumentReference.context.period. Definición: ddfs-r4-document-reference-period.json.
patientCuerpo de la pantalla o consultaNºreferenceCoincide con subject restringido a objetivos de paciente. El modificador :identifier existente busca en identifier la referencia. Definición: ddfs-r4-patient-reference-identifier-modifier.json.
_revincludeCuerpo de la pantalla o consultaNoespecialValores 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 emitidosystem/DocumentReference.s
Solicitud de token/otorgamiento de clienteddfssystem/DocumentReference.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 DocumentReference 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.

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/DocumentReference?patient=Patient/patient-1&category=genetics&status=current&date=ge2026-01-01&date=lt2027-01-01
POST /api/fhir/r4/DocumentReference/_search
Content-Type: application/x-www-form-urlencoded

patient=Patient%2Fpatient-1&period=ge2026-02-01&period=lt2026-03-01

Respuestas

Estado correctoSignificado
200Un 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.