DocumentReference (FHIR R5)
FHIR You're viewing the FHIR R5 reference.
FHIR R5 DocumentReference resource.
This page is auto-generated from the server's FHIR R5 CapabilityStatement (
/fhir/R5/metadata).
FHIR R5 Specification
Official spec: DocumentReference — HL7 FHIR R5
Supported Interactions
- read — Read a single resource by ID (
GET /fhir/R5/{Resource}/{id}) - search-type — Search resources with query parameters (
GET /fhir/R5/{Resource}?...) - create — Create a new resource (
POST /fhir/R5/{Resource}) - update — Update an existing resource (
PUT /fhir/R5/{Resource}/{id}) - $upload — operation
Scopes
Scopes are shared across FHIR releases — the same system/DocumentReference.* scope grants DocumentReference access on both /fhir/R4 and /fhir/R5.
- system/DocumentReference.rs — see scope reference
- system/DocumentReference.cru — see scope reference
Search Parameters
| Parameter | Type | Notes |
|---|---|---|
patient | reference | Resource reference — supply the UUID of the referenced resource. |
type | token | Exact match. For identifiers use `system |
category | token | Exact match. For identifiers use `system |
date | date | Supports FHIR date prefixes: eq, ne, gt, ge, lt, le. Format: [prefix]YYYY-MM-DD. |
_count | number | Integer. For _count: default 20, max 100. |
_offset | number | Integer. For _count: default 20, max 100. |
Endpoints
Operations, request/response examples, and code samples mirror the R4 surface — call them at /fhir/R5 with the same token and scopes. See the DocumentReference R4 reference.