How Can We Help?
Claims API
| Claim Screen |
| Claim Get |
| Request | |
| URL | http{s}://{server name }/riskmasterapi/events/{eventid}/claimva/{claimid} |
| Method | HTTPGET |
| 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 associated to claim from EVENT table Formname, claim line of business. It could be claimgc, claimva, claimwc, claimdi, claimpc Claimid, claim id of claim record from CLAIM table. |
| Claim Create |
| Request | |
| URL | http{s}://{server name }/riskmasterapi/events/0/{formname} |
| 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. EventId, event id of event associated to claim from EVENT table Formname, claim line of business. It could be claimgc, claimva, claimwc, claimdi, claimpc |
| Mandatory fields for Claim Create |
| Fields in JSON | Description | Sample data |
| eventNumber | Event Number | EV0002376 |
| claimNumber | Claim Number | GA0006489 |
| claimStatusCode | Claim Status Code | “id”:2545, “shortCode”:”O”, “desc”:”Open”, “codeTable”:”CLAIM_STATUS” |
| claimTypeCode | Claim Type Code | “id”:6664, “shortCode”:”GCL”, “desc”:”GENERAL LIABILITY”, “codeTable”:”CLAIM_TYPE” |
| dateOfClaim | Date Of Claim | 11/01/2010 |
| timeOfClaim | Time Of Claim | 12:00 PM |
| currencyType | Currency Type | “id”:5713, “shortCode”:”USD”, “desc”:”United States|en-US”, “codeTable”:”CURRENCY_TYPE” |
| deptEid | Department | “id”:199, “shortCode”:”8-PMC”, “desc”:”Pharmacists Mutual Companies”, “codeTable”:”DEPARTMENT” |
| policyLOBCode | Policy LOB | “id”:222621, “shortCode”:”APV1″, “desc”:”APV1″, “codeTable”:”POLICY_CLAIM_LOB” |
| sysExData.Event eventNumber | Event Number | EV0002376 |
| sysExData.Event dateOfEvent | Date Of Event | 10/31/2010 |
| sysExData.Event timeOfEvent | Time Of Event | 11:58 AM |
| Claim Save |
| Request | |
| URL | http{s}://{server name}/RiskmasterAPI/events/{eventid}/{Formname} |
| 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 |
| Data Dictionary for Claim Json |
| JSON Fields | UX field | Description |
| errors | Collection of Errors returned from API | |
| primaryPiEmployee | Employee data Json. This will be rendered for Worker’s compensation claim. | |
| propRowId | This defines property unit row id associated to any claim and will be rendered for property claim only. | |
| claimId | Defines primary key from CLAIM table for the specific record. | |
| eventId | Defines record id of EVENT record to which claim is associated . | |
| eventNumber | Event Number | Defines Event number of EVENT record to which claim is associated . |
| claimNumber | Claim Number | Defines claim number of claim record. |
| claimStatusCode | Event Number | Defines claim status. |
| lineOfBusCode | Defines claim’s line of business like General claim, Worker’s compensation claim. | |
| claimTypeCode | Event Number | Claim type |
| dttmClosed | Date Closed | Date time when claim was closed |
| dateOfClaim | Date Of Claim | Date of claim |
| timeOfClaim | Time Of Claim | Time of claim |
| fileNumber | File Number | File number field |
| methodClosedCode | Close Method | Method closed code |
| paymntFrozenFlag | Payments Frozen | Defines if payments associated to specific claim are frozen. |
| lssClaimInd | LSS Claim | If claim is uploaded to LSS |
| vssClaimInd | If claim is uploaded to VSS | |
| Leaveonlyflag | Leave Only | This field is used for Non Occ. Claim. |
| emailAddresses | E-mail ACORD To: | Email address to which accord forms will be sent to |
| mailSent | If accord mail has been sent | |
| submitToISOFlag | If claim is submitted to ISO for verification. | |
| currencyType | Currency Type | Currency in which claim is reported. |
| policyLOBCode | Policy LOB | Policy LOB of claim |
| primaryPolicyId | Policy Name | Policy id of Policy tracking record associated to claim |
| primaryPolicyIdEnh | Policy Name | Policy Id of policy Management record associated to claim. |
| serviceCode | Service Code | Claim Service code |
| dateFddotRpt | Date reported to Federal | |
| dateStdotRpt | Date reported to State | |
| policeAgencyEid | Authority Contacted | rmA Entity id of Authority Contacted record |
| estCollection | Est. Collection | Estimated collection made on claim |
| dateRptdToRm | Claim Date Rptd. | Date on which claim was reported to rmA |
| filingStateId | Jurisdiction | State in which claim was reported |
| planId | Plan Name | Used to Non occ Claim.This is plan Id of plan record associated to claim |
| classRowId | Class Name | Plan class record id. Used for Non occ claim |
| disabilFromDate | Disability Start Date | Start date of employee disability. Used for Non occ claim |
| disabilToDate | Disability To Date | Date till which disability is reported. Used for non occ claim |
| disTypeCode | Benefit distype code | Disability benefit code. Used for Non occ claim. |
| aiaCode12 | AIA Codes 12 | AIA 12 codes. It defines loss information of claim |
| aiaCode34 | AIA Codes 34 | AIA 34 codes. It defines loss information of claim |
| aiaCode56 | AIA Codes 56 | AIA 56 codes. It defines loss information of claim |
| spHandlingFlag | Special Handling Flag | Special handling flag |
| selfInsuredFlag | Self Insured Flag | Self insured flag. |
| dateOfDiscovery | Date of Discovery | Date of discovery |
| reportNumber | Report Number | Report Number |
| catastropheCode | Catastrophe Type | Catastrophe code |
| catastropheRowId | Catastrophe id from CATASTROPHE table | |
| confRecFlag | Confidential Record | Used for confidential claims. |
| claimDescriptionCode | Claim Loss type | Claim loss Type |
| lossDescription | Loss Description | NON –HTML Loss Description |
| lossDescription_HTMLComments | HTML content of Loss Description | |
| noticeDate | Notice Date | Notice Date |
| errorDate | Error Date | Error Date |
| underlyingLossDate | Underlying Loss Date | Underlying Loss Date |
| insuredClaimDeptEid | Insured Department (Claim Level) | Department of claim. It is used if department of claim and event are different |
| clueFaultInd | Fault Indicator | Fault Indicator code |
| clueLossofDispos | Claim/Cause of Loss Disposition | Claim/Cause of Loss Disposition |
| clueReportingStatus | CLUE Reporting Status | CLUE Reporting Status |
| clueRemovalReason | CLUE Removal Reason | CLUE Removal Reason |
| Accord | Data related to Acord Fields | |
| propertyClaim | Data related to property associated to claim. It is used for Property claim | |
| docRetentionDate | Document Retention Date | Document Retention Date |
| exclDeletionFlag | Exclude from Deletion | Exclude from Deletion |
| minorInvolvedFlag | Minor Involved | Minor Involved |
| Jurisdictionals | Data related to jurisdictions. It is used for Worker’s Compensation claim | |
| claimSupervisorId | Claim Supervisor | Claim Supervisor. Used in supervisory approval |
| customHierarchy | Custom Hierarchy | Custom Hierarchy |
| Supplementals | Data related to Supplementals added to claim | |
| dttmRcdLastUpd | Date time when claim record was last modified | |
| Links | It defines API routes for all possible actions that can be done on claim depending upon user’s permission | |
| associatedEntities | It defines API routes for all claim children.User can call these links to fetch list of respective claim child | |
| sysExData.checkPolicyValidation | It is used if policy needs to be validated for current claim | |
| sysExData.claimLetterTmplId | This is template id and is used for Mail merge | |
| sysExData.makePolicyLOBMandatory | It is true if financial key is defined on policy lob or claim is carrier equivalent claim. | |
| sysExData.Hdnselectedpermsusers | Contains list of user ids who have access to claim. Used for confidential claims | |
| sysExData.hidden_DataChanged | If claim data is changed | |
| sysExData.allCodes | Contains all closed claim status code id defined in table maintanence | |
| sysExData.currentAdjuster | Current adjuster | Current adjuster associated to claim |
| sysExData.eventOnPremiseChecked | Event premises flag | |
| sysExData.Event | Defines data related to parent event record | |
| sysExData.Event eventNumber | Event number | |
| eventStatusCode | Event status | |
| sysExData.Event eventTypeCode | Event type | |
| sysExData.Event eventIndCode | Event indicator | |
| sysExData.Event eventDescription | Event Description | Event Description |
| sysExData.Event deptEid | Department | Event Department id |
| sysExData.Event addr1 | Event detail tab | Event location details |
| sysExData.Event Addr2 | ||
| sysExData.Event Addr3 | ||
| sysExData.Event Addr4 | ||
| sysExData.Event City | ||
| sysExData.Event stateId | ||
| sysExData.Event zipCode | ||
| sysExData.Event countryCode | ||
| sysExData.Event locationAreaDesc | Location Description | Event Location Description |
| sysExData.Event primaryLocCode | Event Primary Location | |
| sysExData.Event locationTypeCode | Event Location Type | |
| sysExData.Event onPremiseFlag | Event On Premises flag | |
| sysExData.Event noOfInjuries | Event Number Of Injuries | |
| sysExData.Event Nooffatalities | Event Number Of Fatalities | |
| sysExData.Event causeCode | Event Cause Code | |
| sysExData.Event dateOfEvent | Date of event | Date on which event was occurred |
| sysExData.Event timeOfEvent | Time of Event | Time when event occurred |
| sysExData.Event dateReported | Date when event was reported | |
| sysExData.Event timeReported | Time when event was reported | |
| sysExData.Event rptdByEid | Entity who reported the event | |
| sysExData.Event dateRptdToRm | Date when event was reported to rmA | |
| sysExData.Event dateToFollowUp | Event follow Up date | |
| sysExData.Event datePhysAdvised | Event Date Physician Advised | |
| sysExData.Event timePhysAdvised | Event Time physician advised | |
| sysExData.Event treatmentGiven | Event treatment given | |
| sysExData.Event releaseSigned | Event Release signed | |
| sysExData.Event deptHeadAdvised | Event Department head advised | |
| sysExData.Event physNotes | Event Physician notes | |
| sysExData.Event dateCarrierNotif | Event Carrier Notified Date | |
| sysExData.Event Injfromdate | Event Injury From Date | |
| sysExData.Event injuryToDate | Event Injury To date | |
| sysExData.Event eventDescription_HTMLComments | Event description HTML comments | |
| sysExData.Event locationAreaDesc_HTMLComments | Event Location Description HTML comments | |
| sysExData.Event requireIntervention | Event Intervention Requested/Required | |
| sysExData.Event confRecFlag | True if Event Confidential Record | |
| sysExData.Event catastropheNumber | Event Catastrophe number | |
| sysExData.Event eventXAction | Event Actions Taken | |
| sysExData.Event eventXOutcome | Event Outcome | |
| sysExData.Event eventQM | Date related to Event Quality management | |
| sysExData.Event reporterEntity | Date related to entity who reported event | |
| sysExData.Event Supplementals | Event supplemental data | |
| sysExData.Event dttmRcdLastUpd | Date when event record was last modified | |
| sysExData.subtitle | Title for specific claim record | |
| sysExData.sysSid | SMS permission id for claim record | |
| View | Displays fields which are rendered on APP |
