Table of Contents style Square
...
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
- 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.
User Interaction
Near Miss
...
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 |
...
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 |
...
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 (System Generated)": "sampleSample string 1String",
"Incident Internal Id (System Generated)Title/Site": "sampleSample string 2String",
"Incident Title (No Personal data to be entered)Type": "sample string 3Injury/Illness", "Incident Type
"Location Code": "sampleDecatur string 4IN",
"Were multiple people injured as part of this incident?": "sample string 5", No"
},
"General Details": {
"Date of Incident": "2019-08-14T12:39:46.403Z", Sample String",
"Time of Incident": "sampleSample string 6String",
"Time undeterminedUndetermined": "sampleSample string 7String",
"Day "Day Of WeekOf Week": "sampleSample string 8String",
"Work Shift": "sampleSample string 9String",
"Time Work Day Began": "sampleSample string 10String",
"Description of Incident": "sampleSample string 11String",
"Incident Occurred on Employer's Premises": "sampleSample string 12String", "Address of Incident Location
"Operating Unit": "sampleSample string 13String", "City
"Location of IncidentInjury LocationScene": "sampleSample string 14String"
},
"Employee / Individual "County of Incident LocationDetails": [
{
"Personnel Type": "sample string 15Employee", "Country of Incident Location
"Employee": {
"Last Name": "sampleSample string 16String", "State/Province of Incident Location
"First Name": "sampleSample string 17String", "Postal Code/Zip Code of Incident Location
"Middle Name": "sampleSample string 18String", "Department
"Salutation": "sampleSample string 19String"
},
"Employee ID": "Location of Injury Scene"Sample String",
"Gender": "sampleSample string 20String", "Would you like to submit a Workers Compensation claim?
"Occupation/Job Title": "sampleSample string 21String", "Personnel Type
"Hire Date": "sampleSample string 22String",
"Employee / Individual Involved (Prefix, First, M.I., Last)Department": "sampleSample string 23String",
"Supervisor (Last,First,MI)": {
"Last Name": "Sample String",
"EmployeeFirst IdName": "sampleSample string 24String",
"Middle Name": "Sample "Gender"String"
},
"Supervisor's Email": "sampleSample string 25String",
"Supervisor Phone": "Sample String",
"Home Address": "Occupation/Job TitleSample String",
"City": "sampleSample string 26String", "Hire Date
"State": "2019-08-14T12:39:46.404Z", "Time in Current job": 1, "Time in Current job Unit": "sample string 27", "Employee / Individual Department": "sample string 28", "Supervisor (First, M.I., Last)": "sample string 29", "Supervisor's Email": "sample string 30", "Supervisor Phone": "sample string 31", "Employee Home Address": "sample string 32", "Employee City": "sample string 33", "Employee State": "sample string 34", "Employee Postal Code/Zip Code": "sample string 35", "Employee Home Phone Number": "sample string 36", "Marital Status": "sample string 37", "Years at Company": 1, "Number Of Dependents": 1, "Current Weekly Wage": 1.1, "Hourly Wage": 1.1, "Hours Worked per Week": 1.1, "Days worked Per Week": 1, "Hours worked Per Day": 1, "State Hired": "sample string 38", "Employment Status": "sample string 39", "Was Employee Paid in Full for Date of Injury?": "sample string 40", "Any Prior WC Injuries?": "sample string 41", "Name of Contractor": "sample string 42", "Name of Sub-Contractor": "sample string 43", "Was Employee treated offsite?": "sample string 44", "Did this incident involve an in-patient hospitalization, amputation, or a loss of an eye?": "sample string 45", "Has OSHA been contacted?": "sample string 46", "Please Identify OSHA Contact Details (Name and Phone Number)": "sample string 47", "Nature of Injury / Illness": "sample string 48", "Cause of Illness/Injury": "sample string 49", "Injured Body Part": "sample string 50", "What was the employee doing just before the incident occurred?": "sample string 51", "Please describe what object or substance directly harmed the employee? If this question does not apply, enter 'not applicable'": "sample string 52", "Most Severe Case": "sample string 53", "Current Case": "sample string 54", "Health & Safety / WC Contact Name": "sample string 55", "Employer Telephone Number": "sample string 56", "Employer Title": "sample string 57", "Employer Mailing Address": "sample string 58", "Employer City": "sample string 59", "Employer State": "sample string 60", "Employer Postal Code/Zip Code": "sample string 61", "Employer Location Code": "sample string 62", "Employer SIC": "sample string 63", "Nature of Business": "sample string 64", "Is This Claim Work Related": "sample string 65", "Did the incident result in fatality?": "sample string 66", "Date fatality occurred": "2019-08-14T12:39:46.406Z", "Did the employee lose any time from work?": "sample string 67", "What was the first full day out?": "2019-08-14T12:39:46.406Z", "Do you know the Date Employee Last Worked?": "sample string 68", "Date Returned to Work": "2019-08-14T12:39:46.407Z", "Estimated Return to Work Date": "2019-08-14T12:39:46.407Z", "Reqs Sharps Inj Log": "sample string 69", "Was employee sent to Hospital / Clinic to receive Medical Treatment?": "sample string 70", "Initial Medical Treatment": "sample string 71", "Hospital / Clinic Name": "sample string 72", "Hospital Address": "sample string 73", "Hospital City": "sample string 74", "Hospital State": "sample string 75", "Hospital Postal Code/Zip Code": "sample string 76", "Hospital Phone": "sample string 77", "Hospital Fax": "sample string 78", "Clinic/Doctor Name": "sample string 79", "Do you question the Validity of the claim?": "sample string 80", "Provide details": "sample string 81", "Other Comments": "sample string 82", "Is Claim Form Completed?": "sample string 83", "Claim Submission Status": "sample string 84", "Claim Submitted By": "sample string 85", "Claim Submitted Date": "2019-08-14T12:39:46.407Z", "Claim Status": "sample string 86", "Date Claim Closed": "2019-08-14T12:39:46.407Z", "Total Cost Incurred": 1.1, "Total Cost Paid": 1.1, "Total Outstanding Cost": 1.1, "Total Developed Cost": 1.1, "Are there any Witnesses identified?": "sample string 87", "Witness Information": [ { "LastName": "sample string 2", "FirstName": "sample string 3", "MiddleName": "sample string 4", "PhoneNumber": "sample string 5", "Notes": "sample string 6" }, { "LastName": "sample string 2", "FirstName": "sample string 3", "MiddleName": "sample string 4", "PhoneNumber": "sample string 5", "Notes": "sample string 6" } ], "Name": "sample string 88", "Title": "sample string 89", "Phone": "sample string 90", "Incident Status": "sample string 91", "Incident Created By": "sample string 92", "Incident Created Date": "2019-08-14T12:39:46.408Z", "Incident Last Updated By": "sample string 93", "Incident Last Updated Date": "2019-08-14T12:39:46.408Z" 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
...