Oracle Cloud Infrastructure Documentation

Create RelatedPerson

Create a FHIR R4 Related Person resource.

Endpoint

POST /api/fhir/r4/RelatedPerson

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

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

Headers

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

Parameters

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

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

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

Creates a RelatedPerson resource.

cURL Example

curl.exe `
  -sS `
  --connect-timeout 10 `
  --max-time 90 `
  -X POST `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/RelatedPerson `
  -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"}]}}'

Status Codes

CodeStatus
201 Created RelatedPerson representation.

FHIR Definition

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

Related Operations