DocumentReference
Trabajar con recursos FHIR R4 4.0.1 DocumentReference.
Seleccione una operación para este recurso:
- Buscar en DocumentReference
- Lea DocumentReference
- Lea la versión DocumentReference
- Crear DocumentReference
- Actualizar DocumentReference
- Suprimir DocumentReference
- Supresión permanente DocumentReference
- Depurar DocumentReference suprimido
El diagrama resume las solicitudes y respuestas de DocumentReference. Consulte Interacciones REST de FHIR soportadas para conocer el modelo de interacción compartida.
Definición de FHIR R4: https://hl7.org/fhir/R4/documentreference.html. Consulte códigos de respuesta de interacción y respuestas de error comunes.
El punto final base es /api/fhir/r4/DocumentReference. Almacene aquí los metadatos de los documentos y las descripciones de los anexos. DDFS conserva el contenido proporcionado y las versiones históricas, incluidas las extensiones y los metadatos complementarios primitivos. No recupera URL de anexos, expone un punto final binario, ingiere documentos externos ni procesa el contenido del documento.
Interacciones y respuestas
| Solicitud | Respuesta correcta |
|---|---|
POST /DocumentReference | 201 Creado; el servidor asigna el ID lógico y la versión. |
GET /DocumentReference/{id} | 200 con el recurso actual. |
GET /DocumentReference/{id}/_history/{version} | 200 con el recurso histórico solicitado. |
PUT /DocumentReference/{id} | 200 para sustitución; 201 para PUT-as-create o restauración. El ID de cuerpo debe coincidir con el ID de URL. |
DELETE /DocumentReference/{id} | 204 después de la supresión suave. El recurso se excluye de las búsquedas actuales. |
GET /DocumentReference o con codificación de formato POST /DocumentReference/_search | 200 con un paquete searchset. |
POST /DocumentReference/{id}/$hardDelete | 200 con un valor OperationOutcome después de la eliminación permanente de un recurso de supresión flexible. Suprima primero el recurso. |
POST /DocumentReference/$purgeDeleted | 200 con un OperationOutcome. Proporcione el cuerpo de parámetros de FHIR existente con before y limit; solo se depuran los recursos elegibles suprimidos temporalmente. |
- Ciclo de vida de los recursos: crear, leer, leer con versiones, actualizar, suprimir de software y condiciones previas de versión.
- PUT como creación y restauración: creación/restauración, metadatos gestionados por el servidor, cabeceras de respuesta y preferencias de devolución.
- Respuestas de interacción: códigos
statuscorrectos. - OperationOutcome errors: errores comunes y cuerpos de respuesta.
- Solicitudes de lote: procesamiento de entrada independiente.
| Capacidad DocumentReference | Soporte o requisito |
|---|---|
| Creación condicional | No soportado. |
| Actualización condicional | No soportado. |
| Paquetes de transacciones | No soportado. |
Búsquedas admitidas
- Operación de búsqueda: puntos finales, tabla de parámetros completa, formularios y ejemplos soportados.
- Controles de búsqueda comunes: controles compartidos y enlaces de paginación proporcionados por el servidor.
- Tipos de Valores y Sintaxis y Comparadores, Modificadores y Cadenas: sintaxis compartida. Utilice solo los formularios soportados por este recurso.
| DocumentReference detalle | Requisito o comportamiento |
|---|---|
| Filtros de fecha | Fecha, period y _lastUpdated soportan hasta dos límites repetidos y los comparadores eq, ne, gt, lt, ge, le, sa, eb y ap. |
| Limitaciones | No se admiten alternativas de coma. |
| Limitaciones | Los parámetros de referencia y token de recurso aceptan una incidencia; los modificadores de token y las nuevas cadenas de referencia no están soportados. |
| Regla de recurso | Siga el enlace del paquete next sin cambios para la paginación. |
| Regla de recurso | Se ignora el parámetro _sort. |
| Origen de escritura | La expansión _revinclude=Provenance:target existente está disponible con el acceso de proveniencia necesario. |
| Regla de recurso | Consulte parámetros de búsqueda soportados. |
| Parámetro | Significado |
|---|---|
identifier | Coincide con masterIdentifier y identifier mediante un token no modificado: value, system|value, |value (sin sistema) o system|. |
patient | Coincide con subject restringido a objetivos de paciente. El modificador :identifier existente busca en identifier la referencia. |
category, type, status | El 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. |
date | Tiempo de creación de referencia en DocumentReference.date; el valor proporcionado es un instante. |
period | Servicio clínico period en DocumentReference.context.period. |
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
Crear ejemplo
| DocumentReference detalle | Requisito o comportamiento |
|---|---|
| Estado | El estado y al menos un elemento de contenido son obligatorios; cada elemento de contenido requiere un anexo. |
| Regla de recurso | El enlace opcional docStatus permite preliminary, final, amended y la introducción en error. |
| Referencias | Las referencias deben utilizar los destinos permitidos por la definición de recurso R4. |
| Origen de escritura | La procedencia generada describe el cambio en el recurso de referencia. |
POST /api/fhir/r4/DocumentReference
Content-Type: application/fhir+json
{
"resourceType": "DocumentReference",
"status": "current",
"masterIdentifier": {"system": "urn:example:documents", "value": "synthetic-report-1"},
"subject": {"reference": "Patient/patient-1"},
"date": "2026-04-20T10:11:12Z",
"content": [{"attachment": {"contentType": "text/plain", "url": "https://example.test/synthetic-report"}}],
"context": {"period": {"start": "2026-02-01", "end": "2026-02-28"}}
}
Permisos y límites
- Autenticación y ámbitos: tokens portadores, configuración de ámbito y acceso restringido. Los ámbitos de recursos necesarios se muestran en cada página de operación.
- Operaciones de eliminación y depuración de datos: elegibilidad para supresión permanente y permisos adicionales.
- Hard Delete y Purge Deleted: puntos finales de recursos y ámbitos necesarios; consulte también la guía de depuración compartida.
| Artículo | Requisito o comportamiento |
|---|---|
| Limitaciones | No se admiten la creación condicional, la actualización condicional ni la participación en transacciones. |
| Referencias | No proporciona el punto final R6 DocumentReference, los filtros de episodio clínico/contexto, los filtros de personal clínico/organización, la búsqueda de texto completo, el servicio de recuperación de anexos o la certificación Core de EE. UU. |