Update Endpoint

Create, replace, or restore a FHIR Endpoint resource using a logical ID.

PUT creation and restoration

A PUT to an unused ID creates that identity; a PUT to a logically deleted resource restores it. Both return 201 Created and require create and update permission. Updating a live resource returns 200 OK and requires update permission. For ID syntax, headers, version preconditions, batch behavior, and availability, see Create, Update, and Restore Resources with PUT.

Endpoint

PUT /api/fhir/r4/Endpoint/{rid}

Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4

Example request: PUT /api/fhir/r4/Endpoint/00000000-0000-4000-8000-000000000005

Example URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Endpoint/00000000-0000-4000-8000-000000000005

Headers

{"Accept":"application/fhir+json","Authorization":"Bearer [REDACTED]","Content-Type":"application/fhir+json"}

Parameters


Parameter	In	Required	Type	Description
`rid`	path	true	FHIR logical ID string	Logical id of the Endpoint resource. Use the logical id of the resource.

Version preconditions

Optionally send the ETag from your last read as If-Match, for example If-Match: W/"4". A nonmatching condition returns 412 Precondition Failed without applying the PUT; malformed headers return 400. Omitting the header does not protect against concurrent changes. A supplied condition cannot create an unused ID. See Update with If-Match.

Authorization

The supported authorization model uses OAuth 2.0 scopes issued by OCI Identity Domains. Send the access token as a bearer token. Resource-server definitions and issued access-token claims use canonical system/... scopes. Client grants and token requests use the corresponding ddfssystem/... form. For examples, see Reference: Authentication and Scopes.

Context	Scope form
Resource-server definition	`system/Endpoint.u` for a live update; `system/Endpoint.cu` for creation or restoration.
Client grant/token request	`ddfssystem/Endpoint.u` for a live update; `ddfssystem/Endpoint.cu` for creation or restoration.
Issued token's `scope` claim	`system/Endpoint.u` for a live update; `system/Endpoint.cu` for creation or restoration.

Example Request

{"resourceType":"Endpoint","identifier":[{"system":"https://example.com/fhir/identifier/endpoint","value":"documentation-example"}],"status":"active","connectionType":{"system":"http://terminology.hl7.org/CodeSystem/endpoint-connection-type","code":"hl7-fhir-rest"},"payloadType":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/data-absent-reason","code":"not-applicable","display":"Not applicable"}]}],"address":"https://example.com/fhir","managingOrganization":{"reference":"Organization/00000000-0000-4000-8000-000000000009"},"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"},{"system":"https://example.com/fhir/tag/phase","code":"updated","display":"Updated example"}]},"name":"Example endpoint","id":"00000000-0000-4000-8000-000000000005"}

Example Response

{
  "resourceType": "Endpoint",
  "connectionType": {
    "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
    "code": "hl7-fhir-rest"
  },
  "payloadType": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
          "code": "not-applicable",
          "display": "Not applicable"
        }
      ]
    }
  ],
  "id": "00000000-0000-4000-8000-000000000005",
  "meta": {
    "versionId": "2",
    "lastUpdated": "2020-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "documentation-example",
        "display": "Documentation example"
      },
      {
        "system": "https://example.com/fhir/tag/phase",
        "code": "updated",
        "display": "Updated example"
      }
    ]
  },
  "identifier": [
    {
      "system": "https://example.com/fhir/identifier/endpoint",
      "value": "documentation-example"
    }
  ],
  "status": "active",
  "name": "Example endpoint",
  "managingOrganization": {
    "reference": "Organization/00000000-0000-4000-8000-000000000009"
  },
  "contact": [],
  "address": "https://example.com/fhir",
  "header": []
}

Behavior

Creates a Endpoint at an unused logical ID, replaces an existing live resource, or restores a logically deleted resource. The body resource type and ID must match the request path. Creation and restoration return 201; live replacement returns 200. See PUT creation and restoration for response headers and history behavior.

cURL Example

curl.exe `
  -sS `
  -X PUT `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Endpoint/00000000-0000-4000-8000-000000000005 `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]' `
  -H 'Content-Type: application/fhir+json' `
  --data '{"resourceType":"Endpoint","identifier":[{"system":"https://example.com/fhir/identifier/endpoint","value":"documentation-example"}],"status":"active","connectionType":{"system":"http://terminology.hl7.org/CodeSystem/endpoint-connection-type","code":"hl7-fhir-rest"},"payloadType":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/data-absent-reason","code":"not-applicable","display":"Not applicable"}]}],"address":"https://example.com/fhir","managingOrganization":{"reference":"Organization/00000000-0000-4000-8000-000000000009"},"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"},{"system":"https://example.com/fhir/tag/phase","code":"updated","display":"Updated example"}]},"name":"Example endpoint","id":"00000000-0000-4000-8000-000000000005"}'

Status Codes


Code	Status
200	The live resource was updated.
201	The resource was created or restored.

FHIR Definition

Canonical: https://hl7.org/fhir/R4/endpoint.html

Oracle Cloud Infrastructure Documentation