Skip to content

FHIR Authoring Pattern Language

Schema-aligned pattern language for building FHIR R4 Implementation Guides and terminology artifacts with fast feedback using HL7 build.fhir.org auto-build and the fhir.base.template#current publishing template.

Treat IG authoring as software delivery: build a thin slice, validate continuously, and ship increments. The IG is an executable contract packaged for tooling and implementers.

Target Audience

  • IG Lead - Owns scope, decisions, and release train.
  • Terminology Steward - Owns CodeSystems/ValueSets/ConceptMaps and terminology server behavior.
  • FHIR Engineer - Authors profiles, examples, tests, and CI.
  • Clinical SME - Provides clinical intent and usability feedback.
  • Vendor Implementer - Builds implementations and provides interoperability feedback.
  • QA / Conformance - Owns test strategy and cross-product verification.

Common Challenges

  • Slow IG development: Friction in authoring and review causes long feedback loops.
  • Terminology drift: ValueSet expansions and mappings change silently across environments.
  • Interop surprises: Works locally but fails in partner products and validators.
  • Unclear ownership: Decisions stall and constraints conflict.

Pattern Categories

Kickoff Patterns

Establish shared, testable direction in days—not months—by converting scope, risks, and success criteria into executable artifacts and decision logs.

Explore Kickoff Patterns

Governance Patterns

Create workgroups that are small enough to decide and broad enough to be legitimate, with a cadence aligned to shipping increments.

Explore Governance Patterns

Authoring Stack Patterns

Use a software-engineering-grade authoring stack (FSH + CI + packages) and HL7 auto-build previews with the neutral base template.

Explore Authoring Stack Patterns

Terminology Patterns

Make terminology an explicit product with governance, distribution, and tests—so meanings don’t drift across implementations.

Explore Terminology Patterns

Profiling Patterns

Profile only as much as needed; bound complexity; ensure constraints are executable and justified.

Explore Profiling Patterns

Testing & Verification Patterns

Build a verification pipeline that continuously checks conformance across validators, servers, SDKs, and test platforms.

Explore Testing & Verification Patterns

Release & Operations Patterns

Release with compatibility guarantees, publish packages, and operate with a predictable change process.

Explore Release & Operations Patterns

Version 0.2.0