Update PractitionerRole

PUT creation and restoration

A PUT to an unused ID creates that identity; a PUT to a logically deleted resource restores it. Both return 201 Created and require create and update permission. Updating a live resource returns 200 OK and requires update permission. For ID syntax, headers, version preconditions, batch behavior, and availability, see Create, Update, and Restore Resources with PUT.

Endpoint

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

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

Example request: PUT /api/fhir/r4/PractitionerRole/00000000-0000-4000-8000-000000000012

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

Headers

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

Parameters

Version preconditions

Optionally send the ETag from your last read as If-Match, for example If-Match: W/"4". A nonmatching condition returns 412 Precondition Failed without applying the PUT; malformed headers return 400. Omitting the header does not protect against concurrent changes. A supplied condition cannot create an unused ID. See Update with If-Match.

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.

Example Request

{"resourceType":"PractitionerRole","identifier":[{"system":"https://example.com/fhir/identifier/practitionerRole","value":"documentation-example"}],"active":true,"practitioner":{"reference":"Practitioner/00000000-0000-4000-8000-000000000011"},"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"}]}],"organization":{"reference":"Organization/00000000-0000-4000-8000-000000000009"},"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-000000000012"}

Example Response

{
  "resourceType": "PractitionerRole",
  "id": "00000000-0000-4000-8000-000000000012",
  "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/practitionerRole",
      "value": "documentation-example"
    }
  ],
  "active": true,
  "practitioner": {
    "reference": "Practitioner/00000000-0000-4000-8000-000000000011"
  },
  "organization": {
    "reference": "Organization/00000000-0000-4000-8000-000000000009"
  },
  "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": [],
  "telecom": [],
  "availableTime": [],
  "notAvailable": [],
  "endpoint": []
}

Behavior

Creates a PractitionerRole at an unused logical ID, replaces an existing live resource, or restores a logically deleted resource. The body resource type and ID must match the request path. Creation and restoration return 201; live replacement returns 200. See PUT creation and restoration for response headers and history behavior.

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/PractitionerRole/00000000-0000-4000-8000-000000000012 `
  -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":"documentation-example"}],"active":true,"practitioner":{"reference":"Practitioner/00000000-0000-4000-8000-000000000011"},"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"}]}],"organization":{"reference":"Organization/00000000-0000-4000-8000-000000000009"},"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-000000000012"}'

Status Codes

FHIR Definition

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

Related Operations

• Create PractitionerRole
• Read PractitionerRole
• Read PractitionerRole Version
• Update PractitionerRole
• Delete PractitionerRole
• Search PractitionerRole
• Hard Delete PractitionerRole
• Purge Deleted PractitionerRole