Difference between revisions of "Template:Information Model Design Pattern"
| Line 58: | Line 58: | ||
</i></span></small><br/></noinclude> | </i></span></small><br/></noinclude> | ||
<!--Diagrams (generally incomplete HL7 RMIM-style diagrams) that show the key elements of the pattern (what connects to what, what constraints apply, etc.) --> | <!--Diagrams (generally incomplete HL7 RMIM-style diagrams) that show the key elements of the pattern (what connects to what, what constraints apply, etc.) --> | ||
| + | |||
| + | Put diagrams and text here | ||
| + | |||
| + | == Description == | ||
| + | <noinclude><small><span style="color:#0000FF"><i> | ||
| + | Explanation of the pattern and how it works | ||
| + | </i></span></small><br/></noinclude> | ||
| + | <!--Explanation of the pattern and how it works --> | ||
Put text here | Put text here | ||
| − | + | == Applicable circumstances == | |
| − | + | <noinclude><small><span style="color:#0000FF"><i> | |
| − | + | Identifies the model circumstances in which the pattern applies. Use "MAY" for optional and "SHALL" for mandatory | |
| − | + | </i></span></small><br/></noinclude> | |
| − | + | <!--Identifies the model circumstances in which the pattern applies. Use "MAY" for optional and "SHALL" for mandatory --> | |
| − | + | ||
| + | Put text here | ||
| + | |||
| + | == Non-applicable circumstances == | ||
| + | <noinclude><small><span style="color:#0000FF"><i> | ||
| + | Identifies the model circumstances in which the does not pattern applies. Use "SHOULD NOT" for optional and "SHALL NOT" for mandatory | ||
| + | </i></span></small><br/></noinclude> | ||
| + | <!--Identifies the model circumstances in which the does not pattern applies. Use "SHOULD NOT" for optional and "SHALL NOT" for mandatory --> | ||
| + | |||
| + | Put text here | ||
| + | |||
| + | == Examples == | ||
| + | <noinclude><small><span style="color:#0000FF"><i> | ||
| + | Reference to models (and locations within them) where the pattern has been used | ||
| + | </i></span></small><br/></noinclude> | ||
| + | <!--Reference to models (and locations within them) where the pattern has been used --> | ||
| + | |||
| + | Put text here | ||
| + | |||
| + | == Variations == | ||
| + | <noinclude><small><span style="color:#0000FF"><i> | ||
| + | Identify other variations of this pattern, if any. | ||
| + | </i></span></small><br/></noinclude> | ||
| + | <!-- Identify other variations of this pattern, if any. --> | ||
| + | |||
| + | Put text here | ||
== Owner == | == Owner == | ||
Revision as of 01:46, 13 September 2011
To use this Template:
- Search (or Go to) for a page with name like xxxxx_IM_Design_Pattern
- Click on the RED link to the (previously) undefined page in order to edit it.
- Type {{subst::Template:Information Model Design Pattern}} as the only content for the new page.
- Preview (if desired) to verify the reference was typed correctly
- "Save" the page.
- At this point, the contents of this template (with the following exceptions) will replace the substitution link. The exceptions are:
- These instructions will not appear.
- The small blue-font annotations about each entry will be replaced with an <!-- XML Comment --> saying the same thing. These comments are visible while editing, but they do not appear when the Wiki page is previewed or saved.
- At this point, the contents of this template (with the following exceptions) will replace the substitution link. The exceptions are:
- Re-edit the page to include the appropriate content in each of the sections
- Save again
Contents
Some Design Pattern Name
Descriptive label for the pattern
Effective Date
Date on which the pattern received final (ballot) approval. (Leave blank for an initial submission.)
Put text here
Purpose
Why is this pattern needed and what does it accomplish? What problem is it trying to solve? Should ideally be only a few sentences
Put text here
Sponsor
Which Work Group has primary responsibility for the pattern and should be the first point of contact for proposed changes?
Put text here
Diagram(s)
Diagrams (generally incomplete HL7 RMIM-style diagrams) that show the key elements of the pattern (what connects to what, what constraints apply, etc.)
Put diagrams and text here
Description
Explanation of the pattern and how it works
Put text here
Applicable circumstances
Identifies the model circumstances in which the pattern applies. Use "MAY" for optional and "SHALL" for mandatory
Put text here
Non-applicable circumstances
Identifies the model circumstances in which the does not pattern applies. Use "SHOULD NOT" for optional and "SHALL NOT" for mandatory
Put text here
Examples
Reference to models (and locations within them) where the pattern has been used
Put text here
Variations
Identify other variations of this pattern, if any.
Put text here
Owner
What is the Work Group or Task Group responsible for
Put text here
