List custom FHIR profiles

GET/fhir/profiles

Returns metadata for every custom (uploaded) FHIR profile on this instance, across all implementation guides. The full StructureDefinition JSON is omitted from each entry; fetch a single profile by id to retrieve it.

The url query parameter filters by canonical URL. The canonical URL is the stable key other platform features use to reference a profile (FHIR's meta.profile, baseDefinition), since StructureDefinition ids are only unique within a package. An unpinned url filter returns metadata for the profile's current StructureDefinition. Pinned url|version filters resolve a retained version when present; otherwise they can fall back to the profile's current StructureDefinition, whose content can change through the profile update endpoint. A non-matching filter returns an empty list, not a 404.

RequiresBearerauthentication

Query parameters

urlstringoptional

Filter by canonical URL. Accepts the FHIR pinned form url|version; without a version pin, returns the profile's current StructureDefinition metadata.

Returns

List of uploaded profiles

Response fields

profilesobject[]required

idstringrequired

The lowercase StructureDefinition id, used as the profile's lookup key.

sourcestringrequired

The profile's origin. Profile management responses return custom (uploaded) profiles, so this value is always "custom".

custombuiltin

resource_typestringrequired

The FHIR resource type from the StructureDefinition.

urlstringrequired

The canonical URL from the StructureDefinition.

versionstringrequired

The version from the StructureDefinition.version field.

statusstringoptional

The publication status from StructureDefinition.status. Expected FHIR values include draft, active, retired, and unknown; the server preserves authored strings.

datestringoptional

The authored publication date from StructureDefinition.date, when present. This is a FHIR dateTime string and may be less precise than a full timestamp.

canonicalstringrequired

The canonical profile reference, including the version pin when present.

fhir_versionstringrequired

The base FHIR version the StructureDefinition targets.

implementation_guidestringrequired

The implementation guide the profile belongs to.

created_atstring (date-time)required

updated_atstring (date-time)required

Last update timestamp for the profile's current StructureDefinition. For retained versions, this equals created_at.

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/profiles?url=http%3A%2F%2Fphenoml.com%2Ffhir%2FStructureDefinition%2Fcustom-patient%7C1.0.0" \
  -H "Authorization: Bearer $PHENOML_TOKEN"

200 OKExample Response

{
  "profiles": [
    {
      "id": "custom-patient",
      "source": "custom",
      "resource_type": "Patient",
      "url": "http://phenoml.com/fhir/StructureDefinition/custom-patient",
      "version": "1.0.0",
      "status": "active",
      "date": "2026-08-24",
      "canonical": "http://phenoml.com/fhir/StructureDefinition/custom-patient|1.0.0",
      "fhir_version": "4.0.1",
      "implementation_guide": "acme-cardiology",
      "created_at": "2026-08-24T15:04:05Z",
      "updated_at": "2026-08-25T16:04:05Z"
    }
  ]
}