Read RelatedPerson Version

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

Endpoint

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

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

Example request: GET /api/fhir/r4/RelatedPerson/00000000-0000-4000-8000-000000000014/_history/1

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

Headers

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

Parameters


Parameter	In	Required	Type	Description
`rid`	path	true	uuid	Logical id of the RelatedPerson 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/RelatedPerson.r`
Client grant/token request	`ddfssystem/RelatedPerson.r`
Issued token's `scope` claim	`system/RelatedPerson.r`

Example Response

{
  "resourceType": "RelatedPerson",
  "patient": {
    "reference": "Patient/00000000-0000-4000-8000-000000000010"
  },
  "id": "00000000-0000-4000-8000-000000000014",
  "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/related-person",
      "value": "documentation-example"
    }
  ],
  "relationship": [],
  "name": [
    {
      "family": "Example",
      "given": [
        "Related"
      ],
      "prefix": [],
      "suffix": []
    }
  ],
  "telecom": [],
  "address": [],
  "photo": [],
  "communication": []
}

Behavior

Reads a specific historical version of a RelatedPerson 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/RelatedPerson/00000000-0000-4000-8000-000000000014/_history/1 `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]'

Status Codes


Code	Status
200	Historical RelatedPerson representation.

FHIR Definition

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

Oracle Cloud Infrastructure Documentation