Krames Patient Education Standard Content Export

Transcription

1 Krames Patient Education Standard Content Export Description and Technical Documentation 1

2 Overview This document provides a description of a Krames Patient Education Standard Content Export. This document will discuss the following topics: Process to download content and quarterly updates from our FTP site. Understand the structure of the XML, HTML and RTF content. Access English and foreign language documents. Define the content metadata. Explain the database that is available with the content export. Standard Content The export consists of the following content and formats: Content has these collections - o Krames On-Demand (KOD) HealthSheets (all languages) o Lab Tests Online o Gold Standard Medication Sheets o Exit-Writer Discharge Instructions Content is available in XML, HTML and RTF formats. Metadata is part of the XML and HTML content. Metadata can be delivered in a database. Definitions FTP File Transfer Protocol Collections The Collections is comprised of different types of collections. These collections consist of HealthSheets, lab tests and discharge instructions documents in English and foreign languages. The different types of collections are discussed in the XML and HTML sections. Dynamic Collection A dynamic collection consists of the Patient Drug Education collection that contains all the drug sheets. Through the Dynamic Collection folder, users will be able to browse through the drug content using an alphabetical browse. Documents This section provides access to all the documents that are available in the HTML folder. By selecting the Documents option, a complete list of document titles is presented. 2

3 Download Content: FTP Customers will be able to download content from our FTP site. The content will be in a zip file for customers to download to their desktop or other location. Since the FTP site will allow customers to download standard content or customized versions, the login requirements and folders will be different. These requirements are discussed in the Standard Download and Custom Content Download sections of this document. Content updates are available on the FTP site on a quarterly basis. Customers will be notified in advance of each quarterly update and a list of new and revised documents will be provided. Standard Download Standard content will be available to customers to download from our FTP site. Each customer will be provided with an FTP link and login information. Each customer will have unique login credentials. When the user logs into the FTP site, the user will be directed to their Standard Collection. FTP Site: ftp.staywell-krames.com Username: To be provided Password: To be provided FTP Software: Recommend FileZilla or similar application (Figure 1: FTP Site) Standard content will be provided to customers in any of these formats: XML content HTML content RTF content with images embedded RTF content with image folder Figure 1: FTP Site 3

4 Custom Content Download Customers that have custom content have the ability to download from the FTP site. Each customer have unique login credentials and their own FTP directory. When the user logs into the FTP site, the user will be directed to their individual folder to download their custom content collection. Each customer will require the following: FTP Site: ftp.staywell-krames.com Username: To be provided Password: To be provided FTP Software: Recommend FileZilla or similar application (Figure 1: FTP Site) Extensible Markup Language (XML) The standard XML download has a consistent directory structure and content type (Figure 2: XML Export Structure). As illustrated, the XML folder will be the repository for all of the document files including HealthSheets, lab tests, drug sheets and discharge instructions. Figure 3: Content Types lists the folders and defines the content type in each. Figure 2: XML Export Structure Content Types Since the content consists of different types of health information, each type is assigned its own content type identifier or content type ID followed by individual document numbers. This enables customers to identify documents by type in the XML folder ( ) where all the documents reside. For instance, in the XML folder, 3,40000.xml indicates this document is a Krames HealthSheets (type 3) document # We offer the following content types: Content Type ID: 3 = Krames HealthSheets Content Type ID: 99 = Lab Tests Online Content Type ID: 82 = Exit-Writer Discharge Instructions Content Type ID: 26 = Gold Standard Medication Sheets 4

5 Collections Krames offers a standard collection of content. Our standard collection includes the following collections: Collection 70 = Krames KOD HealthSheets and Lab Tests Online Collection 8350 = Translations: 10 Sheets in 10 Languages Collection 8572 = Chinese Translations Collection = Russian Translations Collection 8561 = Vietnamese Translations Collection = Exit-Writer Discharge Instructions Dynamic Collection 69 = Gold Standard Medication Sheets Figure 3: Content Types Documents In each download, there are XML documents that provide the following information about the content: Collections.xml = Provides information about the KOD and Exit-Writer collection Documents.xml = Includes a complete list of all documents available in each collection DynamicCollections.xml = Lists all the drug sheets available in the dynamic collection 5

6 HyperText Markup Language (HTML) The standard HTML download has a consistent directory structure and content type (refer to Figure 4: HTML Export Structure). As illustrated, the HTML folder ( ) is the repository for all the document files that include HealthSheets, lab tests, drug sheets and discharge instructions. Figure 5: Content Types lists the folders and defines the content type in each. Structure The content is available in utf-8 or windows format. Generally, utf-8 is preferred because it supports the character formats used in the Krames foreign language documents. Within the content, there are several folders (refer to Figure 4) that are used to store documents with navigation, browse and language options. Figure 4: HTML Export Structure Contains all the specialty topics and sub-topics to support browsing. Includes the browse and style sheets. Provides an alphabetical list of files used to navigate and search for drugs in the browse. Contains all the documents used for patient education. - Includes the logo.jpg placeholder needs to be replaced with the client logo. 6

7 Figure 5: Content Types Content Types Since the content consists of different types of health information, each type is assigned its own content type identifier followed by document numbers. This enables customers to identify documents by type in the HTML folder where all the documents reside. For instance, in the HTML folder, 3,40000.html indicates this document is a Krames HealthSheets (type 3) document # We offer the following content types: Content Type ID: 3 = Krames HealthSheets Content Type ID: 99 = Lab Tests Online Content Type ID: 82 = Exit-Writer Discharge Instructions Content Type ID: 26 = Gold Standard Drug Sheets Collections Krames Collections consists of several different collections that create a content export. Our standard collection consists of the following collections: Collection = Krames KOD HealthSheets and Lab Tests Online Collection = Translations: 10 Sheets in 10 Languages Collection = Chinese Translations Collection = Russian Translations Collection = Vietnamese Translations Collection = Exit-Writer Discharge Instructions Dynamic Collection = Gold Standard Drug Sheets Documents In each download, there are HTML documents that provide a directory structure or listing to link to specific documents. The Collections.html and DynamicCollections.html provide a hierarchical structure to drill down to documents. The Documents.html provides a list of all documents in a collection and links to them. 7

8 Collections.html - This is a browse that customers may integrate into their own work environments. It is similar to the Krames On-Demand browse tree in which users can drill down through topics and subtopics to access documents. In addition, next to the title list are the language identifiers. The Collections contains a group of collections that includes all the English and foreign language HealthSheets, lab tests and discharge instructions documents. It is designed to enable users to open a collection and browse through the different specialties to find a specific document or documents. Figure 6 illustrates the different collections that are available to users. Figure 6: Collections For example, to find a document on ACE inhibitors, the user selects the KOD HealthSheets collection to display the different specialties. The user will find Taking ACE Inhibitors by selecting the specialty Cardiology and opening the sub-folder Acute Myocardial Infarction (Figure 7 and Figure 8). In the Myocardial Infarction sub-folder, the user will have access to a list of documents that includes Taking ACE Inhibitors. When the user opens the Taking ACE Inhibitors document, there will be different options present on the page. The user can use the following navigation options: - Home: Returns to the index page. - Back: Takes users back to a previous page. Along with the navigation, there are different language identifiers presented to the user. These language identifiers allow the user to view a document in a specific language (refer to Figure 9). In this example, a user can select SP for Spanish. 8

9 Figure 7: Browse Figure 8: HealthSheet Taking ACE Inhibitors 9

10 Figure 9: Language Identifiers Clients have the ability to brand documents with their logos. The logo will not appear on a user s computer, it only appears when a document is printed. To add a logo, replace the logo.jpg in the HTML/Images directory. The logo requirements: o o JPEG format Dimensions > 650x100 pixels Documents.html This section provides access to all the documents that are available in the HTML folder. By selecting the Documents option, a complete list of document titles is presented. The title opens an English version of a document and the language identifier opens the foreign language version. In addition, users have access to the Home and Back buttons for navigation. Figure 10 shows a list of documents. Figure 10: Documents Document List Clients have the ability to brand documents with their logos. The logo will not appear on a user s computer, it only appears when a document is printed. To add a logo, replace the logo.jpg in the HTML/Images directory. 10

11 The logo requirements: o o JPEG format Dimensions > 650x100 pixels DynamicCollections.html The Dynamic Collections consists of drug sheets that can be accessed from an alphabetical browse. By selecting a letter, all matching titles are displayed (Figure 11). When the user selects a drug title, the user is presented with the different dosage forms for that drug. The dosage form title is a link to the English version of the document. Foreign language identifiers appear next to the title and link to the foreign language (Spanish) version of the document. Figure 11: Dynamic Collection Drug Sheets When a letter is selected, users will have a view of all the drug sheet titles that start with the selected letter. For instance, select a letter A, a user will see all the drug sheet titles that start with the letter as shown in Figure 11. By selecting the title (Abacavir), the document will be displayed in their browser or window as illustrated in Figure 12. In this case, the drug sheet Abacavir Sulfate Oral solution is presented. The drug sheet enables users to navigate to the homepage and a previous page with the Home and Back respectively. Using the language identifier, SP, the user can view the document in Spanish. 11

12 Figure 12: Drug Sheet Clients have the ability to brand documents with their logos. The logo will not appear on a user s computer, it only appears when a document is printed. To add a logo, replace the logo.jpg in the HTML/Images directory. The logo requirements: o o JPEG format Dimensions > 650x100 pixels 12

13 Rich Text Format (RTF) The RTF files are provided to customers in a single repository where all the documents reside. select an RTF documents may be selected from the list of documents presented. (Figure 13: RTF Directory Structure) There are two versions of the RTF documents: RTF documents with images embedded in them RTF documents that link to images within an image folder Figure 13: RTF Directory for All Documents RTF documents are available for drug sheets, too. Rather than using a hierarchical structure, the documents are available through an alphabetical search. When a user selects a letter, any title that starts with that letter will be presented (Figure 10: RTF Directory Structure for Drug Sheets). When a drug title is selected, the user will be able to select a document from a list of different dosages and languages documents for that drug. Customizing Krames Content Customers can request changes to a standard content export. Any changes will be considered custom and will require additional development. A Statement of Work (SOW) and fees for custom content will be included in a proposal. 13

14 Appendix A: Standard Tagging for Documents XML Tags for Krames HealthSheets This table outlines the tags that are available and standard for XML HealthSheet content. HealthSheet : XML Tags STD Format Custom Content Type ID <Document ContentTypeId="3" ContentId="82252" IsCustom="0" xmlns=" Language Code <Language code="en">english</language> Regular Title <RegularTitle xmlns=" to Diaper</RegularTitle> Inverted Title <InvertedTitle xmlns=" How to</invertedtitle> Blurb <Blurb xmlns=" Overview of the herpes (HSV-1 and HSV-2) test, performed on a swab from the infected area to screen for or diagnose infection with the Herpes Simplex Virus. </Blurb> <Gender>Both</Gender> Gender <Gender>male</Gender> <Gender>female</Gender> Last Modified Date <LastModifiedDate> T00:00:00-06:00</LastModifiedDate> Last Reviewed Date <LastReviewedDate> T00:00:00-07:00</LastReviewedDate> Copyright Statement <CopyrightStatement> The StayWell Company, 780 Township Line Road, Yardley, PA All rights reserved. This information is not intended as a substitute for professional medical care. Always follow your healthcare professional's instructions.</copyrightstatement> Age Groups <AgeGroup>Infant (0-1)</AgeGroup> <AgeGroup>Childhood (1-17)</AgeGroup> <AgeGroup>Teen (12-17)</AgeGroup> <AgeGroup>Adult (18-124)</AgeGroup> <AgeGroup>Senior (65-124)</AgeGroup> MeSH List <MeSHList> <MeSH code="d041381" /> </MeSHList> Included: MeSH keywords CPT List <CPTList> <CPT code="s8402" /> </CPTList> ICD9 List <ICD9List> <ICD9 code="691.0" /> </ICD9List> Keywords <Keywords> <Keyword>How to Diaper</Keyword> <Keyword>How to</keyword> </Keywords> <OtherLanguages> <Document ContentTypeId="3" ContentId="82234" IsCustom="0"> Other Languages <RegularTitle xmlns=" - Regular Title <Language code="es" /> - Language Coded </Document> </OtherLanguages> Encoding UTF-8 14

15 XML Tags for Exit-Writer Discharge Instructions This table outlines the tags that are available and standard for XML discharge instructions. Exit-Writer Discharge Instructions: XML Tags STD Format Custom Content Type ID <Document ContentTypeId="82" ContentId="116750en" IsCustom="0" xmlns=" Language Code <Language code="en">english</language> Regular Title <RegularTitle xmlns=" to Diaper</RegularTitle> Inverted Title Not Available Blurb Not Available Gender <Gender>Both</Gender> <Gender>male</Gender> <Gender>female</Gender> Last Modified Date <LastModifiedDate> T00:00:00-06:00</LastModifiedDate> Last Reviewed Date <LastReviewedDate> T00:00:00-07:00</LastReviewedDate> Copyright Statement <CopyrightStatement> The StayWell Company, 780 Township Line Road, Yardley, PA All rights reserved. This information is not intended as a substitute for professional medical care. Always follow your healthcare professional's instructions.</copyrightstatement> Age Groups <AgeGroup>Infant (0-1)</AgeGroup> <AgeGroup>Childhood (1-17)</AgeGroup> <AgeGroup>Teen (12-17)</AgeGroup> <AgeGroup>Adult (18-124)</AgeGroup> <AgeGroup>Senior (65-124)</AgeGroup> MeSH List <MeSHList> <MeSH code="d041381" /> </MeSHList> Included: MeSH keywords CPT List <CPTList> <CPT code="s8402" /> </CPTList> ICD9 List <ICD9List> <ICD9 code="691.0" /> </ICD9List> Keywords <Keywords> <Keyword>How to Diaper</Keyword> <Keyword>How to</keyword> </Keywords> <OtherLanguages> <Document ContentTypeId="3" ContentId="82234" IsCustom="0"> Other Languages <RegularTitle xmlns=" - Regular Title <Language code="es" /> - Language Coded </Document> </OtherLanguages> Encoding UTF-8 15

16 XML Tags for Gold Standard Medication Sheets This table outlines the tags that are available and standard for XML drug sheets content. Gold Standard Medication Sheets: XML Tags XML Format Custom Content Type ID <Document ContentTypeId="26" ContentId="1" IsCustom="0" xmlns=" Language Code <Language code="en">english</language> Regular Title <RegularTitle xmlns=" to Diaper</RegularTitle> Inverted Title Not Available Additional Title <AdditionalTitles> <AdditionalTitle xmlns=" <AdditionalTitle xmlns=" </AdditionalTitle> </AdditionalTitles> Blurb Not Available Gender <Gender>Both</Gender> <Gender>male</Gender> <Gender>female</Gender> Last Modified Date <LastModifiedDate> T00:00:00-06:00</LastModifiedDate> Last Reviewed Date <LastReviewedDate> T00:00:00-07:00</LastReviewedDate> Copyright Statement Not Available Age Groups <AgeGroup>Infant (0-1)</AgeGroup> <AgeGroup>Childhood (1-17)</AgeGroup> <AgeGroup>Teen (12-17)</AgeGroup> <AgeGroup>Adult (18-124)</AgeGroup> <AgeGroup>Senior (65-124)</AgeGroup> MeSH List <MeSHList> <MeSH code="d041381" /> </MeSHList> Included: MeSH keywords CPT List <CPTList> <CPT code="s8402" /> </CPTList> ICD9 List <ICD9List> <ICD9 code="691.0" /> </ICD9List> <OtherLanguages> <Document ContentTypeId="3" ContentId="82234" IsCustom="0"> Other Languages <RegularTitle xmlns=" - Regular Title <Language code="es" /> - Language Coded </Document> </OtherLanguages> Encoding UTF-8 16

17 HTML Tags for Krames HealthSheets This table outlines the tags that are available and standard for HTML HealthSheet content. HealthSheet : HTML Tags STD Format Custom Content Type <title> Using a Night Drainage System</title> <meta name="unique" content="89998"> Language Code <meta name="language" content="english"> Regular Title <title>what Is Type 2 Diabetes?</title> Inverted Title <meta name="invertedtitle" content="drainage System, Using a Night "> Blurb Not Available Gender <meta name="gender" content="both"> <meta name="gender" content="male"> <meta name="gender" content="female"> Last Modified Date Date Last Modified: T00:00:00-06:00 Last Reviewed Date Date Last Reviewed: T00:00:00-07:00 Copyright Statement The StayWell Company, 780 Township Line Road, Yardley, PA All rights reserved. This information is not intended as a substitute for professional medical care. Always follow your healthcare professional's instructions. Age Groups <meta name="age" content="0-1"> <meta name="age" content="1-17"> <meta name="age" content="12-17"> <meta name="age" content="18-124"> <meta name="age" content="65-124"> MeSH List <meta name="mesh codes" content="d015444"> <meta name="mesh Term" content="exercise"> <meta name="mesh Term" content="aerobic Exercise"> <meta name="mesh Term" content="aerobic Exercises"> <meta name="mesh Term" content="exercise, Aerobic"> CPT List <meta name="cpt codes" content=" "> ICD9 List <meta name="icd-9 codes" content=" " /> Keywords <meta name="keywords" content="urinary Tract Infection,ER/Trauma,Tract,General,Information,Urology,bacterial,cystitis,bladder " /> Encoding UTF-8 17

18 HTML Tags for Exit-Writer Discharge Instructions This table outlines the tags that are available and standard for HTML discharge instructions content. Exit-Writer Discharge Instructions: HTML Tags STD Format Custom Content Type <title>abdominal PAIN, Unknown Cause, (Female)ABDOMINAL PAIN, Unknown Cause, (Female)ABDOMINAL PAIN, Unknown Cause</title> <meta name="unique" content=" en"> Language Code <meta name="language" content="english"> Regular Title <title>what Is Type 2 Diabetes?</title> Additional Title <meta name= Additional titles content= Abdominal Pain > Gender <meta name="gender" content="both"> <meta name="gender" content="male"> <meta name="gender" content="female"> Last Modified Date Date Last Modified: T00:00:00-06:00 Last Reviewed Date Date Last Reviewed: T00:00:00-07:00 Copyright Statement The StayWell Company, 780 Township Line Road, Yardley, PA All rights reserved. This information is not intended as a substitute for professional medical care. Always follow your healthcare professional's instructions. Age Groups <meta name="age" content="0-1"> <meta name="age" content="1-17"> <meta name="age" content="12-17"> <meta name="age" content="18-124"> <meta name="age" content="65-124"> MeSH List <meta name="mesh codes" content="d015444"> <meta name="mesh Term" content="exercise"> <meta name="mesh Term" content="aerobic Exercise"> <meta name="mesh Term" content="aerobic Exercises"> <meta name="mesh Term" content="exercise, Aerobic"> CPT List <meta name="cpt codes" content=" "> ICD9 List <meta name="icd-9 codes" content=" " /> Keywords <meta name="keywords" content="urinary Tract Infection,ER/Trauma,Tract,General,Information,Urology,bacterial,cystitis,bladder " /> Encoding UTF-8 18

19 HTML Tags for Gold Standard Medication Sheets This table outlines the tags that are available and standard for HTML drug sheet content Gold Standard Medication Sheets: HTML Tags STD Format Custom Content Type <title>acarboseacarbose</title> <meta name="unique" content="26-2"> Language Code <meta name="language" content="english"> Regular Title <title>what Is Type 2 Diabetes?</title> Additional Titles <meta name= Additional titles content= Tylenol > <meta name= Additional titles content= Acetaminophen > Gender <meta name="gender" content="both"> <meta name="gender" content="male"> <meta name="gender" content="female"> Last Modified Date Date Last Modified: T00:00:00-06:00 Last Reviewed Date Date Last Reviewed: T00:00:00-07:00 Copyright Statement Not available Age Groups <meta name="age" content="0-1"> <meta name="age" content="1-17"> <meta name="age" content="12-17"> <meta name="age" content="18-124"> <meta name="age" content="65-124"> MeSH List <meta name="mesh Term" content="urinary Tract Infection"> <meta name="mesh Term" content=" Urology"> CPT List <meta name="cpt codes" content=" "> ICD9 List <meta name="icd-9 codes" content=" " /> Keywords Not available Encoding UTF-8 19

20 Metadata for RTF Files: Krames HealthSheets This table outlines the tags that are available in the database and that are standard for all documents provided in RTF files. Metadata for RTF Files: Exit-Writer Discharge Instructions This table outlines the tags that are available in the database and that are standard for all documents provided in RTF files. 20

21 Metadata for RTF Files: Gold Standard Medication Sheets This table outlines the tags that are available in the database and that are standard for all documents provided in RTF files. 21

22 Appendix B: Metadata Used in Content Database Metadata: Data Elements The Krames metadata can be provided to clients in a database. This section provides a summary of the data elements that are available in the content database. Data Elements Business Unit Content Type ID: - Content Type ID: 3 = Krames HealthSheets - Content Type ID: 99 = Lab Tests Online - Content Type ID: 82 = Exit-Writer Discharge Instructions - Content Type ID: 26 = Gold Standard Drug Sheets Business Unit Content ID - Document ID Inverted Titles - Regular Titles used if inverted title is not available Additional Titles (normalized) Language Name Last Modified Date - MM/DD/YYYY Gender - both - male - female Age Group - Infant (0 1) - Child (1 17) - Teen (12 17) - Adult (18+) (18 124) - Senior (65 124) MeSH Terms (normalized) ICD-9 Codes (normalized) CPT Codes (normalized) 22