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
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.
Name | Description | Type | Additional information |
---|---|---|---|
locationCode | Represents the unique code of location for which Incident records to return. | string | Required |
dateFrom | Represents the starting date of Incident records to return. | date | Required but value optional |
dateTo | Represents the ending date of Incident records to return. | date | Required but value optional |
lastSyncedDate | Represents the data from incident created date or incident modified date. | date | Required but value optional |
Headers
Name | Description | Sample |
---|---|---|
Authorization | Represents the value of the authentication token. Allow multiple values: no. | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... |
ConsumerId | Represents the value of the consumer id. Allow multiple values: no. | 2426 |
Response
Sample:
{
"Incident ID (System Generated)": "US-TESTING LOCATION-19-I-0018",
"Incident Title/Site": "Test near Miss",
"Location Code": "Testing Location",
"Location": "Testing Location",
"Incident Date": "2019-12-02T00:00:00.000Z",
"Time of Incident": "9:00",
"Time Undetermined": "No",
"Day Of Week": "Monday",
"Reported By": "Sample String",
"Work Shift": "Morning",
"Operating Unit": "Sample String",
"Was this an HPE (Potential life altering injury or fatality)? ((IF YES - The incident investigation is mandatory))": "Yes",
"Describe what occurred to create the Near Miss/Hazard Recognition?": "Sample String",
"Is Contractor Involved?": "Yes",
"Please provide Contractor Name, Company": "Sample String",
"Is this a stop work?": "Yes",
"Employee/Individual Details": {
"Was an Employee / Individual involved in the incident?": "Yes",
"Personnel Type": "Employee",
"First Name": "Sample String",
"Middle Name": "Sample String",
"Last Name": "Sample String",
"Salutation": "Sample String",
"Employee Id": "Sample String",
"Gender": "Male",
"Occupation/Job Title": "Sample String",
"Hire Date": "2003-05-01T00:00:00.000Z",
"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?": "Yes",
"Number of Witnesses": 1,
"Witness Information": [
{
"First Name": "Sample String",
"Middle Name": "Sample String",
"Last Name": "Sample String",
"Phone Number": "Sample String",
"Notes": "Sample String"
}
],
"Incident Status": "Investigation Report Completed",
"Created By": "Sample String",
"Created Date": "2019-12-02T07:38:26.087Z",
"Modified Date": "2019-10-14T11:47:29.440Z",
"Modified By": "Sample String",
"Investigation Responsibility": {
"Responsible Team": [
{
"Salutation": "Sample String",
"First Name": "Sample String",
"Last Name": "Sample String"
}
],
"Target Completion Date": "2019-12-24T00:00:00.000Z",
"Note/Comments": "Sample String",
"Notify Immediate Supervisor": "Y"
},
"Investigation Details": [
{
"Date Reported to Management": "12/02/2019"
},
{
"Time Reported to Management": "10:00"
},
{
"Is this an HPE?": "Yes",
"Please select Non-HPE Type": "Sample String",
"HPE Type": "Hoisted Loads"
},
{
"Is this a Near Miss or a Hazard Recognition?": "Hazard Recognition"
},
{
"Did this result in Stop Work?": "Yes",
"Who performed the Stop Work?": "Sample String"
},
{
"EHS Category": "Sample String"
},
{
"Did this incident involve a Procedural Breakdown?": "Yes"
},
{
"Are new procedures or special training needed to prevent recurrence?": "Yes",
"If yes, provide the details": "Sample String"
},
{
"Was incident reviewed with the involved employee?": "Yes",
"Employee Comments (If yes to answer above)": "Sample String"
},
{
"Could this incident have resulted in a life-altering injury?": "Yes",
"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": "15:10"
},
{
"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": "12/02/2019"
}
],
"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": "Yes"
}
]
},
{
"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 Analysis": [
"Sample String",
"Sample String"
],
"Comments": "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": "Corrective Action",
"Action Item Description": "Sample String",
"Action Item Priority": "Low",
"Due Date": "2020-01-02T00:00:00.000Z",
"Owners": [
"Sample String"
],
"Assigned By": "Sample String",
"Verification Required": "Yes",
"Verify User": [
"Sample String"
],
"Action Item Status": "Open",
"Action Taken": "Sample String",
"Completed By": "Sample String",
"Action Item Completed Date": "Sample String",
"Verification Status": "Open",
"Verification Performed": "Onsite",
"Verified By": [
"Sample String"
],
"Verification Date": "Sample String",
"Comments": "Sample String"
}
]
}
Near Miss Field List
Section | Field Name | Database Column Size |
---|---|---|
Incident Detail | ||
Incident ID (System Generated) | NVARCHAR(400) | |
Incident Title/Site | NVARCHAR(400) | |
General Detail | ||
Incident Date | DATETIME | |
Time of Incident | NVARCHAR(100) | |
Time Undetermined | NVARCHAR(10) | |
Day of Week | NVARCHAR(50) | |
Reported By | NVARCHAR(200) | |
Work Shift | NVARCHAR(200) | |
Operating Unit | NVARCHAR(200) | |
Was this an HPE (Potential life altering injury or fatality)? ((IF YES - The incident investigation is mandatory)) | NVARCHAR(100) | |
Describe what occurred to create the Near Miss/Hazard Recognition? | NVARCHAR(8000) | |
Is Contractor Involved? | NVARCHAR(50) | |
Please provide Contractor Name, Company | NVARCHAR(500) | |
Is this a stop work? | NVARCHAR(200) | |
Employee / Individual Details | ||
Was an Employee / Individual involved in the incident? | NVARCHAR(50) | |
Personnel Type | NVARCHAR(50) | |
First Name | NVARCHAR(200) | |
Middle Name | NVARCHAR(200) | |
Last Name | NVARCHAR(200) | |
Salutation | NVARCHAR(200) | |
Employee Id | NVARCHAR(200) | |
Gender | NVARCHAR(200) | |
Occupation/Job Title | NVARCHAR(200) | |
Hire Date | DATETIME | |
Employee / Individual Department | NVARCHAR(100) | |
Supervisor First Name | NVARCHAR(200) | |
Supervisor Last Name | NVARCHAR(200) | |
Supervisor Middle Name | NVARCHAR(200) | |
Supervisor's Email | NVARCHAR(50) | |
Name of Contractor | NVARCHAR(800) | |
Name of Sub-Contractor | NVARCHAR(800) | |
Witness Information | ||
Are there any Witness identified? | NVARCHAR(20) | |
Number of Witnesses | INT | |
First Name | NVARCHAR(50) | |
Middle Name | NVARCHAR(50) | |
Last Name | NVARCHAR(50) | |
Phone Number | NVARCHAR(100) | |
Notes | NVARCHAR(2000) | |
Investigation Section | ||
Incident Status | NVARCHAR(100) | |
Created By | NVARCHAR(100) | |
Created Date | DATETIME | |
Modified Date | DATETIME | |
Modified By | NVARCHAR(100) | |
Investigation Responsibility | ||
Responsible Team | NVARCHAR(100) | |
Target Completion Date | DATETIME | |
Note/Comments | NVARCHAR(2000) | |
Notify Immediate Supervisor | NVARCHAR(100) | |
Investigation Details | ||
Date Reported to Management | DATETIME | |
Time Reported to Management | DATETIME | |
Is this an HPE? | NVARCHAR(100) | |
Please select Non-HPE Type | NVARCHAR(100) | |
HPE Type | NVARCHAR(100) | |
Is this a Near Miss or a Hazard Recognition? | NVARCHAR(100) | |
Did this result in Stop Work? | NVARCHAR(100) | |
Who performed the Stop Work? | NVARCHAR(100) | |
EHS Category | NVARCHAR(100) | |
Did this incident involve a Procedural Breakdown? | NVARCHAR(100) | |
Are new procedures or special training needed to prevent recurrence? | NVARCHAR(100) | |
If yes, provide the details | NVARCHAR(500) | |
Was incident reviewed with the involved employee? | NVARCHAR(100) | |
Employee Comments (If yes to answer above) | NVARCHAR(500) | |
Could this incident have resulted in a life-altering injury? | NVARCHAR(100) | |
What type of injury could have occurred? | NVARCHAR(100) | |
Please specify | NVARCHAR(500) | |
How severe could the injury have been? | NVARCHAR(100) | |
Length of Normal Workday | NVARCHAR(100) | |
What tool, machine, equipment, object or substance was involved in the near-miss. If this question does not apply, enter ?not applicable? | NVARCHAR(500) | |
Time Work Day Began | DATETIME | |
Specific Work Activity when the incident occurred | NVARCHAR(100) | |
Please specify | NVARCHAR(500) | |
Area where near miss/hazard recognition occurred | NVARCHAR(100) | |
Please specify | NVARCHAR(100) | |
Investigation Conducted By | NVARCHAR(100) | |
Investigation Conducted Date | DATETIME | |
Contributing Factor/Immediate Cause | ||
Contributing Factor Type (Parent) | NVARCHAR(500) | |
Contributing Factor/Immediate Cause | NVARCHAR(100) | |
Comments | NVARCHAR(250) | |
5 Why? Methodology | ||
Select Action or Condition that may have directly caused incident | NVARCHAR(100) | |
Why or what created the scenario above to affect the action or condition | NVARCHAR(2000) | |
Final Root Cause/Basic Cause Checked | NVARCHAR(100) | |
Root Cause/Basic Cause Analysis | ||
Root cause Type (Parent) | NVARCHAR(100) | |
Root Cause/Basic Cause Analysis | NVARCHAR(100) | |
Comments | NVARCHAR(250) | |
Action Items | ||
Source ID | NVARCHAR(400) | |
Source Title | NVARCHAR(400) | |
Action Item Title | NVARCHAR(500) | |
Action Item Category | NVARCHAR(100) | |
Action Item Type | NVARCHAR(100) | |
Action Item Description | NVARCHAR(2000) | |
Action Item Priority | NVARCHAR(100) | |
Due Date | DATETIME | |
Owners | NVARCHAR(100) | |
Assigned By | NVARCHAR(100) | |
Verification Required | NVARCHAR(100) | |
Verify User | NVARCHAR(100) | |
Action Item Status | NVARCHAR(100) | |
Action Taken | NVARCHAR(2000) | |
Completed By | NVARCHAR(100) | |
Action Item Completed Date | DATETIME | |
Verification Status | NVARCHAR(100) | |
Verification Performed | NVARCHAR(100) | |
Verified By | NVARCHAR(100) | |
Verification Date | DATETIME | |
Comments | NVARCHAR(2000) |
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.
Name | Description | Type | Additional information |
---|---|---|---|
locationCode | Represents the unique code of location for which Incident records to return. | string | Required |
dateFrom | Represents the starting date of Incident records to return. | date | Required but value optional |
dateTo | Represents the ending date of Incident records to return. | date | Required but value optional |
lastSyncedDate | Represents the data from incident created date or incident modified date. | date | Required but value optional |
Headers
Name | Description | Sample |
---|---|---|
Authorization | Represents the value of the authentication token. Allow multiple values: no. | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... |
ConsumerId | Represents the value of the consumer id. Allow multiple values: no. | 2222 |
Response
Sample:
{
"Injury/Illness Incident Detail": {
"Incident Details": {
"Incident ID": "Sample String",
"Incident Title/Site": "Sample String",
"Incident Type": "Injury/Illness",
"Location Code": "Decatur IN",
"Were multiple people injured as part of this incident?": "No"
},
"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",
"Operating Unit": "Sample String",
"Location of Injury Scene": "Sample String"
},
"Employee / Individual Details": [
{
"Personnel Type": "Employee",
"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",
"Supervisor Phone": "Sample String",
"Home Address": "Sample String",
"City": "Sample String",
"State": "Sample String",
"Home Postal Zip Code": "Sample String",
"Phone Number": "Sample String",
"Marital Status": "Sample String",
"Years atBunge": "Sample String",
"Number of Dependents": "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",
"State Hired": "Sample String",
"Employment Status": "Sample String",
"Was employee paid in full for date of injury?": "Sample String",
"Any Prior WC Injuries?": "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",
"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"
}
],
"RIDDOR Classification": [],
"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",
"Postal Code/Zip Code": "Sample String",
"Employer Location Code": "Sample String",
"Employer SIC": "Sample String",
"Nature of Business": "Sample String"
}
],
"Injury Information": [
{
"Is this Claim work related?": "Sample String",
"Did this 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",
"Has the employee returned to work?": "Sample String",
"Date Returned to Work": "Sample String",
"Estimated Return to Work Date": "Sample String",
"Requires Sharp Injury Log": "Sample String"
}
],
"Medical Information": [
{
"Was employee sent to Hospital / Clinic to receive Medical Treatment?": "Sample String",
"Initial Medical Treatment": "Sample String",
"Hospital / Clinic Name": "Sample String",
"Hospital Address": "Sample String",
"Hospital City": "Sample String",
"Hospital State": "Sample String",
"Hospital Zip": "Sample String",
"Hospital Phone": "Sample String",
"Hospital Fax": "Sample String",
"Clinic/Doctor Name": "Sample String"
}
],
"Witness Information": {
"Are there any Witnesses identified?": "Sample String",
"Number of Witnesses": 0,
"Witness Information": ["Sample String","Sample String"]
},
"Additional Comments and Information": [
{
"Do you question the Validity of the claim?": "Sample String",
"If yes, provide the details": "Sample String",
"Other Comments": "Sample String"
}
],
"Additional Claim Information": [
{
"Claim Form Completed": "Sample String",
"Claim Submission Status": "Sample String",
"Claim Submitted By": "Sample String",
"Claim Submitted Date": "Sample String",
"Claim Status": "Sample String",
"Date Claim Closed": "Sample String",
"Total Cost Incurred": "Sample String",
"Total Cost Paid": "Sample String",
"Total Outstanding Cost": "Sample String",
"Total Developed Cost": "Sample String"
}
],
"Report Prepared By": [
{
"Name": "Sample String",
"Title": "Sample String",
"Phone": "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 Company 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",
"Date": "Sample String",
"Comments": "Sample String",
"Completed By": "Sample String",
"Title": "Sample String",
"Phone": "Sample String"
}
],
"Case Classification and Progress Tracking": {
"First Aid": [
{
"Employee Name": "Sample String",
"Classification of Case": "Sample String",
"Date First Aid Provided": "Sample String",
"Reason for Classification": "Sample String",
"Comments": "Sample String",
"Official Medical Diagnosis (Nature of Injury / Illness)": "Sample String",
"Was the Corporate Medical Director contacted?": "Sample String",
"Was Medical Treatment Rejected?": "Sample String",
"Reason for Refusal": "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"
}
]
}
},
"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": ["Sample String"],
"Contributing Factor/Immediate Cause": ["Sample String"],
"5 Why? Methodology": ["Sample String"],
"Root Cause/Basic Cause Analysis": ["Sample String"],
"Final root cause statement": ["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",
"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"
}
]
}
Injury/Illness and Claim Field List
Section | Field Name | Database Column Size |
---|---|---|
Incident Detail | ||
Incident ID * | NVARCHAR(400) | |
Internal Incident ID | NVARCHAR(200) | |
Incident Title/Site* | NVARCHAR(400) | |
Incident Type * | INT | |
Were multiple people injured as part of this incident? | NVARCHAR(50) | |
General Details | ||
Is this a MSHA Related Incident*? | NVARCHAR(100) | |
Date of Incident * | DATETIME | |
Time of Incident * | NVARCHAR(100) | |
Time undetermined | NVARCHAR(10) | |
Day Of Week ** | NVARCHAR(100) | |
Length of Normal Workday | NVARCHAR(100) | |
Work Shift ** | INT | |
Time Work Day Began ** | NVARCHAR(200) | |
Description of Incident * | NVARCHAR(8000) | |
Incident Occurred on Employer's Premises * | NVARCHAR(6) | |
Address of Incident Location * | NVARCHAR(1000) | |
City * | NVARCHAR(100) | |
County | NVARCHAR(100) | |
Country * | NVARCHAR(100) | |
State/Province * | NVARCHAR(100) | |
Postal Code/Zip Code | NVARCHAR(100) | |
Department * | INT | |
Department where the incident/injury occurred | INT | |
Location of Injury Scene | NVARCHAR(1000) | |
Date and Time Reported to Employer | DATETIME | |
NVARCHAR(200) | ||
Confirm Significance level of incident | INT | |
Employee / Individual Details | ||
Would you like to submit a Workers Compensation claim? * | NVARCHAR(100) | |
Personnel Type * | INT | |
Employee / Individual Involved ( Last, First, M.I.) * | NVARCHAR(200), NVARCHAR(200), NVARCHAR(200) | |
Employee Id * | NVARCHAR(200) | |
Employee's Social Security Number ** | NVARCHAR(200) | |
Date of Birth ** | datetime | |
Gender ** | NVARCHAR(200) | |
Occupation/Job Title ** | NVARCHAR(200) | |
Hire Date ** | DATETIME | |
Time in Current job | INT | |
Employee / Individual Department | INT | |
Supervisor ( Last, First, M.I) | INT | |
Supervisor's Email | NVARCHAR(50) | |
Supervisor Phone | NVARCHAR(50) | |
Home Address | NVARCHAR(500) | |
City | NVARCHAR(50) | |
State | NVARCHAR(50) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Home Phone Number | NVARCHAR(50) | |
Marital Status | NVARCHAR(50) | |
Years at "Company" | NVARCHAR(50) | |
Number Of Dependents | INT | |
Type of Employment | NVARCHAR(100) | |
Current Weekly Wage | FLOAT | |
Hourly Wage | FLOAT | |
Hours Worked per Week | FLOAT | |
Days worked Per Week | INT | |
Hours worked Per Day | INT | |
State Hired | NVARCHAR(50) | |
Employment Status | NVARCHAR(50) | |
Was Employee Paid in Full for Date of Injury? | NVARCHAR(50) | |
Any Prior WC Injuries? | NVARCHAR(50) | |
Do you want to further classify Unsupervised Contract Employee | NVARCHAR(50) | |
Type of Client Personnel | NVARCHAR(20) | |
Client Company | NVARCHAR(100) | |
Name of Contractor | NVARCHAR(800) | |
Name of Sub-Contractor | NVARCHAR(800) | |
Will employee's salary continue? | NVARCHAR(50) | |
Injury/Illness Summary | ||
Was Employee treated offsite? ** | NVARCHAR(50) | |
Where was employee treated | NVARCHAR(1000) | |
Explain Why | ||
If this injury had occurred in a slightly different matter, could it have caused a serious injury or fatality | ||
Did this incident involve an in-patient hospitalization, amputation, or a loss of an eye? | ||
Has OSHA been contacted? | ||
Please Identify OSHA Contact Details (Name and Phone Number) | ||
Nature of Injury / Illness ** | INT | |
Cause of Illness/Injury ** | INT | |
Injured Body Part ** | INT | |
What was the employee doing just before the incident occurred? * | NVARCHAR(4000) | |
Please describe what object or substance directly harmed the employee? If this question does not apply, enter “not applicable” ** | NVARCHAR(MAX) | |
Specific Work Activity when the incident occurred | NVARCHAR(4000) | |
Was any Machine / Equipment involved? | NVARCHAR(4000) | |
Machine/Equipment Number | NVARCHAR(100) | |
Reviewed by EHS Representative | NVARCHAR(4000) | |
Review Date | DATETIME | |
Is this a Needlestick Injury? | VARCHAR(50) | |
Type | NVARCHAR(100) | |
Brand | NVARCHAR(100) | |
Model | NVARCHAR(100) | |
Identify Initial Treatment | INT | |
Was Drug Testing Performed? | NVARCHAR(10) | |
Explain Why | [NVARCHAR](1000) | |
RIDDOR Classification | ||
RIDDOR Classification | INT | |
Employer Information | ||
Health & Safety / WC Contact Name | NVARCHAR(50) | |
Telephone Number | NVARCHAR(50) | |
Title | NVARCHAR(50) | |
Mailing Address | NVARCHAR(500) | |
City | NVARCHAR(50) | |
State | NVARCHAR(20) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Employer Location Code | NVARCHAR(50) | |
Employer SIC | NVARCHAR(50) | |
Nature of Business | NVARCHAR(500) | |
Employer FEIN Number | NVARCHAR(20) | |
Employer Name | NVARCHAR (100) | |
Injury Information | ||
Workers Comp Claim# | NVARCHAR(50) | |
Is This Claim Work Related | NVARCHAR (50) | |
Jurisdiction State | NVARCHAR (100) | |
Did the incident result in fatality? | NVARCHAR(50) | |
Date fatality occurred | DATETIME | |
Did the employee lose any time from work? | NVARCHAR(50) | |
What was the first full day out? | DATETIME | |
Do you know the Date Employee Last Worked? | NVARCHAR(50) | |
Date Employee Last Worked | DATETIME | |
Has the employee returned to work? | NVARCHAR(50) | |
Date Returned to Work | DATETIME | |
Return to Work Status | NVARCHAR(50) | |
Estimated Return to Work Date | DATETIME | |
Reqs Sharps Inj Log | NVARCHAR(50) | |
Medical Information | ||
Was employee sent to Hospital / Clinic to receive Medical Treatment? ** | NVARCHAR(50) | |
Initial Medical Treatment | NNVARCHAR(50) | |
Hospital / Clinic Name | NVARCHAR(500) | |
Address | NVARCHAR(500) | |
City | NVARCHAR(50) | |
State | NVARCHAR(50) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Fax | NVARCHAR(50) | |
Clinic/Doctor Name | NVARCHAR(50) | |
Additional Comments and Information | ||
Do you question the Validity of the claim? | NVARCHAR(50) | |
Provide details | NVARCHAR(500) | |
Other Comments | NVARCHAR(500) | |
Additional Claim Information | ||
Claim Form Completed | NVARCHAR(100) | |
Claim Submission Status | NVARCHAR(200) | |
Claim Submitted By | NVARCHAR(200) | |
Claim Submitted Date | DATETIME | |
Claim Status | NVARCHAR(100) | |
Date Claim Closed | DATETIME | |
Total Cost Incurred | FLOAT | |
Total Cost Paid | FLOAT | |
Total Outstanding Cost | FLOAT | |
Total Developed Cost | FLOAT | |
Witness Information | ||
Are there any Witnesses identified? | NVARCHAR(20) | |
Number of Witnesses | INT | |
Last Name | NVARCHAR(50) | |
First Name | NVARCHAR(50) | |
Middle Name | NVARCHAR(50) | |
Phone Number | NVARCHAR(100) | |
Notes | NVARCHAR(2000) | |
Witness relation to <CUSTOMER> Coworker, friend, public, supervisor, venue employee | NVARCHAR(500) | |
Report Prepared By: | ||
Name | NVARCHAR(50) | |
Title | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Additional Incident Information | ||
Incident Status | NVARCHAR(100) | |
Created By | NVARCHAR(100) | |
Created Date | DATETIME | |
Last Updated By | NVARCHAR(100) | |
Last Updated Date | DATETIME |
Case Management Field List
Section | Field Name | Database Column Size |
---|---|---|
Classification Of Case | ||
Case Number | NVARCHAR(500) | |
Was this case Work-Related? | NVARCHAR(50) | |
Describe the reason for the "Non Work Related" classification | NVARCHAR(1000) | |
Did this incident result in a fatality? | NVARCHAR(100) | |
Did this incident result in an amputation, fractured/cracked bone(s) (including teeth), or loss of consciousness? | NVARCHAR(100) | |
Did the incident result in work restrictions, lost time or job transfer? | NVARCHAR(100) | |
Was Treatment Provided beyond First Aid? (Prescription strength medications, Application of wound closing devices, Intravenous Fluids). | NVARCHAR(100) | |
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? | NVARCHAR(100) | |
Was treatment defined as "First Aid" provided? | NVARCHAR(100) | |
This is a First Aid Case, identify the specific treatment(s) provided. | INT | |
Is This a Company defined Recordable Case ? | NVARCHAR(50) | |
Describe the reason for the "Not Recordable" classification | NVARCHAR(500) | |
Is this Case Recordable According to Local Recordkeeping Requirements? | NVARCHAR(50) | |
Does this meet FCA's requirement for FAI classification | NVARCHAR(50) | |
Did this case involve a chronic injury, a strain or a sprain? * | NVARCHAR(50) | |
Date reported to Health Care Center | DATETIME | |
Time reported to Health Care Center | NVARCHAR(50) | |
Case Status | NVARCHAR(50) | |
Date | DATETIME | |
Comments/Notes | NVARCHAR(MAX) | |
Completed By | INT | |
Title | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Case Progression Tracking | ||
Employee Name | NVARCHAR(200) | |
Classification of Case | NVARCHAR(50) | |
Date Reported | DATETIME | |
Date First Aid Provided | DATETIME | |
Date other Recordable case Occurred | DATETIME | |
First Day of Restricted Duty | DATETIME | |
Last Day of Restricted Duty | DATETIME | |
First Day of Lost Time | DATETIME | |
Last Day of Lost Time | DATETIME | |
Date Fatality Occurred | DATETIME | |
Reason for Classification | NVARCHAR(500) | |
Reason for Classification | NVARCHAR(500) | |
Is This A Defense Based Act Case? | NVARCHAR(50) | |
Is This A Compensable Case? | NVARCHAR(50) | |
Comments/Notes | NVARCHAR(500) | |
Official Medical Diagnosis (Nature of Injury / Illness) | NVARCHAR(100) | |
Was the Corporate Medical Director contacted? | NVARCHAR(50) | |
Was medical Treatment Rejected? | NVARCHAR(50) | |
Reason for Refusal | NVARCHAR(500) | |
Was Treatment Provided beyond First Aid?(Prescription strength medications, Application of wound closing devices, Intravenous Fluids) | NVARCHAR(50) | |
Was Treatment provided offsite? | NVARCHAR(10) | |
Hospital/Clinic Name | NVARCHAR(500) | |
Type | NVARCHAR(50) | |
Physician/Health care Provider | NVARCHAR(50) | |
Street | NVARCHAR(200) | |
City | NVARCHAR(100) | |
Country | INT | |
State | NVARCHAR(50) | |
Postal Code/Zip Code | NVARCHAR(50) | |
Phone | NVARCHAR(50) | |
Fax | NVARCHAR(100) | |
Was the employee treated in an emergency room | NVARCHAR(50) | |
Was employee hospitalized overnight as an in-patient | NVARCHAR(50) | |
Recording/Revision Date | DATETIME |
Investigation Sections Field List (Common to All Incident Types)
Section | Field Name | Database Column Size |
---|---|---|
Investigation Responsibility | ||
Responsible Team * | ||
Target Completion Date * | DATE | |
Note/Comments | NVARCHAR(2000) | |
Investigation Questions | ||
All Questions | NVARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Dependencies | INT / INT | |
Questions Configuration based on Business Types & Operation Types (Near Miss & Injury / Illness) | INT / INT / INT | |
Ergonomic Analysis (Applicable only when respective question in Investigation Details is answered as Yes) | ||
All Questions | VARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Picklist Answer | NVARCHAR(500) | |
All Dependencies | INT / INT | |
Incident Specific Questions and its answers | INT / INT / INT | |
Contributing Factors | ||
Contributing Factors | INT / INT | |
5 Why ? Methodology | ||
Root Cause Evaluation | INT / INT | |
Contributing Factors | INT / NVARCHAR(50) | |
Whys | NVARCHAR(2000) | |
Check this box (If the above is FINAL ROOT CAUSE) | NVARCHAR(2000) | |
Root Cause Analysis | ||
Root Cause analysis | INT / INT | |
Comments | ||
Final Root Cause Statement | ||
Final Root cause statement | Nvarchar(4000) | |
Primary Countermeasure | INT / INT | |
Primary Root Cause | INT | |
Release / Impacts | ||
Environmental Media | INT | |
Impacts | Nvarchar(500) | |
Comments/Notes | Nvarchar(500) | |
Critique of response / Follow up | ||
All Questions | NVARCHAR(2000) | |
All Answers | NVARCHAR(500) | |
All Dependencies | INT / INT |
Action Item Field List (Common to All Incident Types)
Section | Field Name | Database Column Size |
---|---|---|
Source Details | ||
Source ID | NVARCHAR(400) | |
Source Title | NVARCHAR(400) | |
Management Review Role | VARCHAR(50) | |
TMS Enabled Department | NVARCHAR(50) | |
TMS Work Order Number | NVARCHAR(100) | |
Create | ||
Action Item Title | NVARCHAR(50) | |
Action Item Category | ||
Action Item Type | NVARCHAR(50) | |
Root Cause | ||
Action Item Description | NVARCHAR(2000) | |
Action Item Priority | ||
Action Item Due Date | DATETIME | |
Owner | INT, NVARCHAR(50) | |
Responsible Department | INT | |
Countermeasure | INT | |
Applicable to Expansion? | NVARCHAR(10) | |
Description of Actions to be Expanded * | NVARCHAR(1000) | |
Applicable to EEM/EPM Info ? | NVARCHAR(10) | |
EEM / EPM * | NVARCHAR(10) | |
EEM/EPM Info Submitted ? | NVARCHAR(10) | |
Document Number * | NVARCHAR(200) | |
Assigned By | VARCHAR(50) | |
Verification required | INT | |
Verify User | ||
Approval | ||
Approval Status | INT | |
Approvers | ||
Approval Comment | NVARCHAR(2000) | |
Approval Date | DATETIME | |
Complete | ||
Action Item Status | ||
Action Taken | NVARCHAR(2000) | |
Action item Completed By | VARCHAR(50) | |
Action item Completed Date | DATETIME | |
Due Date Extension | NVARCHAR(50) | |
Requested Due Date Extension | NCHAR(10) | |
Reason for Due Date Extension | NVARCHAR(2000) | |
Due Date Extension Request Approved? | NVARCHAR(2000) | |
Reason for not extending the Due Date. | DATETIME | |
Review/Verify | ||
Verification Status | INT | |
Verification Performed | VARCHAR(50) | |
Verified By | INT | |
Verification Date | DATETIME | |
Comments | NVARCHAR(2000) | |
Cost Information | ||
Capital Expenditure involved | ||
Approximate cost | ||
Estimated Budget |
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:
Question | Outcome |
---|---|
We would like to start playing with Location (papi/v1/location) and IMS (papi/v1/ims) services and I have a few questions. | Data would be exposed per Location |
I assume we have to use the App (papi/v1/auth/app) Endpoint to obtain the authentication token for our Integration application to submit further requests. How can we obtain ConsumerId, App Id and ConsumerKey? How long the token is valid? How will we find out that the token has expired (HTTP 401,403)? | Any Existing Valid User credentials along with the ConsumerKey can be used to call the Auth API.PMAP would provide the Unique ConsumerKey to the Customer. If the User is valid, an Authorization Token is generated which can be used further in the Header to call Module Endpoints.If it is successful, data can be extracted else HTTP 401 Error is thrown. Each Authorization Token is valid for lifetime unless there is any change in the ConsumerKey. User can request PMAP to reset the Token anytime. |
How can we obtain UserId required for papi/v1/locations/all/{UserId} and other services? Does UserId identify Bunge as a user among other customers? | Yes.. Any Existing Valid User credentials for any specific customer can be used to call the Auth API. |
papi/v1/ims/incidents service specifies that LocationId is required and accepts only a single value. Does it mean that we have to submit a request for each location? Can you describe the effect of the lastSynced parameter? | Yes.For now the data can be viewed for one Location only per request. |