Update DocumentReference
Update DocumentReference using FHIR R4 4.0.1.
Resource category: DocumentReference.
Endpoint
| Method | Endpoint |
|---|---|
PUT | /api/fhir/r4/DocumentReference/{rid} |
Use the R4 base URL from your DDFS instance. Send Authorization: Bearer <access-token> and accept application/fhir+json.
Send Content-Type: application/fhir+json.
Parameters
| Parameter | Location | Required | Type | Description |
|---|---|---|---|---|
rid | Path | Yes | FHIR logical ID | The logical ID of the DocumentReference resource. |
DocumentReference | JSON request body | Yes | FHIR R4 DocumentReference | Supply a valid complete resource whose body id matches rid. |
If-Match | Header | No | ETag | When using a version precondition, send the current ETag. A stale version is rejected with HTTP 412; see resource lifecycle guidance. |
Authorization
| Context | Resource scope |
|---|---|
| Resource-server definition / issued token | system/DocumentReference.u |
| Client grant / token request | ddfssystem/DocumentReference.u |
PUT creation/restoration — issued token | system/DocumentReference.cu |
PUT creation/restoration — client grant | ddfssystem/DocumentReference.cu |
Resource constraints still apply. Use the least privilege needed for this operation; see authentication and scope configuration.
Behavior
Replace the addressed DocumentReference resource. A supported PUT-as-create or restoration returns 201; updating a live resource returns 200. Restoration retains history and continues version numbering. The body ID must match the URL ID. A stale If-Match request does not apply the update.
- PUT-as-create and restoration: shared operation semantics.
- DocumentReference resource guidance: resource-specific requirements and restrictions.
- R4 CapabilityStatement and R4 metadata: supported capabilities.
Example Request
Replace the example logical IDs, version IDs and connection values with values for your workflow.
PUT /api/fhir/r4/DocumentReference/{rid}
Content-Type: application/fhir+json
If-Match: W/"<current-version>"Responses
| Successful status | Meaning |
|---|---|
| 200 | Live resource updated. |
| 201 | Resource created or restored through the supported PUT-as-create behavior. |
For common error statuses and FHIR-formatted error bodies, see OperationOutcome errors. Authentication/authorization responses follow the shared policy; a protected resource can be concealed as 404. See also interaction responses.
Supported Prefer return preferences control response content; applicable Location, ETag and Last-Modified headers follow the lifecycle contract.
FHIR Definition
FHIR R4 definition: https://hl7.org/fhir/R4/documentreference.html. Canonical profile URI: http://hl7.org/fhir/StructureDefinition/DocumentReference.