API Reference

Upload a custom FHIR profile

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

Creates a custom profile from a FHIR StructureDefinition supplied as a JSON
object. All metadata (version, resource type, id, url) is derived from the
StructureDefinition; the lowercase StructureDefinition id becomes the
profile's lookup key. Code system configuration is auto-extracted from the
snapshot. Optionally group the profile under a named implementation guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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 id collides with a built-in US Core or R4 base profile
  • A custom profile with the same id or url already exists
401

Unauthorized

403

Forbidden - custom profiles are only available on dedicated instances

500

Server error

Updated 18 days 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 18 days ago

Did this page help you?