Patch FHIR resource

PATCH/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.

RequiresBearerauthentication

Header parameters

X-Phenoml-On-Behalf-Ofstringoptional

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-Providerstringoptional

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.

Path parameters

fhir_provider_idstringrequired

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_pathstringrequired

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)

Returns

Resource patched successfully

Response fields

resourceTypestringoptional

idstringoptional

metaobjectoptional

versionIdstringoptional

lastUpdatedstringoptional

PATCHRequest

# Get authentication token
PHENOML_TOKEN=$(curl -X POST "https://experiment.app.pheno.ml/v2/auth/token" \
  -u "$PHENOML_CLIENT_ID:$PHENOML_CLIENT_SECRET" \
  | jq -r '.access_token')

curl -X PATCH "https://experiment.app.pheno.ml/fhir-provider/550e8400-e29b-41d4-a716-446655440000/fhir/Patient" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "op": "replace",
    "path": "/name/0/family",
    "value": "NewFamilyName"
  }
]'

200 OKExample Response

{
  "resourceType": "Patient",
  "id": "123",
  "meta": {
    "versionId": "3",
    "lastUpdated": "2024-02-20T11:30:00Z"
  }
}