How Can We Help?
Events API
| Events API |
| Event Get |
| Request | |
| URL | http{s}:// { server name }/riskmasterapi/events/{eventid} |
| Method | GET |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
 |
application/json Returns a response data with HATEOS |
 |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
 |
Forbidden Access |
| Description | Server name, The IP or machine name of rmA application server. Eventid: event id of event record from EVENT table. |
| Event Create |
| Request | |
| URL | http{s}://{ server name }/RiskmasterAPI/events/event |
| Method | POST |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
| |
application/json Returns a response data with HATEOS |
| |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
|
Forbidden Access |
| Description | Server name, The IP or machine name of rmA application server. |
| Mandatory fields for Event Create |
| Fields in JSON | Description | Sample data |
| eventNumber | Event Number | EV0002376 |
| eventTypeCode | Event Type | “shortCode”:”AH”, “desc”:”Accident & Health”, “id”:2749, “display”:”AH Accident & Health”, “parentCode”:” “, “parentDesc”:”” |
| eventStatusCode | Event Status | “shortCode”:”O”, “desc”:”Open”, “id”:12, “display”:”O Open”, “parentCode”:”O”, “parentDesc”:”Open” |
| dateOfEvent | Date Of Event | 07/04/2017 |
| timeOfEvent | Time Of Event | 12:01 AM |
| dateReported | Date Reported | 10/16/2017 |
| timeReported | Time Reported | 2:00 AM |
| deptEid | Department | “id”:199, “shortCode”:”8-PMC”, “desc”:”Pharmacists Mutual Companies”, “codeTable”:”DEPARTMENT” |
| Event Save |
| Request | |
| URL | http{s}:// { server name }/riskmasterapi/events/event |
| Method | HTTPPUT |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
| |
application/json Returns a response data with HATEOS |
| |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
|
Forbidden Access |
| Description | Server name, The IP or machine name of rmA application server. |
| Data Dictionary for Event Json |
| JSON Fields | UX field | Description | ||
| eventide | Primary key of event record from EVENT table | |||
| addr1 | Event location details | Event location details | ||
| addr2 | ||||
| addr3 | ||||
| addr4 | ||||
| countryCode | ||||
| stated | ||||
| County | ||||
| zipCode | ||||
| City | ||||
| countyOfInjury | County of Injury | County of Injury | ||
| eventNumber | Event number | Event number | ||
| eventTypeCode | Event Type | Event Type | ||
| eventStatusCode | Event Status | Event Status | ||
| eventIndCode | Event Indicator | Event Indicator | ||
| eventDescription | Event Description | Non html content of Event Description | ||
| eventDescription_HTMLComments | Html content of event description | |||
| deptEid | Department | Department on which event is created | ||
| deptInvolvedEid | Department Involved | Department involved | ||
| locationAreaDesc | Location Description | Non html content Location Description | ||
| locationAreaDesc_HTMLComments | HTML content of Location description | |||
| primaryLocCode | Primary Location | Primary Location | ||
| locationTypeCode | Location Type | Location Type | ||
| onPremiseFlag | Event on Premise | Event on Premise | ||
| noOfInjuries | Number Of Injuries | Number Of Injuries | ||
| noOfFatalities | Number Of Fatalities | Number Of Fatalities | ||
| causeCode | Cause code | Cause Code | ||
| dateOfEvent | Date of Event | Date of Event | ||
| timeOfEvent | Time of Event | Time of Event | ||
| dateReported | Date Reported | Date when Event was reported | ||
| timeReported | Time Reported | Time when Event was reported | ||
rptdByEid |
Primary key of entity record who reported the event |
|||
| dateRptdToRm | Date when event was reported to rmA | |||
| dateToFollowUp | Follow Up date | Follow Up date | ||
| datePhysAdvised | Date Physician Advised | Date Physician Advised | ||
| timePhysAdvised | Time Physician Advised | Time Physician Advised | ||
| treatmentGiven | Treatment Given | Treatment Given | ||
| releaseSigned | Release Signed | Release Signed | ||
| deptHeadAdvised | Department Head Advised | Department Head Advised | ||
| physNotes | Physician Notes | Physician Notes | ||
| dateCarrierNotif | Carrier Notified Date | Carrier Notified Date | ||
| injuryFromDate | Injury From | Injury From Date | ||
| injuryToDate | Injury To | Injury To Date | ||
| requireIntervention | Intervention Requested/Required | Intervention Requested/Required | ||
| confRecFlag | Confidential Record | Used for confidential event. | ||
| catastropheNumber | Catastrophe Number | Catastrophe Number | ||
| eventXAction | Actions | Event X Action list | ||
| eventXOutcome | Outcome | Event X OutCome list | ||
| eventQM | Event Quality Management data | |||
| isSupplementalPay | Case Number | Case Number | ||
| MedCaseNumber | Mail to address fields | Address id of on which check will be printed | ||
| medFileCode | Med. File/Category | Med. File/Category | ||
| IrStatusCode | Med. Indicator | Quality management initial review screen control | ||
| irReviewerUid | Reviewer | Quality management initial review screen control | ||
| irReviewerName | Reviewer Name | |||
| irDetermCode | Determination | Quality management initial review screen control | ||
| irReviewDate | Review Date | Quality management initial review screen control | ||
| irFollowUpDate | Follow Up Date | Quality management initial review screen control | ||
| irComments | Comments | Quality management initial review screen control | ||
| irRecActions | Recommendations/Actions | Quality management initial review screen control | ||
| PaStatusCode | Status | Quality management Physician Advisory review screen | ||
| paReviewerEid | Physician | Quality management Physician Advisory review screen | ||
paDetermCode |
Determination |
Quality management Physician Advisory review screen |
||
| paReviewDate | Review Date | Quality management Physician Advisory review screen | ||
| paFollowUpDate | Follow Up Date | Quality management Physician Advisory review screen | ||
| paComments | Comments | Quality management Physician Advisory review screen | ||
| paRecActions | Recommendations/Actions | Quality management Physician Advisory review screen | ||
| cdStatusCode | Status | Quality Management Committee/Department Review screen | ||
| cdCommitteeCode | Committee | Quality Management Committee/Department Review screen | ||
| cdDeptEid | Department | Quality Management Committee/Department Review screen | ||
| cdReviewDate | Review Date | Quality Management Committee/Department Review screen | ||
| cdDetermCode | Determination | Quality Management Committee/Department Review screen | ||
| cdFollowUpDate | Follow Up date | Quality Management Committee/Department Review screen | ||
| cdComments | Comments | Quality Management Committee/Department Review screen | ||
| cdRecActions | Recommendations/Actions | Quality Management Committee/Department Review screen | ||
| qmStatusCode | Status | Quality Management Review screen | ||
| qmReviewerUid | Reviewer | Quality Management Review screen | ||
| qmReviewerName | Reported | Reviewer name | ||
| qmDetermCode | Determination | Quality Management Review screen | ||
| qmReviewDate | Review Date | Quality Management Review screen | ||
| qmCloseDate | Close Date | Quality Management Review screen | ||
| qmComments | Comments | Quality Management Review screen | ||
| qmRecActions | Recommendations/Actions | Quality Management Review screen | ||
| reporterEntity | Reported info tab | Entity Data of Reporter Entity | ||
| Supplementals | Event Supplemental data | |||
| dttmRcdLastUpd | Date time when event record was last modified | |||
| Links | API routes of the operations that can be performed on Event | |||
| associatedEntities | Routes to get list of children of event | |||
| Sysexdata.eventCat | Event Category | Event Category | ||
| Subtitle | Header title | |||
| Syssid | SMS permission ID for EVENT |
