API Reference

Update a custom FHIR profile

put
https://{instanceUrl}/fhir/profiles/

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.
When implementation_guide is omitted, the profile keeps its existing
implementation guide. A retained version string is allowed only when
re-submitting the profile's current version with an unchanged
StructureDefinition; otherwise it returns a conflict. While the profile
has retained versions, its
canonical URL cannot be changed.

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 StructureDefinition as a JSON object. Must include url, type, and a snapshot with elements. Metadata such as version, resource type, and url is read from the StructureDefinition itself. The lowercase id becomes the profile's lookup key; when omitted, a random UUID is assigned.

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
  • The implementation_guide is reserved or invalid
401

Unauthorized

403

Forbidden - custom profiles are only available on dedicated instances

404

Profile not found

409

Conflict. Possible reasons:

  • The requested StructureDefinition.version is already used by a retained version and this is not an unchanged re-submission of the profile's current version
  • The profile has retained versions and the request changes its canonical URL
500

Server error

Updated 2 months ago

Did this page help you?
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

Updated 2 months ago

Did this page help you?