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. 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 (split on the last |); the bare form matches the current version.

Returns

List of uploaded profiles

Response fields

profilesobject[]optional

idstringoptional

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

sourcestringoptional

The profile's origin. Listings currently return only custom (uploaded) profiles, so this is always "custom" today; built-in (US Core / R4 base) profiles would be surfaced via an opt-in parameter in a future release, not by changing the default behavior.

custombuiltin

resource_typestringoptional

The FHIR resource type from the StructureDefinition.

urlstringoptional

The canonical URL from the StructureDefinition.

versionstringoptional

The version from the StructureDefinition.version field.

fhir_versionstringoptional

The base FHIR version the StructureDefinition targets.

implementation_guidestringoptional

The implementation guide the profile belongs to.

created_atstring (date-time)optional

updated_atstring (date-time)optional

GETRequest

curl 'https://experiment.app.pheno.ml/fhir/profiles?url=http%3A%2F%2Fphenoml.com%2Ffhir%2FStructureDefinition%2Fcustom-patient%7C1.0.0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

200 OKResponse

{
  "profiles": [
    {
      "id": "custom-patient",
      "source": "custom",
      "resource_type": "Patient",
      "url": "http://phenoml.com/fhir/StructureDefinition/custom-patient",
      "version": "1.0.0",
      "fhir_version": "4.0.1",
      "implementation_guide": "acme-cardiology",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ]
}