List implementation guides

GET/fhir/implementation-guides

Returns every implementation guide on this instance — both guides that have stored metadata (a profile_context) and guides referenced by at least one custom profile — with the number of profiles in each.

RequiresBearerauthentication

Returns

List of implementation guides

Response fields

implementation_guidesobject[]optional

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.

GETRequest

# 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 GET "https://experiment.app.pheno.ml/fhir/implementation-guides" \
  -H "Authorization: Bearer $PHENOML_TOKEN"

200 OKExample Response

{
  "implementation_guides": [
    {
      "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"
    }
  ]
}