Dataset Records

This section contains an overview of the models used by the different dataset types. These models can also be discovered via the ListDatasets operation.

MedicareOptOut

Model used for the MedicareOptOut dataset type.

speciality
string or null
effectiveDate
string <date-time>
endDate
string <date-time>
eligibleToOrderAndRefer
boolean
id
string <uuid>
hash
string <uuid>
address
string or null
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
npiNumber
integer or null <int64>
{
  • "speciality": "string",
  • "effectiveDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "eligibleToOrderAndRefer": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "address": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "npiNumber": 0
}

SAM

Model used for the SAM dataset type.

classification
string
Enum: "Unknown" "Firm" "Individual" "SpecialEntityDesignation" "Vessel"
openDataFlag
boolean
duns
string or null
uei
string or null
exclusionProgram
string
Enum: "Unknown" "Reciprocal" "Nonreciprocal" "Procurement" "NonProcurement"
excludingAgency
string or null
ctCode
string or null
exclusionType
string or null
additionalComments
string or null
activeDate
string or null <date-time>
terminationDate
string or null <date-time>
recordStatus
string
Enum: "Active" "Inactive"
crossReference
string or null
samNumber
string or null
cage
string or null
creationDate
string or null <date-time>
id
string <uuid>
hash
string <uuid>
address
string or null
fullName
string or null
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
npiNumber
integer or null <int64>
{
  • "classification": "Unknown",
  • "openDataFlag": true,
  • "duns": "string",
  • "uei": "string",
  • "exclusionProgram": "Unknown",
  • "excludingAgency": "string",
  • "ctCode": "string",
  • "exclusionType": "string",
  • "additionalComments": "string",
  • "activeDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "recordStatus": "Active",
  • "crossReference": "string",
  • "samNumber": "string",
  • "cage": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "address": "string",
  • "fullName": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "npiNumber": 0
}

OFAC

Model used for the OFAC dataset type.

identityNumber
integer <int64>
type
string
Enum: "Individual" "Unknown"
program
string or null
title
string or null
remarks
string or null
Array of objects or null (OfacAddressRecord)
Array of objects or null (OfacAlternateIdentityRecord)
id
string <uuid>
hash
string <uuid>
dateOfBirth
string or null <date-time>
fullName
string or null
{
  • "identityNumber": 0,
  • "type": "Individual",
  • "program": "string",
  • "title": "string",
  • "remarks": "string",
  • "addresses": [
    ],
  • "alternateIdentities": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "fullName": "string"
}

OigFugitives

Model used for the OigFugitives dataset type.

status
string or null
id
string <uuid>
hash
string <uuid>
dateOfBirth
string or null <date-time>
fullName
string or null
{
  • "status": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "fullName": "string"
}

OigExclusions

Model used for the OigExclusions dataset type.

businessName
string or null
general
string or null
specialty
string or null
upin
integer or null <int32>
exclusionType
string or null
exclusionDate
string <date-time>
id
string <uuid>
hash
string <uuid>
address
string or null
dateOfBirth
string or null <date-time>
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
npiNumber
integer or null <int64>
{
  • "businessName": "string",
  • "general": "string",
  • "specialty": "string",
  • "upin": 0,
  • "exclusionType": "string",
  • "exclusionDate": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "address": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "npiNumber": 0
}

StateSanctionsAndExclusions

Model used for the StateSanctionsAndExclusions dataset type

object (StateSanctionsAndExclusionsSource)
providerType
string or null
Array of objects or null (StateSanctionsAndExclusionsProviderAlias)
object (StateSanctionsAndExclusionsExclusionDetails)
object or null
id
string <uuid>
hash
string <uuid>
address
string or null
dateOfBirth
string or null <date-time>
fullName
string or null
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
npiNumber
integer or null <int64>
{
  • "source": {
    },
  • "providerType": "string",
  • "aliases": [
    ],
  • "exclusionDetails": {
    },
  • "additionalInfo": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "address": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "fullName": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "npiNumber": 0
}

NPDB

Model used for the NPDB dataset type

object (NpdbSubjectInformation)
object (NpdbQueryInformation)
Array of objects or null (NpdbReportInformation)
reportPaths
Array of strings or null
id
string <uuid>
hash
string <uuid>
{
  • "subjectInformation": {
    },
  • "queryInformation": {
    },
  • "reports": [
    ],
  • "reportPaths": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}

DMF

Model used for the Death Master File dataset type

fullName
string or null
deceased
boolean
deceasedStateOnRecord
string or null
dateOfDeath
string or null <date-time>
lastKnowState
string or null
lastKnowZipCode
string or null
lastKnowCountry
string or null
id
string <uuid>
hash
string <uuid>
dateOfBirth
string or null <date-time>
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
{
  • "fullName": "string",
  • "deceased": true,
  • "deceasedStateOnRecord": "string",
  • "dateOfDeath": "2019-08-24T14:15:22Z",
  • "lastKnowState": "string",
  • "lastKnowZipCode": "string",
  • "lastKnowCountry": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string"
}

NPI

Model used for the NPI dataset type

enumerationType
string or null
isDeactivated
boolean
deactivationReason
string or null
object (NpiProfile.NpiBasicModel)
Array of objects or null (NpiProfile.OtherName)
Array of objects or null (NpiProfile.Address)
Array of objects or null (NpiProfile.Address)
Array of objects or null (NpiProfile.Taxonomy)
Array of objects or null (NpiProfile.Identifier)
id
string <uuid>
hash
string <uuid>
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
npiNumber
integer or null <int64>
{
  • "enumerationType": "string",
  • "isDeactivated": true,
  • "deactivationReason": "string",
  • "basic": {
    },
  • "otherNames": [
    ],
  • "addresses": [
    ],
  • "practiceLocations": [
    ],
  • "taxonomies": [
    ],
  • "identifiers": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "npiNumber": 0
}

NSC

Model used for the NSC dataset type

Array of objects or null (Degree)
Array of objects or null (Enrollment)
object (Transaction)
Array of objects or null (PersonName)
id
string <uuid>
hash
string <uuid>
dateOfBirth
string or null <date-time>
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
{
  • "degreeDetails": [
    ],
  • "enrollmentDetails": [
    ],
  • "transaction": {
    },
  • "previousNames": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string"
}

DEA

Model used for the DEA dataset type.

businessActivityCode
string or null
drugSchedules
string or null
expirationDate
string <date-time>
additionalCompanyInfo
string or null
address1
string or null
address2
string or null
city
string or null
state
string or null
zipCode
string or null
businessActivitySubCode
string or null
paymentIndicator
string
Enum: "Paid" "Exempt"
active
boolean
object (DeaxModel)
degree
string or null
stateLicenseNumber
string or null
stateControlledSubstanceLicenseNumber
string or null
businessActivity
string or null
id
string <uuid>
hash
string <uuid>
registrationNumber
string or null
fullName
string or null
{
  • "businessActivityCode": "string",
  • "drugSchedules": "string",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "additionalCompanyInfo": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string",
  • "businessActivitySubCode": "string",
  • "paymentIndicator": "Paid",
  • "active": true,
  • "deax": {
    },
  • "degree": "string",
  • "stateLicenseNumber": "string",
  • "stateControlledSubstanceLicenseNumber": "string",
  • "businessActivity": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "registrationNumber": "string",
  • "fullName": "string"
}

CmsPreclusion

Model used for the Cms Preclusion List dataset type.

id
string <uuid>
hash
string <uuid>
firstName
string or null
middleName
string or null
lastName
string or null
prefix
string or null
suffix
string or null
npiNumber
integer or null <int64>
dateOfBirth
string or null <date-time>
address
string or null
businessName
string or null
general
string or null
speciality
string or null
ein
integer or null <int64>
exclusionDate
string or null <date-time>
claimRejectionDate
string or null <date-time>
reinstatedDate
string or null <date-time>
lastUpdate
string or null <date-time>
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "npiNumber": 0,
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "address": "string",
  • "businessName": "string",
  • "general": "string",
  • "speciality": "string",
  • "ein": 0,
  • "exclusionDate": "2019-08-24T14:15:22Z",
  • "claimRejectionDate": "2019-08-24T14:15:22Z",
  • "reinstatedDate": "2019-08-24T14:15:22Z",
  • "lastUpdate": "2019-08-24T14:15:22Z"
}

ABMS

Model used for the board ABMS dataset type.

Array of objects or null (AbmsMemberId)
object (AbmsNameRecord)
object (AbmsAddressRecord)
Array of objects or null (AbmsEducationInfo)
Array of objects or null (AbmsCertificationInfo)
object (AbmsOccupationInfo)
object (AbmsPersonalInfo)
object (AbmsExtensibleInfo)
restrictions
string or null
id
string <uuid>
hash
string <uuid>
{
  • "uniqueId": [
    ],
  • "name": {
    },
  • "address": {
    },
  • "educationInfo": [
    ],
  • "certificationInfo": [
    ],
  • "occupationInfo": {
    },
  • "personalInfo": {
    },
  • "extensibleInfo": {
    },
  • "restrictions": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}

Board Certification

Model used for the board certification datasets.

boardCertificationNumber
string or null
object (FlexibleDataModel)
Array of objects or null (BoardCertification)
screenshots
Array of strings or null
attachments
Array of strings or null
id
string <uuid>
hash
string <uuid>
fullName
string or null
{
  • "boardCertificationNumber": "string",
  • "additionalProperties": {
    },
  • "certifications": [
    ],
  • "screenshots": [
    ],
  • "attachments": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "fullName": "string"
}

Certification

Model used for the certification datasets.

certificateType
string or null
certificateNumber
string or null
firstName
string or null
lastName
string or null
middleName
string or null
prefix
string or null
suffix
string or null
issueDate
string or null <date-time>
expirationDate
string or null <date-time>
certifyingOrganization
string or null
object (FlexibleDataModel)
attachments
Array of strings or null
id
string <uuid>
hash
string <uuid>
fullName
string or null
{
  • "certificateType": "string",
  • "certificateNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "certifyingOrganization": "string",
  • "additionalProperties": {
    },
  • "attachments": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd",
  • "fullName": "string"
}