Update RelatedPerson

Update a FHIR R4 Related Person resource by logical ID.

Endpoint

PUT /api/fhir/r4/RelatedPerson/{rid}

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

Example request: PUT /api/fhir/r4/RelatedPerson/00000000-0000-4000-8000-000000000014

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

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

Example Request

{"resourceType":"RelatedPerson","identifier":[{"system":"https://example.com/fhir/identifier/related-person","value":"documentation-example"}],"patient":{"reference":"Patient/00000000-0000-4000-8000-000000000010"},"name":[{"family":"Example","given":["Related"]}],"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"},{"system":"https://example.com/fhir/tag/phase","code":"updated","display":"Updated example"}]},"id":"00000000-0000-4000-8000-000000000014"}

Example Response

{
  "resourceType": "RelatedPerson",
  "patient": {
    "reference": "Patient/00000000-0000-4000-8000-000000000010"
  },
  "id": "00000000-0000-4000-8000-000000000014",
  "meta": {
    "versionId": "2",
    "lastUpdated": "2020-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "documentation-example",
        "display": "Documentation example"
      },
      {
        "system": "https://example.com/fhir/tag/phase",
        "code": "updated",
        "display": "Updated 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

Replaces an existing RelatedPerson resource by logical id.

cURL Example

curl.exe `
  -sS `
  --connect-timeout 10 `
  --max-time 90 `
  -X PUT `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/RelatedPerson/00000000-0000-4000-8000-000000000014 `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]' `
  -H 'Content-Type: application/fhir+json' `
  --data '{"resourceType":"RelatedPerson","identifier":[{"system":"https://example.com/fhir/identifier/related-person","value":"documentation-example"}],"patient":{"reference":"Patient/00000000-0000-4000-8000-000000000010"},"name":[{"family":"Example","given":["Related"]}],"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"documentation-example","display":"Documentation example"},{"system":"https://example.com/fhir/tag/phase","code":"updated","display":"Updated example"}]},"id":"00000000-0000-4000-8000-000000000014"}'

Status Codes


Code	Status
200	Updated RelatedPerson representation.

FHIR Definition

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

Oracle Cloud Infrastructure Documentation