CDR Tickets

Issue Number 3332
Summary [Summaries] Summary modules
Created 2011-03-24 11:48:44
Issue Type Improvement
Submitted By Beckwith, Margaret (NIH/NCI) [E]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2011-10-20 14:21:10
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107660
Description

BZISSUE::5025
BZDATETIME::2011-03-24 11:48:44
BZCREATOR::Margaret Beckwith
BZASSIGNEE::Bob Kline
BZQACONTACT::William Osei-Poku

I would like to start the discussion about how to create modules of information that could be used in multiple other PDQ summaries. This would be different from a miscellaneous doc. For example, Sharon has a document that includes descriptions of different types of radiation therapy. She would like to link to the appropriate descriptions from her Pediatric treatment summaries. In this particular case, we could probably get by with making these HP defintions in the glossary and then displaying them as pop-ups the way we do for the HP Genetics terms in the Genetics summaries. But I think that there will be more and more need for developing modules that could be used in different ways, so thought that we could have a discussion about it. I will attach her document as an example.

Comment entered 2011-03-24 11:48:44 by Beckwith, Margaret (NIH/NCI) [E]

Attachment Radiation therapy descriptions Edited CIAT 3_22_11 (2).doc has been added with description: Radiation Therapy module

Comment entered 2011-04-14 15:10:54 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-04-14 15:10:54
BZCOMMENTOR::Robin Juthe
BZCOMMENT::1

As I described in today's meeting, the Genetics of Colorectal Cancer summary and the Genetics of Breast and Ovarian cancer summary each contain a section on Peutz-Jeghers syndrome. We're planning to have this text maintained only by the Colorectal working group, since they are more familiar with this rare syndrome, but the text will also appear in the Breast/Ovarian summary (in QC reports, as well as on the live site). This seems to be a good example where a summary module might work well.

The summary module will need to have metadata, such as an association with a particular PDQ Board and assigned reviewers, and all other elements in summaries, but it will not be independently published to Cancer.gov - it will only be published as part of another document. We will be able to link to the module from the 2 summaries (Colorectal and Breast/Ovarian) and this link could occur at various summary section levels in the document.

Comment entered 2011-04-18 10:42:58 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-04-18 10:42:58
BZCOMMENTOR::Bob Kline
BZCOMMENT::2

I guess the best place to start would be to have you identify the parts of the Summary schema which should not be the same in the schema for a SummaryModule document (apart from the obvious change in the name of the top-level element):

http://bach.nci.nih.gov/cgi-bin/cdr/GetSchema.py?id=203

Depending on how much is the same, we may want to move more definitions from SummarySchema to SummaryCommon, or we may want to create a second included schema of definitions which are common to summary and summary module docs.

Comment entered 2011-04-26 08:53:50 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-04-26 08:53:50
BZCOMMENTOR::Bob Kline
BZCOMMENT::3

At last week's status meeting, the users asked why we couldn't just use the existing Summary schema for these new documents. The answer was that we could, as long as we add some way for the publishing software to know that even thought they would be marked as publishable (so the main documents could link to them) they weren't to be published as standalone summaries. Margaret and Robin are going to review the Summary schemas to make sure there are no required elements which be inappropriate for the new Summary Module documents.

Comment entered 2011-05-16 12:49:23 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-05-16 12:49:23
BZCOMMENTOR::Robin Juthe
BZCOMMENT::4

(In reply to comment #3)
> Margaret and
> Robin are going to review the Summary schemas to make sure there are no
> required elements which be inappropriate for the new Summary Module documents.

We reviewed the following schemas:

-SummarySchema
-SummaryCommon
-CDRCommonBase

We didn't find anything that was required by one of these schemas and we wouldn't want to be in the module. So, we think we could use the same schema as for a summary document. We would need to modify publishing rules, however, to allow the module to be published as a standalone document (like a regular summary) and/or inside another document.

Comment entered 2011-06-16 15:14:18 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-06-16 15:14:18
BZCOMMENTOR::Robin Juthe
BZCOMMENT::5

We decided in last week's status meeting to make a couple changes to the summary schema to allow for modules:

1. Add an attribute called "ModuleOnly" with a value of Yes (or nothing). This will be used to control which documents will only be published as part of another document. Other documents could be published as a stand-alone document AND as a module.

2. Add a para-level element called "Summary Module Link". This will be used to include modularized content in a summary.

Comment entered 2011-06-21 08:30:06 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-06-21 08:30:06
BZCOMMENTOR::Bob Kline
BZCOMMENT::6

(In reply to comment #5)

> 1. Add an attribute called "ModuleOnly" with a value of Yes (or nothing).

Installed on Mahler.

> 2. Add a para-level element called "Summary Module Link". This will be used to
> include modularized content in a summary.

Where exactly do you want this?

Comment entered 2011-08-01 09:46:56 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-08-01 09:46:56
BZCOMMENTOR::Robin Juthe
BZCOMMENT::7

(In reply to comment #6)
> > 2. Add a para-level element called "Summary Module Link". This will be used to
> > include modularized content in a summary.
> Where exactly do you want this?

We would like the summary module link element to be capable of being added at the top-level of a summary document (as we would add a new summary section) or at the para level of a summary document. I think this would mean we would need to add the new summary module link element to two places:

CDR common base schema - add as a para-level element
Summary schema - add as a top-level element

Comment entered 2011-08-01 12:00:29 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-08-01 12:00:29
BZCOMMENTOR::Bob Kline
BZCOMMENT::8

Both summary changes are now installed on Mahler. You'll want to have Volker make some adjustments to the CSS in XMetaL. I added the SummaryModuleLink element in such a way that it can alternate with SummarySection elements, rather than have all the SummarySection elements, followed by all the SummaryModuleLink elements. If that's not right I can change it, but the way I did it seemed more in keeping with the use cases being described.

Comment entered 2011-08-01 14:57:59 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-08-01 14:57:59
BZCOMMENTOR::Bob Kline
BZCOMMENT::9

(In reply to comment #8)
> Both summary changes are now installed on Mahler ....

I meant to write "Both schema changes are now installed on Mahler..."

Comment entered 2011-08-11 12:24:29 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-08-11 12:24:29
BZCOMMENTOR::Robin Juthe
BZCOMMENT::10

(In reply to comment #8)
> I added the SummaryModuleLink
> element in such a way that it can alternate with SummarySection elements,
> rather than have all the SummarySection elements, followed by all the
> SummaryModuleLink elements.

Good – this is right. I verified the placement of these elements on Mahler and added a separate issue (OCECDR-3403) for the CSS change.

Comment entered 2011-08-11 12:27:00 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-08-11 12:27:00
BZCOMMENTOR::Robin Juthe
BZCOMMENT::11

Added [Summaries] to title.

Comment entered 2011-08-17 12:47:48 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2011-08-17 12:47:48
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::12

I updated the linking table to allow links from the SummaryModuleLink element before I was able to test the link. I hope that is Okay to update the linking table at this point.

Comment entered 2011-09-07 13:35:52 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-09-07 13:35:52
BZCOMMENTOR::Robin Juthe
BZCOMMENT::13

Now that the CSS changes are complete (OCECDR-3403), these schema changes can be promoted to Bach.

Comment entered 2011-09-07 14:10:06 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-09-07 14:10:06
BZCOMMENTOR::Bob Kline
BZCOMMENT::14

(In reply to comment #13)
> Now that the CSS changes are complete (OCECDR-3403), these schema changes can be
> promoted to Bach.

Done. Please check (and close if OK).

Comment entered 2011-09-07 17:56:46 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2011-09-07 17:56:46
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::15

(In reply to comment #14)
> (In reply to comment #13)
> > Now that the CSS changes are complete (OCECDR-3403), these schema changes can be
> > promoted to Bach.
>
> Done. Please check (and close if OK).

I updated the linking table to allow links from the SummaryModuleLink element. It seems to be working fine.

Comment entered 2011-10-20 14:20:55 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-10-20 14:20:55
BZCOMMENTOR::Robin Juthe
BZCOMMENT::16

Verified on Bach.

Comment entered 2011-10-20 14:21:10 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-10-20 14:21:10
BZCOMMENTOR::Robin Juthe
BZCOMMENT::17

Closing issue.

Attachments
File Name Posted User
Radiation therapy descriptions Edited CIAT 3_22_11 (2).doc 2011-03-24 11:48:44

Elapsed: 0:00:00.000579