Get a retained custom FHIR profile version

GET/fhir/profiles/{id}/versions/{version}

Returns metadata and the full StructureDefinition for one retained version. The returned StructureDefinition's id is the profile id. The path version is the authored StructureDefinition.version value.

RequiresBearerauthentication

Path parameters

idstringrequired

The lowercase StructureDefinition id of the custom profile.

versionstringrequired

The authored StructureDefinition.version. It may contain letters, numbers, and the punctuation characters ., _, ~, +, and -; it cannot be exactly . or ...

Returns

The requested profile version

Response fields

idstringoptional

sourcestringoptional

resource_typestringoptional

urlstringoptional

versionstringoptional

statusstringoptional

datestringoptional

canonicalstringoptional

fhir_versionstringoptional

implementation_guidestringoptional

created_atstringoptional

updated_atstringoptional

structure_definitionobjectoptional

resourceTypestringoptional

idstringoptional

urlstringoptional

versionstringoptional

namestringoptional

statusstringoptional

fhirVersionstringoptional

kindstringoptional

abstractbooleanoptional

typestringoptional

baseDefinitionstringoptional

derivationstringoptional

snapshotobjectoptional

elementarray<object>optional

idstringoptional

pathstringoptional

minintegeroptional

maxstringoptional

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/custom-patient/versions/2.0.0" \
  -H "Authorization: Bearer $PHENOML_TOKEN"

200 OKExample Response

{
  "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",
  "structure_definition": {
    "resourceType": "StructureDefinition",
    "id": "custom-patient",
    "url": "http://phenoml.com/fhir/StructureDefinition/custom-patient",
    "version": "1.0.0",
    "name": "CustomPatient",
    "status": "active",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Patient",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
    "derivation": "constraint",
    "snapshot": {
      "element": [
        {
          "id": "Patient",
          "path": "Patient",
          "min": 0,
          "max": "*"
        }
      ]
    }
  }
}