Pattern Co-Usage Map

Patterns that work well together

Overview

IG authoring patterns are designed to complement each other. This section shows common combinations for different project situations.

Common Pattern Combinations

Starter IG stack

Purpose: Baseline for a new IG

Pattern Combination:

• Standard IG Layout - Keep authors and tools in sync by adopting the HL7 IG Publis...
• ADR Log - Make design rationale discoverable and reviewable so that fu...
• Aliases and RuleSets - Centralise constants and reusable rule blocks to reduce dupl...
• Local Build Parity - Ensure the same toolchain runs locally and in CI...

Key Interactions:

• ADR links in profile comments
• CI validates examples against compiled SDs

Multi-IG collaboration

Purpose: Split shared artifacts

Pattern Combination:

• Shared Modules IG - Extract cross-cutting profiles, extensions, and terminology ...
• Co-authoring Workflow - Enable concurrent edits with clear ownership and review...
• SemVer and Release Channels - Publish predictable versions and previews so consumers know ...

---

Pattern Synergies

The patterns in this collection are designed to work together. Start with a core pattern like Broker or Security Strategy, then add complementary patterns as needed.

Customization

These combinations are starting points. Adapt them based on your specific requirements, existing infrastructure, and organizational constraints.