Patch FHIR resource

patch

https://{instanceUrl}/fhir-provider/{fhir_provider_id}/fhir/{fhir_path}

Partially updates a FHIR resource on the specified provider.

Two body formats are supported, selected by request content type:

application/json-patch+json — an array of JSON Patch operations as defined in RFC 6902. Each operation specifies:
- op: The operation type (add, remove, replace, move, copy, test)
- path: JSON Pointer to the target location in the resource
- value: The value to use (required for add, replace, and test operations)
application/fhir+json — a partial FHIR resource for merge-patch semantics.

Note: This proxy currently forwards the request body to the upstream FHIR server with Content-Type: application/fhir+json regardless of the declared request content type. JSON Patch (RFC 6902) therefore only succeeds against upstream servers that accept patch arrays under application/fhir+json; servers that strictly enforce patch media types may reject or misinterpret it. Support for either format ultimately depends on the upstream FHIR server.

The request is proxied to the configured FHIR server with appropriate authentication headers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

fhir_provider_id

string

required

The ID of the FHIR provider to use. Can be either:

A UUID representing the provider ID
A provider name (legacy support - will just use the most recently updated provider with this name)

fhir_path

string

required

The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
Examples:

"Patient" (for resource type operations)
"Patient/123" (for specific resource operations)
"Patient/123/_history" (for history operations)

Body Params

JSON Patch operations to apply to the FHIR resource (RFC 6902)

Array of JSON Patch operations following RFC 6902

Headers

X-Phenoml-On-Behalf-Of

string

Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
Must be in the format: Patient/{uuid} or Practitioner/{uuid}

X-Phenoml-Fhir-Provider

string

Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
Multiple FHIR provider integrations can be provided as comma-separated values.

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Resource patched successfully