Webhook Callbacks

This section contains an overview of the models that are in the HTTP POST payload of a webhook callback. Refer to Webhooks for more information on how to register a webhook.

DatasetScanCompleted

Model used in the HTTP POST request triggered by an event of type DatasetScanCompleted. This event occurs whenever a dataset scan has completed. The outcome of the scan and the matches found are included in the model.

id
string <uuid>

Unique identifier for this dataset scan.

started
string <date-time>

Timestamp when this scan was started.

completed
string <date-time>

Timestamp at which the scan was completed or failed. If empty the scan is still running.

type
string

The type of records that are being scanned.

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

The identifier of the provider that is associated with this scan, if any.

provider
any
Deprecated

The provider model that is associated with this scan, if any.

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"
object (DatasetScanOptions)
object (FailureModel)

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.

statusDescription
any
Array of any (IProviderParameter)

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.

Array of objects (DatasetMatchModel)

Array of records that match the input data for this scan.

object (MonitoringMetadata)
verifiedAt
string <date-time>

Indicates the most recent time that the verification was performed successfully.

{
  • "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",
  • "provider": null,
  • "trigger": "Manual",
  • "options": {
    },
  • "failureReason": {
    },
  • "statusDescription": null,
  • "parameters": [
    ],
  • "matches": [
    ],
  • "monitoringMetadata": {
    },
  • "verifiedAt": "2019-08-24T14:15:22Z"
}

ExportCompleted

Model used in the HTTP POST request triggered by an event of type ExportCompleted. This event occurs whenever a PDF export of the license has been generated. The full path to the PDF export can be found in the model.

providerId
string <uuid>

Identifier of the provider associated with this license.

licenseNumber
string

The license number used when attaching this license to the provider.

firstName
string

Provider first name number used when attaching this license to the provider.

lastName
string

Provider last name used when attaching this license to the provider.

state
string

State associated with the license.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
object (NonVerifiedLicenseInfoModel)
currentVerificationStatus
string

Status of the last requested verification for this license.

Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (LicenseVerificationModel)
restrictionStatus
string

Restriction status for the license. None is a default value.

Enum: "None" "Restricted" "Unrestricted"
approvedStatus
string

Approval status for the license. Pending is a default value.

Enum: "Pending" "Yes" "No"
isPrimary
boolean

If the flag is set, license will be set as primary for the provider.

id
string <uuid>

Unique identifier for this specific license.

isCurrentlyPracticing
boolean

Indicates whether the provider is currently practicing in this state.

prescriptiveAuthority
string

The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.

Enum: "RequiredMet" "RequiredNotMet" "NotRequired"
collaboratingProviderId
string <uuid>

Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

object (SimplifiedLicenseTypeModel)
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}

LicenseChanged

Model used in the HTTP POST request triggered by an event of type LicenseChanged. This event occurs whenever the primary source results from the currentVerification object changes for a monitored license. The license object including the verification data is included in the model.

providerId
string <uuid>

Identifier of the provider associated with this license.

licenseNumber
string

The license number used when attaching this license to the provider.

firstName
string

Provider first name number used when attaching this license to the provider.

lastName
string

Provider last name used when attaching this license to the provider.

state
string

State associated with the license.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
object (NonVerifiedLicenseInfoModel)
currentVerificationStatus
string

Status of the last requested verification for this license.

Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (LicenseVerificationModel)
restrictionStatus
string

Restriction status for the license. None is a default value.

Enum: "None" "Restricted" "Unrestricted"
approvedStatus
string

Approval status for the license. Pending is a default value.

Enum: "Pending" "Yes" "No"
isPrimary
boolean

If the flag is set, license will be set as primary for the provider.

id
string <uuid>

Unique identifier for this specific license.

isCurrentlyPracticing
boolean

Indicates whether the provider is currently practicing in this state.

prescriptiveAuthority
string

The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.

Enum: "RequiredMet" "RequiredNotMet" "NotRequired"
collaboratingProviderId
string <uuid>

Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

object (SimplifiedLicenseTypeModel)
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}

LicenseExpired

Model used in the HTTP POST request triggered by an event of type LicenseExpired. This event occurs once when a license has passed the expiry date noted in the primary source. The license in question is included in the model.

providerId
string <uuid>

Identifier of the provider associated with this license.

licenseNumber
string

The license number used when attaching this license to the provider.

firstName
string

Provider first name number used when attaching this license to the provider.

lastName
string

Provider last name used when attaching this license to the provider.

state
string

State associated with the license.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
object (NonVerifiedLicenseInfoModel)
currentVerificationStatus
string

Status of the last requested verification for this license.

Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (LicenseVerificationModel)
restrictionStatus
string

Restriction status for the license. None is a default value.

Enum: "None" "Restricted" "Unrestricted"
approvedStatus
string

Approval status for the license. Pending is a default value.

Enum: "Pending" "Yes" "No"
isPrimary
boolean

If the flag is set, license will be set as primary for the provider.

id
string <uuid>

Unique identifier for this specific license.

isCurrentlyPracticing
boolean

Indicates whether the provider is currently practicing in this state.

prescriptiveAuthority
string

The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.

Enum: "RequiredMet" "RequiredNotMet" "NotRequired"
collaboratingProviderId
string <uuid>

Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

object (SimplifiedLicenseTypeModel)
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}

LicenseExpiresSoon

Model used in the HTTP POST request triggered by an event of type LicenseExpiresSoon. This event occurs once when a license has an expiry date within 60 days. The license in question is included in the model.

providerId
string <uuid>

Identifier of the provider associated with this license.

licenseNumber
string

The license number used when attaching this license to the provider.

firstName
string

Provider first name number used when attaching this license to the provider.

lastName
string

Provider last name used when attaching this license to the provider.

state
string

State associated with the license.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
object (NonVerifiedLicenseInfoModel)
currentVerificationStatus
string

Status of the last requested verification for this license.

Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (LicenseVerificationModel)
restrictionStatus
string

Restriction status for the license. None is a default value.

Enum: "None" "Restricted" "Unrestricted"
approvedStatus
string

Approval status for the license. Pending is a default value.

Enum: "Pending" "Yes" "No"
isPrimary
boolean

If the flag is set, license will be set as primary for the provider.

id
string <uuid>

Unique identifier for this specific license.

isCurrentlyPracticing
boolean

Indicates whether the provider is currently practicing in this state.

prescriptiveAuthority
string

The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.

Enum: "RequiredMet" "RequiredNotMet" "NotRequired"
collaboratingProviderId
string <uuid>

Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

object (SimplifiedLicenseTypeModel)
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}

VerificationCompleted

Model used in the HTTP POST request triggered by an event of type VerificationCompleted. This event occurs whenever a license verification is completed, either successfully or not. Refer to the model to find the current state of the license and the verification.

providerId
string <uuid>

Identifier of the provider associated with this license.

licenseNumber
string

The license number used when attaching this license to the provider.

firstName
string

Provider first name number used when attaching this license to the provider.

lastName
string

Provider last name used when attaching this license to the provider.

state
string

State associated with the license.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
object (NonVerifiedLicenseInfoModel)
currentVerificationStatus
string

Status of the last requested verification for this license.

Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (LicenseVerificationModel)
restrictionStatus
string

Restriction status for the license. None is a default value.

Enum: "None" "Restricted" "Unrestricted"
approvedStatus
string

Approval status for the license. Pending is a default value.

Enum: "Pending" "Yes" "No"
isPrimary
boolean

If the flag is set, license will be set as primary for the provider.

id
string <uuid>

Unique identifier for this specific license.

isCurrentlyPracticing
boolean

Indicates whether the provider is currently practicing in this state.

prescriptiveAuthority
string

The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.

Enum: "RequiredMet" "RequiredNotMet" "NotRequired"
collaboratingProviderId
string <uuid>

Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

object (SimplifiedLicenseTypeModel)
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}

LicenseStatusChanged

Model used in the HTTP POST request triggered by an event of type LicenseStatusChanged. This event occurs whenever the status of the latest verification of a license is modified or when the approved status of a license is modified.

providerId
string <uuid>

Identifier of the provider associated with this license.

licenseNumber
string

The license number used when attaching this license to the provider.

firstName
string

Provider first name number used when attaching this license to the provider.

lastName
string

Provider last name used when attaching this license to the provider.

state
string

State associated with the license.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the license verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
object (NonVerifiedLicenseInfoModel)
currentVerificationStatus
string

Status of the last requested verification for this license.

Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (LicenseVerificationModel)
restrictionStatus
string

Restriction status for the license. None is a default value.

Enum: "None" "Restricted" "Unrestricted"
approvedStatus
string

Approval status for the license. Pending is a default value.

Enum: "Pending" "Yes" "No"
isPrimary
boolean

If the flag is set, license will be set as primary for the provider.

id
string <uuid>

Unique identifier for this specific license.

isCurrentlyPracticing
boolean

Indicates whether the provider is currently practicing in this state.

prescriptiveAuthority
string

The prescriptive authority status identifying whether the license requires a collaborative practice agreement or protocol, and whether the requirement has been met.

Enum: "RequiredMet" "RequiredNotMet" "NotRequired"
collaboratingProviderId
string <uuid>

Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement.

object (SimplifiedLicenseTypeModel)
{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "licenseNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "state": "AL",
  • "jobStatus": "Idle",
  • "nonVerifiedInfo": {
    },
  • "currentVerificationStatus": "Found",
  • "currentVerification": {
    },
  • "restrictionStatus": "None",
  • "approvedStatus": "Pending",
  • "isPrimary": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "isCurrentlyPracticing": true,
  • "prescriptiveAuthority": "RequiredMet",
  • "collaboratingProviderId": "79ac5e55-1b65-4bd8-a907-2b31ef7aa4a6",
  • "licenseType": {
    }
}

ProviderStatusChanged

Model used in the HTTP POST request triggered by an event of type ProviderStatusChanged. This event occurs whenever the credentialing status of a provider is modified.

id
string <uuid>

Unique identifier associated with this provider.

firstName
required
string non-empty

The first (given) name associated with this provider.

lastName
required
string non-empty

The last (family) name associated with this provider.

dateOfBirth
string <date-time>

The date of birth of this provider.

ssn
string

The social security number of this provider.

credentialingStatus
required
string non-empty

The name of credentialing status. The default value is 'Data Collection'.

credentialedDate
string <date-time>

Date this provider was originally credentialed

nextCredentialingDate
string <date>
npi
integer <int64>
deactivated
boolean

If set, the provider is deactivated. Verifications and profile imports can't be triggered for the inactive provider.

deactivatedAt
string <date-time>
Array of objects (ProviderAliasModel)

A list of aliases that this provider is also known by.

Array of objects (ProviderAddressModel)

If set, the provider's addresses will be updated with this value. To remove the addresses pass an empty array.

Array of objects (ProviderEmailModel)

If set, the provider's emails will be updated with this value. To remove the emails pass an empty array.

phone
string

Primary phone number associated with this provider

languages
Array of strings

A list of languages, other than English, this provider speaks.

recredentialedDates
Array of strings <date-time>

A list of dates when this provider was re-credentialed.

object (ProviderTypeModel)
createdAt
string <date-time>

Timestamp when this provider was created.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "ssn": "string",
  • "credentialingStatus": "string",
  • "credentialedDate": "2019-08-24T14:15:22Z",
  • "nextCredentialingDate": "2019-08-24",
  • "npi": 0,
  • "deactivated": true,
  • "deactivatedAt": "2019-08-24T14:15:22Z",
  • "aliases": [
    ],
  • "addresses": [
    ],
  • "emails": [
    ],
  • "phone": "string",
  • "languages": [
    ],
  • "recredentialedDates": [
    ],
  • "providerType": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ProviderProfileImportCompleted

Model used in the HTTP POST request triggered by an event of type ProviderProfileImportCompleted. This event occurs whenever the credentialing status of a provider is modified.

id
string <uuid>

Unique identifier associated with this provider profile import.

providerId
string <uuid>

The provider unique identifier associated with this profile import.

source
string

Source of the import.

Enum: "Npi" "Caqh"
started
string <date-time>

TimeStamp of this import when started

completed
string <date-time>

TimeStamp of this import when completed or null if is still in progress.

status
string

Status of the import. If it is Pending or Working it means that we are busy performing the import. Once the status is Completed or Failed the import is done.

Enum: "Pending" "Working" "Completed" "Failed"
trigger
string

Type of trigger for this import.

Value: "Manual"
failureCode
string

If set it means there was an error during the import or null when no errors happened.

Enum: "DatabaseError" "InvalidImportSourceError" "UnknownError" "ParseError" "NpiSourceError" "ImportError" "ImportRequestError" "SourceError" "NoContent" "BadRequest" "Unauthorized" "Forbidden" "NotFound" "NotAcceptable" "RequestTimeout" "TooManyRequests" "InternalServerError" "BadGateway" "ServiceUnavailable" "GatewayTimeout"
object (FailureModel)

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.

any (ProviderProfileModel)
Array of any (IProviderParameter)
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "source": "Npi",
  • "started": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "status": "Pending",
  • "trigger": "Manual",
  • "failureCode": "DatabaseError",
  • "failureReason": {
    },
  • "profile": {
    },
  • "parameters": [
    ]
}

BoardCertificationVerificationCompleted

Model used in the HTTP POST request triggered by an event of type BoardCertificationVerificationCompleted. This event occurs whenever the board certification verification of a provider is completed.

providerId
string <uuid>

Identifier of the provider associated with this board certification.

jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the board certification verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
currentVerificationStatus
string
Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (NonVerifiedBoardCertificationInfoModel)
object (BoardCertificationQueryInputs)
id
string <uuid>

Unique identifier for this specific board certification.

object (BoardCertificationVerificationModel)
object (BoardCertificationSourceModel)
isPrimary
boolean

If the flag is set, certification will be set as primary for the provider.

{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "jobStatus": "Idle",
  • "currentVerificationStatus": "Found",
  • "nonVerifiedInfo": {
    },
  • "queryInputs": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "currentVerification": {
    },
  • "source": {
    },
  • "isPrimary": true
}

BoardCertificationExportCompleted

Model used in the HTTP POST request triggered by an event of type BoardCertificationExportCompleted. This event occurs whenever the board certification export of a provider is completed.

providerId
string <uuid>

Identifier of the provider associated with this board certification.

jobStatus
string

If the jobStatus is Pending or Working it means that we are busy performing the board certification verification. Once the status is Idle the verification is done.

Enum: "Idle" "Pending" "Working"
currentVerificationStatus
string
Enum: "Found" "Failed" "NeedsReview" "NotFound" "Pending" "Working"
object (NonVerifiedBoardCertificationInfoModel)
object (BoardCertificationQueryInputs)
id
string <uuid>

Unique identifier for this specific board certification.

object (BoardCertificationVerificationModel)
object (BoardCertificationSourceModel)
isPrimary
boolean

If the flag is set, certification will be set as primary for the provider.

{
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "jobStatus": "Idle",
  • "currentVerificationStatus": "Found",
  • "nonVerifiedInfo": {
    },
  • "queryInputs": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "currentVerification": {
    },
  • "source": {
    },
  • "isPrimary": true
}

CredentialingRequestChanged

Model used in the HTTP POST request triggered by an event of type CredentialingRequestChanged. This event occurs whenever the credentialing request of a provider changed.

id
string <uuid>

Unique identifier of the credentialing request.

object (ProviderModel)
object (FacilityModel)
type
string

The type of credentialing request.

Enum: "Initial" "ReCredentialing"
createdAt
string <date-time>

The timestamp when this credentialing request was created.

object (CredentialingRequestEventModel)
Array of objects (CredentialingRequestEventModel)

All events associated with this credentialing request.

priority
string

The priority of credentialing request.

Enum: "Low" "Medium" "High" "Urgent"
isSelfManaged
boolean

If the flag is set, this is a self-managed credentialing request.

object (CredentialingRequestChecklistModel)
object (BaseUserModel)
facilitySpecialtyIds
Array of strings <uuid>

Facility specialties associated with this credentialing request.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": {
    },
  • "type": "Initial",
  • "createdAt": "2019-08-24T14:15:22.0000000Z",
  • "currentEvent": {
    },
  • "allEvents": [
    ],
  • "priority": "Low",
  • "isSelfManaged": true,
  • "checklist": {
    },
  • "owner": {
    },
  • "facilitySpecialtyIds": [
    ]
}

GenerateReport

Model used in the HTTP POST request triggered by an event of type GenerateReport. This event occurs whenever a configurable report of a provider is completed.

id
string <uuid>

The unique identifier of the report entity.

providerId
string <uuid>

The unique identifier of the provider associated with the report.

facilityId
string <uuid>

The unique identifier of the facility associated with the report.

type
string

Format of the report file. For now only PDF is supported.

Value: "Pdf"
startedAt
string <date-time>

Timestamp when the report was started.

completedAt
string <date-time>

Timestamp when the report was completed.

status
string

Status of the report job.

Enum: "Pending" "Working" "Completed" "Failed"
object (FailureModel)

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.

path
string

The path where report will be stored.

object (ReportData)
credentialingRequestId
string <uuid>

The id of credentialing request which check list will be used for report generation. Latest verification data will be used by default if null.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "facilityId": "d7244f5b-52c1-4d27-b4f5-43b1113fc304",
  • "type": "Pdf",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "status": "Pending",
  • "failureReason": {
    },
  • "path": "string",
  • "data": {
    },
  • "credentialingRequestId": "f021af69-ba5c-4380-b7b4-b3b05372ab35"
}

DatasetScanMatchesChanged

Model used in the HTTP POST request triggered when there are changes to the matches on a scan. This event occurs when a scan moves to the Active status, when one or more matches change on a scan in the Active status, or when a match is Accepted or Rejected. The scan and all matches (old and new) are included in the model.

id
string <uuid>

Unique identifier for this dataset scan.

started
string <date-time>

Timestamp when this scan was started.

completed
string <date-time>

Timestamp at which the scan was completed or failed. If empty the scan is still running.

type
string

The type of records that are being scanned.

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

The identifier of the provider that is associated with this scan, if any.

provider
any
Deprecated

The provider model that is associated with this scan, if any.

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"
object (DatasetScanOptions)
object (FailureModel)

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.

statusDescription
any
Array of any (IProviderParameter)

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.

Array of objects (DatasetMatchModel)

Array of records that match the input data for this scan.

object (MonitoringMetadata)
verifiedAt
string <date-time>

Indicates the most recent time that the verification was performed successfully.

{
  • "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",
  • "provider": null,
  • "trigger": "Manual",
  • "options": {
    },
  • "failureReason": {
    },
  • "statusDescription": null,
  • "parameters": [
    ],
  • "matches": [
    ],
  • "monitoringMetadata": {
    },
  • "verifiedAt": "2019-08-24T14:15:22Z"
}

NpdbUpdateRequestRejected

Model used in the HTTP POST request triggered by an event of type NpdbUpdateRequestRejected. This event occurs whenever a NPDB update request has been rejected. Rejected parameters and the error message are included in the model.

message
string

The reason why the update request was rejected by NPDB.

providerId
string <uuid>

The identifier of the provider that is associated with the NPDB update request.

npdbVerificationRequestId
string <uuid>

The identifier of the active NPDB continuous query associated with the NPDB update request.

Array of any (IProviderParameter)
{
  • "message": "string",
  • "providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
  • "npdbVerificationRequestId": "7620d7c5-5442-474b-8df9-f22ad8b60c53",
  • "rejectedParameters": [
    ]
}