Generate report for an existing provider

Generates report for the specified provider.

Request
path Parameters
providerId
required
string <uuid>

Identifier of the provider to generate report.

Request Body schema: application/json
sections
Array of strings

Report sections to generate.

Items Enum: "BasicInfo" "NpiNumber" "DeaRegistrations" "Licenses" "BoardCertifications" "LiabilityInsurance" "EducationAndTraining" "WorkHistory" "SanctionsAndExclusions" "CaqhProfile"
datasetTypes
Array of strings

Source types for SanctionsAndExclusions section.

Items Enum: "Sam" "MedicareOptOut" "OigFugitives" "OfacSdn" "OfacConsolidated" "OigExclusions" "StateSanctionsAndExclusions" "Npdb" "Dmf" "CmsPreclusion" "Tricare"
deaRecordNumbers
Array of strings

DEA record numbers associated with the provider to include in the report.

licenseIds
Array of strings <uuid>

Unique license identifiers associated with the provider to include in the report.

boardCertificateIds
Array of strings <uuid>

Unique board certificate identifiers associated with the provider to include in the report.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

post/providers/{providerId}/report
Request samples
application/json
{
  • "sections": [
    ],
  • "datasetTypes": [
    ],
  • "deaRecordNumbers": [
    ],
  • "boardCertificateIds": [
    ],
  • "licenseIds": [
    ]
}
Response samples
application/json
"string"