Interaction response sets
Summarizes the HTTP responses for each FHIR interaction.
Scope
The current R4 and R6 CapabilityStatements advertise create, read, versioned read, update, delete, and type-level search for every resource listed below.
Supported resources
FHIR R4: AllergyIntolerance, CarePlan, CareTeam, Composition, Condition, Device, DiagnosticReport, DocumentReference, Encounter, Endpoint, FamilyMemberHistory, Group, Immunization, Location, Medication, MedicationRequest, MedicationStatement, Observation, Organization, Patient, Practitioner, PractitionerRole, Procedure, Provenance, RelatedPerson, ServiceRequest, Specimen.
FHIR R6: Device, DeviceAssociation, Encounter, Location, Observation, Patient, Practitioner, PractitionerRole, Provenance, Subscription, and SubscriptionTopic.
Successful interaction responses
| Interaction | Request | Successful response |
|---|---|---|
| Search | GET /Resource or POST /Resource/_search | 200 with a search-set Bundle |
| Create | POST /Resource | 201 with the created resource |
| Read | GET /Resource/{rid} | 200 with the resource |
| Versioned read | GET /Resource/{rid}/_history/{vid} | 200 with the requested resource version |
| Update | PUT /Resource/{rid} | 200 for a live update; 201 for supported PUT-as-create or restoration. Body content follows the requested return preference. |
| Delete | DELETE /Resource/{rid} | 204 with no response body |
Operation responses
- Every resource listed above advertises
POST /Resource/$purgeDeletedandPOST /Resource/{rid}/$hardDelete. A successful request returns HTTP 200 with anOperationOutcome. GET /api/fhir/r6-ballot4/Subscription/$statusandGET /api/fhir/r6-ballot4/Subscription/{rid}/$statusreturn HTTP 200 with a search-set Bundle containingSubscriptionStatusoperation results.
For common unsuccessful responses and FHIR-formatted error bodies, see OperationOutcome errors. A response does not always contain a FHIR body.
See also
For permanent deletion guidance, see Data deletion and purge operations.