IHE FHIR Profile Publication/Overview and Concepts
IHE FHIR Profile Publication/Overview and Concepts
This page is targeted at an IHE author who wants to write a new supplement that will be published using web based tools and not a PDF document. There are separate forces at work, and you need to understand those.
- There is general work designed to allow a profile author to write a supplement that will be web based.
- There is a second level of work intended to support profiles that are based on the HL7 FHIR specification.
There are also other forces such as the use of Github to control files during the publication process. That will be addressed separately.
Supplement Type Background
I decided to not use numeric values for the different types that will be described below. With the exception of the first level (alpha), I am not convinced that one will be able to draw a clear line from one type to the next that is monotonically increasing using some measure. I expect you will see more of a connected graph relationship between the various types rather than a series of types where each type has exactly all of the features of the previous type plus one or more new feature. To put it another way, do not take the labels assigned to the types to mean that one supplement type is better than another.
Supplement Types
alpha
alpha: This supplement consists of the following:
- One main HTML page
- One index HTML page
- No other pages
- No other related artifacts other than icons, figures, etc.
Note that we make no comment about the level of detail on the main HTML page. It would have to contain enough information to satisfy what is currently in an IHE supplement.
The alpha supplement is intended for a profile author to get started with the documentation process. You will quickly add more files/content once you have an outline.
Author Requirements
This section describes the content you need to provide to create a supplement.