List dataset scans

Returns a page of dataset scans.

Request
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 of strings

If set, the results will only contain scans with the specified dataset types.

Items 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"
parameterSetId
string <uuid>

If set, the results will only contain scans with the specified parameter set.

referenceId
string <uuid>

If set, the results will only contain scans with the specified provider info reference id.

status
Array of strings

If set, the results will only contain scans with the specified statuses.

Items 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 associated with a monitor, or when false, the results will only contain scans not associated with a monitor.

entityType
string

Indicates whether to retrieve credentialing requests for providers or facilities. Defaults to providers.

Enum: "Practitioner" "Facility"
entityId
string <uuid>

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 <int64>

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.

providerId
string <uuid>
Deprecated

If set, the results will only contain scans for this provider.

providerName
string
Deprecated

If set, the results will only contain scans for providers with the specified name or alias name.

providerNpi
integer <int64>
Deprecated

If set, the results will only contain scans for providers with the specified npi number.

providerDeactivated
boolean
Deprecated

If set, the results will only contain scans for providers in the specified deactivated status.

object

If set, the properties and directions the returned data will be sorted by.

offset
integer <int32>
Deprecated

The offset for the page to start.

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 <int32>

The number of items to include in a single page.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/datasets/scans
Response samples
application/json
{
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Id",
  • "sortDirection": "Asc",
  • "sort": {
    }
}