Appendix G - LMS/EMS Interface

Appendix G - LMS/EMS Interface

Commonwealth of PA-Department of Health / Bureau of Informatics & Information Technology

Appendix G - LMS/EMS Interface

Requirements Document

Prepared by: / Brandon Shaw
Project #:
Submitted to: / Bob Chilcote
Date submitted / 4/29/2016
Document version: / V1.0

Document History

Version / Date / Author / Status / Revision Descriptions
0.1 / 12/3/15 / Brandon Shaw / Initial Draft
0.2 / 12/22/15 / Brandon Shaw / Second Draft / Added User Check web service information.
1.0 / 4/29/16 / Brandon Shaw / Published / Added clarifications, removed unused sections.

Approvals

Your signature below indicates that this document meets its objectives and is acceptable.

Signature / Signature
Name / Name
Title / Title
Date / Date
Signature / Signature
Name / Name
Title / Title
Date / Date

Table of Contents

Purpose of the Document

Acronyms

Executive Summary

Introduction

1.1Project Overview

Business Model

1.1.1Organizational Profile

1.1.2High Level ‘As-Is’ Process Flow

1.1.3High Level ‘To-Be’ Process Flow

Requirements Definition

1.2Overview

1.2.1Approach

1.3Detailed Requirements

1.3.1Business Requirements

1.3.2Input & Output Requirements

1.3.3Internal & External Requirements

Appendix G - LMS/EMS Interface / Page 1 of 18 / Requirements Document
Commonwealth of PA-Department of Health / Bureau of Informatics & Information Technology

Purpose of the Document

The purpose of this Requirements Document is to provide technical specifications for a Learning Management System to interface with the Pennsylvania Department of Health, Bureau of Emergency Management applications.

Acronyms

Table: Acronyms Used in This Document

Acronym / Definition
LMS / Learning Management System
EMS / Emergency Medical Service(s)
PA / Pennsylvania
DOH / Department of Health
BEMS / Bureau of Emergency Medical Services
BIIT / Bureau of Informatics and Information Technology
ConEd / Continuing Education

Executive Summary

The LMS/EMS interface will facilitate data exchange, providing the Department with up-to-date information on the required Continuing Education courses that Emergency Medical Service personnel must take in order to maintain active certification. This interface and exchange of information is a critical component of the Department’s ability to track and certify Emergency Medical Service personnel as well as providing the EMS community a valuable resource that reduces administrative overhead. This interface and information exchange must be built, tested, and operational by July 1, 2016, or within 45 calendar days of the date of the purchase order, whichever is later.

Introduction

1.1 Project Overview

The LMS/EMS Interface is a part of the overall DOH LMS effort. This document is specifically to define the LMS/EMS interface and what the EMS interface requires of an LMS system.

Business Model

The current LMS provider interfaces with the EMS system via DOH-developed ASMX web services. Any information provided to the EMS system is in XML format. This model works well as-is.

1.1.1 Organizational Profile

The LMS/EMS interface will impact BIIT applications development staff who will have to work with the new LMS provider to ensure the systems communicate correctly. BEMS staff will be impacted only if the interface does not work as it does now, and the impact will be the loss of an automated process resulting in more administrative overhead (e.g. hand entering data into the BEMS ConEd system, coordinating with EMS regional councils and organizations to have their personnel record data in the BEMS ConEd system).

1.1.2 High Level ‘As-Is’ Process Flow

The ‘As-Is’ process operates as follows:

  1. User registers with LMS system.
  2. LMS system checks with EMS User Check web service to determine if the person is a registered PA practitioner currently in good standing as determined in the DOH EMS system. If the practitioner is in good standing and registered, the EMS User Check web service returns ‘Yes’ otherwise ‘No’ is returned.
  3. If the PA practitioner is in good standing and registered, they will be allowed to complete account registration. The practitioner’s LMS account shall be marked as an EMS record from which information must be provided to DOH BEMS via DOH EMS Registry Web Service.
  4. If the PA practitioner is not in good standing or registered, they will not be allowed to complete account registration and shall be directed to contact DOH BEMS.
  5. For PA practitioners in good standing, the LMS system gathers relevant information on student, class, course as defined below and passes data in XML format to DOH EMS Registry Web Service without additional calls to the EMS User Check web service.
  6. Any historical data (defined as data existing prior to contract award) in the LMS system for Pennsylvania users should be retained in the LMS system but not sent to the DOH EMS Registry Web Service.
  7. In instances of a practitioner regaining good standing as determined in the DOH EMS system and attempting to register or continue registration in the LMS system, the LMS system shall follow the steps starting at Step 1 as defined in this section (1.1.2).
  8. Any ConEd data recorded for a practitioner from the date of contract award forward shall be provided to DOH EMS via DOH EMS Registry Web Service regardless of standing in DOH EMS system. Standing determined as described above.

1.1.3 High Level ‘To-Be’ Process Flow

The ‘To-Be’ flow shall be similar to the ‘As-Is’ flow, so that the same DOH EMS Web Service is used to receive ConEd information for EMS personnel.

Appendix G - LMS/EMS Interface / Page 1 of 18 / Requirements Document
Commonwealth of PA-Department of Health / Bureau of Informatics and Information Technology

Requirements Definition

1.2 Overview

1.2.1 Approach

Requirements determined based on existing applications.

1.3 Detailed Requirements

1.3.1 Business Requirements

Business requirements are usually provided by the program area during the requirements gathering process. It is helpful to include the business goal linked to the requirement in order to provide the “why” of the requirement. For example, will this requirement fulfill a legislative mandate, the organization’s financial goal, or productivity goal?

ID / Priority / Requirements Statement / Source
BR01 / Critical / LMS system shall pass EMS personnel training information to the DOH EMS systems / BIIT, BEMS
BR02 / High / LMS system shall check with the DOH EMS systems to determine if a registered PA provider is in good standing. / BIIT, BEMS
BR03 / High / The LMS system shall provide the ability for DOH BEMS personnel to disable a practitioner user account. When a practitioner user account is disabled, the LMS shall not transfer data from that practitioner account to the DOH EMS Registry Web Service. / BIIT, BEMS

1.3.2 Input & Output Requirements

This section describes all manual and automated input requirements for the software product (e.g., data entry from source documents or other applications). The source of the input and output requirements are identified and shall be as follows:

a) Reports: define the report(s) to be produced as indicated by the processing requirement. It includes a description of the function of the report(s), and the frequency, distribution, sequence of the report(s), as well as the list of data elements which are to appear on the report. Examples of the report(s) are to be included, if they are available.

b) Forms: This subsection defines the form(s) to be produced as indicated by the processing requirement. It includes a description of the function of the form(s) and the frequency, distribution, sequence of the form(s), as well as the list of data elements to appear on the form. Examples of the form(s) are to be included, if they are available.

c) Screens: This subsection defines the screen(s) to be developed. It includes a description of the function of the screen(s), pass-off rules, security requirements, and the list of data elements to appear on the screen. Examples of the screen(s) are to be included, if they are available

d) Files: This subsection defines the file(s) to be created by the processing requirement. It includes the file format required, data elements to be included, and the name of the system(s) that will be receiving the file. Identify the data elements and logical data groupings that will be created accessed, stored and processed by the software product. Identifying and grouping data begins during the Requirements Definition Stage and is expanded in subsequent stages, as more information becomes known. Data requirements may include the need for data purification, either as a conversion effort or as an ongoing activity, and additional issues such as data archival and purging.

e) Data Elements: This subsection identifies and describes in general terms each of the data elements within the scope of the new system. Initially, the data elements identified are those contained on the outputs, plus additional data elements required to support automated functions of the system. As the system project progresses into subsequent levels of detail, this list is refined and expanded as additional data elements are defined. The emphasis is on the characteristics of data elements rather than specific formats.

f) Data Structure: This subsection establishes a preliminary organization of the defined data elements into logical records and the relationships between these logical records. The data are organized in a way that facilitates the processing of inputs to generate outputs and satisfy other computational requirements. Generally, this is best accomplished by defining data structure that models the way in which data naturally occurs in the environment. As a part of this task, the project team organizes required data elements into logical records or schemas and develops an initial specification for these data element groups and group relationship. A data structure chart is then prepared to illustrate the logical relationships among the records defined above. Connecting lines may be used to indicate that one record can be logically accessed from another. In addition, a key is identified for each record that may be directly accessed. The objective of this task is to define a logical set of records and record relationships that satisfy the user-based requirements of the new system.

g) Files: This subsection defines the input and output file(s) required for the processing requirements. It includes a description of the function of the file, file layouts, and the list of data elements to be included.

ID / Priority / Requirements Statement / Acceptance Criteria / Source / BR ID
IO01 / High / The LMS system shall provide information to the DOH EMS Registry Web Service, ProcessConed method.
The Web Service is available at:
/ LMS system can access DOH EMS Registry Web Service / BIIT / BR01
IO02 / High / The LMS system shall be provided a secure GUID to be used to access the DOH EMS Registry Web Service. / LMS provider is provided a secure GUID, DOH EMS Registry Web Service configured to allow access to submit data based on provided GUID / BIIT / BR01
IO03 / High / The LMS system shall provide data in XML format to the strXML parameter of the ProcessConed method of the DOH EMS Registry Web Service. Each call to the DOH EMS Registry web service shall transmit information about one individual taking one class.
The XML shall be formatted as follows:
<CONEDRAW>
<TABLE>
<HEADER</HEADER>
<DOB</DOB>
<VALID</VALID>
<OLDCERT</OLDCERT>
<LEVEL1</LEVEL1>
<REGION>07</REGION>
<COURSE</COURSE>
<CLASS</CLASS>
<HOURS</HOURS>
<DATEFINAL</DATEFINAL>
<SSN</SSN>
<REMED />
<COUNTY</COUNTY>
<LASTNAME</LASTNAME>
<FIRSTNAME</FIRSTNAME>
<MI</MI>
<SUFFIX</SUFFIX>
<SPONSORID</SPONSORID>
<SPONNAME</SPONNAME>
<TEMP</TEMP>
<ERRORS</ERRORS>
<MESSAGE1</MESSAGE1>
<MESSAGE2</MESSAGE2>
<MESSAGE3</MESSAGE3>
<SEND />
</TABLE>
<Constraint>
<Securitystring</Securitystring>
</Constraint>
</CONEDRAW>
The XML schema can be provided as needed.
Field Definitions:
Field Name / Description / Is Required?
HEADER / LMS provider record identity / Y
DOB / Date of Birth of the individual receiving the training. / Y
VALID / Indicates a valid record / Y
OLDCERT / PA EMS certification number / Y
LEVEL1 / EMS Certification Level/Type / Y
REGION / EMS Region the practitioner lives in / Y
COURSE / Training course number / Y
CLASS / Training class number / Y
HOURS / Number of hours the class counts towards certification/re-certification / Y
DATEFINAL / Date class was completed. / Y
SSN / Social Security Number of the individual receiving the training / N
REMED / N/A / N
COUNTY / Primary county the individual receiving training resides in / Y
LASTNAME / Last name of individual receiving training / Y
FIRSTNAME / First name of individual receiving training / Y
MI / Middle Initial of individual receiving training / N
SUFFIX / Suffix of individual receiving training / N
SPONSORID / ID of sponsoring EMS provider / Y
SPONSORNAME / Name of sponsoring EMS provider / Y
TEMP / N/A / N
ERRORS / N/A / N
MESSAGE1 / N/A / N
MESSAGE2 / N/A / N
MESSAGE3 / N/A / N
SEND / N/A / N
Securitystring / GUID, see IO02 / Y
/ LMS provider submits data to the DOH EMS Registry Web Service provided in IO01 in the format specified. / BIIT / BR01
IO04 / High / The LMS system shall check with the DOH EMS User Check web service to determine if the practitioner is:
  1. Registered with the PA DOH EMS system.
  2. Is in good standing in the PA DOH EMS system.
The LMS system shall use the CheckUser method of the DOH EMS User Check web service. The DOH EMS User Check web service can be accessed at the following URL:
/ LMS system can access DOH EMS web service. / BIIT, BEMS / BR02
IO05 / High / The LMS system shall be provided a secure GUID to be used to access the DOH EMS User Check Web Service. / LMS provider is provided a secure GUID, DOH EMS User Check Web Service configured to allow access to query data based on provided GUID / BIIT / BR01
IO06 / High / The LMS system shall use the CheckUser method of the DOH EMS User Check web service. The CheckUser method takes the following parameters:
Parameter Name / Description / Is Required?
strSecurityGuid / GUID provided by DOH BIIT, referenced in IO05 / Y
intCheckType / Valid value is either 1 or 2. Use 1 for an initial check, 2 for any follow up checks. / Y
strCertNumber / PA EMS certification number / Y
strLevel / EMS Certification Level/Type / Y
strRegion / EMS Region the practitioner lives in / Y
strDOB / Date of Birth of the practitioner / Y
strCounty / Primary county the individual receiving training resides in / Y
The CheckUser method returns a ‘Yes’ if the provider is both registered with PA and in good standing. Otherwise, a ‘No’ is returned. / LMS provider is able to submit data as specified to the CheckUser method, and appropriately determine LMS workflow based on returned value.

1.3.3 Internal & External Requirements

This section discusses the environmental requirements and how they are determined. It includes both internal and external interface requirements, operating constraints, policy change, and control requirements and shall be provided as follows:

ID / Priority / Requirements Statement / Acceptance Criteria / Source / BR ID
IE01 / High / The LMS system shall use the existing DOH EMS Web Services ‘As-Is’. / The LMS provider modifies their system to consume and provide data to the existing DOH EMS Web Services without DOH needing to make modifications to existing applications. / BIIT / BR01, BR02
LMS/EMS Interface / Page 1 of 18 / Requirements Document
Commonwealth of PA-Department of Health / <enter sponsor dept or bureau name>
<enter project code & name> / Page 1 of 18 / Requirements Document