Publish an exact custom-profile package

POST/fhir/implementation-guides/{name}/versions

Publishes an exact package beneath this guide family. Each guide family supports one exact package version. Publishing another version returns 409 Conflict.

RequiresBearerauthentication

Path parameters

namestringrequired

Body parameters

implementation_guideobjectrequired

A complete authored FHIR ImplementationGuide JSON resource.

resourceTypestringrequired

ImplementationGuide

idstringoptional

urlstringrequired

versionstringrequired

namestringoptional

statusstringoptional

packageIdstringoptional

fhirVersionstring[]optional

profile_refsstring[]required

Exact canonical url|version references to builtin or custom profiles. A package can contain at most 250 references.

profile_contextstringoptional

Natural-language profile-selection context for this package.

Returns

Canonical package published

Response fields

namestringrequired

urlstringrequired

versionstringrequired

profile_contextstringrequired

profilesstring[]required

profile_refsstring[]required

implementation_guideobjectrequired

A complete authored FHIR ImplementationGuide JSON resource.

resourceTypestringrequired

ImplementationGuide

idstringoptional

urlstringrequired

versionstringrequired

namestringoptional

statusstringoptional

packageIdstringoptional

fhirVersionstring[]optional

created_atstring (date-time)required

updated_atstring (date-time)required

POSTRequest

# 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 POST "https://experiment.app.pheno.ml/fhir/implementation-guides/{name}/versions" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "implementation_guide": {
    "resourceType": "ImplementationGuide",
    "id": "abc-123-def-456",
    "url": "https://example.com",
    "version": "1.0.0",
    "name": "Example Name",
    "status": "active",
    "packageId": "abc-123-def-456",
    "fhirVersion": [
      "example"
    ]
  },
  "profile_refs": [
    "example"
  ],
  "profile_context": "Example text content"
}'

201 CreatedExample Response

{
  "name": "Example Name",
  "url": "https://example.com",
  "version": "1.0.0",
  "profile_context": "Example text content",
  "profiles": [
    "example"
  ],
  "profile_refs": [
    "example"
  ],
  "implementation_guide": {
    "resourceType": "ImplementationGuide",
    "id": "abc-123-def-456",
    "url": "https://example.com",
    "version": "1.0.0",
    "name": "Example Name",
    "status": "active",
    "packageId": "abc-123-def-456",
    "fhirVersion": [
      "example"
    ]
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}