Start a dataset scan

Starts a new dataset scan.

Will return a failed scan if required parameters are missing.

Request
Request Body schema: application/json
type
string

The specific dataset that will be scanned.

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" "AmericanHeartAssociation"
providerId
string <uuid>

Identifier of the provider containing data properties to scan for; mutually exclusive with facilityId .

facilityId
string <uuid>

Identifier of the facility containing data properties to scan for; mutually exclusive with providerId.

object (DatasetScanOptions)
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Server Error

post/datasets/scans
Request samples
application/json
{
  • "type": "Sam",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "facilityId": "d7244f5b-52c1-4d27-b4f5-43b1113fc304",
  • "options": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "started": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "type": "Sam",
  • "status": "Pending",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "facilityId": "d7244f5b-52c1-4d27-b4f5-43b1113fc304",
  • "provider": null,
  • "trigger": "Manual",
  • "options": {
    },
  • "failureReason": {
    },
  • "statusDescription": null,
  • "parameters": [
    ],
  • "matches": [
    ],
  • "monitoringMetadata": {
    },
  • "verifiedAt": "2019-08-24T14:15:22Z"
}