; Requirements Template - Download as DOC
Documents
Resources
Learning Center
Upload
Plans & pricing Sign in
Sign Out
Your Federal Quarterly Tax Payments are due April 15th Get Help Now >>

Requirements Template - Download as DOC

VIEWS: 59 PAGES: 8

  • pg 1
									ABP ACTIVITY REPORT WEB SERVICE REQUIREMENTS
       FOR THIRD PARTY ORGANIZATIONS




             DOCUMENT REVISION: 1.1
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                               Page 2 of 8



                          ABP Activity Report Web Service Requirements
                                 For Third Party Organizations
1.      SCOPE
        This document establishes the American Board of Pediatrics’ (ABP) Web Service
        requirements for third party organizations which will transmit Notice of Start and/or
        Notice of Completion documents electronically to the ABP when our diplomates start
        and/or complete the third party’s products or programs. In addition, it will introduce the
        requirements for those third party organizations who require diplomate data sent from the
        ABP in order for the diplomate to access the product or program.

2.      OVERVIEW AND OBJECTIVE
        The ABP approves products or programs created by third party organizations that will be
        used by our diplomates to satisfy their Maintenance of Certification (MOC) requirements.
        This approval process requires that the third party provider provide completion data when
        the diplomate successfully completes the approved completion requirements for this
        product or program. In addition, the approval agreement can include two additional
        requirements. One requirement can be diplomate data that will be transferred from the
        ABP to the third party organization’s product or program web site in order for the
        diplomate to access this web site. The other requirement can be a transfer of data from
        the third party organization to the ABP to inform the ABP that the diplomate has begun
        the product or program.

        This document also outlines the technical requirements to provide a secured method of
        transmitting this data through the Internet, the transferred data requirements, and
        implementation requirements.

        Please contact Skip Bartolanzo at (919) 929-0461 or ljb@abpeds.org during normal
        business hours to coordinate a meeting with your technical and business representatives
        to discuss these steps in detail.

3.      TECHNICAL REQUIREMENTS
        Secured communications is a high priority at the ABP. The following steps outline the
        requirements for secured communications. Actual implementation could vary depending
        upon your environment.
             1. The ABP will install and configure two secured HTTP servers and two
                WebSphere application servers, one set for the test environment and one set for
                the production environment. The production HTTP server is dedicated to
                exchanging data with only ABP’s production server.
             2. The ABP will create and issue two self-signed certificates (ABP’s public keys) to
                you, one for each of the environments mentioned above. These certificates should
                be imported and installed into the trust stores on the respective server.


4/21/2010 5:34 AM                           Page 2 of 8                               Requirements
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                                  Page 3 of 8


              3. The ABP will create and filter services on its firewalls to only allow traffic from
                 your specific IP addresses and/or ports. You will be required to supply your
                 specific IP address and/or ports to the ABP and to keep the ABP updated about
                 any changes.
              4. Webservice client requests will be authenticated using Basic HTTP
                 Authentication. A username and password will be needed to access the webservice
                 which will be provided by ABP.


4.      TRANSFERRED DATA
        Your approved product or program should outline the data transfer requirements with the
        ABP. In some cases, an initial handoff of data from the ABP web site to your product’s
        or program’s web site may be required to uniquely identify our diplomate in your system.
        Also in some cases, a notification that our diplomate has successfully begun your product
        or program may be required. Finally, all products and programs are required to provide
        the ABP a notification that our diplomate has completed your product or program in
        order for him/her to receive MOC credit. As part of the notice that our diplomate has
        either started or completed your product or program, member matching data must be sent
        along with these notifications. Examples of each of these transferred data requirements
        are outlined below.

        4.1      TRANSFERRING FROM THE ABP’S WEB SITE TO YOUR PRODUCT’S OR
                 PROGRAM’S WEB SITE.
                 In some cases, it is necessary to transfer data to your product or program which
                 will uniquely identify the diplomate as an ABP diplomate. Briefly, the following
                 steps will occur:
                1. Your organization will set up a port that will be used by only the ABP to issue a
                    HTTPS post request for the secured HTTPS session. The certificate used to
                    secure this port must have been signed by a trusted certificate authority.
                2. The ABP will authenticate the diplomates through the login process on ABP’s
                    Web Site.
                3. The diplomate will select your product or program from a list of approved
                    products and programs valid during this selection process. This list will appear
                    on a page hosted by the ABP.
                4. Upon selection of your product or program, the diplomate’s data will be posted
                    via a secure HTTP POST request to your product’s or program’s web site.
                5. Your product or program should then appear in a new browser window with
                    full browser functions. If the user has previously completed a part of your
                    product or program, they should either be taken to the previous point of
                    completion or provided with a way to easily navigate to it.

                The following user information will be passed via the HTTP post so that it will not
                appear on the URL:

                          FIELD                               VALUE
4/21/2010 5:34 AM                              Page 3 of 8                                Requirements
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                                   Page 4 of 8


                          ABP ID                              ABP ID of the Diplomate
                          First Name                          First Name of the Diplomate
                          Last name                           Last Name of the Diplomate
                          Designation                         Diplomate’s Degree
                          E-mail Address                      Diplomate’s E-mail Address

                 There will be times when your product’s or program’s web site will be
                 unavailable. In these cases, we will inform the diplomate that your product or
                 program is unavailable at this time and to try again later. In order to minimize
                 this occurrence, please make sure that any scheduled outage is clearly displayed
                 on your product’s or program’s web site.

                 There will be cases where the diplomate would like to have more information
                 concerning your product or program. In these cases, you will need to provide the
                 ABP with the URL of a demo or web page containing information about your
                 product or program. The ABP will create a link to this URL from our web pages.

        4.2      MEMBER MATCHING USING MEDBIQUITOUS SCHEMA
                 Member matching data must be sent to the ABP’s web service, prior to sending
                 the notice of start or completion or along with the notification, in order to have a
                 high confidence level that data being sent identifies the same person on both
                 systems.

                 The following data fields and corresponding point values will be used for scoring
                 the member matching.

                           FIELD TYPE                        POINT VALUE
                           ABP ID                            1 point
                           Date of Birth                     0.5 point
                           Last Name                         0.5 point
                           First Name                        0.1 point
                           Other Names (Middle,              0.1 point
                           Maiden, etc)

                 The MedBiquitous Member schema will be used to define the xml format of the
                 data being sent. The MedBiquitous MemberService web service definition will
                 be used to define the xml format of the service requests being sent.

                 The ABP ID field is required and must match a record in the ABP database. After
                 a match is found for the ABP ID, the remaining fields supplied by you will be
                 compared and scored against the ABP data using the point values specified above.
                 A score of 1.6 or above is considered a match and a successful response will be
                 sent to you. Once you receive the successful response, the activity report can be
4/21/2010 5:34 AM                              Page 4 of 8                                Requirements
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                                  Page 5 of 8


                 sent by you to report a notice of start or completion of an activity, using the
                 MedBiquitous ActivityReportService and Activity Report schema. Otherwise,
                 this transaction should be handled by your internal error processing procedures or
                 by the contingency plan process outlined in section 6.4.

                 See the references in section 8 for information regarding the MedBiquitous
                 schemas.



        4.3      NOTICE OF START DATA
                 In case of PIM, Notice of Start data can be sent by your organization to notify the
                 ABP that the diplomate has actually begun the product or program. Once the
                 diplomate has started your product or program, your organization must transfer
                 the Member matching data described in section 4.2 via the secured web service
                 described in section 3. If a secure match is determined, then the following data
                 will be sent to the ABP via the secured web service described in section 3:

                          FIELD                             VALUE
                          ABP ID                            ABP ID of the Diplomate
                          First Name                        First Name of the Diplomate
                          Family Name                       Last Name of the Diplomate
                          Title                             Diplomate’s Degree
                          E-mail Address                    Diplomate’s E-mail Address
                          Activity Name                     Name of Activity
                          Module ID                         Your Product’s or Program’s ID
                          Module Name                       Your Product’s or Program’s Title
                          Diplomate’s Start Date            Date which the Diplomate Began Your
                                                            Product or Program
                          Diplomate’s                       Null
                          Completion Date
                          Provider Organization             Organization providing the product
                          Name
                          Reporting Organization            Organization reporting this notice
                          Name

                 The MedBiquitous Activity Report schema will be used to define the xml format
                 of the data being sent. The MedBiquitous ActivityReportService web service
                 definition will be used to define the xml format of the service requests being sent.

                 If at any time the web service process generates or encounters an error, both the
                 ABP and your organization must have error handling logic programmed to ensure
                 that the transaction is not lost. Preferably, it should be resent when the web
                 service issue has been resolved; however, the contingency plan should be used if
4/21/2010 5:34 AM                             Page 5 of 8                                Requirements
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                                  Page 6 of 8


                 the issue will take more than a business day to resolve. Please refer to the
                 contingency plan process in section 6.4.

        4.4      NOTICE OF COMPLETION TRANSACTION
                 The Notice of Completion data must be sent by your organization when our
                 diplomate has completed your product or program as outlined in the approved
                 agreement. Your organization will transfer the Member Matching data, described
                 in section 4.2, via the secured web service described in section 3. If a secure
                 match is determined, then the following data will be sent to the ABP via the
                 secured web service described in section 3:

                          FIELD                             VALUE
                          ABP ID                            ABP ID of the Diplomate
                          First Name                        First Name of the Diplomate
                          Family Name                       Last Name of the Diplomate
                          Title                             Diplomate’s Degree
                          E-mail Address                    Diplomate’s E-mail Address
                          Activity Name                     Name of Activity
                          Module ID                         Your Product’s or Program’s ID
                          Module Name                       Your Product’s or Program’s Title
                          Diplomate’s Start Date            Date which the Diplomate Began Your
                                                            Product or Program
                          Diplomate’s                       Date which the Diplomate Completed
                          Completion Date                   Your Product or Program
                          Provider Organization             Organization providing the product
                          Name
                          Reporting Organization            Organization reporting this notice
                          Name

                 The MedBiquitous Activity Report schema will be used to define the xml format
                 of the data being sent. The MedBiquitous ActivityReportService web service
                 definition will be used to define the xml format of the service requests being sent.

                 If at any time the web service process generates or encounters an error, both the
                 ABP and your organization must have error handling logic programmed to ensure
                 that the transaction is not lost. Preferably, it should be resent when the web
                 service issue has been resolved; however, the contingency plan should be used if
                 the issue will take more than a business day to resolve. Please refer to the
                 contingency plan process in section 6.4.


5.      TEST REQUIREMENTS



4/21/2010 5:34 AM                             Page 6 of 8                                Requirements
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                                 Page 7 of 8


        Each business/technical requirement stated in this document will be tested. It should be
        recognized that one testable statement in these requirements often results in several test
        procedures in the test plan.


6.      IMPLEMENTATION
        6.1.     AVAILABILITY
                 Every effort will be made to keep the ABP Activity Report web service available
                 around the clock with the exception of a period between 3am and 5am EST daily
                 during which the web service will be down for maintenance. Please refer to the
                 Contingency Plan in section 6.4 in the event that a transaction could not be
                 transmitted or processed due to an outage during the maintenance window or an
                 unexpected occurrence.
                 Availability information for your product must be supplied to the ABP on an
                 ongoing basis in order for the ABP to inform its diplomates of planned outages.


        6.2.     PRODUCTION SUPPORT
                 Each party must supply two points of contact for ongoing support.
                 One contact should be someone within the IT organization who is responsible for
                 the availability of the web site and the web service.
                             For the ABP, please call Allen Gubert at (919) 929-0461 during normal
                              business hours.
                 The second contact should be someone within the organization who is responsible
                 to resolve diplomate data issues with your product or program.
                             For the ABP, please call the MOC Administrative department at (919)
                              929-0461 during normal business hours.

        6.3.     SECURITY BREACH NOTIFICATION
                 In the event of a security breach, either external or internal, your organization
                 must immediately inform the ABP about the breach by calling Allen Gubert at
                 (919) 606-0818 AND Todd Hawkins at (919) 606-2194. Your organization will
                 provide, at a minimum, the date and time of the breach, type of breach, data
                 affected, diplomates affected, notification plan and correction plan. Once the
                 ABP is notified of a security breach, your transactions will no longer be trusted
                 and will no longer be received or processed by the ABP.
                 During this outage, the contingency plan outlined in section 6.4 will be used to
                 communicate our diplomate’s completion in your product or program. After your
                 organization has resolved the security breach, contact the ABP in order to
                 reinitiate the web service.
        6.4.     CONTINGENCY PLAN
4/21/2010 5:34 AM                              Page 7 of 8                               Requirements
The American Board of Pediatrics, Inc.
ACTIVITY REPORT WEB SERVICE REQUIREMENTS                                                Page 8 of 8


                 In the event of any situation where start or completion data cannot be transmitted
                 through the WebService, the following contingency plan will be followed:
                 1.    Please call Linda Seals at (919) 929-0461 during normal business hours to
                      inform her that your product’s or program’s WebService is unavailable and the
                      anticipated length of interruption.
                 2. Email Linda Seals at LSeals@abpeds.org an Excel spreadsheet containing the
                    data that would have been transferred through the web service.


7.      GLOSSARY OF TERMS
         ABP - American Board of Pediatrics. See www.abp.org for more information.

          Diplomate - ABP approved user.

          MedBiquitous – Standards body that creates technology standards to enable
          collaboration for healthcare education. See www.medbiq.org for more information.

          MOC - Maintenance of Certification.




8.      REFERENCES
        MedBiquitous Activity Report Specifications and Description Document which
        contains the Activity Report schema may be found at:
        http://medbiq.org/working_groups/activity_report/ActivityReportSpecification.pdf


        MedBiquitous Healthcare Professional Profile Specifications Document which
        contains the Member schema may be found at:
        http://www.medbiq.org/working_groups/professional_profile/ProfessionalProfileSpecific
        ations.pdf


        WSDL and Schema Files used to build the Activity Report web service are available
        upon request.




4/21/2010 5:34 AM                             Page 8 of 8                               Requirements

								
To top