Difference between revisions of "Profile Overview Template"

From IHE Wiki
Jump to navigation Jump to search
(→‎Systems Affected: Add References Section)
 
(38 intermediate revisions by 5 users not shown)
Line 1: Line 1:
''This is a template page.  Click edit, Do Not Save This Page, Copy the current text then go edit your page and paste it in.''
+
'''This is a template page.  [[:Category:Templates|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.'''
  
''<Your page name should simply be Full Profile Name Profile with spaces, with capitals, without the acronym. e.g. Scheduled Workflow Profile>''
 
  
''<Put the one sentence profile description here (and copy this text into the [[Profiles]] page as well), e.g. Scheduled Workflow (SWF) integrates ordering, scheduling, imaging acquisition, storage and viewing for Radiology exams. >''
+
''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. Delete text in italics and replace it with your material. Don't forget to delete the double quotes too.''
  
''<If you are adding a Profile, you may also want to add a section to the [[:Category:Actors| pages for existing Actors]] or copy the [[Actor Template]] if creating a new Actor.>''
+
''Your page name should simply be Full Profile Name with spaces, with capitals, without the acronym. e.g. Scheduled Workflow. so it provides a title to the page. You can redirect the acronym to the full named page if you like for bonus points.''
  
 +
 +
''<IN ONE LINE, tell a user what the profile is about (including the acronym) so they can decide if they're on the right page.  Basically this should be the same sentence that appears on the [[Profiles]] catalog page>''
 +
 +
''e.g. Scheduled Workflow (SWF) integrates ordering, scheduling, imaging acquisition, storage and viewing for Radiology exams.''
  
 
__TOC__
 
__TOC__
 
  
 
==Summary==
 
==Summary==
 +
''<Describe the profile in about a paragraph using user-oriented language.  Focus on what it accomplishes for a user (i.e. the Use Cases).  Don't get into how it works, leave that to the Details section.>''
  
''<Describe the profile in about a paragraph>''
+
''<Insert a simple graphic that, at a glance, visually summarizes what the profile is about.  Do not use an actor/transaction diagram here.  Show your graphic to someone for 5 seconds (literally) and ask them what it's about.  If what they say hits the main points in your summary paragraph, you have succeeded.  E.g. a graphic of a hospital, a clinic, and a lab with patient records moving between them.  .>''
  
''<Include a simple graphic that, at a glance, gives an impression of what the profile does.  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 inserting an image/graphic.>''
  
 
==Benefits==
 
==Benefits==
 +
''<If the profile can improve Cost, Safety, Quality or Efficiency then list the specific examples of that benefit (e.g. error reduction, increased throughput) 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).  Consider using a bullet list for readability.  Such benefits help users and vendors make the business case for the profile.  If the profile does not improve any aspect of Cost, Safety, Quality or Efficiency feel free to talk about something else here.>''
  
 
==Details==
 
==Details==
  
''<Detailed discussion of what the profile does and how it works>''
+
''<A few paragraphs, if appropriate, providing more details (mostly in user-speak, not tech-speak) on what the profile does and how it works.>''
 +
 
 +
''<If the user might be familiar with the mechanisms used by the profile, you can mention them here.  E.g. Evidence Documents is based on DICOM Structured Report (SR) Templates.>''
  
 +
''<If the user might have an appreciation for the problems addressed in the profile, you can mention them here, but keep it short.  E.g. Mapping HL7 Order fields to DICOM Modality Worklist attributes can be inconsistent in the marketplace, so Scheduled Workflow provides vendors with more detailed instructions.>''
 +
 
==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) the types of systems they might expect to have implemented actors from this profile, e.g. RIS, PACS, HIS, CAD Workstation, etc. and for each, how it would participate.>''
  
==References==
+
* ''PACS systems may store, manage, and/or display Evidence Documents.''
 +
* ''Display systems may query, retrieve and display Evidence Documents.''
 +
* ''Reporting workstations may retrieve, process and include details from Evidence Documents in reports
  
''<List References (good and bad) (with link if possible) to Journal Articles that mention IHE's work (and hopefully include some analysis) >''
+
'''Actors & Transactions:'''
 +
 
 +
''<Insert an actor-transaction diagram, and or list of Content Definitions>''
 +
 
 +
==Specification==
 +
 
 +
'''Profile Status:''' [[Comments| Final Text]] 
 +
''<Replace "Final Text" with "Trial Implementation" or "Public Comment" as appropriate.>''
 +
 
 +
'''Documents:'''
 +
 
 +
''<Provide direct links to the specific volumes or supplements, and list the volume sections relevant to this profile.  This is a simple inventory of official normative and informative text.  If you would like to provide a reading guide or walkthrough of what is in each of the different sections for implementers or users, do that in the Profile FAQ or the Profile Implementation Page linked below.  If the profile uses transactions from multiple Tech. Frameworks, repeat the structure below.>''
 +
 
 +
[http://www.ihe.net/Technical_Framework/index.cfm#radiology IHE Radiology Technical Framework:]
 +
:* [http://www.ihe.net/Technical_Framework/upload/ihe_tf_rev8.pdf Vol. 1] - Section 5 (SWF Profile)
 +
:* [http://www.ihe.net/Technical_Framework/upload/ihe_tf_rev8-2.pdf Vol. 2] - Sections 4.8 to 4.10, 4.14 to 4.19, and 4.23
 +
:* [http://www.ihe.net/Technical_Framework/upload/ihe_tf_rev8-3.pdf Vol. 3] - Appendix E
 +
 
 +
'''Underlying Standards:'''
 +
 
 +
''<list all the standards on which the profile is based; if possible with links to sources>''
 +
:* [http://dicom.nema.org DICOM]
 +
:* [http://www.hl7.org HL7]
 +
:* ...
  
 
==See Also==
 
==See Also==
Profile Status: [[Comments| Final Text]] ''<Replace Final Text with Trial Implementation or Public Comment as appropriate.>''
 
  
The [[Frameworks#IHE Radiology Technical Framework| Radiology Technical Framework]] is the official master document for this Profile. ''<Replace Radiology Technical Framework with the Trial Implementation Supplement or Public Comment Supplement as appropriate.>''
+
''<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.  Start with the name of the other profile as a link and then explain the relationship.>''
 +
 
 +
* ''[[Reporting Workflow]] [RWF] may use Evidence Documents as inputs to the reporting process.''
 +
* ''[[Simple Image & Numeric Reports]] [SINR] may include data copied from Evidence Documents.''
 +
* ''[[Cross-enterprise Document Sharing for Imaging]] [XDS-I] can be used to share Evidence Documents between sites over a network.''
 +
* ''[[Portable Data for Imaging]] [PDI] can store Evidence Documents on media such as CDs.''
 +
* ''[[Import Reconciliation Workflow]] [IRWF] can fix patient ids, etc. of Evidence Documents when importing.''
  
''<Replace the Template links below with links to the actual pages for the Profile>''
 
  
The [[Profile FAQ Template]] answers typical questions about what the Profile does.
+
'''Consumer Information'''
  
The [[Profile Purchasing Template]] describes considerations when purchasing equipment to deploy this Profile.
+
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 Implementation Template]] provides additional information about implementing this Profile in software.
+
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'''
  
This page is based on the [[Profile Template]]
+
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'''
  
''<Delete this Category Templates line since your Profile page is no longer a template.>'' [[Category:Templates]]
+
''<List References (good and bad) (with link if possible) to Journal Articles that mention IHE's work (and hopefully include some analysis).  Go ahead, Google: IHE <Profile Name> abstract  or Google: IHE <Profile Name> and under the "more" select "Scholar".  You might be surprised. >''
  
 
[[Category:Profiles]]
 
[[Category:Profiles]]
 +
 +
This page is based on the [[Profile Overview Template]]
 +
 +
[[Category:Templates]]
 +
<noinclude>''<'''Delete this Category Templates line''' since your Profile page is no longer a template.>'' </noinclude>
 +
 +
<!--
 +
Categorize the Domain of your Profile with one of the following (delete the rest):
 +
[[Category:Cardiac Profile]]
 +
[[Category:Dental Profile]]
 +
[[Category:Endoscopy Profile]]
 +
[[Category:Eye Profile]]
 +
[[Category:ITI Profile]]
 +
[[Category:PaLM Profile]]
 +
[[Category:PCC Profile]]
 +
[[Category:PCD Profile]]
 +
[[Category:PHARM Profile]]
 +
[[Category:QRPH Profile]]
 +
[[Category:RO Profile]]
 +
[[Category:RAD Profile]]
 +
 +
Categorize key standards used in your Profile with one or more of the following (delete the rest):
 +
[[Category:CDA]]
 +
[[Category:FHIR]]
 +
[[Category:DICOM]]
 +
[[Category:DICOMweb]]
 +
[[Category:HL7v2]]
 +
[[Category:XDW]]
 +
[[Category:DocShare]]
 +
[[Category:RFD]]
 +
[[Category:HL7v3]]
 +
 +
And if people forget to do this, we'll comment this out and you can forget to opt-in. :-)
 +
-->

Latest revision as of 12:28, 5 November 2019

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. Delete text in italics and replace it with your material. Don't forget to delete the double quotes too.

Your page name should simply be Full Profile Name with spaces, with capitals, without the acronym. e.g. Scheduled Workflow. so it provides a title to the page. You can redirect the acronym to the full named page if you like for bonus points.


<IN ONE LINE, tell a user what the profile is about (including the acronym) so they can decide if they're on the right page. Basically this should be the same sentence that appears on the Profiles catalog page>

e.g. Scheduled Workflow (SWF) integrates ordering, scheduling, imaging acquisition, storage and viewing for Radiology exams.

Summary

<Describe the profile in about a paragraph using user-oriented language. Focus on what it accomplishes for a user (i.e. the Use Cases). Don't get into how it works, leave that to the Details section.>

<Insert a simple graphic that, at a glance, visually summarizes what the profile is about. Do not use an actor/transaction diagram here. Show your graphic to someone for 5 seconds (literally) and ask them what it's about. If what they say hits the main points in your summary paragraph, you have succeeded. E.g. a graphic of a hospital, a clinic, and a lab with patient records moving between them. .>

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

Benefits

<If the profile can improve Cost, Safety, Quality or Efficiency then list the specific examples of that benefit (e.g. error reduction, increased throughput) 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). Consider using a bullet list for readability. Such benefits help users and vendors make the business case for the profile. If the profile does not improve any aspect of Cost, Safety, Quality or Efficiency feel free to talk about something else here.>

Details

<A few paragraphs, if appropriate, providing more details (mostly in user-speak, not tech-speak) on what the profile does and how it works.>

<If the user might be familiar with the mechanisms used by the profile, you can mention them here. E.g. Evidence Documents is based on DICOM Structured Report (SR) Templates.>

<If the user might have an appreciation for the problems addressed in the profile, you can mention them here, but keep it short. E.g. Mapping HL7 Order fields to DICOM Modality Worklist attributes can be inconsistent in the marketplace, so Scheduled Workflow provides vendors with more detailed instructions.>

Systems Affected

<List (in user terms) the types of systems they might expect to have implemented actors from this profile, e.g. RIS, PACS, HIS, CAD Workstation, etc. and for each, how it would participate.>

  • PACS systems may store, manage, and/or display Evidence Documents.
  • Display systems may query, retrieve and display Evidence Documents.
  • Reporting workstations may retrieve, process and include details from Evidence Documents in reports

Actors & Transactions:

<Insert an 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.>

Documents:

<Provide direct links to the specific volumes or supplements, and list the volume sections relevant to this profile. This is a simple inventory of official normative and informative text. If you would like to provide a reading guide or walkthrough of what is in each of the different sections for implementers or users, do that in the Profile FAQ or the Profile Implementation Page linked below. If the profile uses transactions from multiple Tech. Frameworks, repeat the structure below.>

IHE Radiology Technical Framework:

  • Vol. 1 - Section 5 (SWF Profile)
  • Vol. 2 - Sections 4.8 to 4.10, 4.14 to 4.19, and 4.23
  • Vol. 3 - Appendix E

Underlying Standards:

<list all the standards on which the profile is based; 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. Start with the name of the other profile as a link and then explain the relationship.>


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). Go ahead, Google: IHE <Profile Name> abstract or Google: IHE <Profile Name> and under the "more" select "Scholar". You might be surprised. >

This page is based on the Profile Overview Template <Delete this Category Templates line since your Profile page is no longer a template.>