This chapter provides an overview of the British Columbia (B.C.) Workers' Compensation Board's (WCB) web service and discusses how to send and receive injury and incident data.
The British Columbia (B.C.) Workers' Compensation Board (WCB), also known as WorkSafeBC, uses the Interchange Specification Standard Version 3 (ISSv3) web service to submit and receive data from the WCB Accident Registration System. The ISSv3 web service is an Extensible Markup Language (XML) application that permits data transfer between employers using PeopleSoft Human Resources applications and the WCB's Accident Registration System. By creating an XML document in the form of a Simple Object Access Protocol (SOAP) message, an employer can send accident information to the web service across the Internet, and receive a response, also in the form of an XML document. Upon receiving an XML document, the web services interface validates the data against business rules and transforms the XML data into a format understood by the WCB Accident Registration System. The system rejects XML documents that do not pass the validation and does not save the submitted data in the WCB Accident Registration System.
The following diagram illustrates the WorkSafeBC web service process:
WorkSafeBC Web Service process
Warning! We have associated a series of data-entry checks and warning messages with key fields to remind you about key information that you must complete to meet British Columbia WCB reporting requirements. You activate these data-entry checks and warnings during data entry by applying the regulatory region and setID CANBC to an incident. If you do not use the proper regulatory region and setID, you could produce an XML message that is formatted correctly but is rejected by the WCB due to missing or invalid information.
Before you can use the new WorkSafeBC Web Service functionality, you must:
Confirm your PeopleTools release.
Identify a static Internet protocol (IP) address from which your system calls WorkSafeBC's web services. This is required to connect to WCB's Accident Registration System
Register with WorkSafeBC Web Services.
Set Up Integration Broker.
Enter a phone number for your location.
Change the ISSv3 web service URL.
Confirming your PeopleTools Release
You must be running PeopleTools 8.48 or later to use the WorkSafeBC Web Service functionality.
Identifying a Static Internet Protocol (IP) Address
To protect the integrity of the ISSv3 Web Service, WorkSafeBC uses several firewalls, each of which requires authentication before permitting messages to pass. Therefore, before an employer requests access to the ISSv3 Web Service, it must register with WorkSafeBC one or more static IP addresses from which its system calls the Web Services.
Registering with WorkSafeBC Web Services
Before you begin implementing and testing your web service functionality, you must register with WorkSafeBC. Registration enables you to:
Use WorkSafeBC's business-to-business services.
Use the web service feature in PeopleSoft Human Resources to electronically submit the Employer's Report of Injury (Form 7).
Complete WorkSafeBC's web service testing requirements before being permitted access to the production environment (optional). Optional testing may include a connectivity test and/or a data test.
To obtain instructions on web service registration, visit the WorkSafe BC website.
See http://www.worksafebc.com/online_services/web_services/default.asp
Setting Up Integration Broker
The WorkSafeBC Web Service enhancement uses PeopleSoft Integration Broker to transmit information between your PeopleSoft system and the WCB system. To use Integration Broker for this purpose, you need to configure the default local node, PSFT_HR, and make sure that it is active.
The WorkSafeBC Web Service enhancement uses the following four service operations:
RETRIEVEEMPLOYERCODES
RETRIEVEINCIDENTSTATUS
RETRIEVESYSTEMCODES
SUBMITINCIDENT
Entering a Phone Number for your Location
Telephone Area Code and Telephone Number are mandatory fields for WCB for
Reporting employers
Submitting employers
Payroll contacts
Workers
Telephone number, however, is not a mandatory field in PeopleSoft Human Resources, so it is imperative that you enter an area code and telephone number on the Company page. The system uses this telephone number if no telephone number exists for one of the entities listed above.
Changing the ISSv3 Web Service URL
Although completing WorkSafeBC's web service testing requirements is an optional step, we deliver a client validation ISSv3 web service URL so that you can perform this testing if you wish. In test mode, you can send web service messages to request system codes, request employer-related codes, and submit injury reports. Only the ability to request submission status is disabled for client validation testing. You need to contact WorkSafeBC prior to connecting to the production database. In addition, you need to change the client validation URL to the production URL. To change the ISSv3 web service URL:
Access the Service page (PeopleTools, Integration Broker, Integration Setup, Services) for the ISSV3 service.
In the Existing Operations group box, click the RETRIEVEEMPLOYERCODES.V1 link to access the Service Operations component for the RETRIEVEEMPLOYERCODES service operation.
Access the Routings page of the Service Operations component.
In the Routing Definitions group box, click the ~IMPORTED~22075 link to access the Routings component for the ~IMPORTED~22075 routing.
Access the Connector Properties page.
Change the value of the PRIMARYURL property ID from https://cv.b2b.online.worksafebc.com/ISSV3/ISSV3.asmx to https://b2b.online.worksafebc.com/ISSV3/ISSV3.asmx.
Click Save.
Repeat these steps for the routings associated with the RETRIEVEINCIDENTSTATUS, RETRIEVESYSTEMCODES, and SUBMITINCIDENT service operations.
See Also
Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker
The BC WCB expects you to perform a significant amount of editing and checking to make sure that submitted reports are complete, accurate, and compatible with WorkSafeBC's web service. The WCB returns incomplete files for more information.
For this reason, Human Resources contains several edit checks and warnings. By following the warnings during data entry, you significantly increase the likelihood that the BC WCB will accept the report file the first time that you send it.
However, the BC WCB's mainframe computer checks for some things that Human Resources cannot. For example, the BC WCB system knows whether a postal code and an address associated with it are correct or incorrect. If you send address information for which the address is correct, but the postal code is wrong, their system detects the error and rejects the file. In most cases, you can solve the problem by correcting and resubmitting the report file to the BC WCB.
The BC WCB recognizes five types of incident outcomes for health and safety incidents. The following table lists these outcomes in increasing order of severity.
Incident Outcome |
Definition |
Dangerous Occurrence |
The least severe outcome. An event is a dangerous occurrence when no workers are injured but there is a potential for serious injuries. You complete the pages in the report about incident-related information rather than injury-related information. |
Reported Only |
An event in which one or more workers are injured, but the workers do not require health care treatment or lose time away from work. The workers may or may not receive first aid treatment. You report this type of event at the discretion of the employer or at the worker's request. |
Health Care Only |
An event in which one or more workers are injured and a health care practitioner renders care for at least one worker, but the injuries do not result in any time away from work. The workers may or may not receive first aid treatment. |
Short Term Disability |
An event in which one or more workers are injured, a health care practitioner renders care for at least one worker, and at least one of the injured workers requires time away from work. The workers may or may not receive first aid treatment. |
Fatality |
An event in which one or more workers are injured and at least one injured worker dies. First aid and health care practitioner care may have been rendered. |
As a general rule, the more severe the incident outcome, the more information that you report to the BC WCB. As the amount of information required for an incident increases, the number of checks carried out by the WCB mainframe system also increases, and so does the number of checks and warnings built into the Human Resources system. This means that entering a particular piece of information into the PeopleSoft system may cause the system ask you for several other pieces of information.
Also note that Dangerous Occurrence is the only non-injury incident outcome. The remaining categories are injury-related incident outcomes that have a corresponding injury outcome. Whenever you enter WCB incidents in which there is only one injured employee, the category or severity of the incident outcome is determined by the injury outcome. When more than one employee is injured, the incident outcome is automatically determined as the most severe of the injury outcomes.
This diagram shows how incident outcome is derived from injury outcome:
Injury outcome and incident outcome
This section provides an overview of WorkSafeBC's web service processes and discusses how to:
Enter employer registration details.
Request system codes.
Request employer codes.
Populate staging tables.
Create and transmit injury reports.
Review error messages.
Review success messages.
Request submission status.
Review submission status.
Using the WorkSafeBC web service you can:
Request employer and system codes.
Submit injury reports.
Request submission statuses.
Requesting Employer and System Codes
This diagram illustrates the process flow for requesting employer and system codes using the WorkSafeBC web service:
Employer and system code request process
Using the WCB_EMPLR_REL_CD or WCB_SYSTEM_CD component, you initiate the Employer_Codes or System_Codes application class, respectively.
Both application classes generate an XML file and initiate a web service operation through Integration Broker to send the XML file as a SOAP envelope to WCB's Accident Registration System.
After receiving the XML file, the WCB system validates it and returns either completion codes confirming that the validation was successful, or error codes indicating that the validation failed.
Based on the response from WCB, the PeopleSoft system parses the XML file and extracts the data to update the database.
Submitting Injury Reports
This diagram illustrates the process flow for submitting injury reports using the WorkSafeBC web service:
Injury report submittal process
You initiate the OHS501BC.SQR process to collect injury and incident data from the INJURY_ILL and INCIDENT_DATA tables and use it to populate staging tables. The process collects the following types of data:
Incident/injury data.
Corrective preventative actions.
Non-employee information.
Employee information.
Employment information.
Claims information.
Using the INIT_BC_WCB_WEB component, you trigger the Incident_Submission application class, which collects data from the staging tables and uses it to generate an XML file. The same application class also initiates a web service operation through Integration Broker to send the XML file as a SOAP envelope to the WCB's Accident Registration System.
After receiving the XML file, the WCB system validates it and returns either completion codes confirming that the validation was successful, or error codes indicating that the validation failed.
Based on the response from WCB, the PeopleSoft system parses the XML file and extracts the data to update the database.
Requesting Submission Statuses
This diagram illustrates the process flow for requesting submission statuses using the WorkSafeBC web service:
Submission status request process
Using the WCB_SUB_STAT component, you initiate the Submission_Status application class.
The application class generates an XML file and initiates a web service operation through Integration Broker to send the XML file as a SOAP envelope to WCB's Accident Registration System.
After receiving the XML file, the WCB system validates it and returns either completion codes confirming that the validation was successful, or error codes indicating that the validation failed.
Based on the response from WCB, the PeopleSoft system parses the XML file and extracts the data to update the database.
Page Name |
Definition Name |
Navigation |
Usage |
WCB_WEB_REG_DTLS |
Setup HRMS, Product Related, Workforce Monitoring, Health and Safety, WCB Web Service CAN, Employer Web Srv Registration, Employer Web Srv Registration |
Enter employer WCB registration details. |
|
WCB_EMPLR_REL_CD |
Setup HRMS, Product Related, Workforce Monitoring, Health and Safety, WCB Web Service CAN, Employer-Related Codes, Employer-Related Codes |
Request employer codes. |
|
WCB_SYSTEM_CD |
Setup HRMS, Product Related, Workforce Monitoring, Health and Safety, WCB Web Service CAN, System Codes, System Codes |
Request system codes. |
|
RUNCTL_WCB_501 |
Workforce Monitoring, Health and Safety, Collect Health/Safety Data, Extract WCB Injury Data CAN, Extract WCB Injury Data CAN |
Run the OHS501BC SQR process to populate staging tables with WCB injury data. |
|
INIT_BC_WCB_WEB |
Workforce Monitoring, Health and Safety, WCB Web Services CAN, Submit Injury Report, Submit Injury Report |
Create and transmit injury reports. |
|
Review Error Messages |
WCB_INJ_ERR_RESP |
Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Review Error Messages |
Review error messages received from the WCB. |
WCB_SUB_STAT |
Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Request Submission Status |
Request submission status. |
|
WCB_INC_SUB_STAT |
Workforce Monitoring, Health and Safety, WCB Web Services CAN, Review Submission Status |
Review the submission status of an injury report. |
|
WCB_INJ_RPT_RESP |
Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Review Success Messages |
Review success messages received from the WCB. |
Access the Employer Web Srv Registration page (Setup HRMS, Product Related, Workforce Monitoring, Health and Safety, WCB Web Service CAN, Employer Web Srv Registration, Employer Web Srv Registration).
WCB Employer ID |
Enter the employer ID assigned by the WCB. |
Business Partner Identifier |
Enter the six-digit WCB account number. |
Business Partner Type |
Enter the role type assigned to the employer during web service registration. |
Business Partner Token |
Enter the unique credential issued to each business partner. |
Access the Employer-Related Codes page (Setup HRMS, Product Related, Workforce Monitoring, Health and Safety, WCB Web Service CAN, Employer-Related Codes, Employer-Related Codes).
Use this page to retrieve employer-related codes from the WCB. An employer should run this web service every time that it adds, changes or deletes operating locations or industry classifications because the WCB validates every web service transmission to ensure that the codes are correct.
Employer ID |
Enter the ID of the employer for which you want to request employer-related codes. |
Select All Employer IDs |
Select to request codes for all valid employer IDs. |
Request Employer Codes |
Click to initiate the employer-related codes request to the WCB. The WCB sends a response message containing the valid employer-related code values for the selected employer ID. |
Clear |
Click to deselect the displayed information in the Employer Related Codes group box. |
Operating Location |
Displays the identification number of the employer's operating location(s) as assigned by the WCB. The Start Date and End Date fields next to this field represent the date on which the location became active and the date on which it became inactive, respectively. |
Class/Subclass |
Displays the type of industry classification assigned to the employer by the WCB. The Start Date and End Date fields next to this field represent the date on which the classification unit became active and the date on which it became inactive, respectively. |
Access the System Codes page (Setup HRMS, Product Related, Workforce Monitoring, Health and Safety, WCB Web Service CAN, System Codes, System Codes).
Use this page to request system codes. It is necessary to request system codes only once during implementation unless new system codes are added.
Employer ID |
Select the ID of the employer for which you are requesting system codes. |
System Category |
Select the system category for which you are requesting codes. |
Select All System Categories |
Select to request system codes for all valid system categories. |
Request System Codes |
Click to initiate the system codes request to the WCB. The WCB sends a response message containing the valid system code values for the selected system category. |
Clear |
Click to deselect the displayed information in the System Code group box. |
System Code |
Displays the system codes of the system category that you select. |
Description |
Displays the description of the system code. |
Start Date |
Indicates the date on which the system code became active. |
End Date |
Indicates the date on which the system code became inactive. |
Note. One of the system codes is SEXTY, which is the gender code. The PeopleSoft system derives the gender of an EmplID from the Personal Data table, so the gender values of Male and Female are hard coded. These values are the same as those currently delivered by the WCB, but if these values change or new values are added, you need to update the hard coded PeopleSoft values accordingly.
Access the Extract WCB Injury Data CAN page (Workforce Monitoring, Health and Safety, Collect Health/Safety Data, Extract WCB Injury Data CAN, Extract WCB Injury Data CAN).
(CAN) Use this page to run the OHS501BC SQR process, which extracts injury data to staging tables, where it can then be transmitted to the WCB.
Employer ID |
Enter the employer ID assigned by the WCB. |
Operating Location |
Enter your organization's operating location ID. |
Name of Person Transmitting |
Enter the name of the primary point of contact for the transmitting organization. |
Phone Number |
Enter the phone number of the primary point of contact for the transmitting organization. |
Phone Extension |
Enter the phone extension of the primary point of contact for the transmitting organization. |
Email ID |
Enter the email address of the primary point of contact for the transmitting organization. |
Date Transmitted |
Enter the date on which the injury report data was extracted. |
Time |
Enter the time at which the injury report data was extracted. |
Data Request Parameters
Use this group box to select the incidents for which you want to extract injury data.
Access the Submit Injury Report page (Workforce Monitoring, Health and Safety, WCB Web Services CAN, Submit Injury Report, Submit Injury Report).
Incident Number |
Enter the unique identifying number of the incident you want to report to the WCB. |
Event Report Type |
Displays the event report type of the incident number you select. |
Resubmission |
Indicates that the employer has made updates to a previously reported incident and is resubmitting it. |
Transaction Identifier |
Displays the unique identifier returned by the WCB as part of the response to a successfully validated transmission. This field is populated only if you select the Resubmission check box. |
Message Status |
Indicates whether a transmitted message resulted in success or error. |
Details |
Click to open the Review Error Messages page or Review Success Messages page depending on whether the message was transmitted successfully. |
Submit Injury Report |
Click to submit the selected injury reports. |
Note. You should submit to the WCB only incidents with an outcome of Short Term Disability or Health Care Only. Do not submit incidents with an outcome of Dangerous Occurrence, Reported Only, and Fatality through the WorkSafeBC web service. The outcome of an incident is displayed in the Outcome field of the Incident Details – Incident page.
Access the Review Error Messages page (Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Review Error Messages).
This page displays any business logic error messages returned by the WCB. These types of errors are usually data entry errors and easily rectified.
Reviewing Non-Business Logic Errors
The WCB Web Service Administrator in your organization needs to review the more technical errors that are not a result of bad business logic. To review these errors, go to the Synchronous Services page (PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Synchronous Services) and enter the name of the service operation on which you want to run a query. You can view additional details for an error by opening the errorlog.html and msglog.html files, which are located in the <PS_HOME>\webserv\<database name>\applications\peoplesoft\PSIGW directory.
Access the Request Submission Status page (Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Request Submission Status).
Use this page to request the current submission status of an incident. WorkSafeBC updates the submission status code of an incident as the state of the claim changes.
Incident Number |
Enter the unique identifying number of the incident for which you want to review the status. |
Transaction Identifier |
Displays the unique identifier returned by the WCB as part of the response to a successfully validated transmission. |
Request Submission Status |
Click to retrieve the submission status of the selected incidents. |
View Submission Status |
Click to open the Incident Submission Status page for the associated incident. |
Note. Your organization must be live on the production URL to receive responses to submission status requests.
Access the Incident Submission Status page (Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Review Submission Status).
This page displays the submission Status Code and Status Message associated with the incident. There are four valid submission status codes that the WCB can return in response to a reported incident:
Submission Status Code |
Submission Status Message |
Description |
CNP |
Submission Not Processed Yet |
The submission currently resides in the WCB interim repository and is awaiting processing. |
CAC |
Submission Was Accepted |
The submission is successfully stored in the WCB Accident Registration System. |
CNW |
Submission Has No Workers |
The submission has no workers and therefore no claim numbers. |
CNF |
Submission Not Found |
The submission could not be found in the interim repository or in the WCB Accident Registration System. |
In addition, for each EmplID and Claim Number, this page displays the Claim Status Code and Claim Status Message. There are nine valid claim status codes that the WCB can return for each claim:
Claim Status Code |
Claim Status Message |
Description |
AC |
This claim has been accepted. |
The claim has been accepted. |
AI |
We require more information to process this claim. |
The claim has been accepted for investigative purposes only. Only health care costs are payable. This is not a final decision on the claim. |
AN |
This claim has been accepted. |
The claim has been accepted on an interim basis. Only wage loss costs are payable. This is not a final decision. |
DI |
This claim has not been accepted. |
This claim has been disallowed. |
PE |
We require more information to process this claim. |
The claim is in a pending state as we have not made a claim decision yet. |
SU |
We require more information to process this claim. |
The claim has been suspended as we did not have all the evidence we required to make a claim decision. |
HC |
This claim has been accepted for health care only. |
The claim has been accepted for the payment of health care benefits only. |
IN |
This claim has been registered but needs more information. |
The claim has been recorded for information purposes only. There was no medical attention sought or time loss involved. |
RE |
This claim has not been accepted. |
The claim has been rejected. The claim does not meet the requirements of the Workers Compensation Act. |
Access the Review Success Messages page (Workforce Monitoring, Health and Safety, WCB Web Services CAN, Monitor Web Services, Review Success Messages).
This page displays success messages returned by the WCB.