FHIR R4 Endpoints
Find FHIR R4 4.0.1 resource endpoints and their operation references.
Use the R4 base URL returned for your DDFS instance. Resource type names are case-sensitive. Choose a resource below for its supported parameters, authorization scopes, examples and operation details.
Resource endpoints
| Resource and operation references | Collection endpoint |
|---|---|
| AllergyIntolerance | /api/fhir/r4/AllergyIntolerance |
| CarePlan | /api/fhir/r4/CarePlan |
| CareTeam | /api/fhir/r4/CareTeam |
| Composition | /api/fhir/r4/Composition |
| Condition | /api/fhir/r4/Condition |
| Device | /api/fhir/r4/Device |
| DiagnosticReport | /api/fhir/r4/DiagnosticReport |
| DocumentReference | /api/fhir/r4/DocumentReference |
| Encounter | /api/fhir/r4/Encounter |
| Endpoint | /api/fhir/r4/Endpoint |
| FamilyMemberHistory | /api/fhir/r4/FamilyMemberHistory |
| Group | /api/fhir/r4/Group |
| Immunization | /api/fhir/r4/Immunization |
| Location | /api/fhir/r4/Location |
| Medication | /api/fhir/r4/Medication |
| MedicationRequest | /api/fhir/r4/MedicationRequest |
| MedicationStatement | /api/fhir/r4/MedicationStatement |
| Observation | /api/fhir/r4/Observation |
| Organization | /api/fhir/r4/Organization |
| Patient | /api/fhir/r4/Patient |
| Practitioner | /api/fhir/r4/Practitioner |
| PractitionerRole | /api/fhir/r4/PractitionerRole |
| Procedure | /api/fhir/r4/Procedure |
| Provenance | /api/fhir/r4/Provenance |
| RelatedPerson | /api/fhir/r4/RelatedPerson |
| ServiceRequest | /api/fhir/r4/ServiceRequest |
| Specimen | /api/fhir/r4/Specimen |
Operation patterns
Replace {Resource} with the resource type, {rid} with its logical ID and {vid} with a resource version ID. GET search uses query parameters. POST search sends the supported filters as application/x-www-form-urlencoded.
| Operation | Method | Endpoint | Successful response |
|---|---|---|---|
| Search | GET | /api/fhir/r4/{Resource} | 200; search-set Bundle |
| Search with a form body | POST | /api/fhir/r4/{Resource}/_search | 200; search-set Bundle |
| Create | POST | /api/fhir/r4/{Resource} | 201; created resource, subject to return preference |
| Get | GET | /api/fhir/r4/{Resource}/{rid} | 200; current resource |
| Get Version | GET | /api/fhir/r4/{Resource}/{rid}/_history/{vid} | 200; requested resource version |
| Update, PUT-as-create or restoration | PUT | /api/fhir/r4/{Resource}/{rid} | 200 for a live update; 201 for creation or restoration, subject to return preference |
| Delete | DELETE | /api/fhir/r4/{Resource}/{rid} | 204; no response body |
| Hard Delete | POST | /api/fhir/r4/{Resource}/{rid}/$hardDelete | 200; OperationOutcome |
| Purge Deleted | POST | /api/fhir/r4/{Resource}/$purgeDeleted | 200; OperationOutcome |
For return preferences, response headers and version preconditions, see Resource lifecycle and PUT-as-create and restoration. For common error statuses and FHIR-formatted error responses, see Interaction responses and OperationOutcome errors.
Hard Delete and Purge Deleted require additional authorization and follow the permanent-deletion policy. See their Hard Delete definition and Purge Deleted definition for the custom operation contracts.
Metadata and batch requests
Use GET /api/fhir/r4/metadata to retrieve the R4 CapabilityStatement. For independent batch requests sent to POST /api/fhir/r4, see Batch requests. The R4 contract definition lists advertised resource capabilities.