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

Difference between revisions of "Templates for SAIF Generic Information Model Artifact Elements"

From HL7Wiki
Jump to navigation Jump to search
m (moved Template:SAIF Generic Information Model Artifact Elements to Templates for SAIF Generic Information Model Artifact Elements: This page is NOT technically a Template - it HOSTS other templates)
Line 1: Line 1:
−
<noinclude>
+
<noinclude>[[Category:SAIF Artifact Definition]]
−
<!--
 
−
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 comments
 
−
-->
 
−
[[Category:StyleGuides]]<big>To use this Template:
 
−
#Search (or Go to) for a page with name like xxxxx_Artifact_Definition
 
−
#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.
 
−
#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 &lt;!-- XML Comment --&gt; saying the same thing. These comments are visible while editing, but they do not appear when the Wiki page is previewed or saved.
 
−
#Re-edit the page to include the appropriate content in each of the sections
 
−
#Save again<br/>
 
−
 
 
−
<center>'''The displayed contents below this line is the outline for an artifact definition'''</center>
 
−
----
 
−
----
 
−
</big>
 
−
</noinclude>
 
−
[[Category:SAIF Artifact Definition]]
 
 
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
 
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
 +
=Generic Information Model Artifact Definition Elements=
 +
== Definition and Purpose ==
 +
<big><b>This document is, of itself, neither an Artifact Definition nor a Template</b></big>
  
−
=Some Artifact Name=
+
This document and the templates it "includes" define '''generic elements for inclusion''' in the SAIF Artifact Definitions of the RIM and RIM-derived models.  The inclusion will be verbatim from the templates where the actual generic content is maintained.   
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
Artifact names should be descriptive and short.  They may change as we further refine the methodology
 
−
</i></span></small><br/></noinclude>
 
−
<!-- Artifact names should be descriptive and short.  They may change as we further refine the methodology -->
 
  
−
== Definition and Purpose ==
+
<b>Key features of this document</b>:
−
<noinclude><small><span style="color:#0000FF"><i>
+
* structured using the [[:Template:SAIF Artifact Definition]]
−
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 sentence.  Should ideally be only a few sentences
+
* only selected sub-sections of that template are actually defined
−
</i></span></small><br/></noinclude>
+
* sections that appear as being defined here are actually contained in a set of Wiki templates that are "included" in this document
−
<!-- At a high level, what is this artifact and why is it needed? Should ideally be only a few sentences -->
+
* where ever this template inclusion occurs, the name and span of that template will be indicated in <big><span style="color:#0000FF">large blue font</span></big>   
  
−
Put text here
+
<b>To include a particular generic section, do the following:</b>
 +
# Prepare the target document up to the point where the inclusion will occur
 +
#*'''Note:''' This should include the header for the subsection in question
 +
#On a new line insert the template reference that is included in the <big><span style="color:#0000FF">large blue font</span></big> text surrounding the inclusion
 +
#*The template reference can be copied (select and Ctrl-C) from the normal viewing page for this document.
 +
#*:
 +
#*The template reference looks like <b><nowiki>{{Template:Referenced Template Name}}</nowiki></b>
 +
#When the target document is displayed (Show Preview or Save Page) the content from the template will be included '''as the page is rendered'''.  The content is '''not copied''' into the "source" for the target page.
  
 +
<b>Note: </b> Do not attempt to use this document as a template.  All content that is displayed is marked for exclusion, with exception of the template references that are packaged here,
 +
<big><span style="color:#0000FF">No generic content for this section.</span></big>
 
== SAIF Matrix Location ==
 
== SAIF Matrix Location ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
Where does this artifact fit into the SAIF matrix?  Delete those rows and columns that do not apply and provide qualification if appropriate
 
−
</i></span></small><br/></noinclude>
 
−
<!-- Where does this artifact fit into the SAIF matrix?  Delete those rows and columns that do not apply and provide qualification if appropriate -->
 
−
'''Row(s)'''
 
−
* Conceptual (CIM)
 
−
* Logical (PIM)
 
−
* Implementable (PSM)
 
−
 
 
−
'''Column(s)'''
 
−
* Enterprise/Business
 
−
* Information
 
−
* Computational
 
−
* Engineering
 
−
 
 
 
== Audience ==
 
== Audience ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
Who will be the consumers of this artifact type and what will they do with it? Select from 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 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 Information Technology (IT) Audiences:
 
−
*System designers and architects
 
−
*System purchasers
 
−
*Programmers/implementers
 
−
*System vendor management
 
−
 
 
 
== Applicability ==
 
== Applicability ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why?
 
−
</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? -->
 
−
Text
 
−
 
 
−
<i>Rationale</i>: More text
 
−
 
 
 
== Requirements, Relationships and Content ==
 
== Requirements, Relationships and Content ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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 ===
 
=== Relationships and traceability ===
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this sub-section.</span></big>
−
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.
 
−
</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?
 
−
 
 
−
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. 
 
−
-->
 
−
* 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 ===
 
=== Content ===
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this sub-section.</span></big>
−
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.)
 
−
</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.) -->
 
−
* <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 ==
 
== Artifact Technology ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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 ===
 
=== Rationale ===
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
What's the justification for selecting the chosen technology?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What's the justification for selecting the chosen technology? -->
 
−
* Some reason
 
−
* Some other reason
 
−
 
 
 
=== Alternatives ===
 
=== Alternatives ===
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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>
 
−
* Some pro or con
 
−
* Some other pro or con
 
−
 
 
 
== Content Constraints ==
 
== Content Constraints ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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.
 
−
</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. -->
 
−
# Some rule
 
−
## <i>Rationale</i>: Some reason
 
−
# Some other rule
 
−
## <i>Rationale</i>: Some other reason
 
−
 
 
 
== Content Guidelines ==
 
== Content Guidelines ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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.
 
−
</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) ==
 
== Publishing Representation(s) ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
How will this artifact be shared and published as part of specifications?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- How will this artifact be shared and published as part of specifications? -->
 
−
# Some text
 
−
## <i>Rationale</i>: Some rationale
 
−
# Some other text
 
−
## <i>Rationale</i>: Some other rationale
 
−
 
 
 
== Publishing Constraints ==
 
== Publishing Constraints ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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 ==
 
== Tooling Considerations ==
−
<noinclude><small><span style="color:#0000FF"><i>
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
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 ==
 
== Development Process Considerations ==
−
 
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
<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
 
−
 
 
 
== Governance Process Considerations ==
 
== Governance Process Considerations ==
−
 
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
<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 ==
 
== Issues ==
−
 
+
<big><span style="color:#0000FF">No generic content for this section.</span></big>
−
<noinclude><small><span style="color:#0000FF"><i>
+
</noinclude>
−
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
 

Revision as of 17:50, 9 April 2011

Return to Artifact List

Generic Information Model Artifact Definition Elements

Definition and Purpose

This document is, of itself, neither an Artifact Definition nor a Template

This document and the templates it "includes" define generic elements for inclusion in the SAIF Artifact Definitions of the RIM and RIM-derived models. The inclusion will be verbatim from the templates where the actual generic content is maintained.

Key features of this document:

  • structured using the Template:SAIF Artifact Definition
  • only selected sub-sections of that template are actually defined
  • sections that appear as being defined here are actually contained in a set of Wiki templates that are "included" in this document
  • where ever this template inclusion occurs, the name and span of that template will be indicated in large blue font

To include a particular generic section, do the following:

  1. Prepare the target document up to the point where the inclusion will occur
    • Note: This should include the header for the subsection in question
  2. On a new line insert the template reference that is included in the large blue font text surrounding the inclusion
    • The template reference can be copied (select and Ctrl-C) from the normal viewing page for this document.
    • The template reference looks like {{Template:Referenced Template Name}}
  3. When the target document is displayed (Show Preview or Save Page) the content from the template will be included as the page is rendered. The content is not copied into the "source" for the target page.

Note: Do not attempt to use this document as a template. All content that is displayed is marked for exclusion, with exception of the template references that are packaged here, No generic content for this section.

SAIF Matrix Location

No generic content for this section.

Audience

No generic content for this section.

Applicability

No generic content for this section.

Requirements, Relationships and Content

No generic content for this section.

Relationships and traceability

No generic content for this sub-section.

Content

No generic content for this sub-section.

Artifact Technology

No generic content for this section.

Rationale

No generic content for this section.

Alternatives

No generic content for this section.

Content Constraints

No generic content for this section.

Content Guidelines

No generic content for this section.

Publishing Representation(s)

No generic content for this section.

Publishing Constraints

No generic content for this section.

Tooling Considerations

No generic content for this section.

Development Process Considerations

No generic content for this section.

Governance Process Considerations

No generic content for this section.

Issues

No generic content for this section.

Retrieved from "https://wiki.hl7.org/w/index.php?title=Templates_for_SAIF_Generic_Information_Model_Artifact_Elements&oldid=48668"