Create Encounter

Create a FHIR R6 Encounter resource.

Endpoint

POST /api/fhir/r6-ballot4/Encounter

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

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

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
No parameters

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

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"}]},"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"}}]}

Example Response

{
  "resourceType": "Encounter",
  "id": "00000000-0000-4000-8000-000000000005",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2025-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "example-resource",
        "display": "Example resource"
      }
    ]
  },
  "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

Creates a Encounter resource.

cURL Example

curl.exe `
  -sS `
  -X POST `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/Encounter `
  -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"}]},"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"}}]}'

Status Codes


Code	Status
201	Created Encounter representation.

FHIR Definition

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

Oracle Cloud Infrastructure Documentation