Skip to content

Canonical URL and Package ID

Intent

Ensure stable discovery and dependency management across IGs by establishing consistent, predictable identifiers from the start of the project.

Implementation Considerations

Conventions

  • Canonical URL: https://{org-domain}/{ig}/{major}
  • Package id: {org}.{ig}[.{module}] (lowercase; matches npm-ish reverse-DNS)
  • Title-cased IG name in sushi-config.yaml; keep id stable across releases

sushi-config.yaml

sushi-config.yaml
id: au.csiro.lab.example
canonical: https://example.org/fhir/ig/example
name: ExampleIG
status: draft
version: 0.1.0
dependencies:
  hl7.fhir.r4.core: 4.0.1
  hl7.terminology.r4: 5.3.0

Benefits

  • Predictable imports
  • Clear provenance

Trade-offs

  • Early naming ceremony

sushi-config.yaml

id: au.csiro.lab.erequesting canonical: https://csiro.au/fhir/ig/erequesting name: ERequestingIG status: active version: 1.2.0