This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Template:Information Model Design Pattern"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "<noinclude> <!-- NOTE: If you edit the guidance text in this template, be sure to change both the content inside the 'noinclude' tags as well as the content inside the XML commen...")
 
 
(7 intermediate revisions by one other user not shown)
Line 4: Line 4:
 
-->
 
-->
 
[[Category:StyleGuides]]<big>To use this Template:
 
[[Category:StyleGuides]]<big>To use this Template:
#Search (or Go to) for a page with name like xxxxx_Artifact_Definition
+
#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.
 
#Click on the '''RED''' link to the (previously) undefined page in order to edit it.
#Type '''<nowiki>{{subst::Template:SAIF Artifact Definition}}</nowiki>''' as the '''only content''' for the new page.
+
#Type '''<nowiki>{{subst::Template:Information Model Design Pattern}}</nowiki>''' as the '''only content''' for the new page.
 
#Preview (if desired) to verify the reference was typed correctly
 
#Preview (if desired) to verify the reference was typed correctly
 
#"Save" the page.
 
#"Save" the page.
Line 15: Line 15:
 
#Save again<br/>
 
#Save again<br/>
  
<center>'''The displayed contents below this line is the outline for an artifact definition'''</center>
+
<center>'''The displayed contents below this line is the outline for an design pattern'''</center>
 
----
 
----
 
----  
 
----  
 
</big>
 
</big>
 
</noinclude>
 
</noinclude>
[[Category:SAIF Artifact Definition]]
+
[[Category:Design Patterns]]
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
+
[[Category:Information Model Design Patterns - Candidate]]
 +
[[:Category:Information Model Design Patterns - Candidate|Return to Candidate Information Model Design Pattern List]]
  
=Some Artifact Name=
+
=Some Design Pattern Name=
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
Artifact names should be descriptive and short.  They may change as we further refine the methodology
+
Descriptive label for the pattern
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- Artifact names should be descriptive and short.  They may change as we further refine the methodology -->
+
<!-- Descriptive label for the pattern should be descriptive and short.  They may change as the design pattern approval process evolves -->
  
== Definition and Purpose ==
+
== Effective Date ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
At a high level, what is this artifact and why is it needed?  Note that according to HL7's [[Annotations Best Practices]] the opening fragment should be a noun phrase rather than a complete sentenceShould ideally be only a few sentences
+
Date on which the pattern received final (ballot) approval(Leave blank for an initial submission.)
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- At a high level, what is this artifact and why is it needed? Should ideally be only a few sentences -->
+
<!--Date on which the pattern received final (ballot) approval. (Leave blank for an initial submission.) -->
  
 
Put text here
 
Put text here
  
== SAIF Matrix Location ==
+
== Purpose ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
Where does this artifact fit into the SAIF matrixDelete those rows and columns that do not apply and provide qualification if appropriate
+
Why is this pattern needed and what does it accomplish?  What problem is it trying to solveShould ideally be only a few sentences
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- Where does this artifact fit into the SAIF matrixDelete those rows and columns that do not apply and provide qualification if appropriate -->
+
<!--Why is this pattern needed and what does it accomplishWhat problem is it trying to solve?  Should ideally be only a few sentences -->
'''Row(s)'''
 
* Conceptual (CIM)
 
* Logical (PIM)
 
* Implementable (PSM)
 
  
'''Column(s)'''
+
Put text here
* Enterprise/Business
 
* Information
 
* Computational
 
* Engineering
 
* Technical
 
  
== Prior Methodology Correspondence ==
+
== Sponsor ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
Identifies how this artifact relates to artifacts from HL7's previous methodology and, in particular, whether there have been changes in scope or behavior from previous artifacts.  In some cases, the artifact will be net new.
+
Which Work Group has primary responsibility for the pattern and should be the first point of contact for proposed changes?
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- Identifies how this artifact relates to artifacts from HL7's previous methodology and, in particular, whether there have been changes in scope or behavior from previous artifacts.  In some cases, the artifact will be net new. -->
+
<!--Which Work Group has primary responsibility for the pattern and should be the first point of contact for proposed changes? -->
  
== Audience ==
+
Put text here
<noinclude><small><span style="color:#0000FF"><i>
 
Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.
 
</i></span></small><br/></noinclude>
 
<!-- Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.-->
 
Health Care Community Audiences:
 
*General public <!-- as health care participants -->
 
*Health care practitioners <!-- of all stripes -->
 
*Health system administrators <!-- includes payors, pharma management -->
 
*Health care policy makers
 
 
 
Health Care Semantic Analysis Audiences:
 
*Business Analysts: Map requirements to models (or system requirements)
 
*Informaticists: Select and differentiate between information models and terminologies
 
*System analysts: Map system requirements to specific technical solutions
 
 
 
Health Care Information Technology (IT) Audiences:
 
*Standards developers and standards development organizations
 
*System designers and architects
 
*System purchasers
 
*Programmers/implementers
 
*System vendor management
 
*Education/Research
 
  
== Applicability ==
+
== Diagram(s) ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why?
+
Diagrams (generally incomplete HL7 RMIM-style diagrams) that show the key elements of the pattern (what connects to what, what constraints apply, etc.)
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why? -->
+
<!--Diagrams (generally incomplete HL7 RMIM-style diagrams) that show the key elements of the pattern (what connects to what, what constraints apply, etc.) -->
Text
 
  
<i>Rationale</i>: More text
+
Put diagrams and text here
  
== Requirements, Relationships and Content ==
+
== Description ==
<noinclude><small><span style="color:#0000FF"><i>
 
What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.)
 
</i></span></small><br/></noinclude>
 
<!-- What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.) -->
 
# Some requirement
 
## <i>Rationale</i>Some reason
 
# Some other requirement
 
## <i>Rationale</i>Some other reason
 
=== Relationships and traceability ===
 
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
What are the other artifacts to which this artifact must or may be required to relate?  (Express those relationships that are "many-to-one" - that is where many of this artifact type will usually relate to one of the other artifact type.) How do they relate?  Why is the relationship important? <br/><br/>Follow with a bullet list of artifacts that may or must relate to this artifact, where many of the listed artifact type will relate to one of this artifact type. 
+
Explanation of the pattern and how it works
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- What are the other artifacts to which this artifact must or may be required to relate?  (Express those relationships that are "many-to-one" - that is where many of this artifact type will usually relate to one of the other artifact type.) How do they relate?  Why is the relationship important?
+
<!--Explanation of the pattern and how it works -->
  
Follow with a bullet list of artifacts that may or must relate to this artifact, where many of the listed artifact type will relate to one of this artifact type. 
+
Put text here
-->
 
* Some relationship
 
** <i>Rationale</i>: Reason for relationship
 
* Some other relationship
 
** <i>Rationale</i>: Reason for other relationship
 
 
 
<b>Artifact types that may or must relate to this artifact types:</b>
 
* Many-related Artifact Type
 
* Another Many-related Artifact Type
 
  
=== Content ===
+
== Applicable circumstances ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
What elements or components are required to be part of this artifact, and what is their hierarchical structure?  How?  Why is the content important? (These can be expresses as a hierarchical set of content element names, with a brief phrase to describe each.)
+
Identifies the model circumstances in which the pattern applies. Use "MAY" for optional and "SHALL" for mandatory
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- What elements or components are required to be part of this artifact, and what is their hierarchical structure?  How?  Why is the content important? (These can be expresses as a hierarchical set of content element names, with a brief phrase to describe each.) -->
+
<!--Identifies the model circumstances in which the pattern applies. Use "MAY" for optional and "SHALL" for mandatory -->
* <b>Content element name</b> - Brief Description
 
* <b>Another content element name</b> - Brief Description
 
** <b>Sub-element name</b> - Brief Description
 
* <b>Another content element name</b> - Brief Description
 
  
== Artifact Technology ==
+
Put text here
<noinclude><small><span style="color:#0000FF"><i>
 
What technological/standard solution has been selected for use in creating this artifact and why?
 
</i></span></small><br/></noinclude>
 
<!-- What technological/standard solution has been selected for use in creating this artifact and why? -->
 
Text here
 
  
=== Rationale ===
+
== Non-applicable circumstances ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
What's the justification for selecting the chosen technology?
+
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>
 
</i></span></small><br/></noinclude>
<!-- What's the justification for selecting the chosen technology? -->
+
<!--Identifies the model circumstances in which the does not pattern applies.  Use "SHOULD NOT" for optional and "SHALL NOT" for mandatory -->
* Some reason
 
* Some other reason
 
  
=== Alternatives ===
+
Put text here
<noinclude><small><span style="color:#0000FF"><i>
 
What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen?
 
</i></span></small><br/></noinclude>
 
<!-- What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen? -->
 
  
<b>Some technology</b>
+
== Examples ==
* Some pro or con
 
* Some other pro or con
 
 
 
== Content Constraints ==
 
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
What are the formal rules about how the artifact can be constructed, including any extensions and constraints based on the selected technology, as well as the rationale for those rules.  These are rules that can reasonably be enforced or validated by tools.
+
Reference to models (and locations within them) where the pattern has been used
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- What are the formal rules about how the artifact can be constructed, including any extensions and constraints for the selected technology as well as the rationale for those rules.  These are rules that can reasonably be enforced or validated by tools. -->
+
<!--Reference to models (and locations within them) where the pattern has been used -->
# Some rule
 
## <i>Rationale</i>: Some reason
 
# Some other rule
 
## <i>Rationale</i>: Some other reason
 
  
== Content Guidelines ==
+
Put text here
<noinclude><small><span style="color:#0000FF"><i>
 
What are the informal guidelines about the artifact content.  I.e. What constitutes good practice?  These guidelines should be used in the evaluation of artifact instances but generally can't be enforced or validated by tools.
 
</i></span></small><br/></noinclude>
 
<!-- What are the informal guidelines about how the artifact content.  I.e. What constitutes good practice?  These guidelines should be used in the evaluation of artifact instances but generally can't be enforced or validated by tools. -->
 
# Some rule
 
## <i>Rationale</i>: Some reason
 
# Some other rule
 
## <i>Rationale</i>: Some other reason
 
  
== Publishing Representation(s) ==
+
== Variations ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
How will this artifact be shared and published as part of specifications?
+
Identify other variations of this pattern, if any.
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
<!-- How will this artifact be shared and published as part of specifications? -->
+
<!-- Identify other variations of this pattern, if any.  -->
# Some text
 
## <i>Rationale</i>: Some rationale
 
# Some other text
 
## <i>Rationale</i>: Some other rationale
 
  
== Publishing Constraints ==
+
Put text here
<noinclude><small><span style="color:#0000FF"><i>
 
What are the constraints imposed by the publishing process on how artifacts are constructed and submitted to HL7and what are the reasons behind such constraints?
 
</i></span></small><br/></noinclude>
 
<!-- What are the constraints imposed by the publishing process on how artifacts are constructed and submitted to HL7and what are the reasons behind such constraints? -->
 
# Some rule
 
## <i>Rationale</i>: Some reason
 
# Some other rule
 
## <i>Rationale</i>: Some other reason
 
 
 
== Tooling Considerations ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
What tooling features are required or "nice to have" to allow successful development, publication or other use of the artifact?
 
</i></span></small><br/></noinclude>
 
<!-- What tooling features are required or "nice to have" to allow successful development, publication or other use of the artifact? -->
 
# Nice-to-have|Required: Some feature
 
## <i>Rationale</i>: Some rationale
 
# Nice-to-have|Required: Some other feature
 
## <i>Rationale</i>: Some other rationale
 
 
 
== Development Process Considerations ==
 
 
 
<noinclude><small><span style="color:#0000FF"><i>
 
This section is optional.  It identifies thoughts or guidance around how the artifact will be used.  This may include development process, guidance on how many of this type of artifact are likely to exist within a domain or topic, etc.
 
</i></span></small><br/></noinclude>
 
<!-- This section is optional.  It identifies thoughts or guidance around how the artifact will be used.  This may include development process, guidance on how many of this type of artifact are likely to exist within a domain or topic, etc. -->
 
 
 
# Some text
 
## <i>Rationale</i>: Some rationale
 
# Some other text
 
## <i>Rationale</i>: Some other rationale
 
 
 
== Artifact Exchange and Version Management ==
 
 
 
<noinclude><small><span style="color:#0000FF"><i>What is the format that will be used to share and exchange "source" representations of this artifact and how will it be managed in source control?</i></span></small><br/></noinclude>
 
<!-- What is the format that will be used to share and exchange "source" representations of this artifact and how will it be managed in source control? -->
 
 
 
== Authoring and Maintenance Tools ==
 
 
 
<noinclude><small><span style="color:#0000FF"><i>What tool or set of alternate tools will be used by HL7 International and recommended for use by others for the development and maintenance of this artifact?</i></span></small><br/></noinclude>
 
<!-- What tool or set of alternate tools will be used by HL7 International and recommended for use by others for the development and maintenance of this artifact? -->
 
 
 
== Governance Process Considerations ==
 
 
 
<noinclude><small><span style="color:#0000FF"><i>
 
This section is optional.  It identifies anticipated or existing governance processes that control or impact the development and adoption of this type of artifact. 
 
</i></span></small><br/></noinclude>
 
<!-- This section is optional.  It identifies anticipated or existing governance processes that control or impact the development and adoption of this type of artifact.  -->
 
 
 
# <b>Governance Process name</b> - Some process description
 
## <i>Rationale</i>: Some rationale
 
# <b>Another Governance Process name</b> - Process description
 
## <i>Rationale</i>: Some other rationale
 
 
 
== Issues ==
 
 
 
<noinclude><small><span style="color:#0000FF"><i>
 
This section is optional. It identifies any outstanding issues (methodology or otherwise) that need to be resolved/answered as part of the guidelines
 
</i></span></small><br/></noinclude>
 
<!-- This section is optional. It identifies any outstanding issues (methodology or otherwise) that need to be resolved/answered as part of the guidelines -->
 
 
 
* Some issue
 
* Some other issue
 

Latest revision as of 07:07, 25 November 2011

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