# List dataset scans Returns a page of dataset scans. Endpoint: GET /datasets/scans Version: 26.2.0.4309 Security: Bearer ## Query parameters: - `sortDirection` (string) The direction the returned data will be sorted by. Enum: "Asc", "Desc" - `sortedBy` (string) The property by which the returned data will be sorted. Enum: "Id", "Started", "Completed", "Type", "ProviderId", "ProviderFirstName", "ProviderLastName", "FacilityId", "FacilityName" - `type` (array) If set, the results will only contain scans with the specified dataset types. 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", "AmericanAcademyofOptometry", "AmericanBoardofNeurologicalSurgery", "AmericanBoardofObstetricsandGynecology", "AmericanBoardofOphthalmology", "AmericanBoardofOtolaryngologyHeadandNeckSurgery", "AmericanBoardofPediatrics", "AmericanBoardofOrthopaedicSurgery", "AmericanBoardofPhysicalMedicineandRehabilitation", "AmericanBoardofPlasticSurgery", "AmericanBoardofRadiology", "AmericanBoardofSurgery", "AmericanBoardofUrology", "AmericanBoardofColonandRectalSurgery", "AmericanAssociationofCriticalCareNurses", "AmericanBoardofFootandAnkleSurgery", "PharmacyTechnicianCertificationBoard", "NationalBoardofSurgicalTechnologyandSurgicalAssisting", "AmericanBoardofPainMedicine", "AmericanBoardofOrofacialPain", "NuclearMedicineTechnologyCertificationBoard", "AmericanBoardofEmergencyMedicine", "ArtTherapyCredentialsBoard", "AmericanHeartAssociation", "MedicaidEnrollmentCalifornia", "JointCommission", "FacilityCmsCertification" - `parameterSetId` (string) If set, the results will only contain scans with the specified parameter set. - `referenceId` (string) If set, the results will only contain scans with the specified provider info reference id. - `status` (array) If set, the results will only contain scans with the specified statuses. Enum: "Pending", "Working", "Completed", "Failed", "Active" - `includeOldScans` (boolean) If set, the results will contain all dataset scans, otherwise, only the most recent scans will be included. - `hasMonitor` (boolean) If set, when true, the results will only contain scans currently associated with a monitor, or when false, the results will only contain scans not currently associated with a monitor. - `trigger` (string) If set, the results will only contain scans with the specified trigger. Enum: "Manual", "Monitor" - `entityType` (string) Indicates whether to retrieve dataset scans for practitioners or facilities. Defaults to Practitioners. Enum: "Practitioner", "Facility" - `entityId` (string) If set, the items will be filtered by the specified entity identifier (providerId or facilityId). - `entityName` (string) If set, the items will be filtered by the specified entity name (provider name/alias or facility name). - `entityNpi` (integer) If set, the items will be filtered by the specified entity NPI number. - `entityDeactivated` (boolean) If set, the items will be filtered by the specified entity deactivated status. - `credentialingStatus` (string) If set, the results will only contain scans for providers in the specified credentialing status. - `sort` (object) If set, the properties and directions the returned data will be sorted by. - `cursor` (string) The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. - `count` (integer) The number of items to include in a single page. - `providerId` (string) If set, the results will only contain scans for this provider. - `providerName` (string) If set, the results will only contain scans for providers with the specified name or alias name. - `providerNpi` (integer) If set, the results will only contain scans for providers with the specified npi number. - `providerDeactivated` (boolean) If set, the results will only contain scans for providers in the specified deactivated status. - `offset` (integer) The offset for the page to start. ## Response 200 fields (application/json): - `sort` (object) The properties and directions the data is sorted by. Example: {"Id":"Asc"} - `sort.Keys` (string) Enum: "Id", "Started", "Completed", "Type", "ProviderId", "ProviderFirstName", "ProviderLastName", "FacilityId", "FacilityName" - `sort.Values` (string) Enum: "Asc", "Desc" - `previousCursor` (string) The value to use for cursor to get to the previous paginated page. null will be returned if it's the first page. Example: "string" - `nextCursor` (string) The value to use for cursor to get to the next paginated page. null will be returned if it's the last page. Example: "string" - `pageSize` (integer) The maximum number of items included in this page. - `count` (integer) The number of items in this page. - `totalCount` (integer) The total number of items in all pages combined. - `items` (array) The entries in the current page. Example: [{"datasetTimestamp":"2019-08-24T14:15:22.0000000Z","recordTimestamp":"2019-08-24T14:15:22.0000000Z","data":{"positiveParameters":[{"addressType":"Unspecified","addressLine":"string","city":"string","state":"AL","zipCode":"string","type":"Name"}],"negativeParameters":[{"addressType":"Unspecified","addressLine":"string","city":"string","state":"AL","zipCode":"string","type":"Name"}]},"scanId":"83d71394-faa2-4b6c-b13b-6d3118de459e","scan":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","started":"2019-08-24T14:15:22.0000000Z","completed":"2019-08-24T14:15:22.0000000Z","type":"Sam","status":"Pending","providerId":"4834bcdc-4a64-444d-966b-1a6fe381da24","trigger":"Manual","options":{"parameterSetId":"4da0bbf1-9705-456b-b2bc-910c426536c6","referenceId":"8502eb05-558d-4480-8511-c1011710b340"},"failureReason":{"messageTemplate":"string","messageParams":{"property1":"string","property2":"string"}},"parameters":[{"addressType":"Unspecified","addressLine":"string","city":"string","state":"AL","zipCode":"string","type":"Name"}],"matches":[{}],"monitoringMetadata":{"monitoringInterval":"Monthly","lastMonitoringDate":"2019-08-24T14:15:22.0000000Z","nextMonitoringDate":"2019-08-24T14:15:22.0000000Z","monitorId":"c26980a6-b967-4775-b2ae-fd35a2a71496"},"verifiedAt":"2019-08-24T14:15:22.0000000Z"},"userActionNeeded":true,"isIgnored":true,"matchScore":{"score":0,"recommendation":"Mismatch"}}] - `items.type` (string) The type of records that are being 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", "AmericanBoardofPhysicianSpecialties", "AmericanAcademyofOptometry", "AmericanBoardofNeurologicalSurgery", "AmericanBoardofObstetricsandGynecology", "AmericanBoardofOphthalmology", "AmericanBoardofOtolaryngologyHeadandNeckSurgery", "AmericanBoardofPediatrics", "AmericanBoardofOrthopaedicSurgery", "AmericanBoardofPhysicalMedicineandRehabilitation", "AmericanBoardofPlasticSurgery", "AmericanBoardofRadiology", "AmericanBoardofSurgery", "AmericanBoardofUrology", "AmericanBoardofColonandRectalSurgery", "AmericanAssociationofCriticalCareNurses", "AmericanBoardofFootandAnkleSurgery", "PharmacyTechnicianCertificationBoard", "NationalBoardofSurgicalTechnologyandSurgicalAssisting", "AmericanBoardofPainMedicine", "AmericanBoardofOrofacialPain", "NuclearMedicineTechnologyCertificationBoard", "AmericanBoardofEmergencyMedicine", "ArtTherapyCredentialsBoard", "AmericanHeartAssociation", "MedicaidEnrollmentCalifornia", "JointCommission", "FacilityCmsCertification" - `items.id` (string) Unique identifier for this dataset scan. - `items.started` (string) Timestamp when this scan was started. - `items.completed` (string) Timestamp at which the scan was completed or failed. If empty the scan is still running. - `items.status` (string) The status of this scan. Pending and Working means the scan is still running. Active means the scan has completed its initial execution and will continue to check for any changes going forward. Completed means it completed successfully, while Failed means there was a problem while scanning and the scan should be retried. Enum: "Pending", "Working", "Completed", "Failed", "Active" - `items.providerId` (string) The identifier of the provider that is associated with this scan, if any. - `items.facilityId` (string) The identifier of the facility that is associated with this scan, if any. - `items.trigger` (string) Set to Manual if the scan is triggered by a user or Monitor if the scan was triggered by the monitoring system. Enum: "Manual", "Monitor" - `items.options` (object) - `items.options.parameterSetId` (string) Set this to override the default parameters that will be used for a dataset scan. If a parameterSetId isn’t specified, we will use the default/preferred parameter set. - `items.options.referenceId` (string) Set this to a provider info that will be used during the dataset scan, if a reference id isn’t supplied, we will use the data from the entity itself, such as name. - `items.failureReason` (object) An object with a reason message template and an array of params. Can be used to construct a meaningful description of the error. Not set when no errors happened. - `items.failureReason.messageTemplate` (string) An informative human readable message describing the verification failure. - `items.failureReason.messageParams` (object) Collection of key/value pairs containing parameters to be replaced in messageTemplate. - `items.statusDescription` (any) - `items.parameters` (array) The parameters that where used for this scan. The array of parameters is constructed from the provider data available at the time of the scan. - `items.matches` (array) Array of records that match the input data for this scan. - `items.matches.id` (string) - `items.matches.datasetTimestamp` (string) The timestamp when the dataset was last updated in our system at the time of this scan. - `items.matches.recordTimestamp` (string) The timestamp when this record was last updated in our system at the time of this scan. - `items.matches.data` (object) - `items.matches.data.positiveParameters` (array) Array of parameters used in the scan which have an explicit positive hit on this record. - `items.matches.data.negativeParameters` (array) Array of parameters used in the scan which have an explicit negative hit on this record. - `items.matches.data.record` (any) The matched data. This model is different for each dataset. Refer to [Dataset Records](/references/api/Dataset-Records) for an overview of models for each dataset. The models are also returned in JSON schema in the [GetDataset](/reference/operation/GetDataset) operation. - `items.matches.scanId` (string) The identifier of the scan to which this match belongs. Not set if scan is populated. - `items.matches.scan` (object) - `items.matches.userActionNeeded` (boolean) Boolean indicating if action is needed for this match. - `items.matches.isIgnored` (boolean) Set to true if this match was ignored for the associated provider. - `items.matches.matchScore` (object) - `items.matches.matchScore.score` (number) - `items.matches.matchScore.recommendation` (string) Enum: "Mismatch", "Match" - `items.matches.userActionResolution` (string) Enum: "Accept", "Reject" - `items.matches.userActionResolutionNote` (string) - `items.matches.matchRelevance` (string) Enum: "Low", "Medium", "High" - `items.matches.createdTimestamp` (string) Indicates the time that the match was added to the scan. Only populated for matches on or after January 25th 2024. - `items.matches.obsoleteTimestamp` (string) Indicates the time that the match became obsolete. This only occurs when a scan with a status of Active determines that the match is now obsolete due to changes in primary source data. - `items.monitoringMetadata` (object) - `items.monitoringMetadata.monitoringInterval` (string) The interval at which the data is being monitored.NOTE: Continuous interval is only supported by the NPDB dataset at this time. Enum: "Continuous", "Daily", "Weekly", "Monthly", "Yearly" - `items.monitoringMetadata.lastMonitoringDate` (string) The previous date on which this data was monitored, if any. - `items.monitoringMetadata.nextMonitoringDate` (string) The next date on which this data is scheduled to be monitored. - `items.monitoringMetadata.monitorId` (string) Unique identifier of the monitor. - `items.verifiedAt` (string) Indicates the most recent time that the verification was performed successfully. - `items.datasetMetadata` (object) - `items.datasetMetadata.importDate` (string) The date of the import file that the dataset scan was compared against. - `items.datasetMetadata.importFileName` (string) The original file name of the dataset source. - `items.provider` (any) The provider model that is associated with this scan, if any. - `sortedBy` (string) The property by which the data is sorted. Enum: "Id", "Started", "Completed", "Type", "ProviderId", "ProviderFirstName", "ProviderLastName", "FacilityId", "FacilityName" - `sortDirection` (string) The direction in which the data is sorted. Enum: "Asc", "Desc" - `nextOffset` (integer) The value to use for offset to get the next page following the current page or null if this page is the last. ## Response 400 fields ## Response 401 fields ## Response 403 fields ## Response 500 fields