List dataset matches

Returns a page of dataset matches. By default, only matches that have not been rejected are returned. By default, only the most recent matches are returned.

Request
query Parameters
types
Array of strings

If set, the results will only contain matches for the specified dataset types. As opposed to type you can filter on more than 1 different dataset type this way.

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"
userActionNeeded
boolean
referenceId
string <uuid>
includeOldMatches
boolean

If set, the results will contain all dataset matches, otherwise, only matches from the most recent completed scans will be included.

userActionResolution
string
Enum: "Accept" "Reject"
matchRelevance
Array of strings
Items Enum: "Low" "Medium" "High"
object

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

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" "MatchRelevance"
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
Array of strings

If set, the results will only contain scans for providers ih the specified credentialing status.

providerId
string <uuid>
Deprecated

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

providerName
string
Deprecated
providerNpi
integer <int64>
Deprecated
providerDeactivated
boolean
Deprecated

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

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/matches
Response samples
application/json
{
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Id",
  • "sortDirection": "Asc",
  • "sort": {
    }
}