Set an implementation guide's profile context

PUT/fhir/implementation-guides/{name}

Sets (or clears, with an empty value) the natural-language profile_context for an implementation guide. The context is injected into the LLM during resource detection to help select the right profiles from this guide. It applies to every profile in the guide.

RequiresBearerauthentication

Path parameters

namestringrequired

The implementation guide name.

Body parameters

profile_contextstringoptional

Natural-language context that helps the LLM select the right profiles from this implementation guide during resource detection. An empty value clears the context. Max 2000 characters.

Returns

Implementation guide successfully updated

Response fields

namestringoptional

The instance-local implementation guide name (the stable key).

profile_contextstringoptional

Natural-language context injected into the LLM during resource detection.

profile_countintegeroptional

The number of custom profiles in this implementation guide.

canonical_urlstringoptional

Canonical FHIR ImplementationGuide URL, when the family has an exact package.

version_countintegeroptional

Number of retained exact package versions.

created_atstring (date-time)optional

Present only for guides that have stored metadata (a profile_context has been set). Omitted for guides that exist solely because a profile references them.

updated_atstring (date-time)optional

Present only for guides that have stored metadata. Omitted for guides that exist solely because a profile references them.

PUTRequest

# 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 PUT "https://experiment.app.pheno.ml/fhir/implementation-guides/acme-cardiology" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "profile_context": "When clinical text describes phenotypic features, use the hpo-phenotype-observation profile instead of Condition."
}'

200 OKExample Response

{
  "name": "acme-cardiology",
  "profile_context": "When the text mentions phenotypic features, prefer the hpo-observation profile over Condition.",
  "profile_count": 3,
  "canonical_url": "https://example.com",
  "version_count": 10,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}