Oracle Cloud Infrastructure Documentation

Read Encounter

Read a FHIR R4 Encounter resource by logical ID.

Endpoint

GET /api/fhir/r4/Encounter/{rid}

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

Example request: GET /api/fhir/r4/Encounter/00000000-0000-4000-8000-000000000004

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

Headers

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

Parameters

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

Example Response

{
  "resourceType": "Encounter",
  "class": {
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "code": "AMB",
    "display": "ambulatory"
  },
  "id": "00000000-0000-4000-8000-000000000004",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2020-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "documentation-example",
        "display": "Documentation example"
      }
    ]
  },
  "identifier": [
    {
      "system": "https://example.com/fhir/identifier/encounter",
      "value": "documentation-example"
    }
  ],
  "status": "planned",
  "statusHistory": [],
  "classHistory": [],
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "185349003",
          "display": "Encounter for check up"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/00000000-0000-4000-8000-000000000010"
  },
  "episodeOfCare": [],
  "basedOn": [],
  "participant": [],
  "appointment": [],
  "diagnosis": [],
  "account": [],
  "hospitalization": {
    "dietPreference": [],
    "specialCourtesy": [],
    "specialArrangement": [],
    "dischargeDisposition": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
          "code": "home",
          "display": "Home"
        }
      ]
    }
  },
  "location": [
    {
      "location": {
        "reference": "Location/00000000-0000-4000-8000-000000000007"
      }
    }
  ]
}

Behavior

Reads a Encounter resource by logical id.

cURL Example

curl.exe `
  -sS `
  -X GET `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Encounter/00000000-0000-4000-8000-000000000004 `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]'

Status Codes

CodeStatus
200 Encounter representation.

FHIR Definition

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

Related Operations