AHRQ PSO Information Form. Technical Specifications for XML. Data Submission from PSO to PSOPPC

Transcription

1 AHRQ PSO Information Form Technical Specifications for XML Data Submission from PSO to PSOPPC December 2013

2 Revision History Revision Date Notes 11/2011 Initial release of this specification. 12/ PSO Information Form Update. 12/ PSO Information Form Update. AHRQ PSO Information Form Technical Specifications - December 2013 ii

3 Table of Contents Section One- Introduction Objective Audience Program Overview Data Submission Overview Supporting Documentation... 2 Section Two- Approach Succession Management File Size Limitations File Name Limitations Validation of PSO Information and Provider Information XML Files... 4 Section Three- PSO Information and Provider Information XML File Structure Overview of PSO Information and Provider Information XML File Structure pso-information Element provider-information Element detail Element question Element answer and text Elements Section Four- Sample PSO Information and Provider Information XML Files AHRQ PSO Information Form Technical Specifications - December 2013 iii

4 List of Tables Table 1: PSO and Provider Information Elements and Attributes... 6 List of Figures Figure 1: PSO Information and Provider Information XML File Structure... 6 Figure 2: pso-information Elements and Attributes... 9 Figure 3: provider-information Element Figure 4: detail Element Figure 5: question Element Figure 6: answer and test Elements Figure 7: PSO Information XML Sample Figure 8: Provider Information XML Sample Figure 9: PSO Information and Provider Information XML Sample Figure 10: PSO Information and Information for Multiple Providers XML Sample AHRQ PSO Information Form Technical Specifications - December 2013 iv

5 Section One- Introduction 1.1 Objective This document provides the required file format specifications for transmitting Patient Safety Organization (PSO) information and Provider information from PSOs to the Patient Safety Organization Privacy Protection Center (PPC). The PSO and Provider information submitted to the PPC is based on the PSO Information Form, available on the Agency for Healthcare Research and Quality (AHRQ) PSO Web site ( 1.2 Audience This document serves the following audiences: Patient Safety Organizations (PSOs) Software vendors 1.3 Program Overview PSOs were created as part of the Patient Safety and Quality Improvement Act of 2005 (Patient Safety Act). AHRQ, of the Department of Health and Human Services (HHS), administers the provisions of the Patient Safety Act dealing with PSO operations. Submission of the PSO Information Form provides information to HHS on the types of health care providers, settings, and reports for which PSOs conduct patient safety activities. The PSO Information Form is designed to collect data that will be used to generate aggregate statistics necessary to administer the Patient Safety Act and to report on the Act s impact. More information on the PSO and provider information being submitted can be found in the PSO Information Form, available on the AHRQ PSO Web site ( PSO Information Form Burden Statement Public reporting burden for the collection of information is estimated to average three hours per response. An agency may not conduct or sponsor, and a person is not required to respond to, a collection of information unless it displays a currently valid OMB control number. Send comments regarding this burden estimate or any other aspect of this collection of information, including suggestions for reducing this burden, to: AHRQ Reports Clearance Officer, Attention: PRA, Paperwork Reduction Project ( ), AHRQ, 540 Gaither Road, Room #5036, Rockville, MD Data Submission Overview PSO information and provider information data shall be transmitted to the PPC using the Extensible Markup Language (XML) file format. This document provides the XML file specifications for transmission of PSO and provider information data to the PPC. Transmission of the PSO and provider information XML files by PSOs to the PPC shall be performed using the secure pages of the PPC Web site ( Access to the secure pages of the PPC Web site requires a PPC Web site user account. Please contact the PSOPPC Help Desk at or at support@psoppc.org for more information on obtaining a PPC Web site user account. December 2013

6 1.5 Supporting Documentation The following supporting document is integral to this specification and is available on the PPC Web site ( AHRQ PSO Information and Provider Information Technical Specifications for Data Submission from PSO to PSOPPC: Appendix A This spreadsheet complements the technical specifications and provides information about the PSO and provider information questions and answer values and assists with the development of a PSO and provider information XML file. It also contains information on the validation rules that will be applied to the PSO and provider information questions and associated answer values submitted to the PPC. AHRQ PSO Information Form Technical Specifications - December

7 Section Two- Approach 2.1 Succession Management This specification allows updates to previously submitted PSO and provider information by replacing a previously submitted file with an updated file. Information for a PSO is uniquely identified by a combination of the PSO Identifier and PSO Information Reporting Year. Information for a provider is uniquely identified by a combination of the PSO Identifier, Provider Information Reporting Year, and the PSO-Assigned Provider ID Code. PSO Information Succession Management Previously submitted data shall be overwritten by the updated data submitted in the most recent successful PSO information XML file submission. Hence, data from only the most recent successful submission of a PSO information XML file shall be stored in the system. The updated PSO information XML file shall have the same PSO Identifier (pso-information/@psoid) and PSO Reporting Year (psoinformation/@year) as the previously submitted PSO information XML file. Appending new data to previously submitted files is not allowed within this specification. Provider Information Succession Management Previously submitted data shall be overwritten by the updated data submitted in the most recent successful provider information XML file submission. Hence, data from only the most recent successful submission of a provider information XML file shall be stored in the system. The updated provider information XML file shall have the same PSO Identifier (pso-information/@psoid), PSO Information Reporting Year (pso-information/@year) and PSO-Assigned Provider ID Code (pso-information/providerinformation/@providerid) as the previously submitted provider information XML file. Appending new data to previously submitted files is not allowed within this specification. 2.2 File Size Limitations PSO information and provider information XML files can be submitted individually, submitted as multiple individual files, or grouped together into one or more zip files. Each submission (either individual files or zip files) shall not be greater than 20 MB. 2.3 File Name Limitations PSO information and provider information XML (.xml file extension only) and zip files (.zip file extension only) must conform to the following file name specifications: The file name shall be 45 characters or less in length. The file name shall not include any of the following characters: \ / & *? " < >. AHRQ PSO Information Form Technical Specifications - December

8 2.4 Validation of PSO Information and Provider Information XML Files The PPC shall perform comprehensive validation for every PSO information or provider information XML file submitted to the PPC. The validation includes: 1. Validation to ensure the XML file meets the minimum XML file specifications outlined in this specification. 2. Validation of the business rules outlined in the AHRQ PSO Information and Provider Information Technical Specifications for Data Submission from PSO to PSOPPC: Appendix A. Error messages generated as part of the file processing and the file processing status (Accepted or Rejected) after file processing shall be made available to the submitting organization through submission reports available from the secure pages of the PPC Web site. Access to the secure pages of the PPC Web site requires a PPC Web site user account. When processing for each file upload is complete, the submitter shall be notified by . The notification shall contain the status of the processed files and notify the user that any associated error messages are now available in the submission reports. Submitters should review their submission reports to identify the processing status of the files they have submitted and to view any associated error messages. If a file is rejected, the submitter should review the error messages, fix any errors in their files, and resubmit the file to the PPC. Note: all questions in the PSO Information Form are required to be completed. AHRQ PSO Information Form Technical Specifications - December

9 Section Three- PSO Information and Provider Information XML File Structure 3.1 Overview of PSO Information and Provider Information XML File Structure The XML file structure for the PSO and provider information XML file allows the user to submit PSO information as well as provider information in a single XML file. A user can include information for multiple providers for a single PSO through one XML file. The XML file structure allows for submission of only PSO information or for submission of only the provider information for one or more providers for a PSO (without the PSO information). Figure 1 contains the complete structure for the XML elements along with their child elements and attributes. AHRQ PSO Information Form Technical Specifications - December

10 Figure 1: PSO Information and Provider Information XML File Structure Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

11 Table 1 provides a listing of the XML elements and attributes for the PSO and provider information XML file. Each element and its corresponding attribute(s) are defined. Table 1: PSO and Provider Information Elements and Attributes Type Element Attribute Attribute Element Attribute Element Element Element/ Attribute Name psoinformation psoid year providerinformation providerid detail detail Element question detail Parent Element/ Attribute For n/a (root element) psoinformation psoinformation psoinformation providerinformation This element, if included, may be repeated once for each provider included in the XML file. The attribute used to specify the Provider ID assigned by the PSO for the provider information being included in the XML file. The value shall be the 16- character or less alphanumeric PSO- Assigned Provider ID Code. The container element used for holding the PSO information questions and answers. This element, if included, shall only be included once per XML file. The container element used for holding the provider information questions and answers. psoinformation providerinformation Description Occurrence Data Type The root element for the PSO Information XML file. The attribute used to specify the PSO ID for which the PSO and/or provider information is included. The PSO ID shall be 5-characters in length and in the following format: P#### The attribute used to specify the reporting year for which the PSO or provider information is included. The container element used for holding provider information. This element, if included, may be repeated for each provider included in the XML file. The element used for holding the PSO or provider information questions and answers. Required/ Optional 1 n/a Required 1 Character Required 1 Numeric Required 0 or more n/a Optional 1 Character Required 0 or 1 n/a Optional 0 or more n/a Optional 1 or more Character Required AHRQ PSO Information Form Technical Specifications - December

12 Type Element/ Attribute Name Parent Element/ Attribute For Attribute code question Element answer question Attribute value answer Attribute code answer Attribute text answer Description Occurrence Data Type The attribute used for specifying the PSO or provider question code. Each question code represents a question on the PSO Information Form. See Appendix A for a list of PSO Information Form question codes. The element used for holding the PSO or provider information answer response. The attribute used for specifying the PSO or provider information answer value when a free text answer (numeric or literal value) is required as the answer response. Either the answer value attribute or the code attribute are required for the answer element. See Appendix A for the maximum length values for free text answer responses. The attribute used for specifying the PSO or provider information answer value when a coded answer is required as the answer response. Either the answer value attribute or the code attribute are required for the answer element. See Appendix A for a listing of answer codes for each PSO Information Form question. The element used for holding the Other, please specify text associated with an answer code. Maximum length is 250 characters for Other, please specify text. See Appendix A for a list of answer codes where Other, please specify text is allowed. Required/ Optional 1 Character Required 1 or more Character Required 1 Character Optional 1 Character Optional 1 Character Optional AHRQ PSO Information Form Technical Specifications - December

13 3.2 pso-information Element The pso-information element is the root element for the PSO and provider information XML document. The pso-information element has a required XML attribute of psoinformation/@psoid, which identifies the PSO for which the detail is provided. The value given for the pso-information/@psoid attribute shall be the PSO identifier assigned by AHRQ to the PSO upon official PSO listing. The pso-information/@year attribute is also required and indicates the reporting year for which the PSO or provider information is intended. The value for year shall have a numeric value, 4-digits in length, and must be the current year. Information for past or future years will not be accepted. Note: Per XML convention, the root element of the XML file (pso-information element) should contain the following attribute and value: xmlns:xsi=" The pso-information element has the following two child elements: detail element provider-information element The diagram below shows the pso-information element with each of its attributes and child elements. Figure 2: pso-information Elements and Attributes Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

14 3.3 provider-information Element The provider-information element is a child of the pso-information element. The psoinformation/provider-information is a container element for holding the provider information for a single provider. It is an optional element and may be excluded from the file if no provider information is being submitted in the file. If information for more than one provider is to be included in the file, the psoinformation/provider-information element shall be repeated once for each provider to be included in the XML file. The provider-information element has a required XML attribute of providerinformation/@providerid, which identifies the provider for which the information is provided. The value given for provider-information/@providerid shall be the 16-character or less alphanumeric PSO-Assigned Provider ID Code. The provider-information element has the following child element: detail element The diagram below shows the provider-information element with each of its attributes and child elements. Figure 3: provider-information Element Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

15 3.4 detail Element The detail element is common to both PSO and provider information. The detail element is a child of the pso-information element when being used to submit PSO information and is a child of the provider-information element when being used to submit provider information. The detail element, as a child of the pso-information element, is the container element used for holding the PSO information questions and answers. The detail element shall only be included in the XML file as a child of the pso-information element if PSO information is being submitted. It may be omitted if PSO information is not being included in the XML file. The detail element, as a child of the pso-information element, shall only be included once per XML file to submit information for a single PSO. The detail element, as a child of the provider-information element, is the container element used for holding the provider information questions and answers. The detail element is a required child of the provider-information element. To submit information for multiple providers, the parent element, pso-information/provider-information, shall be repeated once for each provider to be included in the XML file (refer to section 3.3, provider-information Element, for more information on how information for multiple providers may be included in the XML file). The detail element has the following child element: question element The diagram below shows the detail element with each of its attributes and child elements. Figure 4: detail Element Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

16 3.5 question Element The question element is a child of the detail element. The question element is used to hold a question/answer set for each question on the PSO Information Form. The question element shall be repeated for each question on the PSO Information Form. Depending on the information type (PSO or provider), the specific number of question elements inside the detail element will vary. Refer to Appendix A of this specification for the list of required questions for the PSO Information Form. All questions are required unless indicated in Appendix A of this specification. The question element has a required XML attribute of question/@code. The list of allowable values for the code attribute can be found in Appendix A of this specification. The question element has the following child element: answer element The diagram below shows the question element with each of its attributes and child elements. Figure 5: quesiton Element Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

17 3.6 answer and text Elements The answer element is a child of the question element. The answer element is used for holding the PSO or provider information answer response. Each question element is required to have at least one answer element. The answer element may be repeated, if the PSO or provider information question allows for more than one answer value to be submitted. Each answer element is required to have one of two attributes: answer/@value or answer/@code. For questions which require numeric or literal answers (example: item Prov06, which is Number of Licensed Beds ) the value attribute is required to indicate the value as the answer response. For questions which require answer codes (example: item Prov03, which is Provider Type ), the code attribute is required to indicate the code value as the answer response. The answer element has the following child element: text element Some answer responses allow for text to be provided for an Other, please specify answer value. The answer/text element is provided to specify this text for the answer response. The answer/text element is an optional element. Including the Other, please specify in the XML file is optional. Refer to Appendix A of this specification for a list of answer responses that allow for an Other, please specify response. Figure 6: answer and text Elements Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

18 Section Four- Sample PSO Information and Provider Information XML Files The sample XML files provided in this section follow the XML file creation guidelines outlined in this specification for the submission of PSO and provider information. Portions of the XML content may have been omitted from the examples for brevity, marked by an ellipsis ( ). Figure 7: PSO Information XML Sample Figure 7 provides an example XML file that includes PSO information only. This example provides an answer to a question where Other, please specify text is allowed, which is referenced in question code PSO10 below. This example also provides a question where multiple answer codes for a single question are allowed, which is referenced in question code PSO08 below. Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

19 Figure 8: Provider Information XML Sample Figure 8 provides an example XML file that includes information for a single provider. Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

20 Figure 9: PSO Information and Provider Information XML Sample Figure 9 provides an example XML file that includes information for both a PSO and a Provider. This example provides information for a single PSO and information for one provider within a single XML file. Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at support@psoppc.org. Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December

21 Figure 10: PSO Information and Information for Multiple Providers XML Sample Figure 10 provides an example XML file that includes information for both a PSO and multiple providers. This example provides information for a single PSO and two providers within a single XML file. AHRQ PSO Information Form Technical Specifications - December

22 Users requiring additional assistance in viewing examples may contact the PSOPPC Help Desk at or at Hours of operation are 9 a.m. to 5:30 p.m. EST. AHRQ PSO Information Form Technical Specifications - December