Difference between revisions of "Resources for Authors/Editors"
(added section and link to applicable wiki page on searching for external links (e.g., to old ftp site)) |
(→Some Useful IHE.net Web Pages: added link to profiles.ihe.net) |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
The links below take you to some useful IHE Wiki pages, Web Pages, IHE Google Drive folders, and Google Sheets. | The links below take you to some useful IHE Wiki pages, Web Pages, IHE Google Drive folders, and Google Sheets. | ||
| + | ==List of Domain Co-chairs== | ||
| + | See [https://docs.google.com/spreadsheets/d/1cyNuKH-aX33ominihDPWWN4B_gVKY6-Cd22saTHJzIk/edit#gid=0 Domain Committee Co-chairs List] for a complete list of the co-chairs of each domain, the secretary and the Technical Project Manager. | ||
==Inventory of IHE Profiles== | ==Inventory of IHE Profiles== | ||
| Line 14: | Line 16: | ||
==Brief Descriptions of Profiles and Their State== | ==Brief Descriptions of Profiles and Their State== | ||
| − | The [ | + | The [[Profiles]] wiki page provides a brief description of published profiles and an indicator of their state (e.g., final text, trial implementation, public comment, deprecated, etc.) |
==Publication Schedule Information== | ==Publication Schedule Information== | ||
| Line 21: | Line 23: | ||
The IHE Documentation Specialist translates the wiki page information into the detailed publication schedule [https://docs.google.com/spreadsheets/d/1vjX0lYn4xVEVynpoelvLRe_TzXD5KJ2EyDEQ6WIY0w0/edit#gid=1453845999 here]. '''IMPORTANT NOTE:''' If no information is provided on the wiki, no documents can be scheduled for publication. | The IHE Documentation Specialist translates the wiki page information into the detailed publication schedule [https://docs.google.com/spreadsheets/d/1vjX0lYn4xVEVynpoelvLRe_TzXD5KJ2EyDEQ6WIY0w0/edit#gid=1453845999 here]. '''IMPORTANT NOTE:''' If no information is provided on the wiki, no documents can be scheduled for publication. | ||
| − | + | ==Official IHE Templates== | |
| + | The official templates for creating IHE Technical Framework Documents in Word form are found on IHE Google Drive and are linked to at [[Official Templates]]. | ||
| − | + | For supplements that are created using the HL7 IG Publisher, a template is found on the [https://github.com/IHE IHE GitHub Repository] at [https://github.com/IHE/supplement-template https://github.com/IHE/supplement-template]. | |
| − | + | ||
| + | Some supplements are published as markdown (converted from Word or authored in another tool) and maintained in the [https://github.com/IHE IHE GitHub Repository] | ||
| − | This wiki page also contains links to the most recent version of the IHE General Introduction and Shared Appendices found [ | + | This wiki page also contains links to the most recent version of the IHE General Introduction and Shared Appendices found [https://profiles.ihe.net/GeneralIntro/ here]. The shared appendices include information for IHE Actors, Transactions and Glossary items. |
==Profile Proposal Process== | ==Profile Proposal Process== | ||
| Line 33: | Line 37: | ||
==IHE Profile Design Principles and Conventions== | ==IHE Profile Design Principles and Conventions== | ||
| − | Among other things, advice for creating new actors and transactions can be found on the [ | + | Among other things, advice for creating new actors and transactions can be found on the [[IHE Profile Design Principles and Conventions]] Wiki page. |
==Writing Technical Frameworks and Supplements== | ==Writing Technical Frameworks and Supplements== | ||
| Line 76: | Line 80: | ||
==Approval Process for IHE Actors, Transactions and Glossary Terms== | ==Approval Process for IHE Actors, Transactions and Glossary Terms== | ||
| − | New or updated actors, transactions and glossary terms must [https://wiki.ihe.net/index.php/Approval_Process_for_IHE_Actors,_Transactions_and_Glossary_Terms receive approval] from the IHE Domain Coordination Committee prior to being published in a trial implementation supplement. | + | New or updated actors, transactions and glossary terms must [https://wiki.ihe.net/index.php/Approval_Process_for_IHE_Actors,_Transactions_and_Glossary_Terms receive approval] from the IHE Domain Coordination Committee prior to being published in a trial implementation supplement. |
| + | |||
| + | ===Actor and Transaction Naming Conventions=== | ||
| + | See [[IHE Profile Design Principles and Conventions]] for actor and transaction naming conventions. | ||
==Where Public Comments Are Located== | ==Where Public Comments Are Located== | ||
| Line 82: | Line 89: | ||
==USE THE CURRENT PUBLISHED VERSION to update Published Documents== | ==USE THE CURRENT PUBLISHED VERSION to update Published Documents== | ||
| − | When a document is published (for public comment, trial implementation, etc.) the IHE Documentation Specialist | + | When a document is published (for public comment, trial implementation, etc.) the IHE Documentation Specialist does various cleanup. |
| + | |||
| + | It is '''''important''''' that when you update a current published document (e.g., preparing a Trial Implementation version based on the Public Comment version, or applying a CP to supplement), you start by getting the Current Published Word version from the applicable domain's [https://drive.google.com/drive/folders/1qJVFWjhzb_5JgxSDGGE8j-l4FpERyhsG IHE Google Drive Current Published folder.] Otherwise, if you start from a version you may have stored on you local PC or from a domain folder in Google Drive, it '''may not be''' the Current Published version and IHE Documentation Specialist will have to do all the cleanup and fixes '''again''' or may ask you to '''make your changes again''' to the Current Published version. | ||
| + | |||
| − | + | Also see [https://wiki.ihe.net/index.php/IHE_Document_Publication_Google_Drive_Folder_Structure IHE Document Publication Google Drive Folder Structure] for further information about the IHE Document Publication folder structure. | |
==Searching the IHE Wiki for External Links (e.g., to find links to the ftp site that need to be updated to Google Drive)== | ==Searching the IHE Wiki for External Links (e.g., to find links to the ftp site that need to be updated to Google Drive)== | ||
| Line 95: | Line 105: | ||
The [https://wiki.ihe.net/index.php/IHE_Document_Publication_Google_Drive_Folder_Structure IHE Document Publication Google Drive Folder Structure] wiki page describes in detail the structure of the IHE Document Publication Google Drive Folder. | The [https://wiki.ihe.net/index.php/IHE_Document_Publication_Google_Drive_Folder_Structure IHE Document Publication Google Drive Folder Structure] wiki page describes in detail the structure of the IHE Document Publication Google Drive Folder. | ||
| − | ==Some Useful IHE | + | ==Some Additional Useful IHE Web Pages== |
*[https://profiles.ihe.net/GeneralIntro/index.html General Introduction and Shared Appendices] | *[https://profiles.ihe.net/GeneralIntro/index.html General Introduction and Shared Appendices] | ||
| Line 101: | Line 111: | ||
*[https://www.ihe.net/resources/technical_frameworks/ Technical Framework Publication Page] | *[https://www.ihe.net/resources/technical_frameworks/ Technical Framework Publication Page] | ||
*[https://www.ihe.net/resources/technical_frameworks/technical_framework_archives/ Technical Framework Archive Page] | *[https://www.ihe.net/resources/technical_frameworks/technical_framework_archives/ Technical Framework Archive Page] | ||
| + | *[https://profiles.ihe.net/ https://profiles.ihe.net/] | ||
Latest revision as of 07:37, 19 April 2023
This “landing” page provides links useful for IHE Technical Framework Document Authors and Editors.
If you are a first time author, you might want to start with Profile Development Process for First Timers and the Process wiki pages.
Be sure to familiarize yourself with the IHE Wiki. The Wiki Map explains links on the navigation pane to the left of this page.
The links below take you to some useful IHE Wiki pages, Web Pages, IHE Google Drive folders, and Google Sheets.
List of Domain Co-chairs
See Domain Committee Co-chairs List for a complete list of the co-chairs of each domain, the secretary and the Technical Project Manager.
Inventory of IHE Profiles
The Inventory of IHE Profiles Google Sheet lists all current known profiles, their status (Public Comment, Trial Implementation, Deprecated, etc.) and other relevant information.
Brief Descriptions of Profiles and Their State
The Profiles wiki page provides a brief description of published profiles and an indicator of their state (e.g., final text, trial implementation, public comment, deprecated, etc.)
Publication Schedule Information
The information on the Domain Milestone Dates wiki page is provided by each IHE Domain Planning and Technical Committees.
The IHE Documentation Specialist translates the wiki page information into the detailed publication schedule here. IMPORTANT NOTE: If no information is provided on the wiki, no documents can be scheduled for publication.
Official IHE Templates
The official templates for creating IHE Technical Framework Documents in Word form are found on IHE Google Drive and are linked to at Official Templates.
For supplements that are created using the HL7 IG Publisher, a template is found on the IHE GitHub Repository at https://github.com/IHE/supplement-template.
Some supplements are published as markdown (converted from Word or authored in another tool) and maintained in the IHE GitHub Repository
This wiki page also contains links to the most recent version of the IHE General Introduction and Shared Appendices found here. The shared appendices include information for IHE Actors, Transactions and Glossary items.
Profile Proposal Process
The Profile Proposal Process wiki page includes an overview of Call for Proposals -> Selecting Short List -> Performing Technical Evaluation -> Final Profile Selection and links to applicable templates.
IHE Profile Design Principles and Conventions
Among other things, advice for creating new actors and transactions can be found on the IHE Profile Design Principles and Conventions Wiki page.
Writing Technical Frameworks and Supplements
The Writing Technical Frameworks and Supplements wiki page provides some guidelines for authors/editors when developing or updating profiles. It includes the following topics:
- Important Note to Authors/Editors
- Guidance for Authors and Editors
- Document Templates
- IHE Document Publication Google Drive Folder - Instructions for Use
- Approval Process for New or Modified Actors, Transactions and Glossary Terms
- Editing Conventions
- Editing in MS-Word
- TF References
- The Structure of Technical Frameworks
- Volumes
- Section Numbering
- General Introduction and Shared Appendices
- Revision Numbering Convention
- Links to following are found in the See Also section:
SNOMED CT IHE Set
If you need to add a SNOMED CT Concept to a profile, this page describes the process for:
- Locating a suitable SNOMED CT Concept for reference in an IHE Technical Framework Profile or Value Set
- Adding an existing SNOMED CT Concept to the SNOMED CT IHE Set
- Requesting a new Concept if a suitable existing one is not found
Technical Framework Publication Process
The Technical Framework Publication Process wiki page provides a brief overview of the publication process and the following:
- IHE templates (and where to submit comments on them)
- Document Stages
- Public Comment (and a link to the Public Comment Process)
- Trial Implementation
- Final Text
- Workflow Diagrams (with active links):
- New Supplement publication process
- Updated Supplements publication process (future)
- Document File Naming Conventions
- Named Destinations
Approval Process for IHE Actors, Transactions and Glossary Terms
New or updated actors, transactions and glossary terms must receive approval from the IHE Domain Coordination Committee prior to being published in a trial implementation supplement.
Actor and Transaction Naming Conventions
See IHE Profile Design Principles and Conventions for actor and transaction naming conventions.
Where Public Comments Are Located
Among other things, the Public Comment Process wiki page lists where public comments submitted during a public comment period are found.
USE THE CURRENT PUBLISHED VERSION to update Published Documents
When a document is published (for public comment, trial implementation, etc.) the IHE Documentation Specialist does various cleanup.
It is important that when you update a current published document (e.g., preparing a Trial Implementation version based on the Public Comment version, or applying a CP to supplement), you start by getting the Current Published Word version from the applicable domain's IHE Google Drive Current Published folder. Otherwise, if you start from a version you may have stored on you local PC or from a domain folder in Google Drive, it may not be the Current Published version and IHE Documentation Specialist will have to do all the cleanup and fixes again or may ask you to make your changes again to the Current Published version.
Also see IHE Document Publication Google Drive Folder Structure for further information about the IHE Document Publication folder structure.
Searching the IHE Wiki for External Links (e.g., to find links to the ftp site that need to be updated to Google Drive)
See Retirement of the IHE FTP Site #Searching for links to the FTP site on Wiki pages
Using the IHE Google Drive
This Google Document provides information for using the IHE Google Drive.
IHE Google Drive Document Publication Folder Structure
The IHE Document Publication Google Drive Folder Structure wiki page describes in detail the structure of the IHE Document Publication Google Drive Folder.