Difference between revisions of "Profile Overview Template"

From IHE Wiki
Jump to navigation Jump to search
Line 4: Line 4:
 
''This template is for the one or two page user-oriented overview of an IHE Profile that is in Final Text, Trial Implementation or perhaps Public Comment.''
 
''This template is for the one or two page user-oriented overview of an IHE Profile that is in Final Text, Trial Implementation or perhaps Public Comment.''
  
 
 
''<Your page name should simply be Full Profile Name Profile with spaces, with capitals, without the acronym. e.g. Scheduled Workflow Profile>''
 
''<Your page name should simply be Full Profile Name Profile with spaces, with capitals, without the acronym. e.g. Scheduled Workflow Profile>''
 +
  
 
''<Tell a user in one sentence what the profile is about (including the acronym) so they can decide if they're on the right page (and copy this one sentence description into the [[Profiles]] page as well), e.g. Scheduled Workflow (SWF) integrates ordering, scheduling, imaging acquisition, storage and viewing for Radiology exams. >''
 
''<Tell a user in one sentence what the profile is about (including the acronym) so they can decide if they're on the right page (and copy this one sentence description into the [[Profiles]] page as well), e.g. Scheduled Workflow (SWF) integrates ordering, scheduling, imaging acquisition, storage and viewing for Radiology exams. >''
Line 16: Line 16:
 
{{{2|''<Describe the profile in about a paragraph using user-oriented language.>''}}}
 
{{{2|''<Describe the profile in about a paragraph using user-oriented language.>''}}}
  
''<Include a simple graphic that, at a glance, gives an impression of what the profile does.  The actor/transaction diagram usually requires an understanding of IHE actors and transactions and what they mean so it's not exactly "at a glance" but failing a more user-friendly graphic, it is acceptable.
+
''<Try to include a simple graphic that, at a glance, gives an impression of what the profile does.  E.g. a graphic of a hospital, a clinic, and a lab sharing patient records; not the actor/transaction diagram.>''
  
 
''<See [[Help:Contents#Tips_.26_Tricks| Help - Tips and Tricks]] for details on including an image/graphic.>''
 
''<See [[Help:Contents#Tips_.26_Tricks| Help - Tips and Tricks]] for details on including an image/graphic.>''
Line 22: Line 22:
 
==Benefits==
 
==Benefits==
  
''<List the key benefits the profile provides.  Try to indicate HOW the profile provides benefits.  E.g. SWF reduces patient errors due to mistyped demographics at the modality by transfering them electronically from the Order Filler.>''
+
''<List the key benefits the profile provides and how they come about.  E.g. SWF reduces patient errors due to mistyped demographics at the modality by transfering demographics electronically from the Order Filler.>''
  
 
==Details==
 
==Details==
  
''<Detailed discussion (a few paragraphs) of what the profile does and how it works>''
+
''<A few paragraphs, if appropriate, of what the profile does and how it works, in user-speak, not tech-speak.>''
  
 
==Systems Affected==
 
==Systems Affected==
 
''<List (in user terms) systems that would be likely candidates for implementing this profile, e.g. RIS, PACS, HIS, CAD Workstation, etc. >''
 
''<List (in user terms) systems that would be likely candidates for implementing this profile, e.g. RIS, PACS, HIS, CAD Workstation, etc. >''
  
 +
''<Insert actor-transaction diagram, and or list of Content Definitions>''
  
==See Also==
+
==Specification==
 +
 
 +
Profile Status: [[Comments| Final Text]]  ''<Replace Final Text with Trial Implementation or Public Comment as appropriate.>''
  
===Technical Information===
+
Document: [[Frameworks#IHE {{{4|Radiology}}} Technical Framework| {{{4|Radiology}}} Technical Framework]] ''<or link to a Supplement document if appropriate.>''
 +
* ''<Vol 1: Section 3.5>'' documents the profile
 +
* ''<Vol 2: Sections 4.5, 4.6, 4.7, 4.17 and 4.22>'' document specific transactions
 +
* ''<Vol 3: Appendix E>'' provides additional informative text
  
Profile Status: [[Comments| Final Text]]  ''<Replace Final Text with Trial Implementation or Public Comment as appropriate.>''
+
Underlying Standards:
 +
* ''<list standards; if possible with links to sources>''
  
Specification: [[Frameworks#IHE {{{4|Radiology}}} Technical Framework| {{{4|Radiology}}} Technical Framework]] ''<or link to a Supplement document if appropriate.>''
 
* '''Vol 1: Section 3.5''' documents the profile
 
* '''Vol 2: Sections 4.5, 4.6, 4.7, 4.17 and 4.22''' document specific transactions
 
* '''Vol 3: Appendix E''' provides additional informative text
 
  
The [[{{{3|Profile Implementation Template}}}]] provides additional information about implementing this Profile in software''<Replace the link with a link to the actual Implementation page for the Profile>''
+
==See Also==
 +
 
 +
''<The following sections can be left out if there is nothing to point toThis is just to show where such information can go.>''
  
 
===Related Profiles===
 
===Related Profiles===
Line 53: Line 58:
  
 
The [[{{{3|Profile Purchasing Template}}}]] describes considerations when purchasing equipment to deploy this Profile.  ''<Replace the link with a link to the actual Purchasing page for the Profile>''
 
The [[{{{3|Profile Purchasing Template}}}]] describes considerations when purchasing equipment to deploy this Profile.  ''<Replace the link with a link to the actual Purchasing page for the Profile>''
 +
 +
===Implementer Information===
 +
 +
The [[{{{3|Profile Implementation Template}}}]] provides additional information about implementing this Profile in software.  ''<Replace the link with a link to the actual Implementation page for the Profile>''
  
 
===Reference Articles===
 
===Reference Articles===
Line 66: Line 75:
  
  
''<Delete this Category Templates line since your Profile page is no longer a template.>'' [[Category:{{{3|Templates}}}]]
+
''<'''Delete this Category Templates line''' since your Profile page is no longer a template.>'' [[Category:{{{3|Templates}}}]]

Revision as of 18:13, 22 January 2008

This is a template page. CLICK HERE if you're not sure how to use it. DO NOT MODIFY this page unless you are changing the template for all future users.


This template is for the one or two page user-oriented overview of an IHE Profile that is in Final Text, Trial Implementation or perhaps Public Comment.

<Your page name should simply be Full Profile Name Profile with spaces, with capitals, without the acronym. e.g. Scheduled Workflow Profile>


<Tell a user in one sentence what the profile is about (including the acronym) so they can decide if they're on the right page (and copy this one sentence description into the Profiles page as well), e.g. Scheduled Workflow (SWF) integrates ordering, scheduling, imaging acquisition, storage and viewing for Radiology exams. >

<If you are adding a Profile, you may also want to add a section to the pages for existing Actors or copy the Actor Template if creating a new Actor.>

Summary

<Describe the profile in about a paragraph using user-oriented language.>

<Try to include a simple graphic that, at a glance, gives an impression of what the profile does. E.g. a graphic of a hospital, a clinic, and a lab sharing patient records; not the actor/transaction diagram.>

<See Help - Tips and Tricks for details on including an image/graphic.>

Benefits

<List the key benefits the profile provides and how they come about. E.g. SWF reduces patient errors due to mistyped demographics at the modality by transfering demographics electronically from the Order Filler.>

Details

<A few paragraphs, if appropriate, of what the profile does and how it works, in user-speak, not tech-speak.>

Systems Affected

<List (in user terms) systems that would be likely candidates for implementing this profile, e.g. RIS, PACS, HIS, CAD Workstation, etc. >

<Insert actor-transaction diagram, and or list of Content Definitions>

Specification

Profile Status: Final Text <Replace Final Text with Trial Implementation or Public Comment as appropriate.>

Document: Radiology Technical Framework <or link to a Supplement document if appropriate.>

  • <Vol 1: Section 3.5> documents the profile
  • <Vol 2: Sections 4.5, 4.6, 4.7, 4.17 and 4.22> document specific transactions
  • <Vol 3: Appendix E> provides additional informative text

Underlying Standards:

  • <list standards; if possible with links to sources>


See Also

<The following sections can be left out if there is nothing to point to. This is just to show where such information can go.>

Related Profiles

<List profiles this one depends on, profiles that depend on this one, profiles that are synergistic with this one>

Consumer Information

The Profile FAQ Template answers typical questions about what the Profile does. <Replace the link with a link to the actual FAQ page for the Profile>

The Profile Purchasing Template describes considerations when purchasing equipment to deploy this Profile. <Replace the link with a link to the actual Purchasing page for the Profile>

Implementer Information

The Profile Implementation Template provides additional information about implementing this Profile in software. <Replace the link with a link to the actual Implementation page for the Profile>

Reference Articles

<List References (good and bad) (with link if possible) to Journal Articles that mention IHE's work (and hopefully include some analysis) >



This page is based on the Profile Template


<Delete this Category Templates line since your Profile page is no longer a template.>