Alert Methods

POST Search

{
  "desc": true,
  "page": 0,
  "size": 0,
  "sortBy": "MONITOREDSUBJECTNAME",
  "type": "string",
  "reviewStatus": [
    "string"
  ],
  "networkIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "businessUnitIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "creationDates": [
    {
      "startDate": "2021-08-23T12:13:51.169Z",
      "endDate": "2021-08-23T12:13:51.169Z",
      "relativeDate": 0
    }
  ],
  "filter": "string",
  "monitoredList": [
    {
      "monitoredProduct": "NPI",
      "source": [
        "OIG_LEIE"
      ],
      "issuer": [
        "string"
      ],
      "type": [
        "string"
      ],
      "status": [
        "NPI_ACTIVE"
      ]
    }
  ]
}

Data Explanation

Object

Description

desc

boolean; optional (default false)

page

number; optional (default 0)

size

number; optional (default 30; max 1000)

sortBy

string (enum); optional; Must be one of "MONITOREDSUBJECTNAME", "NPI", "MONITORPRODUCT", "SOURCENAME", "RESULTSTATUS", "ALERTDATE", or "REVIEWSTATUS"

type

string (enum); optional; Must be one of "individual" or "organization"

reviewStatus

String array (enum); optional; All items must be one of "Resolved", "Under Review", or "Needs Review"

networkIds

string array (uuid); optional

businessUnitIds

string array (uuid); optional

creationDates

Object array; optional; see below for schema

filter

String; optional;

monitoredList

Object array; optional; see below for schema

Page Fields

  • desc: true if the sortBy is applied in descending order, false if it is applied in ascending order
  • page: Which ordered group of "size" results should be returned. The first page of results is page: 0. You can get all of the returned Alerts for a search by making multiple POSTs, incrementing page until (page+1)*size >= total, where page and size are your request-body parameters and total is the value from the response. Limit = 1000.
  • size: The maximum number of Alerts to return in the response, ie the size of a page
  • sortBy: How to sort the results. Default sort order is by Alert ID

Filter Fields

All of these fields are ANDed together (an Alert must match all filters to be returned), with the exception of businessUnitIds and networkIds, which are ORed together (an Alert must match either filter to be returned). If a field is an array, then all of the filter items in that array are ORed together (an Alert must match any filter to be returned

  • type: Filter Alerts by the type of the Monitored-Subject that the Alerts are for (individual or organization).
  • reviewStatus: Filter Alerts by their Review Status. This field is an Array of all Review Statuses you want to filter on.
  • networkIds: Filter Alerts by the IDs of Networks that the Alert’s Monitored-Subject participates in
  • businessUnitIds: Filter Alerts by the IDs of Business Units that the Alert’s Monitored-Subject participates in. A Subject is considered to be participating in a Business Unit if it has a Participation for a Network under that Business Unit. Add null to the array to include Alerts for Subjects that have no Participations
  • creationDates: Filter Alerts by the absolute or relative date that they were created. The startDate and endDate fields of a creationDate object are Date Strings that are expected in the ISO-8601 format ("YYYY-MM-DDTHH:mm:ss. sssZ"). Each object in this array must contain one of the following combinations of fields:
  • startDate: Return all Alerts created after this time
  • endDate: Return all Alerts created before this time
  • startDate and endDate: Return all Alerts created between these two times
  • relativeDate: Return all Alerts created in the last integer number of days set in this field
  • filter: Filter Alerts by Monitored-Subjects’ Names, NPIs, and TINs. Partial/substring matches will return. This filter is applied to all 3 fields.
  • monitoredList: Filter Alerts by the Alert’s Type (monitorProduct, source if applicable, issuer and type if applicable, and status). All filter objects in this array must contain the "monitoredProduct" field. The following fields are available:
  • monitoredProduct: Must be one of: NPI, SSDMF, CMS_PRECLUSION_LIST, EXCLUSIONS, OFAC, OPTOUT, or LICENSES
  • source: This field is only applicable to EXCLUSIONS. It is an array of Strings representing Exclusion-Sources to filter on. Each entry must be one of: SAM_EXCLUSIONS, EPLS, OIG_WAIVERS, OIG_HIGH_RISK, OIG_LEIE, MICHIGAN, COLORADO, NEW_HAMPSHIRE, WASHINGTON, ALASKA, MINNESOTA, MONTANA, NEW_JERSEY, ALABAMA, NEVADA, IOWA, PENNSYLVANIA, VERMONT, WYOMING, FLORIDA, OHIO, NORTH_DAKOTA, CONNECTICUT, MARYLAND, ARKANSAS, ILLINOIS, LOUISIANA, MISSOURI, MISSISSIPPI, NEBRASKA, SOUTH_CAROLINA, WEST_VIRGINIA, GEORGIA, IDAHO, NORTH_CAROLINA, INDIANA, TENNESSEE, NEW_YORK, WASHINGTON_DC, CALIFORNIA, MAINE, DELAWARE, KANSAS, MASSACHUSETTS, TEXAS, HAWAII, KENTUCKY
  • issuer: This field is only applicable to LICENSES. It is an array of Strings representing the mappedIssuer field of the License to filter on. Valid choices are available at the /monitor/license-definition/issuer endpoint.
  • type: This field is only applicable to LICENSES. It is an array of Strings representing the mappedType field of the License to filter on. Valid choices are available at the /monitor/license-definition/type endpoint.
  • status: This field is applicable to all monitoredProduct choices. It is an array of Strings representing resultStatuses to filter on. The following options are available for each Monitor Product:
         NPI: NPI_ACTIVE, NPI_NOT_FOUND, NPI_INACTIVE, NPI_INVALID
         SSDMF: MATCH, NO_MATCH
         CMS_PRECLUSION_LIST: MATCH, NO_MATCH, SUSPECTED_MATCH
         EXCLUSIONS: MATCH, NO_MATCH, SUSPECTED_MATCH
         OFAC: MATCH, NO_MATCH, SUSPECTED_MATCH
         OPTOUT: MATCH, NO_MATCH, SUSPECTED_MATCH
         LICENSES: REVOKED, MORE_INFO_NEEDED, ACTIVE, EXPIRED, FEE_REQUIRED, NOT_FOUND, PROBATION, RESTRICTED, BOARD_PENDING, INACTIVE, SUSPENDED, TEMPORARY, SURRENDERED

API Reference: Get all Alerts

GET (by subjectID)

When getting alerts by subject, you will provide a monitoredSubjectID.
Note: There is a search type = initial or ongoing.

API Reference: Get Alert Overview for a Monitored Subject

GET (by alertID)

After getting which subjects have alerts, you will need to use the alertID to get the alert details.
Note: There is a search type = initial or ongoing.

There are three statuses for alerts (Needs Review, Under Review, and Resolved). When you have finished your view of an alert, place the alert in the Resolved status.

API Reference: Get Alert Details for an Alert

POST (Review status changes)

API Reference: Create Status Change for an Alert