An implementation guide (IG) defines how FHIR resources should be used to solve a particular problem. It includes use cases, actors, examples, and other documentation. IGs can have different scopes, from a single use case to a national strategy. The content of an IG depends on its scope, audience, and producing organization. Technical sections describe interactions and profiles, while other sections cover terminology, security, and conformance resources. Tools can help author and publish IGs.
1. FHIR® is the registered trademark of HL7 and is used with the permission of HL7. The Flame Design mark is the registered trademark of HL7 and is used with the permission of HL7.
Amsterdam, 15-17 November | @fhir_furore | #fhirdevdays17 | www.fhirdevdays.com
Implementation Guide Authoring
Ardon Toonstra, Furore
2. A little about me…
• Ardon Toonstra
• Furore
• Background
• FHIR Profiler
• MedMij
• Furore Tools
6. What’s an FHIR IG?
An implementation guide is a set of rules about how FHIR resources are
used (or should be used) to solve a particular problem, with associated
documentation to support and clarify the usage.
http://hl7.org/fhir/implementationguide.html
7. What’s in it?
A bit more concrete…
• Use cases
• Actors
• Interactions
• Data definitions
• Examples
10. What kind of formats are there?
Webpages / WikiDocuments / PDF’s
11. Different scopes
• Strategy (overview and strategic choices)
• Guiding principles (describing overarching principles)
• Subject (describing one subject)
• Use case (one single use case)
Source: http://wiki.hl7.org/index.php?title=ImplementationGuide_Guidance
12. Scope: Strategy
• A nationally scoped guide, providing overview, strategic choices
and is referencing more specific guides
• National infrastructure, security and privacy requirements
• MedMij – ‘Afsprakenstelsel’
• INTEROPen – Care Connect API | FHIR®
18. Scope: Subject
• Multiple use cases and scenarios describing one subject
• IHE technical framework
• Medication
• Lab results in Norway
19.
20. Scope: Use case
• A guide describing a use case and its interactions, data structures,
vocab, testing
• IHE integration profile
• prescription
• ZorgDomein FHIR interface
23. Content depends on
• Scale and scope of the guide (from national to product)
• Intended audience
• Background of the IG producing organization
• Standardization organization or a vendor
• Scale and scope of the guide (from national to product)
• Intended audience
• Background of the IG producing organization
• Standardization organization or a vendor
24. Sections
• About the IG
• Use Case(s)
• Technical Implementation Guidance
• Profiles
• Registry
• Security
• Appendix
• Help (general guidance)
• Contact Information
25. Describe Use case(s)
• Overview of systems and architecture
• (System)Actors overview
• Scenarios
• Triggers/reasons (interaction diagrams, sequence
diagram, etc)
• pre- and post conditions
26. Describe Use case(s)
• Dataset and Data elements (could be a
reference)
• Business rules, policy (technology
independent)
• “There has to be a diabetes control document
once every three months”.
• “Systems must have a consent on file for the
patient to be allowed exchange patient data”
28. Technical Implementation Guidance
• Sender and receiver responsibilities (functional requirements)
• “Upon a POST of a new resource, the sender SHALL return a body with the
newly stored resource”.
• List of invocations
• Message Semantics
• Interactions
• Operations
• Search parameters
29. Technical Implementation Guidance
• List of profiles
• Terminology (valueset, conceptmaps)
• NamingSystems
• Mappings
• Examples (instances)
35. Now…. How to make them?
Join us at the next tutorial to see some of the available IG tools
36. Food for thought
• If you need to make an IG for two or more FHIR versions. How would you
set it up?
• Create guides for specific audiences? Is there are “one size fits all”?
• Use of multiple languages – how to maintain?
38. Publicly available IGs on Simplifier.net
• https://simplifier.net/guide/DraftpcCDRFHIRImplementationGuide
• https://simplifier.net/guide/eRefferaldraftiGuide
• https://simplifier.net/guide/FinnishPHRImplemetationGuide
• https://simplifier.net/guide/PCHAPersonalHealthDeviceDataImplementationGuide
• https://simplifier.net/guide/LeitfadenBasisDE
• https://simplifier.net/guide/HelseVestPerioperativeImplementationGuide
• https://simplifier.net/guide/KULEPrescriptionTemporaryIG
Notes de l'éditeur
This presentation is part of the FHIR for Specifiers track. If you followed this track you will have had talks about Profling and the related tools. Ewout talked about FHIRPath, which may come in handy in creating your own profiles.
So next are two sessions about IG. In the first part I will talk about the authoring side of IG’s. The second part we will continue on how to create IG’s using three different tools.
How many people have written an Implemantion Guide themselfs? For FHIR?
The Implementation Guide resource will be covered in the next tutorial.
It is very important to keep in mind who your audience is. For FHIR implementation guides it will probably be fully focused on Developers. So write your content to it.
Business Analysts
Keep in mind your audience. Keep it condense. Nobody likes to read the manual.
Implementation Guides vary widely in scope. If we try to categorize them based on scale of information. In the following slides I give IG examples to every scope.
Strategic target: by 2020 everyone in the netherlands can have a personal health environment if wanted.
“These profiles are intended to be the foundation of future US Realm FHIR implementation guides.”
ZorgDomein use case; sending medical referrals
A list of content we found, categorized under headings we feel are likely candidates for suggested section headers in an Implementation Guide.
Exactly which information is relevant is dependent on the scale of the guide (from national to product oriented), the intended audience and the background of the organization producing the guide (SDO’s, hospital IT departments), so the list below can never be more than a list of “reminders”, a “check list” that authors can use to see if they have forgotten obvious information.
About the IG
Document information (metadata) + Introduction to the Guide (rationale/objective/audience/scope&boundries/relationships/legal obligations)
A list of content we found, categorized under headings we feel are likely candidates for suggested section headers in an Implementation Guide.
Exactly which information is relevant is dependent on the scale of the guide (from national to product oriented), the intended audience and the background of the organization producing the guide (SDO’s, hospital IT departments), so the list below can never be more than a list of “reminders”, a “check list” that authors can use to see if they have forgotten obvious information.
Per specific use case – or transaction
So this is the actual stuff where all your
List of invocations
Message Semantics – How does the actual message look like / sender and reciever messages
Interactions - which interactions are use (CRUD Create, Read, Update, Delete)
Operations - Operation
Search parameters
List of all artifacts used in this guide
Auto generate
An implementation guide is a set of rules about how FHIR resources are used (or should be used) to solve a particular problem, with associated documentation to support and clarify the usage.
Mostly focused on developers
Depending on scope and scale you
