RAD Tech Annual TF Republication Process

From IHE Wiki
Jump to navigation Jump to search

SCOPE

This page details the annual process of republishing IHE Radiology Domain Technical Framework documents (Final Text Volumes & TI Supplements) with changes from approved Final Text CPs and any supplement moving from Trial Implementation to Final Text.

These instructions apply to RAD domain TF documents that are edited using MS-Word during profile developments are published by IHE as PDF documents. Some profiles are published in FHIR IG format. This page does not cover the process for updating IGs. IHE RAD may want to adopt/adapt the republication ITI's republication process using Github; see https://wiki.ihe.net/index.php/ITI_CP_Integration_Process.

ROLES/RESPONSIBILITIES SUMMARY:

  1. Technical Project Manager (TPM):
    1. identify Final Text CPs from the current cycle and determine which document(s) each CP affects
    2. identify TI Supplements moving from Final Text and determine which Final Text volumes will be updated
    3. identify any profiles that will be deprecated
    4. use the above details to create a Republication Plan using the Dashboard
    5. at the spring RAD Tech F2F, complete the plan by identifying editors, reviewers and completion dates
    6. inform the IHE Documentation specialist of the plan
    7. track completion of the plan
    8. be the interface between RAD Tech and the Documentation Specialist for submission of documents to be republished
    9. update the CP tracking sheet and folder location once documents are republished
  2. Editor:
    1. retrieve the MS-Word version of the current published TF document to edit
    2. edit the document to incorporate Final Text CPs and TI Supplments moving from Trial Implementation to Final Text (if any)
    3. pass the edited document to the reviewer to check the incorporation work
  3. Reviewer:
    1. using the CPs and any TI Suppls to incorporsate, review the edits made by the editor; resolve any missing or incorrect updates
    2. pass the reviewed documents to the Technical Project Manager and the RAD Tech co-chairs.
  4. RAD Tech Co-Chairs:
    1. review the updated documents received from the IHE Documentation Specialist
    2. answer any questions
  5. IHE Documentation Specialist: (Mary Jungers mjungers@ihe.net)

QUICK LINKS:

  1. IHE RAD CP Tracking sheet
  2. https://profiles.ihe.net/RAD/index.html - publication location of all IHE RAD Domain TF documents.
  3. IHE Documents>> Documentation Publication >> Current Published >> Radiology folder in Google Drive. Contains the MS-Word and PDF versions of all IHE RAD documents published on profiles.ihe.net.
  4. IHE RAD Reublication Planning Dashboard - google sheet used to assign editors and reviewers to documents, identify CPs affecting each documents, and identify and track dates for completion of tasks

TECHNICAL PROJECT MANAGER INSTRUCTIONS:

EDITOR INSTRUCTIONS: To Integrate CPs into Final Text Volumes or TI Supplements

  1. Refer to the IHE RAD republication Dashboard showing docs being republished this year. It identifies editors and reviewers for each document. See the "2026" tab.
    1. :* In some cases, there is a sequence of editors (noted on the Dashboard), so one editor completes an integration first, and then passes it on to the next editor, e.g., this could happen when a supplement moves from TI to FT. First, one editor integrates CPs into the TI Supplement. Then that documents is passed to the Vol 1 and 2 editors so the supplement can be integrated into the TF.
  2. To start, the most important task is to start editing the right document:
    1. Download the Word document for the for the currently published version. You will find it in Google Drive: IHE Documents >> Document Publication >> Current Published >> Radiology
  3. Important: Turn on track changes in the Word document.
  4. Next, access the CPs that will be integrated into your document:
    1. Refer to the Dashboard . Column C shows CPs that apply to your Volume or TI Supp.
      1. Note that some CPs modify multiple documents
    2. Download the relevant CPs from the Final Text folder so you have a local copy.
  5. Start with oldest (Lowest number) CPs first
  6. Open it
  7. Scroll down in the CP to the first set of editor instructions. Note that editor instructions are contained in a box prior to the edited text. The edited text will contain some markup:
    1. If the instructions are just flat text, that means it is copied from the TI or TF in order to help you find the position in the document to insert the change. “Normal” text in the CP is NOT a change to the Volume or TI.
    2. If it is bold and underlined, that indicates text that should be inserted
      1. To insert use “paste special” and insert “only unformatted text”. DO NOT INSERT FORMATTING FROM OTHER DOCUMENTS or it will add to the template list of styles and this is a major problem for publication.
      2. If you need to re-apply bullets, use the format-painter to re-apply the bullets OR use the style-pulldown menu to find the pre-set style from the template.
    3. If it is bold and strike-out, it means delete
    4. If it is in a “box” it is instructions for you as the editor, don’t copy the “box” in!!!
  8. Make the first change. Make sure to check if the change needs to be made elsewhere in the Volume or TI! (e.g. Change all instances of XY to YZ)
    1. You are tracking changes as you make edits. After you make an edit, a best-practice is to view your changes with 'No markup' so you can see what your change will look like. Sometimes you find you made a small error, like not removing underline markup.
  9. After you make an edit due to the CP, add a Word comment that includes the CP number that the change came from. This helps the Reviewer who will later confirm your changes.
  10. Repeat steps 7-9… for each change within the CP until the CP is completely integrated into the Volume or TI
  11. If you have additional CPs to integrate, repeat from step 5.
  12. Next, you will integrate TI Supplement(s) approved to move to Final Text (if any).
    1. Refer to the 'Dashboard . Column B shows TIs that apply to your Volume.
    2. If the Supplement you are integrating is not affected by CPs in this cycle, then you will again find the MS-Word version in Google Drive: 'IHE Documents >> Document Publication >> Current Published >> Radiology
  13. If the Supplement you are integrating is affected by CPs in this cycle, then you will coordinate with that Editor to get the updated/change-tracked Word document after CP integration. Find the Editor on the Dashboard.
  14. Finally, when all edits are complete for your Volume or TI, upload the updated volume/TI to into google drive under IHE Documents >> Radiology >> TF_Maintentance >> TF republication working folder in the "2026" folder.
  15. Notify folks that you've completed your task: send an email to the RAD Tech co-chairs, TPM, and the Reviewer assigned to your document.

Caveats:

  1. If CPs overlap, or conflict with a previous CP, try to solve it or when in doubt, ask for help. (RAD Tech Co-chairs or the TPM should know who to reach out to.)
  2. If there is a problem with figures that are impossible to update, or that you are unable to update, reach out to the co-chairs for help as well
  3. If the headers or “normal” text used to position the you so you can find where to insert changes within the TF is different than what you find in the TF – check the date when the CP was last updated. If the CP is significantly older (more than 1 year) than the TF, chances are the TF content has since changed and you do not need to change it back to what is in the CP.
  4. In the rare case that your CP has a diagram that is saved in a separate file (ie not integrated into the documentation), please put it in google drive once the documentation and diagrams are final. They go here: IHE Documents >> Document Publication >> Non-standard Diagrams >> Radiology.
  5. If you run into any other problems… reach out to the co-chairs or TP.

REVIEWER INSTRUCTIONS: To check integrated CPs and supplements

Why: Integrating CPs into Final Text volumes and TI supplements is a task requiring attention to detail. It is beneficial for someone to check the integration work prior to delivering updated docs to the Documentation Specialist. This provides a "second set of eyes" on the documentation updates, and may prevent a future CP.

When: After CP integration is complete, before submitting a document for publication.

Who: Ideally, someone other than the editor who did the integration. Domain co-chairs assign this task to members of the Technical Committee.

How:

(1) Find the document you are assigned to verify

(2) Next, access the CPs that will be integrated into your document:

    1. Refer to the Dashboard . Column C shows CPs that apply to your Volume or TI Supp.
    2. Download the relevant CPs from the Final Text folder so you have a local copy.

(3) Verify the integration

  • Open the document to verify and a CP affecting the document. Ensure that "Tracked changes" is set to "Final showing markup" so you can easily see the editor's updates.
  • In the CP, the changes are included beneath the CP's rationale. Interpret the editor's instructions as follows:

a. Editors instructions are included in a 'box'. This guides the editor to find the location in the document to make a change.

b. If the text in the CP just flat text (regular font), that means it has been copied from the TI or TF in order to help you find the position in the document where the change occurs. “Regular font” text in the CP is NOT a change to the Volume or TI.

c. If text is bold and underlined font, that indicates text that should be inserted (Note: a somewhat common integration mistake to watch for is when the editor adds the bold/underline text but forgets to remove the bold/underline font)

d. If text is bold and strike-out font, it means delete the text

(4) Repeat Step (3)

  • ...until you have checked all CPs affecting the document you are verifying

(5) Extra credit (nice, but not a required step)

  • It is also beneficial to check to ensure there are not changes in the document that were *not* from a CP. If you notice an unexpected update that shows up in Change Tracking, you may inquire with the editor about the source of the change.

(6) If you find no errors in CP integration...

  • Send an email to the TPM and the document editor indicating that you are done and that the integration was flawless.

(7) If you find an error in CP integration...

  • (This can happen because an editor missed something in the CP, or perhaps interpreted the intended change differently than you did.)
  • Ensure "Track changes" is set to "On" in the document you are verifying.
  • Fix the text to the way you think the CP should be applied.
  • Save the updated document with a new name; append your initials to the existing file name, eg RAD_TF_Vol_2_203xmmdd_draft_<yourinitials>.docx
  • Upload the updated document in the same folder where you got it from: google drive under IHE Documents >> Radiology >> TF_Maintentance >> TF republication working folder in the "2026" folder.
  • Send an email to the TPM and the document Editor indicating that you have made a change

(7a) The Editor will then...

RAD TECH TPM INSTRUCTIONS: Submit updated documents to the IHE Documentation Specialist (Mary)

Finally, the TPM will

  1. Accept all changes in the document are remove comments showing CP numbers
  2. upload the document edited to Google Drive: IHE Documents >> Document Publication >> Committee Submitted >> Radiology
Retrieved from "http://wiki.ihe.net/index.php?title=RAD_Tech_Annual_TF_Republication_Process&oldid=135044"