Oracle Cloud Infrastructure Documentation

Read Patient Version

Read a version of a FHIR R4 Patient resource by logical ID and version ID.

Endpoint

GET /api/fhir/r4/Patient/{rid}/_history/{vid}

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

Example request: GET /api/fhir/r4/Patient/00000000-0000-4000-8000-000000000010/_history/1

Example URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Patient/00000000-0000-4000-8000-000000000010/_history/1

Headers

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

Parameters

ParameterInRequiredTypeDescription
rid path true uuid Logical id of the Patient resource. Use the logical id of the resource.
vid path true string FHIR resource version id. Use the version 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/Patient.r
Client grant/token request ddfssystem/Patient.r
Issued token's scope claim system/Patient.r

Example Response

{
  "resourceType": "Patient",
  "id": "00000000-0000-4000-8000-000000000010",
  "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/patient",
      "value": "documentation-example"
    }
  ],
  "active": true,
  "name": [
    {
      "family": "Example",
      "given": [
        "Patient"
      ],
      "prefix": [],
      "suffix": []
    }
  ],
  "telecom": [],
  "gender": "unknown",
  "birthDate": "2020-01-01",
  "address": [
    {
      "line": [],
      "city": "Austin",
      "state": "TX",
      "postalCode": "78701"
    }
  ],
  "photo": [],
  "contact": [],
  "communication": [],
  "generalPractitioner": [],
  "link": []
}

Behavior

Reads a specific historical version of a Patient resource.

cURL Example

curl.exe `
  -sS `
  --connect-timeout 10 `
  --max-time 90 `
  -X GET `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/Patient/00000000-0000-4000-8000-000000000010/_history/1 `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]'

Status Codes

CodeStatus
200 Historical Patient representation.

FHIR Definition

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

Related Operations