Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
styleSquare

...

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

...

{
"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"
],
"ResponsibleAssigned DepartmentBy": "Sample String",
"ApplicableVerification to ExpansionRequired": "Sample StringYes",
"Description of Actions to be ExpandedVerify User": [
"Sample String"
],
"ApplicableAction to EEM/EPM InfoItem Status": "Sample StringOpen",
"EEMAction / EPMTaken": "Sample String",
"EEM/EPM Info SubmittedCompleted By": "Sample String",
"Document NumberAction Item Completed Date": "Sample String",
"AssignedVerification ByStatus": "Sample StringOpen",
"Verification RequiredPerformed": "YesOnsite",
"VerifyVerified UserBy": [
"Sample String"
],
"ActionVerification Item StatusDate": "Open",
"Action Taken": "Sample String",
"Completed ByComments": "Sample String",
"Action Item 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": "Open",
"Verification Performed": "Onsite",
"Verified By": [
"Sample String"
],
"Verification Date": "Sample String",
"Comments": "Sample String"
}
]
}

Near Miss Field List

...


}
]
}

Near Miss Field List

SectionField NameDatabase Column Size
Incident Detail

Incident ID (System Generated)NVARCHAR(400)

Incident Title/SiteNVARCHAR(400)
General Detail

Incident DateDATETIME

Time of IncidentNVARCHAR(100)

Time UndeterminedNVARCHAR(10)

Day of WeekNVARCHAR(50)

Reported ByNVARCHAR(200)

Work ShiftNVARCHAR(200)

Operating UnitNVARCHAR(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, CompanyNVARCHAR(500)

Is this a stop work?NVARCHAR(200)
Employee / Individual Details  

Was an Employee / Individual involved in the incident?NVARCHAR(50)

Personnel TypeNVARCHAR(50)

First NameNVARCHAR(200)

Middle NameNVARCHAR(200)

Last NameNVARCHAR(200)

SalutationNVARCHAR(200)

Employee IdNVARCHAR(200)

GenderNVARCHAR(200)

Occupation/Job TitleNVARCHAR(200)

Hire DateDATETIME

Employee / Individual DepartmentNVARCHAR(100)

Supervisor First NameNVARCHAR(200)

Supervisor Last NameNVARCHAR(200)

Supervisor Middle NameNVARCHAR(200)

Supervisor's Email NVARCHAR(50)

Name of ContractorNVARCHAR(800)

Name of Sub-ContractorNVARCHAR(800)
Witness Information  

Are there any Witness identified?NVARCHAR(20)

Number of Witnesses INT

First NameNVARCHAR(50)

Middle NameNVARCHAR(50)

Last NameNVARCHAR(50)

Phone NumberNVARCHAR(100)

NotesNVARCHAR(2000)

Investigation Section


Incident StatusNVARCHAR(100)

Created ByNVARCHAR(100)

Created DateDATETIME

Modified DateDATETIME

Modified ByNVARCHAR(100)
Investigation Responsibility

Responsible TeamNVARCHAR(100)

Target Completion DateDATETIME

Note/CommentsNVARCHAR(2000)

Notify Immediate SupervisorNVARCHAR(100)
Investigation Details

Date Reported to ManagementDATETIME

Time Reported to ManagementDATETIME

Is this an HPE?NVARCHAR(100)

Please select Non-HPE TypeNVARCHAR(100)

HPE TypeNVARCHAR(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 CategoryNVARCHAR(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 detailsNVARCHAR(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 specifyNVARCHAR(500)

How severe could the injury have been?NVARCHAR(100)

Length of Normal WorkdayNVARCHAR(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 BeganDATETIME

Specific Work Activity when the incident occurredNVARCHAR(100)

Please specifyNVARCHAR(500)

Area where near miss/hazard recognition occurredNVARCHAR(100)

Please specifyNVARCHAR(100)

Investigation Conducted ByNVARCHAR(100)

Investigation Conducted DateDATETIME
Contributing Factor/Immediate Cause

Contributing Factor Type (Parent)NVARCHAR(500)

Contributing Factor/Immediate CauseNVARCHAR(100)

CommentsNVARCHAR(250)
5 Why? Methodology

Select Action or Condition that may have directly caused incidentNVARCHAR(100)

Why or what created the scenario above to affect the action or conditionNVARCHAR(2000)

Final Root Cause/Basic Cause CheckedNVARCHAR(100)
Root Cause/Basic Cause Analysis

Root cause Type (Parent)NVARCHAR(100)

Root Cause/Basic Cause AnalysisNVARCHAR(100)

CommentsNVARCHAR(250)
Action Items

Source IDNVARCHAR(400)

Source TitleNVARCHAR(400)

Action Item TitleNVARCHAR(500)

Action Item CategoryNVARCHAR(100)

Action Item TypeNVARCHAR(100)

Action Item DescriptionNVARCHAR(2000)

Action Item PriorityNVARCHAR(100)

Due DateDATETIME

OwnersNVARCHAR(100)

Assigned ByNVARCHAR(100)

Verification RequiredNVARCHAR(100)

Verify UserNVARCHAR(100)

Action Item StatusNVARCHAR(100)

Action TakenNVARCHAR(2000)

Completed ByNVARCHAR(100)

Action Item Completed DateDATETIME

Verification StatusNVARCHAR(100)

Verification PerformedNVARCHAR(100)

Verified ByNVARCHAR(100)

Verification DateDATETIME

CommentsNVARCHAR(2000)

Injury/Illness

Incident Details

...

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:

{
    "Incident ID (System Generated)": "sample string 1",
    "Incident Internal Id (System Generated)": "sample string 2",
    "Incident Title (No Personal data to be entered)": "sample string 3",
    "Incident Type": "sample string 4",
    "Were multiple people injured as part of this incident?": "sample string 5",
    "Date of Incident": "2019-08-14T12:39:46.403Z",
    "Time of Incident": "sample string 6",
    "Time undetermined": "sample string 7",
    "Day Of Week": "sample string 8",
    "Work Shift": "sample string 9",
    "Time Work Day Began": "sample string 10",
    "Description of Incident": "sample string 11",
    "Incident Occurred on Employer's Premises": "sample string 12",
    "Address of Incident Location": "sample string 13",
    "City of Incident Location": "sample string 14",
    "County of Incident Location": "sample string 15",
    "Country of Incident Location": "sample string 16",
    "State/Province of Incident Location": "sample string 17",
    "Postal Code/Zip Code of Incident Location": "sample string 18",
    "Department": "sample string 19",
    "Location of Injury Scene": "sample string 20",
    "Would you like to submit a Workers Compensation claim?": "sample string 21",
    "Personnel Type": "sample string 22",
    "Employee / Individual Involved (Prefix, First, M.I., Last)": "sample string 23",
    "Employee Id": "sample string 24",
    "Gender": "sample string 25",
    "Occupation/Job Title": "sample string 26",
    "Hire Date": "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"
  }

...