NPDB Methods
POST
When enrolling into NPDB continuous query, you will add it to the monitor subject by providing the monitoredSubjectID in the path.
ProviderTrust’s NPDB integration requires specific data.
- The monitor subject must have a "work or business" address.
- The monitor subject must have an associated primary license.
- License Specialty is required if licenseType is a physician (MD/DO) or dentist. Otherwise should be blank. For a complete list see the Specialty code list in https://www.npdb.hrsa.gov/software/CodeLists.pdf
With each enrollment, you must send gender (M, F, or U) and organization name. If sending professional school, you must also send graduation year.
If after you attempt to enroll into NPDB continuous query, you do not receive an enroll date/time; reach out to your client success manager.
{
"gender": "F",
"suffixName": "Jr",
"organizationName": "string",
"itin": "123456789",
"fein": "123456789",
"dea": "AZ1234567",
"upin": "AZ12345",
"professionalSchool": "string",
"graduationYear": 2000,
"dbidEntities": [
{
"entityName": "string",
"dbid": "123456789012345",
"endDate": "2023-12-31",
"eft": boolean
}
],
}
Data Explanation
Data | Description |
---|---|
suffixName | String; optional |
gender | String (M, F, or U) |
organizationName | String |
itin | String, 9 digits; optional |
fein | String, 9 digits; optional |
dea | String, letter+7digits |
upin | String, letter+5digits |
professionalSchool | String; optional |
graduationYear | Date (yyyy-mm-dd); optional |
endDate | Date (yyyy-mm-dd); optional |
dbidEntities | The object includes entity name, dbid, endDate |
entityName | string; optional |
dbid | string, 15 digits; required if client has more than 1 dbid they wish you to enroll the subject |
endDate | Date (yyyy-mm-dd); optional |
nonEnroll | Boolean (T, F) |
API Reference: Enroll into NPDB Continuous Query
PUT
When updating the NPDB continuous query enrollment, you can only update 3 JSON data fields simultaneously. If you want to end NPDB continuous query, add an end date.
API Reference: Update NPDB Continuous Query Enrollment
DELETE
When deleting an NPDB continuous query enrollment, you remove the enrollment from the monitored subject, but you do not delete the enrollment from NPDB. It is not advised to use this method if the subject remains in monitoring and verification with ProviderTrust.
API Reference: Delete NPDB Continuous Query Enrollment connection with ProviderTrust monitoring
GET
To find a subject in NPDB continuous query, provide a monitorSubjectID. In the response, you will see the client-provided NPDB values.
API Reference: Get NPDB Continuous Query data for a Subject
POST Search
{
"desc": boolen,
"page": 0,
"size": 30,
"sortBy": "string",
"filter": "",
"organizationName": "MEDICAL",
"includeTrashed": boolean,
}
Data | Description |
---|---|
desc | boolean; optional (default false) |
page | number; optional (default 0) |
size | number; optional (default 30; max 1000) |
sortBy | string (enum); optional; Must be one of "ORGANIZATION_NAME" or "CERTIFICATION_TITLE" |
filter | String; optional |
organizationName | String; optional |
includeTrashed | Boolean; optional |
Page Fields
- desc: true if the sortBy is applied in descending order, false if it is applied in ascending order
- page: Which ordered group of "size" results should be returned. The first page of results is page: 0. You can get all of the returned Monitored-Subjects for a search by making multiple POSTs, incrementing page until (page+1)*size >= total, where page and size are your request-body parameters and total is the value from the response.
- size: The maximum number of Monitored-Subjects to return in the response, ie the size of a page
- sortBy: How to sort the results. Default sort order is by Monitored-Subjects ID
Filter Fields
- filter: Filter Monitored-Subjects by the Monitored-Subjects’ Names, NPIs, and TINs. Partial/substring matches will return. This filter is applied to all 3 fields.
- organizationName: Filter by a specific organizationName.
- includeTrashed: This filter is a boolean to include deleted subjects.
API Reference: Get all subjects with NPDB Continuous Query
POST Create NPDB DBID Entity
This action would associate a subject with an NPDB dbid if an association were not created when the subject was enrolled into NPDB.
{
"entityName": "string",
"dbid": "string",
"endDate": "2023-07-18",
"enrolledDate": "2023-07-18T17:18:24.455Z",
"subjectId": 0,
"dataBankSubjectId": 0,
"dcn": 0
}
Data | Description |
---|---|
entityName | String; optional |
dbid | String, 15 digits |
endDate | Date (yyyy-mm-dd); optional |
enrolledDate | Date (yyyy-mm-ddTime(UTC)); optional |
subjectId | Integer; optional |
dataBankSubjectId | Integer |
dcn | Integer |
API Reference: Create NPDB DBID Association
Updated about 1 year ago