Official Templates

From IHE Wiki
Jump to: navigation, search

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

IHE Technical Framework Supplement Template

IHE Whitepaper Template

General Introduction and Shared Appendices

The documents contained at http://ihe.net/TF_Intro_Appendices.aspx 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

Appendix A: Actors

Appendix B: Transactions

This section is in DRAFT state. Content presented is for feasibility testing only at this point.

Transaction # Transaction Name Transaction Description Status
ARTI-01 Basic Static Beam Storage In the Basic Static Beam Storage transaction, a Static Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only static, non-MLC treatment beams. Trial Implementation
ARTI-02 Basic Static Beam Retrieval In the Basic Static Beam Retrieval transaction, a Static Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only static, non-MLC treatment beams. Trial Implementation
ARTI-03 Basic Static MLC Beam Storage In the Basic Static MLC Beam Storage transaction, a Static MLC Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only static, MLC treatment beams. Trial Implementation
ARTI-04 Basic Static MLC Beam Retrieval In the Basic Static MLC Beam Retrieval transaction, a Static MLC Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only static, MLC treatment beams. Trial Implementation
ARTI-05 Arc Beam Storage In the Arc Beam Storage transaction, an Arc Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only non-MLC arc treatment beams. Trial Implementation
ARTI-06 Arc Beam Retrieval In the Arc Beam Retrieval transaction, an Arc Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only non-MLC arc treatment beams. Trial Implementation
ARTI-07 MLC Arc Beam Storage In the MLC Arc Beam Storage transaction, an MLC Arc Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only MLC arc treatment beams. Trial Implementation
ARTI-08 MLC Arc Beam Retrieval In the MLC Arc Beam Retrieval transaction, an MLC Arc Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only MLC arc treatment beams. Trial Implementation
ARTI-09 Conformal Arc Beam Storage In the Conformal Arc Beam Storage transaction, a Conformal Arc Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only conformal arc treatment beams. Trial Implementation
ARTI-10 Conformal Arc Beam Retrieval In the Conformal Arc Beam Retrieval transaction, an Conformal Arc Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only conformal arc treatment beams. Trial Implementation
ARTI-11 Hard Wedge Beam Storage In the Hard Wedge Beam Storage transaction, a Hard Wedge Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only static treatment beams using physical wedges. Trial Implementation
ARTI-12 Hard Wedge Beam Retrieval In the Hard Wedge Beam Retrieval transaction, a Hard Wedge Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only static treatment beams using physical wedges. Trial Implementation
ARTI-13 Virtual Wedge Beam Storage In the Virtual Wedge Beam Storage transaction, a Virtual Wedge Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only static treatment beams using virtual wedges. Trial Implementation
ARTI-14 Virtual Wedge Beam Retrieval In the Virtual Wedge Beam Retrieval transaction, a Virtual Wedge Beam Consumer or a TMS receives a treatment plan from the Archive. The treatment plan shall contain only static treatment beams using virtual wedges. Trial Implementation
ARTI-15 Motorized Wedge Beam Storage In the Motorized Wedge Beam Storage transaction, a Motorized Wedge Beam Producer stores a treatment plan to the Archive. The treatment plan shall contain only static treatment beams using motorized wedges. Trial Implementation

Appendix C: Namesapces

See OID Registration

Appendix D: Glossary

New terms from public comment versions of supplements are not in in the glossary; they will be added when the supplement moves to trial implementation. The goal is to update the glossary annually.

Glossary Rules

  1. The following are not to be included in the glossary:
    1. Profile names or acronyms
    2. Actor names or acronyms
    3. Domain names or acronyms (e.g., ITI, PCC, PCD, Radiology, Patient Care Coordination, etc.)
    4. Transaction names or acronyms
    5. Domain Technical Framework names or acronyms (e.g., ITI TF-1)
    6. Words that are used in the standard dictionary sense (e.g., antepartum, antibiotic, anorexia, anesthesia, aperiodic, etc,)
  2. For terms we borrow and use from (HL7, DICOM, etc.), reference the standard. For example:
    1. SCU: DICOM PS 3.5; Service Class User.
    2. Modality Performed Procedure Step: See DICOM PS3.3.
  3. Standards are to be included in the glossary. For example:
    1. HTML: Hyper Text Markup Language
  4. Organizations do belong in the glossary and should include a link to the respective web site. For example:
    1. ACC: American College of Cardiology. See http://www.acc.org/.
  5. 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.
    1. (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.
    2. (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).
  6. For acronyms, include two entries in the glossary, one for the full term and one for the acronym (pointing to the full term). For example:
    1. 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).
    2. MWL: See Modality Worklist

Note: Some domains included acronyms without a brief description. In this case, only the acronym appears in the glossary. Please supply the brief description if missing.

Appendix E: Profiling

Appendix F: Integration Statements

Comments

Comments about the templates can be submitted at: http://www.ihe.net/Templates_Public_Comments/.