Template:Information Model Design Pattern

From HL7Wiki
Jump to navigation Jump to search

To use this Template:

  1. Search (or Go to) for a page with name like xxxxx_IM_Design_Pattern
  2. Click on the RED link to the (previously) undefined page in order to edit it.
  3. Type {{subst::Template:Information Model Design Pattern}} as the only content for the new page.
  4. Preview (if desired) to verify the reference was typed correctly
  5. "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.
  6. Re-edit the page to include the appropriate content in each of the sections
  7. Save again
The displayed contents below this line is the outline for an design pattern


Return to Candidate Information Model Design Pattern List

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

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