| Issue Number | 5059 |
|---|---|
| Summary | SVPC Summary Metadata changes |
| Created | 2021-10-22 12:01:42 |
| Issue Type | New Feature |
| Submitted By | Osei-Poku, William (NIH/NCI) [C] |
| Assigned To | Englisch, Volker (NIH/NCI) [C] |
| Status | Closed |
| Resolved | 2021-12-16 12:51:02 |
| Resolution | Fixed |
| Path | /home/bkline/backups/jira/ocecdr/issue.301082 |
This is a placeholder ticket for potential Summary Metadata Changes for the SVPC initiative.
There are questions about:
1. Summary Type
2. The Summary URL
3. Summary Abstract
4. Summary Keywords
5. Summary Description
6. Summary Boards
7. Main Topics
8. Purpose Text
9. PMID
I will update the ticket as we get more information about these.
This is a question that is more general than just looking at elements of the SummaryMetaData.
We will also need to decide, for instance, what the DateLastModified should be for the partner document or how to handle a situation when multiple SVPC documents are included with each containing a "To Learn More About X Cancer" section.
As we try to create a new default template for the SVPC summaries OCECDR-5056, we need to know which elements in the summary metadata section are needed for the SVPC and Partner summaries. Below is a list of the elements and what we currently know about them. I have marked the ones we've either talked about or know to include or exclude. There have not been definitive guidelines on how the ones without check marks should be handled in either the SVPC or Partner summaries.
1. Summary Type
a. SVPC summary ✔ OK in all cases except that we do not have a Diagnosis type.
b. Partner summary ✔
2. Summary URL
a. SVPC summary ✔
b. Partner summary✔ Use existing legacy URL? Is the partner URL
still necessary ?
3. Summary Abstract
a. SVPC summary
b. Partner summary
4. Summary Keywords
a. SVPC summary
b. Partner summary
5. Summary Description
a. SVPC summary
b. Partner summary
6. Summary Boards
a. SVPC summary ✔ Optional
b. Partner summary ✔ Optional
7. Main Topics
a. SVPC summary
b. Partner summary
8. Purpose Text
a. SVPC summary
b. Partner summary
9. PMID
a. SVPC summary
b. Partner summary ✔ Retain existing PMID.
1. Summary Type
a. SVPC summary ✔ OK in all cases except that we do not have a Diagnosis type.
b. Partner summary ✔
We are adding new values to the existing summary types so they accurately match the SVPC summaries.
2. Summary URL
a. SVPC summary ✔
b. Partner summary✔ Use existing legacy URL? Is the partner URL
still necessary ?
We may provide the partners with the URL for the "What is" summary
3. Summary Abstract
a. SVPC summary
b. Partner summary
Required for the Partner documents but optional for the SVPC summaries.
4. Summary Keywords
a. SVPC summary
b. Partner summary
Optional for SVPC summaries. Possibility of using this to capture SEO keywords in the future.
5. Summary Description
a. SVPC summary
b. Partner summary
Required for SVPC summaries. May be optional for partner summaries
6. Summary Boards
a. SVPC summary ✔ Optional
b. Partner summary ✔ Optional
7. Main Topics
a. SVPC summary
b. Partner summary
Required for both SVPC and Partner summaries
8. Purpose Text
a. SVPC summary
b. Partner summary
Not required for both SVPC and Partner summaries (Not sure if this is accurate)
9. PMID
a. SVPC summary
b. Partner summary ✔ Retain existing PMID.
Not required for SVPC summaries
Summary Type: We are adding new values to the existing summary types so they accurately match the SVPC summaries.
When adding new summary types please keep in mind that the existing types are used for a variety of processing decisions and filters may need to be adjusted accordingly.
Summary URL: We may provide the partners with the URL for the "What is" summary
Will the URL be manually maintained in the partner document or should it be extracted from the first SummaryModuleLink's MetaData information to the SVPC document?
Summary Boards: Element SummaryEditorialBoard removed from partner and SVPC document, no change (i.e. included) in legacy summaries.
Purpose Text: Not required for both SVPC and Partner summaries (Not sure if this is accurate)
This text is used to replace the PlaceHolder element "PurposeofSummary". If that placeholder is not used the element isn't needed. The element is not included in the MetaData of the SVPC, partner, or legacy documents.
PMID: Not required for SVPC summaries
Similar to the PurposeText. This element is not included in the legacy MetaData. The information is used to include the PMID as part of the "About This PDQ Summary" section. If we're not including this section with the partner document we wouldn't need it to be maintained.
Legacy summary documents will still need it, SVPC document won't have it.
Unless we're creating a new SummaryType all other filter-related changes have been implemented.
It will be good to extract it form the first SummaryModuleLink Metadata info so that we are not manually maintaining it in two places.
I agree that in the case of the SummaryURL for the partner document being identical to the URL for the first SVPC it would make sense to use the URL from that document. However, we need to keep in mind that the SummaryURL is a mandatory field and must be populated regardless. In addition, I am wondering if using the first summary's URL will be the right approach for all summaries and summary types.
If that's the case I will make the change to the partner filters
When we first create the partner summary, we can manually enter the URL from the first/What is? summary but then it must be overwritten by the filters to avoid double maintenance. This will help us avoid the problem you mentioned above (mandatory element) so that the document is not invalidated.
It was discusses that we will initially maintain the URL for the partner document by hand. Since URLs for our summaries aren't changing too often and the creation of the partner documents isn't expected to be a permanent process, we can skip implementing this change for now.
No additional filter changes are needed.
Verified on DEV. Thanks!
Verified on QA and PROD. Thanks!
Elapsed: 0:00:00.001564