DocumentReference

Trabajar con recursos FHIR R4 4.0.1 DocumentReference.

Seleccione una operación para este recurso:

El diagrama resume las solicitudes y respuestas de DocumentReference. Consulte Interacciones REST de FHIR soportadas para conocer el modelo de interacción compartida.


Un cliente FHIR envía solicitudes a la API de DDFS R4 DocumentReference. La búsqueda devuelve un paquete; la creación, lectura y actualización devuelve un recurso; vread devuelve una versión histórica; delete devuelve HTTP 204 sin cuerpo. Las operaciones personalizadas y los errores con formato FHIR pueden devolver OperationOutcome.

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

SolicitudRespuesta correcta
POST /DocumentReference201 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/_search200 con un paquete searchset.
POST /DocumentReference/{id}/$hardDelete200 con un valor OperationOutcome después de la eliminación permanente de un recurso de supresión flexible. Suprima primero el recurso.
POST /DocumentReference/$purgeDeleted200 con un OperationOutcome. Proporcione el cuerpo de parámetros de FHIR existente con before y limit; solo se depuran los recursos elegibles suprimidos temporalmente.
Capacidad DocumentReferenceSoporte o requisito
Creación condicionalNo soportado.
Actualización condicionalNo soportado.
Paquetes de transaccionesNo soportado.

Crear ejemplo

DocumentReference detalleRequisito o comportamiento
EstadoEl estado y al menos un elemento de contenido son obligatorios; cada elemento de contenido requiere un anexo.
Regla de recursoEl enlace opcional docStatus permite preliminary, final, amended y la introducción en error.
ReferenciasLas referencias deben utilizar los destinos permitidos por la definición de recurso R4.
Origen de escrituraLa 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

ArtículoRequisito o comportamiento
LimitacionesNo se admiten la creación condicional, la actualización condicional ni la participación en transacciones.
ReferenciasNo 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.