Search DocumentReference
Search DocumentReference using FHIR R4 4.0.1.
Resource category: DocumentReference.
Endpoint
| Method | Endpoint |
|---|---|
GET | /api/fhir/r4/DocumentReference |
POST | /api/fhir/r4/DocumentReference/_search |
Use the R4 base URL from your DDFS instance. Send Authorization: Bearer <access-token> and accept application/fhir+json.
GET uses query parameters. POST search uses the same supported parameters in an application/x-www-form-urlencoded body and requires the same search permission. Follow the server-provided Bundle.link URL with relation next unchanged. See shared search controls.
Parameters
| Parameter | Location | Required | Type | Description |
|---|---|---|---|---|
identifier | Query or form body | No | token | Matches masterIdentifier and identifier using one unmodified token: value, system|value, |value (no system), or system|. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/clinical-identifier. |
_count | Query or form body | No | number | Limit the number of matches returned per page. See shared search controls for supported values and count-only behavior. |
_total | Query or form body | No | token | Request supported total handling; the control name does not imply support for every FHIR total mode. |
_id | Query or form body | No | token | Filter by logical resource ID. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/Resource-id. |
_lastUpdated | Query or form body | No | date | Filter by _lastUpdated using the supported date search semantics. Definition: ddfs-r4-last-updated-date.json. |
_profile | Query or form body | No | uri | Filter by profile URI. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/Resource-profile. |
_tag | Query or form body | No | token | Filter by a resource metadata tag. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/Resource-tag. |
category | Query or form body | No | token | Token searches on the corresponding DocumentReference fields. Status values are current, superseded and entered-in-error. Status has the implicit system http://hl7.org/fhir/document-reference-status; use a code, system|code, or system|. An explicit no-system token such as |current does not match. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/DocumentReference-category. |
type | Query or form body | No | token | Token searches on the corresponding DocumentReference fields. Status values are current, superseded and entered-in-error. Status has the implicit system http://hl7.org/fhir/document-reference-status; use a code, system|code, or system|. An explicit no-system token such as |current does not match. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/DocumentReference-type. |
status | Query or form body | No | token | Token searches on the corresponding DocumentReference fields. Status values are current, superseded and entered-in-error. Status has the implicit system http://hl7.org/fhir/document-reference-status; use a code, system|code, or system|. An explicit no-system token such as |current does not match. Canonical parameter URI: http://hl7.org/fhir/SearchParameter/DocumentReference-status. |
date | Query or form body | No | date | Reference creation time in DocumentReference.date; the supplied value is an instant. Definition: ddfs-r4-date-date.json. |
period | Query or form body | No | date | Clinical service period in DocumentReference.context.period. Definition: ddfs-r4-document-reference-period.json. |
patient | Query or form body | No | reference | Matches subject restricted to Patient targets. The existing :identifier modifier searches the identifier carried on the reference. Definition: ddfs-r4-patient-reference-identifier-modifier.json. |
_revinclude | Query or form body | No | special | Allowed values: Provenance:target. Matching Provenance read permission is also required. |
Authorization
| Context | Resource scope |
|---|---|
| Resource-server definition / issued token | system/DocumentReference.s |
| Client grant / token request | ddfssystem/DocumentReference.s |
Resource constraints still apply. Use the least privilege needed for this operation; see authentication and scope configuration.
Behavior
Return matching DocumentReference resources in a searchset Bundle. Filters and caller constraints determine which matches can be returned. Do not infer unsupported modifiers, chains, repeated values or result-control modes from the base FHIR specification.
- Shared search behavior: 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.
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-01Responses
| Successful status | Meaning |
|---|---|
| 200 | A searchset Bundle. |
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.
FHIR Definition
FHIR R4 definition: https://hl7.org/fhir/R4/documentreference.html. Canonical profile URI: http://hl7.org/fhir/StructureDefinition/DocumentReference.