Initiate monitoring for a provider

Initiate monitoring for a dataset or license for a provider. Please note that not all dataset types support monitoring. Please refer to dataset endpoint to get the capabilities of a dataset.

Request
Request Body schema: application/json
type
required
string

Specify monitoring type, will be used for validation and creating monitor. This will be used along with license id or dataset type

Enum: "Dataset" "License"
providerId
required
string <uuid>

Provider identifier for which the monitor is to be created.

datasetType
string

Specify dataset type for which the monitor is to be created.

Enum: "Sam" "MedicareOptOut" "OigFugitives" "OfacSdn" "OfacConsolidated" "OigExclusions" "StateSanctionsAndExclusions" "Npdb" "Dmf" "Npi" "Nsc" "Dea" "CmsPreclusion" "Tricare" "AmericanBoardofInternalMedicine" "NationalCommissiononCertificationofPhysicianAssistants" "Abms" "NationalBoardforCertifiedCounselors" "AmericanAcademyofNursePractitioners" "NationalBoardofCertificationandRecertificationforNurseAnesthetists" "AmericanOsteopathicAssociation" "AmericanNursesCredentialingCenter" "NationalBoardforCertificationinOccupationalTherapy" "AmericanSpeechLanguageHearingAssociation" "AmericanBoardofFamilyMedicine" "AmericanBoardofPsychiatryandNeurology" "InternationalBoardofLactationConsultantExaminers" "AmericanMidwiferyCertificationBoard" "AmericanDentalBoardofAnesthesiology" "AmericanBoardofClinicalSocialWork" "BoardOfPharmacySpecialties" "AmericanBoardofAllergyandImmunology" "AmericanBoardofOrthodontics" "AmericanBoardofOralMedicine" "AmericanBoardofPediatricDentistry" "AmericanBoardofOralandMaxillofacialSurgery" "AmericanBoardofOralandMaxillofacialRadiology" "AmericanBoardofProsthodontics" "AmericanBoardofOralandMaxillofacialPathology" "AmericanBoardofEndodontics" "AmericanBoardofPeriodontology" "AmericanBoardofOralImplantology" "AmericanBoardofPodiatricMedicine" "AmericanBoardofDentalPublicHealth" "BehaviorAnalystCertificationBoard" "AmericanBoardofGeneralDentistry" "NationalAssociationofSchoolPsychologists" "AmericanBoardofAddictionMedicine" "AmericanBoardofMultipleSpecialtiesinPodiatry" "CommissionOnDieteticRegistration" "AmericanBoardOfObesityMedicine" "NationalCertificationCorporation" "NationalCommissionForCertificationOfAnesthesiologistAssistants" "AmericanRegistryOfRadiologyTechnologists" "AmericanBoardOfAnesthesiology" "AmericanRegistryForDiagnosticMedicalSonography" "NationalBoardOfPhysiciansAndSurgeons" "CardiovascularCredentialingInternational" "NationalCenterForCompetencyTesting" "NationalAssociationOfPhlebotomyTechnicians" "AmericanAlliedHealth" "NationalRegistryOfAlliedHealthProfessionals" "AmericanMedicalTechnologists" "NationalHealthCareerAssociation" "DentalAssistingNationalBoard" "PediatricNursingCertification" "NationalCertificationCommissionForAcupunctureAndOrientalMedicine" "CertificationBoardForMusicTherapists" "AmericanBoardOfChiropracticInternists" "AmericanBoardofPhysicalTherapySpecialties" "AmericanBoardofPhysicianSpecialties" "AmericanHeartAssociation"
licenseId
string <uuid>

Specify license identifier for which the monitor is to be created.

monitoringInterval
string

If set, this will update the monitoring interval for this monitor.
NOTE: Continuous interval is only supported by the NPDB dataset at this time.

Enum: "Continuous" "Daily" "Weekly" "Monthly" "Yearly"
nextMonitoringDate
string <date-time>

If set, this will update the next date at which the data will be monitored.

object (DatasetScanOptions)
triggerImmediateVerification
boolean
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/monitors
Request samples
application/json
{
  • "type": "Dataset",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "datasetType": "Sam",
  • "licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
  • "monitoringInterval": "Monthly",
  • "nextMonitoringDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "triggerImmediateVerification": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Dataset",
  • "monitoringInterval": "Monthly",
  • "nextMonitoringDate": "2019-08-24T14:15:22Z",
  • "lastMonitoringDate": "2019-08-24T14:15:22Z",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "datasetType": "Sam",
  • "options": {
    },
  • "lastVerification": {
    }
}