sortDirectionstring
The direction the returned data will be sorted by.
Enum: "Asc" "Desc" sortedBystring
The property by which the returned data will be sorted.
Enum: "Id" "ProviderId" "Started" "Completed" "Type" "ProviderFirstName" "ProviderLastName" providerIdstring <uuid>
If set, the results will only contain scans for this provider.
providerNamestring
If set, the results will only contain scans for providers with the specified name or alias name.
providerNpiinteger <int64>
If set, the results will only contain scans for providers with the specified npi number.
typeArray 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" "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" "AmericanHeartAssociation" parameterSetIdstring <uuid>
If set, the results will only contain scans with the specified parameter set.
referenceIdstring <uuid>
If set, the results will only contain scans with the specified provider info reference id.
statusArray of strings
If set, the results will only contain scans with the specified statuses.
Items Enum: "Pending" "Working" "Completed" "Failed" "Active" credentialingStatusstring
If set, the results will only contain scans for providers in the specified credentialing status.
includeOldScansboolean
If set, the results will contain all dataset scans, otherwise, only the most recent scans will be included.
providerDeactivatedboolean
If set, the results will only contain scans for providers in the specified deactivated status.
hasMonitorboolean
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.
sortobject
If set, the properties and directions the returned data will be sorted by.
offsetinteger <int32>
Deprecated
The offset for the page to start.
cursorstring
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.
countinteger <int32>
The number of items to include in a single page.