Skip to content

Standard IG Layout

Intent

Keep authors and tools in sync by adopting the HL7 IG Publisher folder schema. When everyone follows the same conventions, onboarding is faster, CI is simpler, and cross-IG contributions become practical.

Structure

The standard IG layout follows HL7 IG Publisher conventions for predictable tooling support. This structure has evolved through years of community experience and represents the path of least resistance for FHIR tooling.

Standard IG repository layout showing key directories and their purposes

Implementation Considerations

Directories

  • input/fsh — primary FSH sources
  • input/resources — generated JSON/XML if committed
  • input/examples — curated example Instances
  • input/includes and input/pagecontent — markdown and fragments
  • docs/adr — Architecture Decision Records (MADR)
  • .github or .gitlab — workflows, issue/PR templates
  • _scripts — local build parity scripts

Branching

  • main: release line
  • develop (optional): integration
  • feature/*: short-lived work
  • release/*: stabilisation and tagging

Benefits

  • Onboard faster
  • Simpler CI

Trade-offs

  • Refactors for legacy repos