Update a custom FHIR profile

Replaces an existing custom profile with a new StructureDefinition. The
id path parameter is authoritative: if the StructureDefinition includes
an id it must match the path parameter, and if it omits one the path
parameter is used. The FHIR resource type of the profile cannot change.
Code system configuration is
re-derived from the new StructureDefinition. When implementation_guide is
omitted, the profile keeps its existing implementation guide. The instance
stores a single version per canonical URL, so this replaces it in place.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The lowercase StructureDefinition id of the custom profile.

Body Params
structure_definition
object
required

A FHIR resource (schema depends on resource type)

string

Implementation Guide name to group this profile under. On create, defaults to "custom" if omitted; on update, omitting it preserves the profile's current guide. Cannot be "us_core" (reserved). Use this to organize custom profiles into named IGs that can be referenced when calling create/multi or document/multi endpoints.

Responses

400

Invalid request or profile validation failed. Possible reasons:

  • Missing or invalid StructureDefinition JSON
  • The StructureDefinition id does not match the id path parameter
  • The resource type differs from the existing profile
  • The url collides with a built-in profile or another custom profile
401

Unauthorized

403

Forbidden - custom profiles are only available on dedicated instances

404

Profile not found

500

Server error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json