Oracle Cloud Infrastructure Documentation

Create PractitionerRole

Create a FHIR R6 Practitioner Role resource.

Endpoint

POST /api/fhir/r6-ballot4/PractitionerRole

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

Example URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/PractitionerRole

The examples use illustrative identifiers and values.

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

Example Request

{"resourceType":"PractitionerRole","identifier":[{"system":"https://example.com/fhir/identifier/PractitionerRole","value":"example-resource"}],"active":true,"practitioner":{"reference":"Practitioner/00000000-0000-4000-8000-000000000002"},"code":[{"coding":[{"system":"http://snomed.info/sct","code":"223366009","display":"Healthcare professional"}]}],"specialty":[{"coding":[{"system":"http://snomed.info/sct","code":"408443003","display":"General medical practice"}]}],"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"example-resource","display":"Example resource"}]}}

Example Response

{
  "resourceType": "PractitionerRole",
  "id": "00000000-0000-4000-8000-000000000007",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2025-01-01T00:00:00Z",
    "profile": [],
    "security": [],
    "tag": [
      {
        "system": "https://example.com/fhir/tag",
        "code": "example-resource",
        "display": "Example resource"
      }
    ]
  },
  "identifier": [
    {
      "system": "https://example.com/fhir/identifier/PractitionerRole",
      "value": "example-resource"
    }
  ],
  "active": true,
  "practitioner": {
    "reference": "Practitioner/00000000-0000-4000-8000-000000000002"
  },
  "network": [],
  "code": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "223366009",
          "display": "Healthcare professional"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "408443003",
          "display": "General medical practice"
        }
      ]
    }
  ],
  "location": [],
  "healthcareService": [],
  "contact": [],
  "characteristic": [],
  "communication": [],
  "endpoint": []
}

Behavior

Creates a PractitionerRole resource.

cURL Example

curl.exe `
  -sS `
  -X POST `
  https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/PractitionerRole `
  -H 'Accept: application/fhir+json' `
  -H 'Authorization: Bearer [REDACTED]' `
  -H 'Content-Type: application/fhir+json' `
  --data '{"resourceType":"PractitionerRole","identifier":[{"system":"https://example.com/fhir/identifier/PractitionerRole","value":"example-resource"}],"active":true,"practitioner":{"reference":"Practitioner/00000000-0000-4000-8000-000000000002"},"code":[{"coding":[{"system":"http://snomed.info/sct","code":"223366009","display":"Healthcare professional"}]}],"specialty":[{"coding":[{"system":"http://snomed.info/sct","code":"408443003","display":"General medical practice"}]}],"meta":{"tag":[{"system":"https://example.com/fhir/tag","code":"example-resource","display":"Example resource"}]}}'

Status Codes

CodeStatus
201 Created PractitionerRole representation.

FHIR Definition

Canonical: https://hl7.org/fhir/6.0.0-ballot4/practitionerrole.html

Related Operations