Upload custom FHIR profile (deprecated)

POST/lang2fhir/profile/uploaddeprecated

Deprecated — use POST /fhir/profiles instead. This route continues to work and operates on the same custom profiles, so no migration is required; it will be removed in a future release. Note that POST /fhir/profiles does not accept profile_context; set implementation-guide context with PUT /fhir/implementation-guides/{name}.

Upload a custom FHIR StructureDefinition profile for use with the lang2fhir service.

All metadata is derived from the StructureDefinition JSON itself. The lowercase id field from the StructureDefinition is used as the profile's unique identifier and lookup key. To use the uploaded profile with /lang2fhir/create, pass this id as the resource parameter.

Uploads will be rejected if:

A built-in US Core or R4 base profile already exists with the same id
A custom profile with the same id has already been uploaded
A custom profile with the same url has already been uploaded

RequiresBearerauthentication

Body parameters

profilestringrequired

Base64 encoded JSON string of a FHIR StructureDefinition. The profile must include id, url, type, and a snapshot with elements. All metadata (version, resource type, identifier) is derived from the StructureDefinition itself. The lowercase id from the StructureDefinition becomes the profile's lookup key.

implementation_guidestringoptional

Implementation Guide name to group this profile under. Defaults to "custom" if omitted. 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.

profile_contextstringoptional

Natural language context that helps the LLM select the right profiles from this implementation guide during resource detection. For example, "When the text mentions phenotypic features or abnormalities, prefer the hpo-observation profile over Condition." This is stored as IG-level metadata and injected into the LLM prompt. Max 2000 characters. Providing this field on any upload will update the context for the entire IG (last write wins).

Returns

Profile successfully uploaded

Response fields

messagestringoptional

idstringoptional

The lowercase StructureDefinition id, used as the profile's unique identifier and lookup key. Pass this value as the resource parameter to /lang2fhir/create or /lang2fhir/profile/json/:version/:resource to use this profile.

typestringoptional

The FHIR resource type from the StructureDefinition

urlstringoptional

The canonical URL from the StructureDefinition

POSTRequest

# 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 POST "https://experiment.app.pheno.ml/lang2fhir/profile/upload" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "profile": "eyJyZXNvdXJjZVR5cGUiOiJTdHJ1Y3R1cmVEZWZpbml0aW9uIiwiaWQiOiJjdXN0b20tcGF0aWVudCIsInVybCI6Imh0dHA6Ly9waGVub21sLmNvbS9maGlyL1N0cnVjdHVyZURlZmluaXRpb24vY3VzdG9tLXBhdGllbnQiLCJuYW1lIjoiQ3VzdG9tUGF0aWVudCIsInN0YXR1cyI6ImFjdGl2ZSIsImZoaXJWZXJzaW9uIjoiNC4wLjEiLCJraW5kIjoicmVzb3VyY2UiLCJhYnN0cmFjdCI6ZmFsc2UsInR5cGUiOiJQYXRpZW50IiwiYmFzZURlZmluaXRpb24iOiJodHRwOi8vaGw3Lm9yZy9maGlyL1N0cnVjdHVyZURlZmluaXRpb24vUGF0aWVudCIsImRlcml2YXRpb24iOiJjb25zdHJhaW50Iiwic25hcHNob3QiOnsiZWxlbWVudCI6W3siaWQiOiJQYXRpZW50IiwicGF0aCI6IlBhdGllbnQiLCJtaW4iOjAsIm1heCI6IioifSx7ImlkIjoiUGF0aWVudC5uYW1lIiwicGF0aCI6IlBhdGllbnQubmFtZSIsIm1pbiI6MSwibWF4IjoiKiJ9XX19Cg==",
  "implementation_guide": "acme-cardiology",
  "profile_context": "When clinical text describes cardiology-specific findings, prefer this profile over the generic US Core Condition."
}'

201 CreatedExample Response

{
  "message": "Profile uploaded successfully",
  "id": "custom-patient",
  "type": "Patient",
  "url": "http://phenoml.com/fhir/StructureDefinition/custom-patient"
}