Background and strategic fit

The purpose of this Integration is to pull over different incident information (Near Miss and Injury Illness) to support our growing customer base to analyze the data they are entering through the ProcessMAP solution.This document provides information on how to consume the API's by the end Users.

Assumptions

• Individual APIs being used for Injury & Claim and Near Miss
• For Injury/Illness the Incident type field will have comma separate value in case it is a combined Incident with other Incident Types
  • Data will be sent only for the Injury/Illness
• ProcessMAP system User permissions would not be considered while exposing the data
• ProcessMAP assumes anyone who is accessing the Outbound API has required authority to access Personal Information
• User would have to input single Location Code(e.g. Westlake) each time to consume that Location data
• Data to be accessed with a limitation of 2 years duration at a time to avoid any performance issues.
• Data will be shown in Readable JSON format
• Fields Names in the Response would be Product Field Naming. Customer will have to use mapping documentation
• User accessing this endpoint through a valid Token & ConsumerId, provided by ProcessMAP, will have access to complete data
• Witness Details  Information will be as nested
• BodyParts -- Will be separated by , and side will be mentioned in braces Ex: Arm (L)(R)
• For Nature, Cause and BodyParts -- IF Other(List) is selected then others description will be appended with '-' Ex: Other(List) --- Some Text
• For Employee, Supervisor, Reported By  -- LastName, MiddleName, First name and Prefix will be combined as shown as single (Prefix(if available) + Firstname+ MiddleName(if available) + LastName)
• For Witness the First Name, Middle Name, Last Name will not be appended as no field is mandatory
• Incident Status will be included in the json output
• DATETIME, INT and FLOAT data will be shown as NULL when there is no data
• Pin Location Information and Default CAPA is not considered for this release
• The data that is being shown in response is in EST Date time format ONLY
• Certain fields are auto-populated in Application but the same will not reflect in JSON until the form is saved

User Interaction

Near Miss

Incident Details

Request

GET papi/v1/imsoutbound/nearmissincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}

Ex: papi/v1/imsoutbound/nearmissincidents?locationCode=westlake&dateFrom=2019-07-01&dateTo=2019-07-30&lastSyncedDate=2019-01-01

URI Parameters

Location Code, DateFrom, DateTo and LastSyncedDate are to be passed as parameters.

DateFrom and DateTo are required when LastSyncedDate is not provided.

When DateFrom, DateTo and LastSyncedDate are provided, data will be returned based on LastSyncedDate only.

Headers

Response

Sample:

[
{
"Incident ID (System Generated)": "Sample_String",
"Incident Title/Site": "Sample_String",
"Location Code": "Sample_String",
"Location": "Sample_String",
"Incident Date": "Sample_String",
"Time of Incident": "Sample_String",
"Time Undetermined": "Sample_String",
"Day Of Week": "Sample_String",
"Reported By": "Sample_String",
"Work Shift": "Sample_String",
"Department": "Sample_String",
"Was this an HPE (Potential life altering injury or fatality)? ((IF YES - The incident investigation is mandatory))": "Sample_String",
"Describe what occurred to create the Near Miss/Hazard Recognition?": "Sample_String",
"Is Contractor Involved?": "Sample_String",
"Please provide Contractor Name, Company": "Sample_String",
"Is this a stop work?": "Sample_String",
"Employee/Individual Details": {
"Was an Employee / Individual involved in the incident?": "Sample_String",
"Personnel Type": "Sample_String",
"First Name": "Sample_String",
"Middle Name": "Sample_String",
"Last Name": "Sample_String",
"Salutation": "Sample_String",
"Employee Id": "Sample_String",
"Gender": "Sample_String",
"Occupation/Job Title": "Sample_String",
"Hire Date": "Sample_String",
"Employee / Individual Department": "Sample_String",
"Supervisor First Name": "Sample_String",
"Supervisor Last Name": "Sample_String",
"Supervisor Middle Name": "Sample_String",
"Supervisor's Email": "Sample_String"
},
"Are there any Witnesses identified?": "Sample_String",
"Number of Witnesses": "Sample_String",
"Witness Information": [
{
"First Name": "Sample_String",
"Middle Name": "Sample_String",
"Last Name": "Sample_String",
"Phone Number": "Sample_String",
"Notes": "Sample_String"
}
],
"Incident Status": "Sample_String",
"Created By EmployeeID": "Sample_String",
"Created By": "Sample_String",
"Created Date": "Sample_String",
"Modified Date": "Sample_String",
"Modified By": "Sample_String",
"Investigation Responsibility": {
"Responsible Team": [
{
"Salutation": "Sample_String",
"First Name": "Sample_String",
"Last Name": "Sample_String"
},
{
"Salutation": "Sample_String",
"First Name": "Sample_String",
"Last Name": "Sample_String"
}
],
"Target Completion Date": "Sample_String",
"Note/Comments": "Sample_String",
"Notify Immediate Supervisor": "Sample_String"
},
"Investigation Details": [
{
"Date Reported to Management": "Sample_String"
},
{
"Time Reported to Management": "Sample_String"
},
{
"Is this an HPE?": "Sample_String",
"Please select Non-HPE Type": "Sample_String",
"HPE Type": "Sample_String"
},
{
"Is this a Near Miss or a Hazard Recognition?": "Sample_String"
},
{
"Did this result in Stop Work?": "Sample_String",
"Who performed the Stop Work?": "Sample_String"
},
{
"EHS Category": "Sample_String"
},
{
"Did this incident involve a Procedural Breakdown?": "Sample_String"
},
{
"Are new procedures or special training needed to prevent recurrence?": "Sample_String",
"If yes, provide the details": "Sample_String"
},
{
"Was incident reviewed with the involved employee?": "Sample_String",
"Employee Comments (If yes to answer above)": "Sample_String"
},
{
"Could this incident have resulted in a life-altering injury?": "Sample_String",
"What type of injury could have occurred?": {
"What type of injury could have occurred?": "Sample_String",
"Please specify": "Sample_String"
},
"How severe could the injury have been?": "Sample_String"
},
{
"Length of Normal Workday": "Sample_String"
},
{
"What tool, machine, equipment, object or substance was involved in the near-miss. If this question does not apply, enter ?not applicable?.": "Sample_String"
},
{
"Time Work Day Began": "Sample_String"
},
{
"Specific Work Activity when the incident occurred": "Sample_String",
"Please specify :": "Sample_String"
},
{
"Area where near miss/hazard recognition occurred": "Sample_String",
"Please specify:": "Sample_String"
},
{
"Investigation Conducted By": "Sample_String"
},
{
"Investigation Conducted Date": "Sample_String"
}
],
"Contributing Factor/Immediate Cause": [
{
"Contributing Factor Type (Parent)": "Sample_String",
"Contributing Factor/Immediate Cause": [
"Sample_String"
],
"Comments": "Sample_String"
},
{
"Contributing Factor Type (Parent)": "Sample_String",
"Contributing Factor/Immediate Cause": [
"Sample_String"
],
"Comments": "Sample_String"
}
],
"5 Why? Methodology": [
{
"Select Action or Condition that may have directly caused incident": [
"Sample_String",
"Sample_String"
],
"Whys": [
{
"Why or what created the scenario above to affect the action or condition": "Sample_String"
},
{
"Final Root Cause/Basic Cause Checked": "Sample_String"
}
]
}
],
"Root Cause/Basic Cause Analysis": [
{
"Root cause Type (Parent)": "Sample_String",
"Root Cause/Basic Cause": [
"Sample_String"
],
"Comments": "Sample_String"
}
],
"Lessons Learned": [
{
"Lessons Learned": "Sample_String"
}
],
"Action Items": [
{
"Source ID": "Sample_String",
"Source Title": "Sample_String",
"Action Item Title": "Sample_String",
"Action Item Category": "Sample_String",
"Action Item Type": "Sample_String",
"Action Item Description": "Sample_String",
"Action Item Priority": "Sample_String",
"Action Item Due Date": "Sample_String",
"Owners": [
"Sample_String"
],
"Assigned By": "Sample_String",
"Verification Required": "Sample_String",
"Verify User": [
"Sample_String"
],
"Action Item Status": "Sample_String",
"Action Taken": "Sample_String",
"Action Item Completed By": "Sample_String",
"Completed Date": "Sample_String",
"Due Date Extension": "Sample_String",
"Requested Due Date Extension": "Sample_String",
"Reason for Due Date Extension": "Sample_String",
"Due Date Extension Request Approved?": "Sample_String",
"Reason for not extending the Due Date": "Sample_String",
"Verification Status": "Sample_String",
"Verification Performed": "Sample_String",
"Verified By": [
"Sample_String",
"Sample_String"
],
"Verification Date": "Sample_String",
"Comments": "Sample_String"
}
]
}
]

Injury/Illness

Incident Details

Request

GET papi/v1/imsoutbound/injuryincidents?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}

Ex: papi/v1/imsoutbound/injuryincidents?locationCode=westlake&dateFrom=2019-07-01&dateTo=2019-07-30&lastSyncedDate=2019-01-01

URI Parameters

Location Code, DateFrom, DateTo and LastSyncedDate are to be passed as parameters.

DateFrom and DateTo are required when LastSyncedDate is not provided.

When DateFrom, DateTo and LastSyncedDate are provided, data will be returned based on LastSyncedDate only.

Headers

Response

Sample:

[
{
"Injury/Illness Incident Detail": {
"Incident Details": {
"Incident ID": "Sample_String",
"Incident Title/Site": "Sample_String",
"Incident Type": "Sample_String",
"Location Code": "Sample_String",
"Location": "Sample_String",
"Were multiple people injured as part of this incident?": "Sample_String"
},
"General Details": {
"Date of Incident": "Sample_String",
"Time of Incident": "Sample_String",
"Time Undetermined": "Sample_String",
"Day Of Week": "Sample_String",
"Work Shift": "Sample_String",
"Time Work Day Began": "Sample_String",
"Description of Incident": "Sample_String",
"Incident Occurred on Employer's Premises": "Sample_String",
"Department": "Sample_String",
"Location of Injury Scene": "Sample_String"
},
"Employee / Individual Details": [
{
"Personnel Type": "Sample_String",
"Employee": {
"Last Name": "Sample_String",
"First Name": "Sample_String",
"Middle Name": "Sample_String",
"Salutation": "Sample_String"
},
"Employee ID": "Sample_String",
"Gender": "Sample_String",
"Occupation/Job Title": "Sample_String",
"Hire Date": "Sample_String",
"Employee / Individual Department": "Sample_String",
"Supervisor (Last,First,MI)": {
"Last Name": "Sample_String",
"First Name": "Sample_String",
"Middle Name": "Sample_String"
},
"Supervisor's Email": "Sample_String"
}
],
"Injury/Illness Summary": [
{
"Was employee taken offsite for evaluation by a medical professional?": "Sample_String",
"Did this incident involve an in-patient hospitalization, amputation, or a loss of an eye?": "Sample_String",
"Has OSHA been contacted?": "Sample_String",
"Please Identify OSHA Contact Details �Name and Phone Number�": "Sample_String",
"Nature of Injury / Illness": "Sample_String",
"Cause of Injury/Illness": "Sample_String",
"Injured Body Parts": [
"Sample_String"
],
"What was the employee doing just before the incident occurred?": "Sample_String",
"Please describe what object or substance directly harmed the employee?.If this question does not apply, enter �not applicable�?": "Sample_String",
"Machine/Equipment Number": "Sample_String",
"Type": "Sample_String",
"Brand": "Sample_String",
"Model": "Sample_String"
}
],
"Witness Information": {
"Are there any Witnesses identified?": "Sample_String",
"Number of Witnesses": "Sample_String",
"Witness Information": [
{
"First Name": "Sample_String",
"Middle Name": "Sample_String",
"Last Name": "Sample_String",
"Phone Number": "Sample_String",
"Notes": "Sample_String"
}
]
},
"Additional Incident Information": {
"Incident Status": "Sample_String",
"Created By": "Sample_String",
"Created Date": "Sample_String",
"Last Updated By": "Sample_String",
"Last Updated Date": "Sample_String"
}
},
"Case Management": {
"Classification of Case": [
{
"Case Number": "Sample_String",
"Was this case Work-Related?": "Sample_String",
"Describe the reason for the \"Non Work Related\" classification": "Sample_String",
"Did this incident result in a fatality?": "Sample_String",
"Did this incident result in an amputation, fractured/cracked bone(s) (including teeth), or loss of consciousness?": "Sample_String",
"Did the incident result in work restrictions, lost time or job transfer?": "Sample_String",
"Was Treatment Provided beyond First Aid? (Prescription strength medications, Application of wound closing devices, Intravenous Fluids)": "Sample_String",
"Did the injury involve a needlestick and cut(s) from sharp objects that are contaminated with another person's blood or other potentially infectious material?": "Sample_String",
"Was treatment defined as \"First Aid\" provided?": "Sample_String",
"This is a First Aid Case, identify the specific treatment(s) provided": "Sample_String",
"Is This a Bunge (US OSHA) defined Recordable Case ?": "Sample_String",
"Describe the reason for the \"Not Recordable\" classification": "Sample_String",
"Is this Case Recordable According to Local Record keeping Requirements ?": "Sample_String",
"Case Status": "Sample_String",
"Comments": "Sample_String",
"Completed By": "Sample_String",
"Title": "Sample_String",
"Phone": "Sample_String"
}
],
"Case Classification and Progress Tracking": {
"Other Recordable/MAA": [
{
"Employee Name": "Sample_String",
"Classification of Case": "Sample_String",
"Date Other Recordable/MAA Case Occurred": "Sample_String",
"Reason for Classification": "Sample_String",
"Comments": "Sample_String",
"Official Medical Diagnosis (Nature of Injury / Illness)": "Sample_String",
"Was Treatment provided offsite?": "Sample_String",
"Hospital / Clinic Name": "Sample_String",
"Type": "Sample_String",
"Physician/Healthcare Provider": "Sample_String",
"Street": "Sample_String",
"City": "Sample_String",
"Country": "Sample_String",
"State": "Sample_String",
"Postal Code/Zip Code": "Sample_String",
"Phone": "Sample_String",
"Fax": "Sample_String",
"Was the employee treated in an emergency room": "Sample_String",
"Was employee hospitalized overnight as an in-patient": "Sample_String",
"Recording/Revision Date": "Sample_String"
}
]
}
},
"Claim": {
"Claim Information": [
{
"Do you want to file a claim for this incident?": "Sample_String",
"Worker's Comp ID": "Sample_String",
"Workers Comp Claim#": "Sample_String",
"Incident Reported By": "Sample_String",
"Reporter's Email": "Sample_String",
"Reporter's Phone": "Sample_String",
"Injury Date": "Sample_String",
"Injury Day of Week": "Sample_String",
"Time of Injury": "Sample_String",
"Time Workday (Shift) Began": "Sample_String",
"Incident id/Case No": "Sample_String",
"Is this Claim work related?": "Sample_String"
}
],
"Employee/Individual Details": [
{
"Employee Name First": "Sample_String",
"Middle": "Sample_String",
"Last": "Sample_String",
"Home Address:Street": "Sample_String",
"City": "Sample_String",
"State": "Sample_String",
"Zip": "Sample_String",
"Home Phone Number": "Sample_String",
"Gender": "Sample_String",
"Date of Birth": "Sample_String",
"Marital Status": "Sample_String",
"Hire Date": "Sample_String",
"Years at Bunge": "Sample_String",
"Number of Dependants": "Sample_String",
"Type of Employment": "Sample_String",
"Occupation": "Sample_String",
"Department Name": "Sample_String",
"State Hired": "Sample_String",
"Supervisor Name": "Sample_String",
"Supervisor Phone": "Sample_String",
"Current Weekly Wage": "Sample_String",
"Hourly Wage": "Sample_String",
"Hours worked per Week": "Sample_String",
"Days worked Per Week": "Sample_String",
"Hours worked Per Day": "Sample_String",
"Employment Status": "Sample_String",
"Employee ID Number": "Sample_String",
"Was Employee Paid in Full for Date of Injury": "Sample_String",
"Any Prior WC Injuries": "Sample_String",
"OSHA Reference No.": "Sample_String",
"Will employee's salary continue?": "Sample_String"
}
],
"Employer Information": [
{
"Health & Safety / WC Contact Name": "Sample_String",
"Telephone Number": "Sample_String",
"Title": "Sample_String",
"Mailing Address": "Sample_String",
"City": "Sample_String",
"State": "Sample_String",
"Zip": "Sample_String",
"Employer Location Code": "Sample_String",
"Employer SIC": "Sample_String",
"Nature of Business": "Sample_String",
"Employer Name": "Sample_String"
}
],
"Accident Information": [
{
"Did the Accident Occur at the Work Location?": "Sample_String",
"If no , where did the accident occur? Accident Address": "Sample_String",
"City": "Sample_String",
"State": "Sample_String",
"Zip": "Sample_String",
"Give a full Description of the Accident: (Be as Complete as Possible)": "Sample_String",
"What was the employee doing just before the incident occurred?": "Sample_String",
"Please describe what object or substance directly harmed the employee?": "Sample_String",
"Jurisdiction State": "Sample_String",
"Date and Time Reported to Employer": "Sample_String",
"Hours: Minutes": "Sample_String"
}
],
"Injury Information": [
{
"Did incident result in a fatality?": "Sample_String",
"Date fatality occurred": "Sample_String",
"Did the employee lose any time from work?": "Sample_String",
"What was the first full day out": "Sample_String",
"Do you know the Date Employee Last Worked?": "Sample_String",
"Date Employee Last Worked": "Sample_String",
"Has the employee returned to work?": "Sample_String",
"Date Returned to Work": "Sample_String",
"Return to Work Status": "Sample_String",
"Estimated return to work date": "Sample_String",
"Nature of Injury": "Sample_String",
"Cause of Injury/illness": "Sample_String",
"Which Part of the Body was Injured?": [
"Sample_String"
],
"Part of the Body Location?": "Sample_String",
"Needle Stick Injury": "Sample_String",
"Reqs Sharps Inj Log": "Sample_String"
}
],
"Medical Information": [
{
"Was employee sent to Hospital / Clinic to receive Medical Treatement?": "Sample_String",
"Initial Medical Treatment": "Sample_String",
"Hospital / Clinic Name": "Sample_String",
"Address": "Sample_String",
"City": "Sample_String",
"State": "Sample_String",
"Zip": "Sample_String",
"Phone": "Sample_String",
"Fax": "Sample_String",
"Clinic/Doctor Name": "Sample_String"
}
],
"Witness Information": [
{
"Were There Any Witnesses?": "Sample_String",
"If Yes, Name": "Sample_String",
"Contact": "Sample_String"
}
],
"Additional Comments and Information": [
{
"Do you question the validity of the claim": "Sample_String",
"If yes, provide Details": "Sample_String",
"Other Comments": "Sample_String"
}
],
"Report Prepared By": [
{
"Name": "Sample_String",
"Title": "Sample_String",
"Phone": "Sample_String"
}
]
},
"Investigation Report": {
"Investigation Responsibility": {},
"Investigation Details": [
{
"Is this an Ergonomic injury?": "Sample_String"
},
{
"Description of incident (please maintain in local language if other than English)": "Sample_String"
},
{
"Is this an HPE incident?": "Sample_String",
"Please select Non-HPE Type": "Sample_String",
"HPE Type": "Sample_String"
},
{
"Task at time of incident": "Sample_String"
},
{
"Did incident interrupt normal operations?": "Sample_String",
"Length of Downtime": "Sample_String",
"Describe interruption:": "Sample_String"
},
{
"Was it necessary to retain items involved with this incident? (tools, equipment, etc.)": "Sample_String",
"If yes, please list items retained and current location": "Sample_String"
},
{
"Were Local or Government Authorities contacted as a result of this incident?": "Sample_String",
"Which agencies were contacted?": {
"Which agencies were contacted?": "Sample_String",
"Please specify": "Sample_String"
}
},
{
"Post Accident: Drug/Alcohol Screen Conducted": "Sample_String"
},
{
"Date Reported to Management": "Sample_String"
},
{
"Time Reported to Management": "Sample_String"
},
{
"Length of Normal Workday": "Sample_String"
},
{
"length of employment at current position": "Sample_String"
},
{
"length of employment at current position Unit": "Sample_String"
},
{
"Was any Machine / Equipment involved?": "Sample_String",
"Machine/Equipment Number": "Sample_String"
},
{
"Specific Work Activity when the incident occurred": "Sample_String",
"Please specify:": "Sample_String"
}
],
"Ergonomic Analysis": [],
"Contributing Factor/Immediate Cause": [
{
"Contributing Factor Type (Parent)": "Sample_String",
"Contributing Factor/Immediate Cause": [
"Sample_String"
],
"Comments": "Sample_String"
},
{
"Contributing Factor Type (Parent)": "Sample_String",
"Contributing Factor/Immediate Cause": [
"Sample_String"
],
"Comments": "Sample_String"
}
],
"5 Why? Methodology": [
{
"Select Action or Condition that may have directly caused incident": [
"Sample_String"
],
"Whys": [
{
"Why or what created the scenario above to affect the action or condition": "Sample_String"
},
{
"Final Root Cause/Basic Cause Checked": "Sample_String"
}
]
},
{
"Select Action or Condition that may have directly caused incident": [
"Sample_String"
],
"Whys": [
{
"Why or what created the scenario above to affect the action or condition": "Sample_String"
},
{
"Final Root Cause/Basic Cause Checked": "Sample_String"
}
]
}
],
"Root Cause/Basic Cause Analysis": [
{
"Root cause Type (Parent)": "Sample_String",
"Root Cause/Basic Cause": [
"Sample_String"
],
"Comments": ""
}
],
"Lessons Learned": [
{
"Lessons Learned": "Sample_String"
}
]
},
"Action Items": [
{
"Source ID": "Sample_String",
"Source Title": "Sample_String",
"Action Item Title": "Sample_String",
"Action Item Category": "Sample_String",
"Action Item Type": "Sample_String",
"Action Item Description": "Sample_String",
"Action Item Priority": "Sample_String",
"Action Item Due Date": "Sample_String",
"Owners": [
"Sample_String"
],
"Assigned By": "Sample_String",
"Verification Required": "Sample_String",
"Verify User": [
"Sample_String"
],
"Action Item Status": "Sample_String",
"Action Taken": "Sample_String",
"Action Item Completed By": "Sample_String",
"Completed Date": "Sample_String",
"Due Date Extension": "Sample_String",
"Requested Due Date Extension": "Sample_String",
"Reason for Due Date Extension": "Sample_String",
"Due Date Extension Request Approved?": "Sample_String",
"Reason for not extending the Due Date": "Sample_String",
"Verification Status": "Sample_String",
"Verification Performed": "Sample_String",
"Verified By": [
"Sample_String",
"Sample_String"
],
"Verification Date": "Sample_String",
"Comments": "Sample_String"
}
]
}
]

Errors/Validation Messages

Generic Error codes are given below.

HTTP ERROR 401

{
"HttpStatusCode": 401,
"HttpStatus": "Unauthorized",
"ErrorCode": 1030,
"ErrorMessage": "Invalid tenant."
}

If the location code given is invalid:

{
"Message": "Invalid Location Code"
}

(When FromDate, ToDate and LastSyncedDate are empty) or (FromDate, ToDate and LastSyncedDate are given in incorrect format of DD-MM-YYYY)

{
"Message": "Date From or Date To should not be empty"
}

When FromDate is greater than ToDate and LastSyncedDate is empty

{
"Message": "Date From is greater than Date To"
}

When LastSyncedDate is greater than current date

{

"Message": "Last Synced Date is a Future Date"
}

Questions

Below is a list of questions to be addressed as a result of this requirements document: