Add a retained version to a custom FHIR profile

Adds an immutable StructureDefinition version to a custom profile. If
the profile does not exist, it is created from the submitted version.
The StructureDefinition must include a non-empty version; its
canonical URL and resource type must match the profile when one already
exists. If it includes an id, that id must match the path parameter;
if it omits id, the path parameter is used. Profiles created through
this endpoint are grouped under custom. Posting the profile's current
StructureDefinition unchanged retains it as a version.
Version strings may contain letters, numbers, and the punctuation
characters ., _, ~, +, and -; they cannot be exactly . or
... Each profile can retain up to 250 versions; delete old
versions before adding more.

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

A FHIR StructureDefinition as a JSON object. Must include resourceType: StructureDefinition, url, type, version, and a snapshot with elements. The canonical URL and resource type must match the profile when one already exists. If id is present, its lowercased value must match the path id; if omitted, the path id is used. The version may contain letters, numbers, and the punctuation characters ., _, ~, +, and -; it cannot be exactly . or ...

Responses

400

Invalid request, version does not match the profile, or the canonical URL is already used by another profile.

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 in use by a different StructureDefinition: either the profile's current one or a retained version
  • The profile has reached the retained version limit
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