Enrollment Document

The Enrollment Document feature allows the user to view or update all uploaded provider or group documents, along with associated document information (type, issuer, effective and expiration dates, and document status).

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Endpoints

Primary

GET

Get list of enrollment documentation for given provider
profile

POST

Upload new enrollment documentation for given provider
profile

Get list of enrollment documentation for given provider profile

GET

/v1/{practiceid}/providers/{providerprofileid}/enrollmentdocs

Retrieves the enrollment documents for a single provider

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

providerprofileid integer providerprofileid

open boolean A boolean flag indicating that the response should include only document's whose OPEN field is true or false (depending on the flag value). If this flag is not set, all documents will be included in the response.

Output Parameters

Expand all

enrollmentdocuments array The set of enrollment documents for this provider

displayname string The human readable name of the document

documentid integer The ID that refers to the ENROLLMENTPERIOD ID where the document is stored

documenttype string The all-caps string that describes the type of document

effectivedate string The date on which the document is effective

enrollmentcategory string The name of the enrollment category for the document (i.e. the type of document)

enrollmentcategoryid integer The ID of the enrollment category for the document (i.e. the type of document)

entity string Type of entity (PROVIDER or MEDICALGROUP)

entityid integer The ID of the ENTITY

entitynumber string If the document is associated with a number, (like a DEA License number or NPI number) it is populated here

entitynumberid integer If the document is associated with a number (like a DEA License number or NPI number), the ID of that number is populated here

expirationdate string The date on which the document expires

open string A boolean indicating whether or not this document has been received or not

parametertype string The document is classified by its ENROLLMENTCATEGORY. The PARAMETERTYPE is a secondary classification within ENROLLMENTCATEGORY

providerprofileid integer The ID of the provider profile associated with the document

stateid string The STATE ID if the parameter type is STATE

status string The name of the status (ENROLLMENTSTATUSVALUE's NAME) the document is in

statusid string The ID of the status (ENROLLMENTSTATUSVALUE's ID) the document is in

taskid string The full enrollment task ID where the document is stored

Example Code

Upload new enrollment documentation for given provider profile

POST

/v1/{practiceid}/providers/{providerprofileid}/enrollmentdocs

Modifies a set of enrollment documents for the given provider

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Try in Postman