Difference between revisions of "Official Templates"
(→Appendix B: IHE Transactions: added link to transaction naming conventions wiki page) |
|||
(92 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{TOCright}} | ||
+ | |||
IHE International manages a set of document templates. These help authors make sure they have addressed the necessary material, and help readers/users by promoting consistency in how the information is organized and expressed. | IHE International manages a set of document templates. These help authors make sure they have addressed the necessary material, and help readers/users by promoting consistency in how the information is organized and expressed. | ||
+ | ==IHE Technical Framework Templates== | ||
+ | ===IHE Technical Framework Volume Templates=== | ||
+ | * [https://drive.google.com/drive/u/0/folders/13jyh22oXwgfD-plpZhSVpCatHSoFqqFu Volume 1: Profiles - Word] | ||
+ | * [https://drive.google.com/drive/u/0/folders/13jyh22oXwgfD-plpZhSVpCatHSoFqqFu Volume 2: Transactions - Word] | ||
+ | * [https://drive.google.com/drive/u/0/folders/13jyh22oXwgfD-plpZhSVpCatHSoFqqFu Volume 3: Content Definitions - Word] | ||
+ | * [https://drive.google.com/drive/u/0/folders/13jyh22oXwgfD-plpZhSVpCatHSoFqqFu Volume 4: National Extensions- Word] | ||
− | ===IHE Technical Framework | + | ===IHE Technical Framework Supplement Template=== |
− | * [ | + | * [https://drive.google.com/drive/u/0/folders/13nsG6u3V--lQgCXCZlt0M73-oRgSXE9q Supplement Template - Word] |
− | + | * [https://github.com/IHE/supplement-template Implementation Guide (IG) Publisher IHE-Supplement template] | |
− | * [ | ||
− | |||
− | === | + | ===IHE White Paper Template=== |
− | * [ | + | * [https://drive.google.com/drive/u/0/folders/13jq16RmmJQJPgSYNhOWcaaBa_smgwnjs White Paper Template - Word] |
− | + | * Alternatively, white papers can be authored in Markdown on GitHub and published in HTML | |
− | |||
− | * | ||
==General Introduction and Shared Appendices== | ==General Introduction and Shared Appendices== | ||
− | The documents contained at | + | The documents contained at https://profiles.ihe.net/GeneralIntro/ are components shared by all of the IHE domain technical frameworks. Each technical framework volume contains links to these documents where appropriate. These documents will be updated on an annual (or as needed) basis. |
===General Introduction=== | ===General Introduction=== | ||
− | ===Appendix A: Actors=== | + | The IHE Technical Frameworks General Introduction is located [https://profiles.ihe.net/GeneralIntro/ here]. |
− | ===Appendix D: Glossary=== | + | |
− | ( | + | ===Appendix A: IHE Actors=== |
+ | IHE Actor information is maintained in Gazelle Master Model. See the [https://profiles.ihe.net/GeneralIntro/ch-A.html IHE General Introduction Appendix A] and the [https://wiki.ihe.net/index.php/Gazelle_Browsing Gazelle Browsing] wiki page for additional information. | ||
+ | |||
+ | See [[IHE Profile Design Principles and Conventions#Actors]] for actor naming conventions | ||
+ | |||
+ | ===Appendix B: IHE Transactions=== | ||
+ | IHE Transaction information is maintained in Gazelle Master Model. See the [https://profiles.ihe.net/GeneralIntro/ch-B.html IHE General Introduction Appendix B] and the [https://wiki.ihe.net/index.php/Gazelle_Browsing Gazelle Browsing] wiki page for additional information. | ||
+ | |||
+ | See [[IHE Profile Design Principles and Conventions#Transactions]] for transaction naming conventions. | ||
+ | |||
+ | ===Appendix C: Namespaces=== | ||
+ | See the [http://wiki.ihe.net/index.php/OID_Registration OID Registration wiki page] or Appendix C located [https://profiles.ihe.net/GeneralIntro/ch-C.html here]. | ||
+ | |||
+ | ===Appendix D: IHE Glossary=== | ||
+ | {| class="wikitable mw-collapsible mw-collapsed sortable" | ||
+ | IHE Glossary terms are managed via the [http://www.skmtglossary.org/ Standards Knowledge Management Tool (SKMT)]. A report can be downloaded from the tool for a "real-time" list of all IHE Glossary terms. The IHE Glossary is also published as Appendix D to the General Introduction and is available [https://profiles.ihe.net/GeneralIntro/ch-D.html here]. Please note that the published Glossary is current as of the publication date and that the SKMT may include additional terms. See the [[Standards_Knowledge_Management_Tool_(SKMT)]] wiki page for additional information. | ||
====Glossary Rules==== | ====Glossary Rules==== | ||
+ | Note: '''New''' terms from public comment versions of supplements are not in in the glossary; they will be added to the SKMT when the supplement moves to trial implementation. The published version of Appendix D is updated periodically as needed. | ||
# The following are '''not''' to be included in the glossary: | # The following are '''not''' to be included in the glossary: | ||
## Profile names or acronyms | ## Profile names or acronyms | ||
## Actor names or acronyms | ## Actor names or acronyms | ||
− | ## Domain names or acronyms (e.g., ITI, PCC, | + | ## Domain names or acronyms (e.g., ITI, PCC, DEV, Radiology, Patient Care Coordination, etc.) |
## Transaction names or acronyms | ## Transaction names or acronyms | ||
## Domain Technical Framework names or acronyms (e.g., ITI TF-1) | ## Domain Technical Framework names or acronyms (e.g., ITI TF-1) | ||
Line 37: | Line 57: | ||
##(TOO LONG) Modality Worklist: A mechanism defined to support the imaging workflow, by which the LIS provides the attributes of the imaging subject to modalities. In radiology, the imaging subject is the patient; in anatomic pathology, the imaging subject is a specimen derived from the patient. The Modality Worklist provides patient, order (study) and specimen identification and description to be included in the acquired images. Therefore the LIS needs to provide the attributes of the Specimen Module for each specimen being imaged. Therefore, the attributes of the Specimen Module have been defined in a ‘Macro’ construct, and added to the Scheduled Procedure Step Module of Modality Worklist. Conceptually, then, the Procedure Step is scheduled for the imaging of one or more specimen containers. While the use of the specimen attributes is optional according to the Standard for any Modality Worklist implementation, the APW profile requires their use for effective interoperability. | ##(TOO LONG) Modality Worklist: A mechanism defined to support the imaging workflow, by which the LIS provides the attributes of the imaging subject to modalities. In radiology, the imaging subject is the patient; in anatomic pathology, the imaging subject is a specimen derived from the patient. The Modality Worklist provides patient, order (study) and specimen identification and description to be included in the acquired images. Therefore the LIS needs to provide the attributes of the Specimen Module for each specimen being imaged. Therefore, the attributes of the Specimen Module have been defined in a ‘Macro’ construct, and added to the Scheduled Procedure Step Module of Modality Worklist. Conceptually, then, the Procedure Step is scheduled for the imaging of one or more specimen containers. While the use of the specimen attributes is optional according to the Standard for any Modality Worklist implementation, the APW profile requires their use for effective interoperability. | ||
##(BETTER) Modality Worklist: DICOM PS3.3; A collection of Scheduled Procedure Steps which describe arbitrarily defined units of service that have been scheduled for an imaging device (such as a CT Scanner or a Pathology Whole-Slide Scanner). | ##(BETTER) Modality Worklist: DICOM PS3.3; A collection of Scheduled Procedure Steps which describe arbitrarily defined units of service that have been scheduled for an imaging device (such as a CT Scanner or a Pathology Whole-Slide Scanner). | ||
− | #For acronyms, include | + | #For acronyms, include them as part of the definition of the full term. When the term is added to SKMT, the acronym will be added with an association to the full term (and vice versa). The report downloaded from SKMT includes an acronym field for each term. |
− | |||
− | |||
− | + | ===Appendix E: Profiling=== | |
+ | Standards Profiling and Documentation Conventions is published as Appendix E to the General Introduction and is available [https://profiles.ihe.net/GeneralIntro/ch-E.html here]. | ||
− | |||
===Appendix F: Integration Statements=== | ===Appendix F: Integration Statements=== | ||
+ | A brief discussion about IHE Integration Statements is published as Appendix F to the General Introduction and is available [https://profiles.ihe.net/GeneralIntro/ch-F.html here]. | ||
+ | |||
+ | The IHE [https://gazelle.ihe.net/content/product-registry IHE Product Registry] enables developers to create, manage and publish Integration Statements for their commercial and open source healthcare IT systems. It allows users to browse for these systems based on their conformance with specific IHE Actors and Profiles. | ||
+ | |||
+ | ===Appendix G: IHE Implementation Materials=== | ||
+ | See [https://profiles.ihe.net/GeneralIntro/ch-G.html Appendix G] for information on where to locate IHE Implementation Material. | ||
− | ==Comments== | + | ==Comments on IHE Templates, General Introduction and Shared Appendices== |
− | Comments | + | Comments on the templates, General Introduction and Shared Appendices can be submitted at: [http://www.ihe.net/Templates_Public_Comments/ http://www.ihe.net/Templates_Public_Comments/]. |
Latest revision as of 09:22, 16 August 2024
IHE International manages a set of document templates. These help authors make sure they have addressed the necessary material, and help readers/users by promoting consistency in how the information is organized and expressed.
IHE Technical Framework Templates
IHE Technical Framework Volume Templates
- Volume 1: Profiles - Word
- Volume 2: Transactions - Word
- Volume 3: Content Definitions - Word
- Volume 4: National Extensions- Word
IHE Technical Framework Supplement Template
IHE White Paper Template
- White Paper Template - Word
- Alternatively, white papers can be authored in Markdown on GitHub and published in HTML
The documents contained at https://profiles.ihe.net/GeneralIntro/ are components shared by all of the IHE domain technical frameworks. Each technical framework volume contains links to these documents where appropriate. These documents will be updated on an annual (or as needed) basis.
General Introduction
The IHE Technical Frameworks General Introduction is located here.
Appendix A: IHE Actors
IHE Actor information is maintained in Gazelle Master Model. See the IHE General Introduction Appendix A and the Gazelle Browsing wiki page for additional information.
See IHE Profile Design Principles and Conventions#Actors for actor naming conventions
Appendix B: IHE Transactions
IHE Transaction information is maintained in Gazelle Master Model. See the IHE General Introduction Appendix B and the Gazelle Browsing wiki page for additional information.
See IHE Profile Design Principles and Conventions#Transactions for transaction naming conventions.
Appendix C: Namespaces
See the OID Registration wiki page or Appendix C located here.
Appendix D: IHE Glossary
IHE Glossary terms are managed via the Standards Knowledge Management Tool (SKMT). A report can be downloaded from the tool for a "real-time" list of all IHE Glossary terms. The IHE Glossary is also published as Appendix D to the General Introduction and is available here. Please note that the published Glossary is current as of the publication date and that the SKMT may include additional terms. See the Standards_Knowledge_Management_Tool_(SKMT) wiki page for additional information.Glossary Rules
Note: New terms from public comment versions of supplements are not in in the glossary; they will be added to the SKMT when the supplement moves to trial implementation. The published version of Appendix D is updated periodically as needed.
- The following are not to be included in the glossary:
- Profile names or acronyms
- Actor names or acronyms
- Domain names or acronyms (e.g., ITI, PCC, DEV, Radiology, Patient Care Coordination, etc.)
- Transaction names or acronyms
- Domain Technical Framework names or acronyms (e.g., ITI TF-1)
- Words that are used in the standard dictionary sense (e.g., antepartum, antibiotic, anorexia, anesthesia, aperiodic, etc,)
- For terms we borrow and use from (HL7, DICOM, etc.), reference the standard. For example:
- SCU: DICOM PS 3.5; Service Class User.
- Modality Performed Procedure Step: See DICOM PS3.3.
- Standards are to be included in the glossary. For example:
- HTML: Hyper Text Markup Language
- Organizations do belong in the glossary and should include a link to the respective web site. For example:
- ACC: American College of Cardiology. See http://www.acc.org/.
- Limit the body of the definitions to briefly describing what the thing is, but avoid getting into IHE usage details that really belong in the bodies of the technical frameworks themselves.
- (TOO LONG) Modality Worklist: A mechanism defined to support the imaging workflow, by which the LIS provides the attributes of the imaging subject to modalities. In radiology, the imaging subject is the patient; in anatomic pathology, the imaging subject is a specimen derived from the patient. The Modality Worklist provides patient, order (study) and specimen identification and description to be included in the acquired images. Therefore the LIS needs to provide the attributes of the Specimen Module for each specimen being imaged. Therefore, the attributes of the Specimen Module have been defined in a ‘Macro’ construct, and added to the Scheduled Procedure Step Module of Modality Worklist. Conceptually, then, the Procedure Step is scheduled for the imaging of one or more specimen containers. While the use of the specimen attributes is optional according to the Standard for any Modality Worklist implementation, the APW profile requires their use for effective interoperability.
- (BETTER) Modality Worklist: DICOM PS3.3; A collection of Scheduled Procedure Steps which describe arbitrarily defined units of service that have been scheduled for an imaging device (such as a CT Scanner or a Pathology Whole-Slide Scanner).
- For acronyms, include them as part of the definition of the full term. When the term is added to SKMT, the acronym will be added with an association to the full term (and vice versa). The report downloaded from SKMT includes an acronym field for each term.
Appendix E: Profiling
Standards Profiling and Documentation Conventions is published as Appendix E to the General Introduction and is available here.
Appendix F: Integration Statements
A brief discussion about IHE Integration Statements is published as Appendix F to the General Introduction and is available here.
The IHE IHE Product Registry enables developers to create, manage and publish Integration Statements for their commercial and open source healthcare IT systems. It allows users to browse for these systems based on their conformance with specific IHE Actors and Profiles.
Appendix G: IHE Implementation Materials
See Appendix G for information on where to locate IHE Implementation Material.
Comments on the templates, General Introduction and Shared Appendices can be submitted at: http://www.ihe.net/Templates_Public_Comments/.