CDR Tickets

Issue Number 3207
Summary Update PDQ XML Documentation
Created 2010-08-16 13:46:15
Issue Type Improvement
Submitted By Englisch, Volker (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2011-10-24 14:43:13
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107535
Description

BZISSUE::4895
BZDATETIME::2010-08-16 13:46:15
BZCREATOR::Volker Englisch
BZASSIGNEE::Volker Englisch
BZQACONTACT::Lakshmi Grama

Since we are now including the DrugInformationSummary documents for distribution we need to update the PDQ XML documentation to include this change.

While I was looking at this document I've noticed many changes that Lakshmi did at the end of last year which should probably be included in the updated version of this document.

Comment entered 2010-09-08 17:19:02 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-08 17:19:02
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1

I was wondering if the updated documentation will need to get approved before making it available again?

Comment entered 2010-09-10 14:16:03 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-10 14:16:03
BZCOMMENTOR::Volker Englisch
BZCOMMENT::2

I have read through the PDQ XML documentation and made some changes (i.e. removing the mention of 'licensee' and removing the Person document type and added the section for the DrugInfoSummary but it's probably better if someone else will describe the elements.
Should we ask Diana?

Comment entered 2010-09-13 11:39:14 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-13 11:39:14
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

The document is located at

mahler\cdr\Documentation\Licensees\PDQ_XML_Package2009.doc

Comment entered 2010-12-09 09:59:04 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-12-09 09:59:04
BZCOMMENTOR::Volker Englisch
BZCOMMENT::4

Diana has been tagged to write up the remaining changes to the documentation.

Waiting for her input.

Comment entered 2010-12-09 10:00:19 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-12-09 10:00:19
BZCOMMENTOR::Volker Englisch
BZCOMMENT::5

Adding Diana as a CC to this issue.

Comment entered 2011-06-15 11:19:37 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-06-15 11:19:37
BZCOMMENTOR::Volker Englisch
BZCOMMENT::6

In addition to the DrugInfo Summary documentation we now will also need to include the changes related to the audio files.

I will take care of the audio updates first.

Comment entered 2011-08-24 14:12:32 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-08-24 14:12:32
BZCOMMENTOR::Volker Englisch
BZCOMMENT::7

I've revised the documentation and included a bunch of updates that Lakshmi had previously included. I've included the new addition of audio files, updated the DTD, and also added some information related to the DrugInfoSummaries but the elements would still need to be explained.

Comment entered 2011-08-25 16:24:46 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-08-25 16:24:46
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8

Margaret, the latest version of the vendor documentation is located at

mahler\d$\cdr\Documentation\Licensees\PDQ_XML_Package2011.doc

or you might just want to add the element descriptions here. I've copied the table from the Word document for you.

Table 16: DrugInformationSummary Data Elements
PDQ XML DTD Comments
------------------— -----------------------------------------------------
DrugInfoMetaData
DrugInfoType Combination attribute 'Yes'
Valid values: Brief, Detailed
DrugInfoAudience Valid values: Patients, Health professionals
DrugInfoDescription
DrugInfoURL
Manufacturers
Manufacturer
FDAApproved
TerminologyLink
GlossaryLink
USBrandNames
USBrandName
Synonyms
Synonym
DrugInfoTitle
Section
DrugInfoDisclaimer Section elements
DateFirstPublished
DateLastModified

Comment entered 2011-09-23 16:43:59 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-09-23 16:43:59
BZCOMMENTOR::Volker Englisch
BZCOMMENT::9

I received input from Margaret and updated the document. If it's OK I would like to update this document on the FTP site with these changes.

Comment entered 2011-09-30 12:33:03 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-09-30 12:33:03
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10

Margaret, I just realized that you wanted to give me some input on these few elements as well. I had forgotten to add these in the original list since these were recent changes:

Pronunciation Info
TermPronunciation
MediaLink
FDAExternalRef

Comment entered 2011-10-24 14:43:13 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-10-24 14:43:13
BZCOMMENTOR::Volker Englisch
BZCOMMENT::11

The updated document has been copied to the FTP site in both, the *.doc and *.pdf versions:
PDQ_XML_Package.doc - R10238
PDQ_XML_Package.pdf - R10238

I hope it's OK with you for me to close this issue.

Elapsed: 0:00:00.001610