Endpoint

Options to work with FHIR R4 Endpoint resources.

Primitive extension support

Endpoint supports primitive companion elements in underscore form for selected fields:

_address, _header, _implicitRules, _language, _name, _payloadMimeType, _status.

For JSON usage patterns, see FHIR primitive extensions in JSON.

Successful HTTP Responses

This table lists successful HTTP responses for this resource.

EndpointMethodSuccessful status code
/api/fhir/r4/Endpoint GET 200
/api/fhir/r4/Endpoint POST 201
/api/fhir/r4/Endpoint/$purgeDeleted POST 200
/api/fhir/r4/Endpoint/{rid} DELETE 204
/api/fhir/r4/Endpoint/{rid} GET 200
/api/fhir/r4/Endpoint/{rid} PUT 200
/api/fhir/r4/Endpoint/{rid}/$hardDelete POST 200
/api/fhir/r4/Endpoint/{rid}/_history/{vid} GET 200

For cross-resource interaction summaries, see FHIR status codes.

See also

For permanent deletion guidance, see Data deletion and purge operations.