Update Encounter

Update a FHIR R6 Encounter resource by logical ID.

Endpoint

PUT /api/fhir/r6-ballot4/Encounter/{rid}

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

Example request: PUT /api/fhir/r6-ballot4/Encounter/00000000-0000-4000-8000-000000000005

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

The examples use illustrative identifiers and values.

Headers

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

Parameters


Parameter	In	Required	Type	Description
`rid`	path	true	uuid	Logical id of the Encounter resource. Use the logical id of the resource.

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/Encounter.u`
Client grant/token request	`ddfssystem/Encounter.u`
Issued token's `scope` claim	`system/Encounter.u`

Example Request

{"resourceType":"Encounter","identifier":[{"system":"https://example.com/fhir/identifier/Encounter","value":"example-resource"}],"status":"planned","class":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"AMB","display":"ambulatory"}]}],"subject":{"reference":"Patient/00000000-0000-4000-8000-000000000001"},"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"example-resource","display":"Example resource"},{"system":"https://example.com/fhir/tag/phase","code":"updated","display":"Example update"}]},"type":[{"coding":[{"system":"http://snomed.info/sct","code":"185349003","display":"Encounter for check up"}]}],"admission":{"dischargeDisposition":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/discharge-disposition","code":"home","display":"Home"}]}},"location":[{"location":{"reference":"Location/00000000-0000-4000-8000-000000000003"}}],"id":"00000000-0000-4000-8000-000000000005"}

Example Response

{
  "resourceType": "Encounter",
  "id": "00000000-0000-4000-8000-000000000005",
  "meta": {
    "versionId": "2",
    "lastUpdated": "2025-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "example-resource",
        "display": "Example resource"
      },
      {
        "system": "https://example.com/fhir/tag/phase",
        "code": "updated",
        "display": "Example update"
      }
    ]
  },
  "identifier": [
    {
      "system": "https://example.com/fhir/identifier/Encounter",
      "value": "example-resource"
    }
  ],
  "status": "planned",
  "businessStatus": [],
  "class": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "AMB",
          "display": "ambulatory"
        }
      ]
    }
  ],
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "185349003",
          "display": "Encounter for check up"
        }
      ]
    }
  ],
  "serviceType": [],
  "subject": {
    "reference": "Patient/00000000-0000-4000-8000-000000000001"
  },
  "episodeOfCare": [],
  "basedOn": [],
  "careTeam": [],
  "participant": [],
  "appointment": [],
  "virtualService": [],
  "reason": [],
  "diagnosis": [],
  "account": [],
  "dietPreference": [],
  "specialArrangement": [],
  "specialCourtesy": [],
  "admission": {
    "dischargeDisposition": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
          "code": "home",
          "display": "Home"
        }
      ]
    }
  },
  "location": [
    {
      "location": {
        "reference": "Location/00000000-0000-4000-8000-000000000003"
      }
    }
  ]
}

Behavior

Replaces an existing Encounter resource by logical id.

cURL Example

curl.exe `
  -sS `
  -X PUT `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/Encounter/00000000-0000-4000-8000-000000000005 `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]' `
  -H 'Content-Type: application/fhir+json' `
  --data '{"resourceType":"Encounter","identifier":[{"system":"https://example.com/fhir/identifier/Encounter","value":"example-resource"}],"status":"planned","class":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"AMB","display":"ambulatory"}]}],"subject":{"reference":"Patient/00000000-0000-4000-8000-000000000001"},"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"example-resource","display":"Example resource"},{"system":"https://example.com/fhir/tag/phase","code":"updated","display":"Example update"}]},"type":[{"coding":[{"system":"http://snomed.info/sct","code":"185349003","display":"Encounter for check up"}]}],"admission":{"dischargeDisposition":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/discharge-disposition","code":"home","display":"Home"}]}},"location":[{"location":{"reference":"Location/00000000-0000-4000-8000-000000000003"}}],"id":"00000000-0000-4000-8000-000000000005"}'

Status Codes


Code	Status
200	Updated Encounter representation.

FHIR Definition

Canonical: https://hl7.org/fhir/6.0.0-ballot4/encounter.html

Oracle Cloud Infrastructure Documentation