How hapifhir/fhir-tutorial works
Project type and purpose
• This is not a traditional code-heavy application but an open-collaborative training package: a static documentation/tutorial site for FHIR (Fast Healthcare Interoperability Resources).
• The README calls it a “FHIR Tutorial” comprising individual lessons (CRUD, FHIRPath, Profiling, etc.), images, and example payloads.
File structure
• Top-level directories correspond to lesson modules:
• CRUD operations
• FHIRPath
• Profiling
• SearchParameter
• Search_References_ChainHasIncludeRevinclude
• Terminology/CodeSystem_and_ValueSet
• Transactions
• examples (contains JSON test-data)
• Each lesson folder has:
• lesson.md (Markdown content)
• img or images subfolder (assets)
• No source code or server components—pure content repository.
README insights
• The focus is on training materials; there is no built-in application code or API server here.
• Licensed under Creative Commons, hosted in Git.
a. Main components to represent:
1. Content Modules – each lesson folder (CRUD, FHIRPath, …)
2. Media Assets – images directories under each module
3. Examples – test-data JSON files
4. Documentation Processing Pipeline – static site generator (e.g., Jekyll, MkDocs) or GitHub Pages renderer
5. CI/CD – GitHub Actions or other build workflows (linting Markdown, deploying site)
6. Hosting & Delivery – GitHub Pages or CDN, served to end-users (browsers)
7. External References – Smile CDR, Creative Commons License badge
b. Relationships & interactions:
– From Pipeline to Hosting/CDN.
– From Hosting to End Users (Browsers).
– CI/CD connected to Git repository and Pipeline.
c. Architectural patterns/design principles:
– Modular content architecture: each lesson is self-contained.
– Static site generation: content-as-code.
– Continuous deployment: automatic publish on commit to main branch.
d. Relevant technologies/frameworks:
– Markdown (.md)
– Static Site Generator (Jekyll, Hugo, MkDocs—choose one or note “to be decided”)
– Git & GitHub (version control, hosting)
– GitHub Actions (CI/CD pipeline)
– CDN/GitHub Pages (hosting)
Additional notes
• Don’t overcomplicate—reflect the straightforward, modular, static nature of the site.
• Viewer can trace from raw markdown files all the way to the rendered tutorial in a browser.
• Where to insert new modules or how to extend the pipeline for new lessons.