Create DocumentReference
Create DocumentReference using FHIR R4 4.0.1.
Resource category: DocumentReference.
Endpoint
| Method | Endpoint |
|---|---|
POST | /api/fhir/r4/DocumentReference |
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 |
|---|---|---|---|---|
DocumentReference | JSON request body | Yes | FHIR R4 DocumentReference | Supply a valid complete resource. The server assigns the created resource ID. |
Authorization
| Context | Resource scope |
|---|---|
| Resource-server definition / issued token | system/DocumentReference.c |
| Client grant / token request | ddfssystem/DocumentReference.c |
Resource constraints still apply. Use the least privilege needed for this operation; see authentication and scope configuration.
Behavior
Create a DocumentReference resource with a server-assigned ID. Use the returned ID, version and applicable Location, ETag and Last-Modified metadata in subsequent requests.
- Resource lifecycle: 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.
POST /api/fhir/r4/DocumentReferenceResponses
| Successful status | Meaning |
|---|---|
| 201 | Resource created; response content follows the supported return preference. |
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.