Technical Framework Publication Process: Difference between revisions

From IHE Wiki
Jump to navigation Jump to search
← Older editNewer edit →
Kevino (talk | contribs)
editor
4,951 edits
No edit summary
Kevino (talk | contribs)
editor
4,951 edits
No edit summary
Line 1: Line 1:
'''<<Items below relating to how supplements/frameworks are structured during the writing process have been copied into the [[Writing Technical Frameworks]] page.>>'''
__NOTOC__


The '''Technical Committee''' of each Domain is responsible for preparing documents (Technical Framework Volumes, Supplements, Change Proposals, Whitepapers, etc).


It would be useful for '''this page''' to contain details about how to get Domain documents (that have reached trial implementation or final text) published to the IHE community in a timely fashion.
The '''Secretariat''' for each Domain is responsible for publication of the documents on the [http://www.ihe.net IHE website].
* Who is responsible for submitting such documents to the secretariat
 
* How should they be submitted
Handling of the documents is coordinated on the IHE FTP Server in the DocumentPublication folder.
* What review/consistency checking, if any, is the secretariat responsible for before publishing
* Who at the secretariat is responsible for publishing them
* Where do they get published
* What announcements should be sent out to whom


Details on proper usage of those FTP folders is provided in the [ftp://ftp.ihe.net/DocumentPublication/ReadMe_InstructionsForUse.doc ReadMe document].  READ IT BEFORE DOING ANYTHING IN THOSE FOLDERS.


==Proposed IHE TF Publication Rules==
An inventory of published IHE documents can be found [http://spreadsheets.google.com/a/ihe.net/ccc?key=0AkfpWndrzLS2dEJnTmo3VlVIbHpEbmowcG1pamxUN3c&hl=en&authkey=CID59tIJ#gid=0 here].


1. Each IHE Domain produces a multi-volume Technical Framework (TF) that includes all Profiles having reached Final Text Status.


2. Volume 1 of each Domain TF is titled: “Profiles”.  It includes a scope and technical overview of each of the Integration or Content Profiles promoted to Final Text.
==Document File Naming==


3. Volume 2 (and Volume 3 if desired) of each Domain TF is titled either: Transactions, or Content or Transaction and Content.
The file naming convention for IHE Technical Frameworks should be as follows:


4. Only two types of Profiles are defined by IHE: Integration Profiles and Content Profiles.  Further refinement is made through the title of the profile (which may or may not contain the words Integration or Content). When a Profile addresses both integration and content, it is of the type Integration Profile.
::IHE-[Domain Abbreviation]_TF_[Rev. # "x.x"]_[Vol. # "n"]_[ISO formatted date]
::Example: IHE_ITI_TF_Rev5.0_Vol1_2008-12-12.pdf


5. A Supplement is a document that specifies a new profile (both with Volume 1 and subsequent Volume material), or an extension to an existing final text Profile.
The file naming convention for supplements should be as follows:


6. Supplements may be of Trail Implementation or Public Comment status.
::IHE-[Domain Abbreviation]_Suppl_[Title Abbreviation]_[Rev. # "x.x"]_[Publication Status PC/FT]_[ISO formatted date]
::Example: IHE-RAD_Suppl_BIR_Rev1.0_2009-06-21.pdf


7. References to an IHE TF is labeled: “IHE XXX TF-n” where XXX is the “acronym” for the IHE Domain and “n” is the volume number.  This Corresponds to the following explicit reference: IHE XXX Technical Framework – Volume n – Profiles/Transactions/Content.
The file naming convention for white papers should be as follows:


8. When a section from another volume is referenced, one shall use: IHE XXX TF-n:3.5.9.1
::IHE-[Domain Abbreviation]_White-Paper_[Title]_[Rev. # "x.x"]_[ISO formatted date]
::Example: IHE-QRPH_White-Paper_Performance_Measure_Data_Element_Structured_for_EHR_Extraction_Rev1.0_2008-06-10.pdf


9. A trial implementation supplement shall be referenced: IHE XXX TF – Trial Implementation Supplement – Title of Supplement.  A public comment supplement shall be referenced: “IHE XXX TF – Public Comment Supplement - Title_of_Supplement”


10. TF Volumes and TF Supplements may have a “revision” number (major.minor) and a publication date.  The following may be appended after the Supplement or TF Volume, when a specific release needs to be referenced, by “rev. n.m” or “rev. n.m, month dd, yyyy”
==See Also==


[[Writing Technical Frameworks and Supplements]] for details on structure, style and conventions when editing technical framework documents.


[[Process]]
[[Process]]


[[Domain Coordination Committee]]
[[Domain Coordination Committee]]
It would be useful for '''this page''' to contain details about how to get Domain documents (that have reached trial implementation or final text) published to the IHE community in a timely fashion.
* Who is responsible for submitting such documents to the secretariat (DONE)
* How should they be submitted (DONE)
* What review/consistency checking, if any, is the secretariat responsible for before publishing
* Who at the secretariat is responsible for publishing them (DONE)
* Where do they get published (DONE)
* What announcements should be sent out to whom

Revision as of 19:06, 17 August 2010


The Technical Committee of each Domain is responsible for preparing documents (Technical Framework Volumes, Supplements, Change Proposals, Whitepapers, etc).

The Secretariat for each Domain is responsible for publication of the documents on the IHE website.

Handling of the documents is coordinated on the IHE FTP Server in the DocumentPublication folder.

Details on proper usage of those FTP folders is provided in the ReadMe document. READ IT BEFORE DOING ANYTHING IN THOSE FOLDERS.

An inventory of published IHE documents can be found here.


Document File Naming

The file naming convention for IHE Technical Frameworks should be as follows:

IHE-[Domain Abbreviation]_TF_[Rev. # "x.x"]_[Vol. # "n"]_[ISO formatted date]
Example: IHE_ITI_TF_Rev5.0_Vol1_2008-12-12.pdf

The file naming convention for supplements should be as follows:

IHE-[Domain Abbreviation]_Suppl_[Title Abbreviation]_[Rev. # "x.x"]_[Publication Status PC/FT]_[ISO formatted date]
Example: IHE-RAD_Suppl_BIR_Rev1.0_2009-06-21.pdf

The file naming convention for white papers should be as follows:

IHE-[Domain Abbreviation]_White-Paper_[Title]_[Rev. # "x.x"]_[ISO formatted date]
Example: IHE-QRPH_White-Paper_Performance_Measure_Data_Element_Structured_for_EHR_Extraction_Rev1.0_2008-06-10.pdf


See Also

Writing Technical Frameworks and Supplements for details on structure, style and conventions when editing technical framework documents.

Process

Domain Coordination Committee


It would be useful for this page to contain details about how to get Domain documents (that have reached trial implementation or final text) published to the IHE community in a timely fashion.

  • Who is responsible for submitting such documents to the secretariat (DONE)
  • How should they be submitted (DONE)
  • What review/consistency checking, if any, is the secretariat responsible for before publishing
  • Who at the secretariat is responsible for publishing them (DONE)
  • Where do they get published (DONE)
  • What announcements should be sent out to whom
Retrieved from "http://wiki.ihe.net/index.php?title=Technical_Framework_Publication_Process&oldid=44167"