openapi: 3.0.1 info: title: Verifiable API Documentation description: >+ # Introduction This document contains the official documentation for the latest version of the Verifiable API. Our solution has been built API-first. That means we first design our API's and build our own user interfaces on top of these API's afterwards. This results in a reusable API that can be used by 3rd parties to offer the exact same functionality as we can provide ourselves. Both the product and API are still subject to significant and potentially breaking changes, so please refer back to this documentation frequently. Any breaking change will be communicated ahead of time to our partners integrating with our API's. # Getting Started This is a RESTful API that can be accessed using convential HTTP methods. It doesn't matter what programming language you use, there is already tooling available that can jumpstart you to access our API's. This documentation is based on OpenAPI 3.0 specifications and as such it is possible to dynamically generate a client in a language of your choice by simply loading our [specification document](https://api.discovery.verifiable.com/.well-known/openapi/vCurrent.json) in a tool such as [Swagger Codegen](https://swagger.io/tools/swagger-codegen/). It is not necessary to generate such a client and it is also possible to simply use any HTTP client to access our API. You can refer to the reference below to find the correct HTTP method, endpoint and model to use. ### Environments When developing an integration with our API we typicially request you to use our `staging` environment for development and only start using `production` when your integration is stable and tested thoroughly. Please contact [Verifiable support](https://verifiable.com/contact) to be granted access to our environments. **Staging Base URL** ``` https://api.discovery-staging.verifiable.com/ ``` **Production Base URL** ``` https://api.discovery.verifiable.com/ ``` ## Authentication Most endpoints require authentication to be used. You can authenticate to the API by passing an access token in the `Authentication` header using the `Bearer` scheme. An access token can be requested by authenticating against one of the [Authentication endpoints](https://api.discovery.verifiable.com). ### Example using password authentication endpoint **Request:** ```http POST /auth/token/password HTTP/1.1 Content-Type: application/json Host: https:// { "email": "john.doe@mail.com", "password": "secret" } ``` **Response:** ```http HTTP/1.1 200 OK Date: Fri, 25 Sep 2020 12:59:56 GMT Content-Type: application/json; charset=utf-8 { "tokenId": "2e5db76c-4c48-4cce-b11f-23a57ac5824c", "token": "MtetyFcIW...xgXXX-Z4yy" } ``` ### Example using access token **Request** ```http GET /audit/log HTTP/1.1 Authorization: Bearer Host: https:// ``` An access token is bound to a single user in an organization. The access token should remain secret and be treated as if it were a password. We recommend you to create access tokens with a short time to live and frequently rotate them. Note that time to live requested might be lowered to a shorter duration based on your organization settings. These can be configured to enforce a suitable maximum time to live for your use-cases that facilitate users and service integrations. ## Create a new provider A provider must be created and associated with license numbers, NPI numbers or other identifiers that can be used to perform lookups to fetch associated data for this provider. ### Example creating a new provider To create a new provider that can be used for license lookups: **Request:** ```http POST /providers HTTP/1.1 Content-Type: application/json Authorization: Bearer Host: https:// { "firstName": "John", "lastName": "Doe" } ``` **Response:** ```http HTTP/1.1 201 Created Date: Fri, 25 Sep 2020 15:25:12 GMT Content-Type: application/json; charset=utf-8 Location: https:///providers/9706f2ea-9c1d-49f3-9a57-871159878c9c { "firstName": "John", "lastName": "Doe", "id": "9706f2ea-9c1d-49f3-9a57-871159878c9c", "licenses": [] } ``` **Note:** The `id` in the response is the `Provider id`. It can be used as a `Path Parameter` to add the licenses to the provider, using Attach license API. Also you need `licenseTypeId` which can be picked from the [List License Types](https://api.discovery.verifiable.com) API, we will handle this next. For more details on providers see [Provider endpoints](https://api.discovery.verifiable.com) ## Get license types The list of license types which are supported for license verification. ### Example get license types Returns a list of all license types that are currently supported and used for license verifications. **Request** ```http GET /licensetypes HTTP/1.1 Authorization: Bearer Host: https:// ``` **Response:** ```http HTTP/1.1 200 OK Date: Fri, 25 Sep 2020 15:32:47 GMT Content-Type: application/json; charset=utf-8 { "nextOffset": "100", "nextCursor": "100", "pageSize": 100, "items": [ { "id": "0059f76a-280a-377a-73e2-ddfe86f4113c", "name": "Medical Physician & Surgeon", "source": { "id": "72dcec62-a0d3-4af8-955d-07ecac8f1e4d", "name": "Missouri Division of ProfessionalRegistration", "state": "MO", "availability": "Available", "isDegraded": false, "url": "https://pr.mo.gov/licensee-search.asp" } }, ], "sortedBy": "Id", "sortDirection": "Asc" } ``` **Note:** `id` in response refers to `licenseTypeId`. It will be unique for each license type. Please see [List License Types](https://api.discovery.verifiable.com) for more details. ## Attach a license to a provider To perform a license verification you must attach a license to a provider. The first time you do this will automatically trigger a license verification on that provider. Once attached you can re-verify the same license without reattaching it. A provider can have more than one license attached. ### Example attach license to a provider **Request:** ```http POST /providers/{providerId}/licenses HTTP/1.1 Content-Type: application/json Authorization: Bearer Host: https:// { "licenseNumber": "123456", "licenseTypeId": "0059f76a-280a-377a-73e2-ddfe86f4113c" } ``` **Response:** ```http HTTP/1.1 201 Created Date: Fri, 25 Sep 2020 15:35:00 GMT Content-Type: application/json; charset=utf-8 Location: https:///providers/9706f2ea-9c1d-49f3-9a57-871159878c9c?licenseId=bfb028f0-52ca-47f4-8181-6b4c8262d29c { "providerId": "9706f2ea-9c1d-49f3-9a57-871159878c9c", "licenseNumber": "123456", "licenseType": { "id": "0059f76a-280a-377a-73e2-ddfe86f4113c", "name": "Registered Nurse - RN", "source": { "id": "679b4f9a-cc3c-49e8-b560-0d0a9af47fd3”, "name": "Missouri Division of ProfessionalRegistration", "state": "MO", "availability": "Available", "url": "https://pr.mo.gov/licensee-search.asp" } } "jobStatus": "Pending", "id": "b45cbeb0-873e-495b-8182-1b9a8b6d379d" } ``` **Note:** Register a Webhook to get notified on HTTP endpoint, this prevents the need to poll the API for completion checks. For more details on Webhooks please see [Webhooks endpoint](https://api.discovery.verifiable.com) and for details on attaching a license see [Attach License endpoint](https://api.discovery.verifiable.com). ## Fetch created provider Returns the data for a specific provider. ### Example to fetch created provider **Request** ```http GET /providers/{providerId} HTTP/1.1 Authorization: Bearer Host: https:// ``` **Response:** ```http HTTP/1.1 200 OK Date: Fri, 25 Sep 2020 15:36:30 GMT Content-Type: application/json; charset=utf-8 { "firstName": "John", "lastName": "Doe", "id": "9706f2ea-9c1d-49f3-9a57-871159878c9c", "npis": [], "licenses": [ { "providerId": "9706f2ea-9c1d-49f3-9a57-871159878c9c", "licenseNumber": "123456", "licenseType": { "id": "0059f76a-280a-377a-73e2-ddfe86f4113c", "name": "Registered Nurse - RN", "source": { "id": "679b4f9a-cc3c-49e8-b560-0d0a9af47fd3”, "name": "Missouri Division of ProfessionalRegistration", "state": "MO", "availability": "Available", "url": "https://pr.mo.gov/licensee-search.asp" } } "jobStatus": "Idle", "currentVerificationStatus": "NeedsReview", "id": "b45cbeb0-873e-495b-8182-1b9a8b6d379d" } ] } ``` **Note:** Response contains attached licenses, NPI details for the given provider. To get details of these individual items (a particular License or an NPI), use unique identifiers in each of these categories. For more details check [Get specific license endpoint](https://api.discovery.verifiable.com) or [Get specific NPI record](https://api.discovery.verifiable.com). Further details on providers are at [Providers endpoint](https://api.discovery.verifiable.com). # Common Concepts ## Pagination, filtering and sorting Some endpoints can return a large list of data. To allow you to efficiently iterate through this data these endpoints offer pagination, sorting and filtering. The concept will be similar for each endpoint that supports it: * Pagination, filtering and sorting parameters are provided through the query string. * Pagination, filtering and sorting is only supported for endpoints that return lists of data. * Filters is only supported for certain endpoints. You can refer to the documentation of the endpoint to find out if filtering is supported. * The `sortedBy` and `sortDirection` parameters can be used to specify the sorting method. * The `count` parameter can be used to specify the page size. Please note that the maximum and default page size can differ per endpoint. * (Deprecated) The `offset` parameter influences the start of the page. For the first page you can always omit this parameter. For any subsequent page you can supply the value from the `nextOffset` parameter as returned by the server. * The `cursor` parameter influences the start of the page. For the first page you can always omit this parameter. For any subsequent page you can supply the value from the `nextCursor` or `previousCursor` parameter as returned by the server. Example on how to make a paginated request: ```http GET /audit/log?sortDirection=Asc&sortedBy=Id&count=10 HTTP/1.1 Authorization: Bearer Host: https:// ``` In addition to returning a list of `items`, a paginated response will also return `nextCursor` and/or `previousCursor`. The value of this property can be used to fetch the next or previous page by passing it in the `cursor` parameter. ## Error handling All responses that do not indicate a success status code will return an error using the error model as specified by [RFC 7807](https://tools.ietf.org/html/rfc7807). The amount of details exposed by the error model varies and depends on the nature of the error. We attempt to include as much information as is necessary to be able to self-diagnose the problem that led to the error. Should this information not be enough, then we also supply a `correlationId` in the response. We kindly request you to make note of this value when contacting Verifiable support as this will help us to quickly locate more information on this error. Example error result on a malformed request: ```json { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "correlationId": "5e94110e-45a8-404c-831d-77eaeaa73ad6", "errors": { "$.firstName": [ "The JSON value could not be converted to System.String. Path: $.firstName | LineNumber: 1 | BytePositionInLine: 18." ] } } ``` ## Nullable properties If an input parameter is required it is marked as such. If an input parameter is not marked as required and you do not wish or need to use it, you should omit the parameter completely in the request. For response parameters you should always code defensively and assume that a parameter might be missing from the response. This could happen in case the parameter is not applicable (yet) or simply because the data is missing. By coding defensively and assuming that a parameter might be missing you also future proof your solution for potential future (otherwise) breaking changes. ## Flexible data model In some cases we collect data from external sources that are hard to fit in a single predefined schema. For these cases we have come up with a flexible data model that allows us to store structured data in 3 different ways: - Form - Table - Section ### Table Data that can be represented in a table structure. The keys of every element/object in the data array is expected to be the same. ```json { "type": "Table", "data": [ { "Status Code": "CB", "Effective Date": "06/10/2016", "Description": "CANCELLED BY BOARD" }, { "Status Code": "NA", "Effective Date": "06/10/2016", "Description": "NOT ACTIVE" } ] } ``` ### Section Sections are used to represent multiple different data representations. For example, additional properties can have three sections with section one being a Form, while the other two could be a table. Also note there could be sections with and without heading. #### With section heading ```json { "type": "Section", "data": { "Discipline": { "type": "Form", "data": { "Discipline/Final Orders state": "ILLINOIS", "Date action was taken": "02/03/2020", "Against privilege to practice (PTP)": "N/A" } }, "NPDB code": { "type": "Form", "data": { "NPDB code": "39 - LICENSE REVOCATION, SUSPENSION OR OTHER DISCIPLINARY ACTION TAKEN BY A FEDERAL, STATE OR LOCAL LICENSING AUTHORITY" } }, "Actions": { "type": "Form", "data": { "Initial action date": "02/03/2020", "Effective date(s)": "02/03/2020 - INDEFINITE/UNSPECIFIED", "Is license automatically reinstated after the effective date(s)": "NOT SUPPLIED", "NPDB code": "1148 - DENIAL OF LICENSE RENEWAL" } } } } ``` #### Without section heading ```json { "type": "Section", "data": [ { "type": "Form", "data": { "Discipline/Final Orders state": "ILLINOIS", "Date action was taken": "02/03/2020", "Against privilege to practice (PTP)": "N/A" } }, { "type": "Form", "data": { "NPDB code": "39 - LICENSE REVOCATION, SUSPENSION OR OTHER DISCIPLINARY ACTION TAKEN BY A FEDERAL, STATE OR LOCAL LICENSING AUTHORITY" } }, { "type": "Form", "data": { "Initial action date": "02/03/2020", "Effective date(s)": "02/03/2020 - INDEFINITE/UNSPECIFIED", "Is license automatically reinstated after the effective date(s)": "NOT SUPPLIED", "NPDB code": "1148 - DENIAL OF LICENSE RENEWAL" } } ] } ``` ### Form A form is essentially a simple key/value collection, but it can also have nested flexible data. #### Simple form ```json { "type": "Form", "data": { "Date of Birth": "1958", "Registration Date": "06/13/2016", "Disciplinary Status": "CANCELLED BY BOARD" } } ``` #### Nested form ```json { "type": "Form", "data": { "Date of Birth": "1958", "Registration Date": "06/13/2016", "Disciplinary Status": "CANCELLED BY BOARD", "Status Change": { "type": "Table", "data": [ { "Status Code": "CB", "Effective Date": "06/10/2016", "Description": "CANCELLED BY BOARD" }, { "Status Code": "NA", "Effective Date": "06/10/2016", "Description": "NOT ACTIVE" } ] } } } ``` version: 24.14.3.683 servers: - description: Production url: https://api.discovery.verifiable.com - description: Staging url: https://api.discovery-staging.verifiable.com tags: - description: > Endpoints related to managing and listing providers' info. Education, insurance, training and CAQH login info can be added to providers. Education, liability insurance, and training can have multiple entries. They can be created via POST, modified by PATCH, and removed by DELETE methods. CAQH login info is a single entry per provider and can be created or replaced by PUT, removed by DELETE and modified by PATCH method. name: ProvidersInfo - description: > These endpoints allow you to add licenses to a provider and perform license lookups. Please note that a license lookup may take some time depending on the load and performance of the external data source. It is generally recommended to wait at least 2 seconds before polling for an update or use one of the notification mechanisms we provide (TBD). License verification result will have the basic information about the license such as license number, licenseType, status, issued date, expiry date, etc. In addition, the disciplinary actions and other additional information that is captured from the source site is represented through the disciplinaryActions and additionalProperties fields. The disciplinary actions and additional properties fields describe the type of data that is getting represented and are using the [Flexible Data Model](/reference/overview/#section/Common-Concepts/flexible-data-model). name: Licenses - description: > Endpoints related to scanning datasets and reading resulting matches. The supported datasets will grow over time and can be discovered via the [ListDatasets](https://api.discovery.verifiable.com) endpoint. A dataset scan is asynchronous, but most scans will result in near immediate completion. A webhook of type [DatasetScanCompleted](/reference/tag/Webhook-Callbacks/#tag/Webhook-Callbacks/section/DatasetScanCompleted) is triggered upon completion, but you can also check the completion status by querying the [GetDatasetScan](https://api.discovery.verifiable.com) operation. name: Datasets - description: > Endpoints related to managing and listing groups. Providers and payers can be associated with groups. name: Groups - description: > These endpoints allow you to create and get credentialing requests. A credentialing request is a workflow that supports the creation of a credentialing packet. You can create a request for Verifiable's NCQA-certified CVO services to process or you can choose to self manage the workflow. By default, a CVO credentialing request will be created unless self managed is specified. Once a request has been created you cannot change between self managed and CVO. Multiple credentialing events can be created and managed for a provider. When a CVO credentialing request is created, the request will be sent directly to the Verifiable CVO team to begin processing. You can check the status of the request by querying the [GetCredentialingRequest](https://api.discovery.verifiable.com) or [ListCredentialingRequests](https://api.discovery.verifiable.com) operations. To keep track of the request, events are created to manage each stage of the credentialing request process using the [CreateCredentialingRequestEvent](https://api.discovery.verifiable.com) operation. You can also fetch specific events using the [GetCredentialingRequestEvent](https://api.discovery.verifiable.com) operation. name: CredentialingRequests - description: > Endpoints related to managing and listing providers. A provider must be created and associated with license numbers, NPI numbers or other identifiers that can be used to perform lookups to fetch associated data for this provider. The data registered on the provider will be matched against the data returned by these lookups and used to detect inconsistencies or problems in the data or licenses. name: Providers - description: > These endpoint allow you to create and manage access tokens to be used in API calls. Unlike most other endpoints, when creating an access token, these do not require an access token to be used. Instead you authenticate via another secure mechanism and in exchange you retrieve an access token. name: Authentication - description: > Endpoints for binary file access. When any of the other API's return file paths, these file paths are referring to the `path` parameter in the following API's. File paths are unique per organization, but the same path can exist in multiple organizations. name: Files - description: > Endpoints to allow you to create and manage webhooks that will be called when a special event occurs. On this special event Verifiable will attempt to make an HTTP POST to the URL specified in the webhook. The payload of this request can vary, depending on the `type`. The `type` is included in the `X-WebhookType` header. This allows you to register multiple webhooks on the same endpoint and still be able to distinguish the webhook types. The webhook dispatcher expects the remote server to return an HTTP success status code. If it cannot be delivered, it will retry the callback a maximum of 10 times with a 30 second interval. By default we do not allow you to use insecure URLs for callbacks. You can optionally create a webhook that allows insecure URLs for testing purposes. We recommend you to use an HTTPS callback with a valid SSL certificate so that the integrity of the callback is ensured. For added security we will pass the webhook id (which is only known to the creator) in the `X-WebhookId` header and we will pass an optional secret in the `X-Secret` header. To be able to uniquely track webhook messages we also include the `X-TraceId` header. This will contain a unique value that doesn't change for every attempt we make to send a specific message. You can use this to keep a log of all messages that you have successfully processed. You can refer to [Webhook Callbacks](https://api.discovery.verifiable.com) to find the model that is included in the payload of the HTTP request to the callback URL. name: Webhooks - description: | These endpoint allow you to create and manage provider notes. name: Notes - description: > Endpoints to allow you to enable/disable monitoring or update monitoring settings for monitorable data. name: Monitoring - description: > Endpoints related to managing and listing payers. Each payer can have zero or more payer's plans. name: Payers - description: | Endpoints related to managing and listing payer plans. name: PayerPlans - description: > Endpoints related to managing and listing provider enrollments. Providers in a group can be associated to payer plans via provider enrollments. name: ProviderEnrollments - description: > These endpoints let you import a provider’s profile data from different sources (such as a provider’s National Provider Identifier (NPI) record). This allows you to build a more complete picture of a provider within Verifiable and gives you easy access to the latest provider profile data across multiple sources. In order to import an external profile, each source has its own list of required parameters. A provider must first have the required data in their Verifiable profile before you can run an import. Once a request is created, fetching a profile is fast and typically takes seconds to return. You can check the status of an import request using the "Get an existing provider profile import" endpoint. name: ProviderProfiles - description: > Endpoints to list and dismiss active alerts. Alerts are triggered when an important event occurs that warrants user involvement. An alert can be considered dismissed if it has a dismissal timestamp and note. name: Alerts - description: > These endpoints are used for our integrations with 3rd party services. They are not intended to be consumed directly by most clients. Please contact us for more information on our integration possibilities. name: Integrations - description: > Each API call that results in data being created, updated or deleted will result in one or more entries in the audit log. Using the endpoints provided in this section it is possible to list entries in this log. name: Audit - description: | Endpoints related to managing and listing users. name: Users - name: Reports - name: CognitoFormsWebhook - name: GetFacilityInfo - name: GetProviderCredentialingData - description: | Endpoints related to managing and listing facilities. name: Facilities - description: > These endpoints are currently in beta and subject to change. Access to these endpoints is restricted and can be granted on request. name: Beta - description: > These endpoints allow you to create and manage organizations, console and organization users. name: Console - description: > This section contains an overview of the models used by the different dataset types. These models can also be discovered via the [ListDatasets](https://api.discovery.verifiable.com) operation. ## MedicareOptOut Model used for the `MedicareOptOut` dataset type. ## SAM Model used for the `SAM` dataset type. ## OFAC Model used for the `OFAC` dataset type. ## OigFugitives Model used for the `OigFugitives` dataset type. ## OigExclusions Model used for the `OigExclusions` dataset type. ## StateSanctionsAndExclusions Model used for the `StateSanctionsAndExclusions` dataset type ## NPDB Model used for the `NPDB` dataset type ## DMF Model used for the `Death Master File` dataset type ## NPI Model used for the `NPI` dataset type ## NSC Model used for the `NSC` dataset type ## DEA Model used for the `DEA` dataset type. ## CmsPreclusion Model used for the `Cms Preclusion List` dataset type. ## ABMS Model used for the board `ABMS` dataset type. ## Board Certification Model used for the board certification datasets. ## Certification Model used for the certification datasets. name: Dataset Records - description: > This section contains an overview of the models that are in the HTTP POST payload of a webhook callback. Refer to [Webhooks](https://api.discovery.verifiable.com) 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. ## 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. ## 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. ## 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. ## 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. ## 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. ## 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. ## 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. ## 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. ## NpiChanged Model used in the HTTP POST request triggered by an event of type `NpiChanged`. This event occurs whenever the NPI number of a provider changed. ## 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. ## 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. ## 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. ## 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. ## 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. ## 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. name: Webhook Callbacks - description: | Endpoints related to managing and listing organization resources. name: Organizations - description: >- These endpoints allow you to merge previously imported profile data with a provider in Verifiable name: ProfileMerges paths: /auth/token/password: post: tags: - Authentication summary: | Password Authentication operationId: Authentication_authenticateWithPassword description: > Endpoint for authentication using an email and password for a user already registered at Verifiable. In return you will receive an access token that can be used in the following API calls. **Note:** The account may require a password change for successful authentication. If password change is required and `newPassword` is not set the server returns `409 Conflict`. If `newPassword` is set but the current `password` is not correct the server returns `403 Forbidden`. **Note:** If `newPassword` is set it *must* be different than the current password. If the password is the same the server returns `400 Bad Request`. **Note:** When `newPassword` is set and the request returns `200 Ok`, all the active access tokens will be invalidated. requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordAuthModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AuthResponseModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '409': description: Conflict '500': description: Server Error /auth/password/reset: post: tags: - Authentication summary: | Resets a password operationId: Authentication_resetPassword description: | Endpoint for changing a password using a token. requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordResetRequestModel' responses: '204': description: No Content '400': description: Bad Request '403': description: Forbidden '404': description: Not Found '500': description: Server Error /auth/password/requestreset: post: tags: - Authentication summary: | Requests a password reset operationId: Authentication_requestPasswordReset description: > Endpoint for requesting a password reset. If the e-mail sent in the body of this request has an account associated with it, a message with a link for changing the password will be sent to it. requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPasswordResetRequestModel' responses: '204': description: No Content '400': description: Bad Request '403': description: Forbidden '500': description: Server Error /auth/token/google: post: tags: - Authentication summary: | Google Authentication operationId: Authentication_googleTokenPost description: > It is possible to use Google Sign-In for authentication with the Verifiable API. In order to do so we follow the [Google Sign-In for server-side apps](https://developers.google.com/identity/sign-in/web/server-side-flow) flow. In order to use this flow you must use the `client ID` from Verifiable when signing in to Google and send the authorization code as payload to this endpoint. In return you will receive an access token that can be used in the following API calls. The email address of the user must already be registered at Verifiable. requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAuthModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AuthResponseModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /auth/token: get: tags: - Authentication summary: | List active access tokens operationId: Authentication_listActiveAccessTokens description: > Returns all access tokens for the current user that are neither expired, nor invalidated. parameters: - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Id type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AccessTokenPageModel' '400': description: Bad Request '401': description: Unauthorized '500': description: Server Error /auth/token/{tokenId}/invalidate: post: tags: - Authentication summary: | Invalidate an access token operationId: Authentication_invalidateToken description: | Invalidates an access token so that it can no longer be used. parameters: - description: The unique identifier of the access token to be invalidated. name: tokenId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '500': description: Server Error /auth/token/invalidate: post: tags: - Authentication summary: | Invalidate multiple access tokens operationId: Authentication_invalidateMultipleTokens description: > Invalidates multiple access tokens that belongs to the user making the request so they can no longer be used. requestBody: content: application/json: schema: $ref: '#/components/schemas/InvalidateAllAccessTokensRequestModel' responses: '204': description: No Content '401': description: Unauthorized '500': description: Server Error /providers: post: tags: - Providers summary: | Create a new provider operationId: Providers_createNewProvider description: >- Creates a new provider that can be used to store information about this provider. Once a provider is created you can attach records, notes, documents and create other associations with this provider such as adding them to a Group or Payer. requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - Providers summary: | List providers operationId: Providers_listPage description: | Returns a page of providers. parameters: - description: >- If set, the items will be filtered on providers with the specified status. name: status in: query schema: enum: - None - NeedsReview - ExpiresSoon - Expired - Monitored - NotMonitored - NotFoundLicenses - DisciplinaryActionLicenses - UnableToVerifyLicenses type: string - description: >- If set, the items will be filtered on providers with the specified name or alias name. name: providerName in: query schema: type: string - description: >- If set, the items will be filtered on providers with the specified credentialing status. name: credentialingStatus in: query schema: type: array items: type: string - description: >- If set, the items will be filtered on providers with the specified provider type. name: providerTypeId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on providers with the specified npi number. name: npi in: query schema: type: integer format: int64 - description: >- If set, the items will be filtered on providers with the specified deactivated status. name: deactivated in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Id - LastName - FirstName - CredentialingStatus - CredentialedDate type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - LastName - FirstName - CredentialingStatus - CredentialedDate type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}: get: tags: - Providers summary: | Get an existing provider operationId: Providers_getData description: | Returns the data for a specific provider. parameters: - description: Identifier of the provider to get the data for. name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Providers summary: | Patch an existing provider operationId: Providers_updateProviderData description: | Allows you to change a provider's name or other data properties. parameters: - description: Identifier of the provider to patch. name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - Providers summary: | Delete an existing provider operationId: Providers_deleteExistingProvider description: > This will delete the provider and all associated data such as attached licenses, NPI records, DEA registration etc. parameters: - description: Identifier of the provider to get the data for. name: providerId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/aggregations: get: tags: - Providers summary: | Get provider aggregations operationId: Providers_getAggregations description: | Returns aggregated counts for providers with different statuses. parameters: - description: >- If set, the items will be filtered on providers with the specified deactivated status. name: providerDeactivated in: query schema: type: boolean responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderAggregationsModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /providertypes: get: tags: - Providers summary: | List provider types operationId: Providers_listProviderTypes description: | Returns a list of all provider types that are currently supported. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersListProviderTypesResponse' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/report: post: tags: - Providers summary: | Generate report for an existing provider operationId: Providers_generateReport description: | Generates report for the specified provider. parameters: - description: Identifier of the provider to generate report. name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderReportRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersGenerateReportResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info: get: tags: - ProvidersInfo summary: | Get info for the existing provider operationId: ProvidersInfo_get description: | Returns the info for a specific provider. parameters: - description: Identifier of the provider to get the data for. name: providerId in: path required: true schema: type: string format: uuid - description: >- If not specified, will return all data for the provider. Info types can be combined, ex.: `providerInfoType=licenses&providerInfoType=deaRegistrations`. name: providerInfoType in: query schema: type: array items: enum: - BasicInfo - Caqh - LiabilityInsurance - Education - Training - WorkHistory - DeaRegistrations - Licenses - BoardCertifications - Certificates type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoGetResponse' example: BasicInfo: firstName: string lastName: string dateOfBirth: '2019-08-24T14:15:22.0000000Z' ssn: '***' id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 credentialingStatus: string aliases: - firstName: string lastName: string addresses: - state: AL zipCode: string city: string addressLine1: string type: Unspecified emails: - email: string type: Unspecified phone: string languages: - string credentialedDate: '2019-08-24T14:15:22.0000000Z' recredentialedDates: - '2019-08-24T14:15:22.0000000Z' providerType: string CaqhInfo: caqhId: string username: string password: '***' LiabilityInsurance: - id: Guid name: string isSelfInsured: bool originalEffectiveDate: Date effectiveDate: Date expirationDate: Date CoverageType: enum isUnlimitedCoverage: bool includesTailCoverage: bool occurrenceCoverageAmount: number aggregateCoverageAmount: number policyNumber: string Education: - id: GuidX ecfmgNumber: string ecfmgIssueDate: '2019-08-24T14:15:22.0000000Z' graduateType: enum schoolName: string schoolCode: string startDate: '2000-09-01T00:00:00.0000000Z' endDate: '2000-09-01T00:00:00.0000000Z' completed: bool degree: string Training: - id: GuidX trainingType: enum institutionName: string schoolCode: string startDate: '2000-09-01T00:00:00.0000000Z' endDate: '2000-09-01T00:00:00.0000000Z' completed: bool '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error x-codeSamples: [] /providers/{providerId}/info/caqh: put: tags: - ProvidersInfo summary: | Create or replace caqh login info for the existing provider operationId: ProvidersInfo_createOrUpdateCaqhLogin description: | Creates or replaces the CAQH login info for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CaqhLoginInfoRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CaqhLoginInfoModel' '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's CAQH login info operationId: ProvidersInfo_changeCAQHLogin description: >+ Change an existing CAQH login info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CaqhLoginInfoRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CaqhLoginInfoModel' '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing CAQH login info for the existing provider operationId: ProvidersInfo_deleteCaqhLogin description: > Deletes an existing CAQH login info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - ProvidersInfo summary: | Get CAQH login info for a provider operationId: ProvidersInfo_getCaqhLoginInfo description: | Returns the CAQH login info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CaqhLoginInfoModel' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/aliases/{aliasId}: put: tags: - ProvidersInfo summary: | Change an existing provider's alias operationId: ProvidersInfo_changeAlias description: | Change an existing alias associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: aliasId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAliasRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderAliasModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/aliases/{id}: get: tags: - ProvidersInfo summary: | Get alias for the existing provider operationId: ProvidersInfo_getAlias description: | Returns the alias for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderAliasModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing alias for the existing provider operationId: ProvidersInfo_deleteAlias description: | Deletes an existing alias associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/boardCertifications: post: tags: - ProvidersInfo summary: | Create board certification info for the existing provider operationId: ProvidersInfo_addBoardCertification description: | Add a board certification info for the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/BoardCertificationInfoRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BoardCertificationInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List board certifications operationId: ProvidersInfo_listBoardCertifications description: | Returns all board certifications associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/ProvidersInfoListBoardCertificationsResponse '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/boardCertifications/{id}: get: tags: - ProvidersInfo summary: | Get board certification for the existing provider operationId: ProvidersInfo_getBoardCertification description: | Returns the board certification for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BoardCertificationInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's board certification info operationId: ProvidersInfo_updateCertificationInfo description: > Change an existing board certification info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/BoardCertificationInfoPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BoardCertificationInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing board certification info for the existing provider operationId: ProvidersInfo_deleteBoardCertificationById description: > Deletes an existing board certification info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/certificates: post: tags: - ProvidersInfo summary: | Create certificate info for the existing provider operationId: ProvidersInfo_createCertificateInfo description: | Add a certificate info for the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateInfoRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CertificateInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List certificates operationId: ProvidersInfo_listCertificates description: | Returns all certificates associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListCertificatesResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/certificates/{id}: get: tags: - ProvidersInfo summary: | Get certificate for the existing provider operationId: ProvidersInfo_getCertificate description: | Returns the certificate for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CertificateInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's certificate info operationId: ProvidersInfo_updateCertificateInfo description: > Change an existing certificate info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateInfoPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CertificateInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing certificate info for the existing provider operationId: ProvidersInfo_deleteCertificateInfo description: > Deletes an existing certificate info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/liabilityInsurances: post: tags: - ProvidersInfo summary: | Create liability insurance info for the existing provider operationId: ProvidersInfo_createLiabilityInsurance description: | Creates the liability insurance info for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/LiabilityInsuranceRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/LiabilityInsuranceModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List liability insurances operationId: ProvidersInfo_listLiabilityInsurances description: | Returns all liability insurances associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/ProvidersInfoListLiabilityInsurancesResponse '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/liabilityInsurances/{id}: get: tags: - ProvidersInfo summary: | Get liability insurance for the existing provider operationId: ProvidersInfo_getLiabilityInsurance description: | Returns the liability insurance for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LiabilityInsuranceModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's liability insurance operationId: ProvidersInfo_updateLiabilityInsurance description: > Change an existing liability insurance associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/LiabilityInsurancePatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LiabilityInsuranceModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing liability insurance info for the existing provider operationId: ProvidersInfo_deleteLiabilityInsuranceById description: > Deletes an existing insurance info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/educations: post: tags: - ProvidersInfo summary: | Create education info for the existing provider operationId: ProvidersInfo_createEducationInfo description: | Creates the education info for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/EducationRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EducationModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List educations operationId: ProvidersInfo_listEducations description: | Returns all educations associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListEducationsResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/educations/{id}: get: tags: - ProvidersInfo summary: | Get education for the existing provider operationId: ProvidersInfo_getEducation description: | Returns the education for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EducationModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's education info operationId: ProvidersInfo_updateEducationInfo description: > Change an existing education info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/EducationPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EducationModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing education info for the existing provider operationId: ProvidersInfo_deleteExistingEducation description: > Deletes an existing education info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/trainings: post: tags: - ProvidersInfo summary: | Create training info for the existing provider operationId: ProvidersInfo_createTraining description: | Creates the training info for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainingRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TrainingModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List trainings operationId: ProvidersInfo_listTrainings description: | Returns all trainings associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListTrainingsResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/trainings/{id}: get: tags: - ProvidersInfo summary: | Get training for the existing provider operationId: ProvidersInfo_getTraining description: | Returns the training for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TrainingModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's training info operationId: ProvidersInfo_updateTrainingInfo description: | Change an existing training info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainingPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TrainingModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing training info for the existing provider operationId: ProvidersInfo_deleteTrainingInfo description: > Deletes an existing training info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/workHistory: post: tags: - ProvidersInfo summary: | Create work history info for the existing provider operationId: ProvidersInfo_createWorkHistory description: | Creates the work history info for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkHistoryRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/WorkHistoryModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List work history entries operationId: ProvidersInfo_listWorkHistory description: | Returns all work history entries associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListWorkHistoryResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/workHistory/{id}: get: tags: - ProvidersInfo summary: | Get work history for the existing provider operationId: ProvidersInfo_getWorkHistoryById description: | Returns the work history for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WorkHistoryModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's work history info operationId: ProvidersInfo_updateWorkHistory description: > Change an existing work history info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkHistoryPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WorkHistoryModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProvidersInfo summary: | Delete existing work history info for the existing provider operationId: ProvidersInfo_deleteWorkHistoryInfo description: > Deletes an existing work history info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/profiles/import/sources: get: tags: - ProviderProfiles summary: | List provider profile import sources operationId: ProviderProfiles_listImportSources description: > Returns a list of sources where you can import provider profile data from. You can choose a source to import from and select the parameters required for a successful request. parameters: - description: The source of the import to get profiles. name: source in: query schema: enum: - Npi - Caqh type: string - name: sortedBy in: query schema: enum: - Name - Source type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Name - Source type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderProfileImportSourcePageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/profiles/import: post: tags: - ProviderProfiles summary: | Create a new provider profile import operationId: ProviderProfiles_createProfileImport description: > To import a profile from an external source, you must first create an import request. When the request is initiated, the provider profile record will be created with a “Pending” status. When complete, the status will change to “Completed”. If the request is successful, the provider profile will have a “Profile" value. If an error occurs, the profile will have a "FailureCode" and "FailureDescription" value. requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderProfileImportRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderProfileImportModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProviderProfiles summary: | List provider profile imports operationId: ProviderProfiles_listImports description: > Returns a list of all the provider profiles that have been imported so far. You can filter the selection by source, status, providerId, get only latest record for each provider, and change the sorting and pages. parameters: - name: latest in: query schema: type: boolean - description: The status of the import to get profiles. name: status in: query schema: enum: - Pending - Working - Completed - Failed type: string - description: The source of the import to get profiles. name: source in: query schema: enum: - Npi - Caqh type: string - name: providerId in: query schema: type: string format: uuid - name: sortedBy in: query schema: enum: - Id - Source - Status - Completed - Started type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - Source - Status - Completed - Started type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderProfileImportPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/profiles/import/{importId}: get: tags: - ProviderProfiles summary: | Get an existing provider profile import operationId: ProviderProfiles_getExistingImport description: > Returns a specific provider profile import model, allowing you to check the model status and get the profile value. parameters: - description: Identifier of the provider profile import to get the data for. name: importId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderProfileImportModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/notes: post: tags: - Notes summary: | Create a new provider note operationId: Notes_createNewProviderNote description: | Creates a note associated with the specified provider. parameters: - description: Identifier of the provider to create a note for. name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNotesRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderNotesModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - Notes summary: | List provider notes operationId: Notes_listProviderNotes description: > Returns all notes associated with the specified provider. This also returns any dismissal related to alerts on this provider. parameters: - description: Identifier of the provider to get all notes for. name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/NotesListProviderNotesResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/notes/{noteId}: get: tags: - Notes summary: | Get an existing provider note operationId: Notes_getExistingProviderNote description: | Gets an existing note associated with the specified provider. parameters: - description: Identifier of the provider associated with the note. name: providerId in: path required: true schema: type: string format: uuid - description: Identifier of the note. name: noteId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderNotesModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error put: tags: - Notes summary: | Change an existing provider note operationId: Notes_updateExistingProviderNote description: | Change an existing note associated with the specified provider. parameters: - description: Identifier of the provider associated with the note to change. name: providerId in: path required: true schema: type: string format: uuid - description: Identifier of the note to be changed. name: noteId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNotesRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderNotesModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error delete: tags: - Notes summary: | Delete an existing provider note operationId: Notes_deleteExistingNote description: | Deletes an existing note associated with the specified provider. parameters: - description: Identifier of the provider associated with the note to delete. name: providerId in: path required: true schema: type: string format: uuid - description: Identifier of the note to be deleted. name: noteId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error /files/uploads/{path}: post: tags: - Files summary: | Upload a file operationId: Files_uploadFile description: > Uploads, copies or moves a file. If the file already exists the server returns `409 Conflict`. If `x-source-path` is set then the file is copied from an existing file and stored at `path`. If `x-source-delete` is set to `1`, `true` or `yes` then the file is moved instead of copied. If `x-source-path` is not set then the content of the file must be uploaded by using form data (Content-Type = `multipart/form-data`). The new file is stored at `path`. Note that there is special handling for files uploaded to `uploads/providers/{providerId}/<>.<>`. If this path is used, then the file will be associated with the provider with that identifier and also deleted when this provider gets deleted. Files must include a `<>` and `<>` to be associated with a provider. parameters: - description: >- The complete path to the file including -but not necessarily requiring- folder separators. name: path in: path required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized '403': description: Forbidden '409': description: Conflict '500': description: Server Error put: tags: - Files summary: | Upload and overwrite a file operationId: Files_uploadAndOverwrite description: > Uploads, copies or moves a file. If the file already exists then it is overwritten. If `x-source-path` is set then the file is copied from an existing file and stored at `path`. If `x-source-delete` is set to `1`, `true` or `yes` then the file is moved instead of copied. If `x-source-path` is not set then the content of the file must be uploaded by using form data (Content-Type = `multipart/form-data`). The new file is stored at `path`. Note that there is special handling for files uploaded to `uploads/providers/{providerId}/<>.<>`. If this path is used, then the file will be associated with the provider with that identifier and also deleted when this provider gets deleted. Files must include a `<>` and `<>` to be associated with a provider. parameters: - description: >- The complete path to the file including -but not necessarily requiring- folder separators. name: path in: path required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /files/uploads/{pathOrId}: delete: tags: - Files summary: | Delete a file operationId: Files_removeFile description: | Deletes a previously uploaded file. parameters: - name: pathOrId in: path required: true schema: type: string responses: '204': description: No Content '401': description: Unauthorized '404': description: Not Found '500': description: Server Error /files/{pathOrId}: get: tags: - Files summary: | Download a file operationId: Files_downloadFile description: | Download the file contents for the file at the specified location. parameters: - name: pathOrId in: path required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FilesDownloadFileResponse' '304': description: Not Modified '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error head: tags: - Files summary: | Get file metadata operationId: Files_getFileMetadata description: | Returns the metadata of a file at the specified location. parameters: - name: pathOrId in: path required: true schema: type: string responses: '200': description: Success '304': description: Not Modified '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /files/uploads: get: tags: - Files summary: | List uploaded files operationId: Files_listUploadedFilesMetadata description: | Returns metadata for previously uploaded files. parameters: - description: >- If set the result is filtered to return only files whose path begin with the specified prefix. name: prefix in: query schema: maxLength: 640 minLength: 0 type: string - description: If set, only returns events from before this date. name: before in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `before` date and time too. name: beforeInclusive in: query schema: type: boolean - description: If set, only returns events from after this date. name: after in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `after` date and time too. name: afterInclusive in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Path - CreatedAt type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Path - CreatedAt type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FilePageModel' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /provider-licenses: get: tags: - Licenses summary: | List provider licenses operationId: Licenses_listProvider description: | Returns a page of provider licenses. parameters: - description: >- If set, the items will be filtered on providers with the specified (first or last) name. name: providerName in: query schema: type: string - description: >- If set, the items will be filtered on providers with the specified credentialing status. name: providerCredentialingStatus in: query schema: type: array items: type: string - description: >- If set, the items will be filtered on licenses with the specified license state. name: licenseState in: query schema: 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 type: string - description: >- If set, the items will be filtered on licenses with the specified license type. name: licenseType in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on licenses with the specified license status. name: licenseStatus in: query schema: enum: - None - Active - Expired - ExpiresSoon - DisciplinaryActions - Found - NotFound - UnableToVerify - NeedsReview - All type: string - description: >- If set, the items will be filtered on licenses with the verification status. name: licenseVerificationStatus in: query schema: enum: - Verified - Unverified type: string - name: licenseApprovedStatus in: query schema: type: array items: enum: - Pending - 'Yes' - 'No' type: string - name: export in: query schema: enum: - None - Csv type: string - name: providerDeactivated in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - ProviderFirstName - ProviderLastName - LicenseState - LicenseExpirationDate type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - ProviderFirstName - ProviderLastName - LicenseState - LicenseExpirationDate type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderLicensePageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/licenses/{licenseId}/verify: post: tags: - Licenses summary: | Trigger a new license verification operationId: Licenses_triggerNewVerification description: > By executing this endpoint a new license verification is scheduled and executed for the specified license. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid - description: The identifier describing the license to be verified again. name: licenseId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/licenses/verify: post: tags: - Licenses summary: | Trigger license verifications operationId: Licenses_triggerVerification description: > By executing this endpoint a license verifications is scheduled and executed for specified licenses for the provider. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid requestBody: description: >- List with license identifiers to run verifications. If list with identifiers is empty, verifications for all provider licenses will be run. content: application/json: schema: $ref: '#/components/schemas/LicensesTriggerVerificationRequest' responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/licenses/{licenseId}: delete: tags: - Licenses summary: | Detach a license from a provider operationId: Licenses_detachProviderLicense description: > This will delete the license and associated verification records for the specified provider. This will also delete any related data such as screenshots, attachments, export reports, alerts etc. parameters: - description: The identifier describing the provider to detach the license from. name: providerId in: path required: true schema: type: string format: uuid - description: The identifier describing the license that you want to detach. name: licenseId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - Licenses summary: | Get a specific license from a provider operationId: Licenses_getSpecificProviderLicense description: > Returns the data and latest verification for a specific license attached to a specific provider. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid - description: >- The identifier describing the license that you want to get the data for. name: licenseId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseModel' '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '500': description: Server Error /providers/{providerId}/licenses/{licenseId}/verifications/{verificationId}: get: tags: - Licenses summary: | Get a specific license verification operationId: Licenses_getVerificationData description: > Returns the data for a specific previously executed license verification. This endpoint can be used to retrieve historical results on older license verifications. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid - description: The identifier describing the license that was previously verified. name: licenseId in: path required: true schema: type: string format: uuid - description: >- The identifier describing the license verification that you want to retrieve. name: verificationId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseVerificationModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Licenses summary: | Resolve problems with a license verification operationId: Licenses_resolveVerificationProblem description: > After a license verification is executed we sometimes are uncertain about the results we get from the source. For example when the source returns more than 1 match or the name of the license does not match the name that was used for the provider. In such cases we mark the license `status` as `NeedsReview`. It is expected that this status is resolved by the end user. The resolution can be patched by using this endpoint. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid - description: >- The identifier describing the license that has a verification problem. name: licenseId in: path required: true schema: type: string format: uuid - description: >- The identifier describing the license verification that needs to be patched. name: verificationId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseVerificationResolutionModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseVerificationModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error /providers/{providerId}/licenses/{licenseId}/verifications/{verificationId}/diff: get: tags: - Licenses summary: | Diff two license verifications operationId: Licenses_diffVerification description: > Returns the diff according to [jsondiffpatch format](https://github.com/benjamine/jsondiffpatch) between the specified verification and the previous successful verification. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid - description: The identifier describing the license that was previously verified. name: licenseId in: path required: true schema: type: string format: uuid - description: >- The identifier describing the license verification that you want to diff with the previous one. name: verificationId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseVerificationDiffModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error /providers/{providerId}/licenses/{licenseId}/verifications: get: tags: - Licenses summary: | List all verifications for a license operationId: Licenses_listVerifications description: > It is possible to perform more than one verification for any given license. In order to go back in history you can use this endpoint to get a list of all verifications for the specified license. parameters: - description: The identifier describing the provider that holds the license. name: providerId in: path required: true schema: type: string format: uuid - description: The identifier describing the license to get the verifications from. name: licenseId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicensesListVerificationsResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /licensetypes: get: tags: - Licenses summary: | List license types operationId: Licenses_listLicenseTypes description: > Returns a list of all license types that are currently supported and used for license verifications. parameters: - description: >- If set, the items will be filtered on the state specified by this parameter name: state in: query schema: 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 type: string - description: The number of items to include in a single page. name: count in: query schema: maximum: 1000 minimum: 1 type: integer format: int32 - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Taxonomy - Name type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Taxonomy - Name type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SimplifiedLicenseTypePageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /licensetypes/status: get: tags: - Licenses summary: | List license source status operationId: Licenses_listLicenseSourceStatus description: > Returns the license source status information for one or more license types. parameters: - description: >- If set, the items will be filtered by the License type id. Please refer to [LicenseTypes](../ListLicenseTypes) for more information on the License type id. name: licenseTypeId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered by the state specified in this parameter. name: state in: query schema: 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 type: string - description: The number of items to include in a single page. name: count in: query schema: maximum: 1000 minimum: 1 type: integer format: int32 - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - State type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - State type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SimplifiedLicenseTypeStatusPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /datasets/scans: post: tags: - Datasets summary: | Start a dataset scan operationId: Datasets_startScan description: > Starts a new dataset scan for a given provider. Will return a failed scan if the provider is missing required parameters for the scan. requestBody: content: application/json: schema: $ref: '#/components/schemas/DatasetScanRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DatasetScanModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error get: tags: - Datasets summary: | List dataset scans operationId: Datasets_listScans description: > Returns a page of the most recently started dataset scans per provider, dataset type and referenceId. parameters: - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Id - ProviderId - Started - Completed - Type type: string - description: If set, the results will only contain scans for this provider. name: providerId in: query schema: type: string format: uuid - description: If set, the results will only contain scans for this dataset. name: type in: query schema: 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 - AmericanHeartAssociation type: string - description: >- If set, the results will only contain scans with the specified parameter set. name: parameterSetId in: query schema: type: string format: uuid - description: >- If set, the results will only contain scans with the specified provider info reference id. name: referenceId in: query schema: type: string format: uuid - description: >- If set, the results will only contain scans with the specified statuses. name: status in: query schema: type: array items: enum: - Pending - Working - Completed - Failed - Active type: string - description: >- If set, the results will only contain scans for providers ih the specified credentialing status. name: credentialingStatus in: query schema: type: string - description: >- If set, the results will contain all dataset scans, otherwise, only the most recent scans will be included. name: includeOldScans in: query schema: type: boolean - description: >- If set, the results will only contain scans for providers in the specified deactivated status. name: providerDeactivated in: query schema: type: boolean - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - ProviderId - Started - Completed - Type type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetScanPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /datasets/scans/{scanId}: get: tags: - Datasets summary: | Get dataset scan operationId: Datasets_getScanResults description: | Returns the status and results for a previously started dataset scan. parameters: - description: The identifier of the scan to get results for. name: scanId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetScanModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /datasets/matches: get: tags: - Datasets summary: | List dataset matches operationId: Datasets_listMatches description: > Returns a list of dataset matches. Only matches that have not been rejected for a provider are returned. By default it returns only matches from the most recent completed scan per provider, dataset type and referenceId. parameters: - name: distinctPerProvider in: query schema: type: boolean - description: If set, the results will only contain matches for this provider. name: providerId in: query schema: type: string format: uuid - description: >- If set, the results will only contain matches for the specified dataset types. As opposed to `type` you can filter on more than 1 different dataset type this way. name: types in: query schema: type: array items: 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 - AmericanHeartAssociation type: string - name: userActionNeeded in: query schema: type: boolean - name: referenceId in: query schema: type: string format: uuid - description: >- If set, the results will only contain scans for providers ih the specified credentialing status. name: credentialingStatus in: query schema: type: array items: type: string - name: providerName in: query schema: type: string - name: providerNpi in: query schema: type: integer format: int64 - description: >- If set, the results will contain all dataset matches, otherwise, only matches from the most recent completed scans will be included. name: includeOldMatches in: query schema: type: boolean - name: userActionResolution in: query schema: enum: - Accept - Reject type: string - name: matchRelevance in: query schema: type: array items: enum: - Low - Medium - High type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - MatchRelevance type: string Values: enum: - Asc - Desc type: string - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Id - MatchRelevance type: string - description: >- If set, the results will only contain scans for providers in the specified deactivated status. name: providerDeactivated in: query schema: type: boolean - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetMatchPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /datasets/{datasetType}: get: tags: - Datasets summary: | Get dataset metadata operationId: Datasets_getMetadata description: > Returns metadata for a specific dataset. The metadata includes the date it was last updated in our system in addition to the JSON schema used for the records. parameters: - description: The specific dataset type to get the metadata for. name: datasetType in: path required: true schema: 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 - AmericanHeartAssociation type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error /datasets: get: tags: - Datasets summary: | List datasets metadata operationId: Datasets_getMetadata description: > Returns metadata for all available datasets. The metadata includes the date it was last updated in our system in addition to the JSON schema used for the records. parameters: - description: >- If set, the result will contain items with matching associated tags. Currently supported tags are: "Sanctions and Exclusions", "Board Certifications", "NPI", "Id Check", "NPDB" name: tags in: query schema: type: array items: type: string - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Name - Type type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Name - Type type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetPageModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /monitors: post: tags: - Monitoring summary: | Initiate monitoring for a provider operationId: Monitoring_initiateProviderMonitoring description: > Initiate monitoring for a dataset or license for a provider. Please note that not all dataset types support monitoring. Please refer to [dataset endpoint](https://api.discovery.verifiable.com) to get the capabilities of a dataset. requestBody: content: application/json: schema: $ref: '#/components/schemas/MonitorRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/MonitorModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - Monitoring summary: | Lists all the monitored items operationId: Monitoring_listMonitoredItems description: > Lists all the monitors and monitoring settings for monitors that are enabled. parameters: - description: If set, the items will be filtered on monitor type. name: type in: query schema: enum: - Dataset - License type: string - description: >- If set, the items will be filtered on providers with the specified ids. name: providerIds in: query schema: type: array items: type: string format: uuid - description: >- If set, the items will be filtered on datasets with the specified types. name: datasetTypes in: query schema: type: array items: 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 - AmericanHeartAssociation type: string - description: >- If set, the items will be filtered on licenses with the specified ids. name: licenseIds in: query schema: type: array items: type: string format: uuid - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Type - NextMonitoringDate type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Type - NextMonitoringDate type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MonitorPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /monitors/{id}: get: tags: - Monitoring summary: | Returns a specified monitored item operationId: Monitoring_getMonitoredItem description: | Returns all the info for a specified monitored item. parameters: - description: The identifier describing the monitored item. name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MonitorModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Monitoring summary: | Patch an existing monitored item operationId: Monitoring_updateMonitoredItem description: > Change existing monitoring for a specified item. Use this endpoint to update the monitoring frequency and next monitoring date. parameters: - description: The identifier describing the monitored item. name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/MonitorPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/MonitorModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - Monitoring summary: | Stop monitoring an item operationId: Monitoring_stopItem description: > Stops existing monitoring for a specified dataset or license for a provider. parameters: - description: The identifier describing the monitored item. name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /alerts/{alertId}: get: tags: - Alerts summary: | Get an existing alert operationId: Alerts_getData description: | Returns the data for a specific alert. parameters: - description: Identifier of the alert to get the data for. name: alertId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /alerts/{alertId}/dismiss: post: tags: - Alerts summary: | Dismiss an alert operationId: Alerts_dismissAlert description: | Dismisses a specific alert. parameters: - description: Identifier of the alert to dismiss. name: alertId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/DismissRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error /alerts/aggregations: get: tags: - Alerts summary: | Get alert aggregations operationId: Alerts_getAggregations description: > Returns aggregated counts for alerts either in active or dismissed state. parameters: - description: >- If set, the items will be filtered on providers with the specified deactivated status. name: providerDeactivated in: query schema: type: boolean responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertAggregationsModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /alerts: get: tags: - Alerts summary: | List alerts operationId: Alerts_getPage description: | Returns a page of alerts. parameters: - description: >- If set, the items will be filtered on provider with the specified identifier. name: providerId in: query schema: type: string format: uuid - name: providerName in: query schema: type: string - name: providerNpi in: query schema: type: integer format: int64 - description: If set, the items will be filtered on alerts of the specified type name: type in: query schema: type: array items: enum: - LicenseChanged - LicenseExpiresSoon - LicenseExpired - NpiRecordChanged - ProfileImportCompleted type: string - description: If set, filter the items by the dismissal status. name: status in: query schema: enum: - Active - Dismissed type: string - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: >- If set, the items will be filtered on providers with the specified deactivated status. name: providerDeactivated in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Timestamp type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Timestamp type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /groups: post: tags: - Groups summary: | Create a new group operationId: Groups_registerNewProviderGroup description: | Creates a new medical group of providers. requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/GroupModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - Groups summary: | List groups operationId: Groups_getAll description: | Returns groups parameters: - description: If set, the items will be filtered by `providerId`. name: providerId in: query schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GroupsGetAllResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /groups/{groupId}: get: tags: - Groups summary: | Get an existing group operationId: Groups_getData description: | Returns the data for a specific group. parameters: - description: Identifier of the group to get the data for. name: groupId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GroupModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Groups summary: | Patch an existing group operationId: Groups_updateGroupProperties description: | Allows you to change a group's name or other data properties. parameters: - name: groupId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GroupModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - Groups summary: | Delete an existing group operationId: Groups_deleteGroupWithAssociations description: | This will delete the group and all its associations with providers. parameters: - name: groupId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /groups/{groupId}/enrollments: get: tags: - Groups summary: | List enrollments for the group operationId: Groups_listEnrollments description: > Returns a page of enrollments for the specified group or generated csv roster if `rosterType` parameter specified. parameters: - description: The unique identifier of the group to get enrollments for. name: groupId in: path required: true schema: type: string format: uuid - description: >- If set, the items will be filtered on enrollments with the specified payer plan. name: payerPlanId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on enrollments with the specified network status. name: networkStatus in: query schema: enum: - None - Par - NonPar type: string - description: >- If set, the items will be filtered on enrollments with the specified enrollment status. name: enrollmentStatus in: query schema: enum: - NotSubmitted - Submitted - Enrolled - Denied type: string - description: >- If set, the items will be filtered on enrollments with the specified specialist type. name: specialistType in: query schema: enum: - None - Pcp - Specialist type: string - name: submissionDate in: query schema: type: string format: date-time - name: effectiveDate in: query schema: type: string format: date-time - name: sortedBy in: query schema: enum: - Id - NetworkStatus - EnrollmentStatus - SpecialistType - SubmissionDate - EffectiveDate - PayerPlanName type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - NetworkStatus - EnrollmentStatus - SpecialistType - SubmissionDate - EffectiveDate - PayerPlanName type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: If set, csv report of specified type will be generated. name: rosterType in: query schema: enum: - Providers - Licenses - Deas - LiabilityInsurances type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /groups/{groupId}/providers: get: tags: - Groups summary: | List providers for the group operationId: Groups_listProviders description: > Returns a page of providers for the specified group or generated csv roster if `rosterType` parameter specified. parameters: - description: The unique identifier of the group to get providers for. name: groupId in: path required: true schema: type: string format: uuid - description: >- If set, the items will be filtered on providers with the specified status. name: status in: query schema: enum: - None - NeedsReview - ExpiresSoon - Expired - Monitored - NotMonitored - NotFoundLicenses - DisciplinaryActionLicenses - UnableToVerifyLicenses type: string - name: providerName in: query schema: type: string - description: >- If set, the items will be filtered on providers with the specified credentialing status. name: credentialingStatus in: query schema: type: array items: type: string - name: providerTypeId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on providers with the specified npi number. name: npi in: query schema: type: integer format: int64 - name: deactivated in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Id - LastName - FirstName - CredentialingStatus - CredentialedDate type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - LastName - FirstName - CredentialingStatus - CredentialedDate type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: If set, csv report of specified type will be generated. name: rosterType in: query schema: enum: - Providers - Licenses - Deas - LiabilityInsurances type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Groups summary: | Patch providers-group relations operationId: Groups_updateProvidersGroupRelations description: | Patch associations between group and providers. parameters: - description: Identifier of the group. name: groupId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupProviderRelationPatchModel' responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /groups/{groupId}/payer-plans: patch: tags: - Groups summary: | Patch payer plans-group relations operationId: Groups_updatePayerPlansGroupRelations description: | Patch associations between group and payer plans. parameters: - description: Identifier of the group. name: groupId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupPayerRelationPatchModel' responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /payers: post: tags: - Payers summary: | Create a new payer operationId: Payers_registerNewPayer description: | Creates a new payer. requestBody: content: application/json: schema: $ref: '#/components/schemas/PayerRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PayerModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - Payers summary: | List payers operationId: Payers_getAll description: | Returns all payers responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayersGetAllResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /payers/{payerId}: get: tags: - Payers summary: | Get an existing payer operationId: Payers_getPayerData description: | Returns the data for a specific payer. parameters: - description: Identifier of the payer to get the data for. name: payerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayerModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Payers summary: | Patch an existing payer operationId: Payers_updatePayerData description: | Allows you to change a payers's name or other data properties. parameters: - description: Identifier of the payer to patch. name: payerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PayerPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayerModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - Payers summary: | Delete an existing payer operationId: Payers_deletePayer description: | This will delete the payer and all its plans. parameters: - description: Identifier of the payer to delete. name: payerId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /payer-plans: post: tags: - PayerPlans summary: | Create a new payer plan operationId: PayerPlans_createNewPlan description: | Creates a new payer plan. requestBody: content: application/json: schema: $ref: '#/components/schemas/PayerPlanRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PayerPlanModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - PayerPlans summary: | List payer plans operationId: PayerPlans_list description: | Returns payer plans parameters: - description: Identifier of the group to get the payer plans for. name: groupId in: query schema: type: string format: uuid - description: Identifier of the payer to get the payer plans for. name: payerId in: query schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayerPlansListResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /payer-plans/{payerPlanId}: get: tags: - PayerPlans summary: | Get an existing payer plan operationId: PayerPlans_getPlanData description: | Returns the data for a specific payer plan. parameters: - description: Identifier of the payer plan to get the data for. name: payerPlanId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayerPlanModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - PayerPlans summary: | Patch an existing payer plan operationId: PayerPlans_updatePlanProperties description: | Allows you to change a payer plan's name or other data properties. parameters: - description: Identifier of the payer plan to patch. name: payerPlanId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PayerPlanPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PayerPlanModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - PayerPlans summary: | Delete an existing payer plan operationId: PayerPlans_deleteExistingPlan description: | This will delete the payer plan. parameters: - description: Identifier of the payer plan to delete. name: payerPlanId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/enrollments: post: tags: - ProviderEnrollments summary: | Create a new provider enrollment operationId: ProviderEnrollments_createNewEnrollment description: | Creates a new enrollment of provider to payer plan. requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProviderEnrollments summary: | List provider enrollments operationId: ProviderEnrollments_listPage description: | Returns a page of provider enrollments. parameters: - description: The unique identifier of the group to get enrollments for. name: groupId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on enrollments with the specified provider. name: providerId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on enrollments with the specified payer plan. name: payerPlanId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered on enrollments with the specified network status. name: networkStatus in: query schema: enum: - None - Par - NonPar type: string - description: >- If set, the items will be filtered on enrollments with the specified enrollment status. name: enrollmentStatus in: query schema: enum: - NotSubmitted - Submitted - Enrolled - Denied type: string - description: >- If set, the items will be filtered on enrollments with the specified specialist type. name: specialistType in: query schema: enum: - None - Pcp - Specialist type: string - name: submissionDate in: query schema: type: string format: date-time - name: effectiveDate in: query schema: type: string format: date-time - name: sortedBy in: query schema: enum: - Id - NetworkStatus - EnrollmentStatus - SpecialistType - SubmissionDate - EffectiveDate - PayerPlanName type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - NetworkStatus - EnrollmentStatus - SpecialistType - SubmissionDate - EffectiveDate - PayerPlanName type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/enrollments/{providerEnrollmentId}: get: tags: - ProviderEnrollments summary: | Get an existing provider enrollment operationId: ProviderEnrollments_getData description: | Returns the data for a specific provider enrollment. parameters: - description: Identifier of the provider enrollment to get the data for. name: providerEnrollmentId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProviderEnrollments summary: | Patch an existing provider enrollment operationId: ProviderEnrollments_updateDataProperties description: | Allows you to change a provider enrollment's data properties. parameters: - description: Identifier of the provider enrollment to patch. name: providerEnrollmentId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderEnrollmentModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - ProviderEnrollments summary: | Delete an existing provider enrollment operationId: ProviderEnrollments_deleteEnrollment description: | This will delete the provider enrollment. parameters: - description: Identifier of the provider enrollment to delete. name: providerEnrollmentId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /integrations/fountain/webhook/{organizationId}: post: tags: - Integrations summary: | Fountain integration webhook operationId: Integrations_fountainWebhookPost description: | Webhook for the Fountain integration. parameters: - description: The organization on which this webhook is called. name: organizationId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FountainWebhookRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FountainWebhookResponseModel' '400': description: Bad Request '403': description: Forbidden '500': description: Server Error /integrations/salesforce/documentrequest: post: tags: - Integrations summary: | Salesforce document request operationId: Integrations_createSalesforceDocumentRequest description: | Request a document to be uploaded to the configured Salesforce tenant. requestBody: content: application/json: schema: $ref: '#/components/schemas/SalesforceDocumentRequestRequestModel' responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error /webhooks: post: tags: - Webhooks summary: Create a new webhook operationId: Webhooks_createNewWebhook description: >- Creates a new webhook that will be called when the specified event is triggered. requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/WebhookModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '409': description: Conflict '500': description: Server Error get: tags: - Webhooks summary: List all webhooks operationId: Webhooks_listAll description: List all webhooks created on this organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebhooksListAllResponse' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /webhooks/{webhookId}: get: tags: - Webhooks summary: Get details from a webhook operationId: Webhooks_getDetails description: Get details from a previously created webhook. parameters: - description: Identifier of a previously created webhook. name: webhookId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebhookModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - Webhooks summary: | Update a webhook operationId: Webhooks_updateWebhook description: | Update a previously created webhook. parameters: - description: Identifier of a previously created webhook. name: webhookId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebhookModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error delete: tags: - Webhooks summary: | Delete a webhook operationId: Webhooks_deleteWebhook description: | Deletes a previously created webhook. parameters: - description: Identifier of a previously created webhook to be deleted. name: webhookId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /webhookslog: get: tags: - Webhooks summary: | List all webhooks logs operationId: Webhooks_listAllLogs description: | List all webhooks logs on this organization. parameters: - description: If set, the items will be filtered with the specified webhook type. name: type in: query schema: enum: - VerificationCompleted - ExportCompleted - LicenseExpiresSoon - LicenseExpired - LicenseChanged - NpiChanged - BoardCertificationVerificationCompleted - BoardCertificationExportCompleted - DatasetScanCompleted - LicenseStatusChanged - ProviderStatusChanged - ProviderProfileImportCompleted - CredentialingRequestChanged - GenerateReport - DatasetScanMatchesChanged - NpdbUpdateRequestRejected type: string - description: >- If set, the items will be filtered with the specified webhook log status. name: status in: query schema: enum: - Triggered - Completed - Failed type: string - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: >- If set, the items will be filtered with the specified webhook log trace id. name: traceId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered with timestamp value less the provided value. name: before in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `before` date and time too. name: beforeInclusive in: query schema: type: boolean - description: >- If set, the items will be filtered with timestamp value more the provided value. name: after in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `after` date and time too. name: afterInclusive in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Timestamp type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Timestamp type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WebhooksLogPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /log/events: get: tags: - Audit summary: | List event log entries operationId: Audit_listEventLogEntries description: > Returns a page of event log entries. Events can occur either system or user initiated. In case an event is user initiated the event context contains information on the user that triggered it and the associated HTTP request is captured. parameters: - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string - description: >- If set, only returns events with the specified type. More than 1 type can be specified. name: type in: query schema: type: array items: enum: - System - Request - Legacy type: string - description: >- If set to `true`, also includes read request events (these are filtered out by default). name: includeReadRequests in: query schema: type: boolean - description: >- If set to `true`, also includes failed request events (these are filtered out by default). Note that not all failed requests can be captured or assigned to your organization, depending on the nature of the failure. name: includeFailedRequests in: query schema: type: boolean - description: >- If set, only returns events related to the specified identifier. For example, to filter on events for a given provider, set this parameter to the identifier of that provider. More than 1 entity identifier can be specified. name: entityId in: query schema: type: array items: type: string format: uuid - description: >- If set, only returns events related to the specified category. More than 1 category can be specified. name: category in: query schema: type: array items: enum: - Verifications - ProviderInfo - ProviderManagement - Organization - Integrations - Groups - ProviderProfile - Beta - Mpd - Console - FacilityManagement - FacilityInfo type: string - description: >- If set, only returns events related to the specified subcategory. The subcategories differ per `category`. More than 1 subcategory can be specified. name: subcategory in: query schema: type: array items: type: string - description: If set, only returns events from before this date. name: before in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `before` date and time too. name: beforeInclusive in: query schema: type: boolean - description: If set, only returns events from after this date. name: after in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `after` date and time too. name: afterInclusive in: query schema: type: boolean - description: >- If set, only returns events related to the specified correlation identifier. name: correlationId in: query schema: type: string format: uuid - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Timestamp - Type type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Timestamp - Type type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EventLogPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /users/me/password: post: tags: - Users summary: | Change the password of the current user operationId: Users_changePassword description: > Changes the password of the current user. **Note:** If the current user does not have a password (e.g. they use Google Authentication) `password` can be empty. Otherwise, `password` must be the current password of the user. requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordUpdateModel' responses: '200': description: Success '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /organization/reports/sanctionsandexclusions: get: tags: - Reports summary: | List sanctions and exclusions reports for the organization. operationId: Reports_listSanctionsAndExclusions description: > Returns a list of all the sanctions and exclusions reports that have been created so far. The reports are sorted in descending order from latest created to oldest. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ReportsListSanctionsAndExclusionsResponse' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /credentialing-requests/aggregations/owners: get: tags: - CredentialingRequests summary: | Aggregate provider credentialing request owners operationId: CredentialingRequests_aggregateProviderOwners description: > Returns an aggregation of all owners assigned to provider credentialing requests parameters: - description: >- If set, the items will be filtered on requests for the providers with the specified deactivated status. name: providerDeactivated in: query schema: type: boolean responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/CredentialingRequestsAggregateProviderOwnersResponse '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /providers/{providerId}/licenses: post: tags: - Licenses summary: | Attach a license to a provider operationId: Licenses_attachProviderLicense description: > To perform a license verification you must first attach a license to a provider. The first time you do this will automatically trigger a license verification on that provider. Once attached you can reverify the same license without reattaching it. A provider can have more than one license attached. parameters: - description: The identifier describing the provider to attach the license to. name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachLicenseRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/LicenseModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - Licenses summary: | List all licenses from a provider operationId: Licenses_listFromProvider description: > Returns a list of all licenses previously attached to the specified provider. parameters: - description: The identifier describing the provider to list all licenses for. name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicensesListFromProviderResponse' '400': description: Bad Request '401': description: Unauthorized '500': description: Server Error /integrations/cognito-forms/webhook/{type}: post: tags: - CognitoFormsWebhook operationId: CognitoFormsWebhook_receiveData parameters: - name: type in: query schema: enum: - Submit - Update - Delete type: string - name: type in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CognitoFormsWebhookReceiveDataRequest' responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Server Error /credentialing-requests: post: tags: - CredentialingRequests summary: | Create a new credentialing request operationId: CredentialingRequests_submitNewRequest description: | Creates a new credentialing request for a provider or facility. requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - CredentialingRequests summary: | List credentialing requests operationId: CredentialingRequests_listRequests description: | Returns credentialing requests parameters: - description: >- Indicates whether to retrieve credentialing requests for providers or facilities. Defaults to providers. name: entityType in: query schema: enum: - Provider - Facility type: string - description: >- If set, the items will be filtered by the specified current event status. name: currentEventStatus in: query schema: type: array items: enum: - RequestSubmitted - RequestInProgress - AdditionalInformationRequested - AdditionalInformationSubmitted - CancellationRequested - Cancelled - Completed - CompletedWithConcern - UnableToComplete - SecondAttemptMissingInfo - ThirdAttemptMissingInfo type: string - description: >- If set, the items will be filtered by the specified provider credentialing status. Has no effect when querying facilities. name: providerCredentialingStatus in: query schema: type: array items: type: string - description: If set, the items will be filtered by the specified priority. name: priority in: query schema: type: array items: enum: - Low - Medium - High - Urgent type: string - description: If set, the items will be filtered by the specified owner. name: ownerId in: query schema: type: array items: type: string format: uuid - description: >- If set, the items will include credentialing requests that are not assigned to any specified owner. Intended to be used together with `ownerId`. name: includeUnassigned in: query schema: type: boolean - description: >- If set, the items will be filtered by the specified credentialing request type. name: credentialingRequestType in: query schema: enum: - Initial - ReCredentialing type: string - description: >- If set, the items will be filtered by the specified entity identifier (`providerId` or `facilityId`). name: entityId in: query schema: type: string format: uuid - description: >- If set, the items will be filtered by the specified entity name (provider name/alias or facility name). name: entityName in: query schema: type: string - description: >- If set, the items will be filtered by the specified entity NPI number. name: entityNpi in: query schema: type: integer format: int64 - description: >- If set, the items will be filtered by the specified entity deactivated status. name: entityDeactivated in: query schema: type: boolean - description: See `entityId`. name: providerId in: query deprecated: true schema: type: string format: uuid deprecated: true - description: See `entityName`. name: providerName in: query deprecated: true schema: type: string deprecated: true - description: See `entityNpi`. name: providerNpi in: query deprecated: true schema: type: integer format: int64 deprecated: true - description: See `entityDeactivated`. name: providerDeactivated in: query deprecated: true schema: type: boolean deprecated: true - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Id - CreatedAt - Priority - CurrentEventStatus - CurrentEventDate - ProviderId - ProviderFirstName - ProviderLastName - ProviderCredentialingStatus - FacilityId - FacilityName type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Id - CreatedAt - Priority - CurrentEventStatus - CurrentEventDate - ProviderId - ProviderFirstName - ProviderLastName - ProviderCredentialingStatus - FacilityId - FacilityName type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestPageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /credentialing-requests/{requestId}/events: post: tags: - CredentialingRequests summary: | Create a new credentialing request event operationId: CredentialingRequests_createEvent description: | Creates a new event for a credentialing request. parameters: - name: requestId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestEventRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestEventModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /providers/{providerId}/info/dea: post: tags: - ProvidersInfo summary: | Create DEA registration info for the existing provider operationId: ProvidersInfo_createDeaRegistrationInfo description: | Add a DEA registration info for the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/DeaRegistrationInfoRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DeaRegistrationInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error get: tags: - ProvidersInfo summary: | List DEA registrations operationId: ProvidersInfo_listDeaRegistrations description: | Returns all DEA registrations associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListDeaRegistrationsResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/addresses: post: tags: - ProvidersInfo summary: | Create address for an existing provider operationId: ProvidersInfo_addAddress description: | Add an address for the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAddressRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderAddressModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - ProvidersInfo summary: | List addresses operationId: ProvidersInfo_listAddresses description: | Returns all addresses associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListAddressesResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/aliases: get: tags: - ProvidersInfo summary: | List aliases operationId: ProvidersInfo_listAliases description: | Returns all aliases associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListAliasesResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error post: tags: - ProvidersInfo summary: | Create alias for an existing provider operationId: ProvidersInfo_createAlias description: | Add an alias for the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAliasRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderAliasModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/emails: post: tags: - ProvidersInfo summary: | Create email for an existing provider operationId: ProvidersInfo_createEmail description: | Add an email for the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderEmailRequestModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProviderEmailModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - ProvidersInfo summary: | List emails operationId: ProvidersInfo_listEmails description: | Returns all emails associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProvidersInfoListEmailsResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/dea/{id}: delete: tags: - ProvidersInfo summary: | Delete existing DEA registration info for the existing provider operationId: ProvidersInfo_deleteDeaRegistration description: > Deletes an existing DEA registration info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - ProvidersInfo summary: | Get DEA registration for the existing provider operationId: ProvidersInfo_getDeaRegistration description: | Returns the DEA registration for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeaRegistrationInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - ProvidersInfo summary: | Change an existing provider's DEA registration info operationId: ProvidersInfo_updateDea description: > Change an existing DEA registration info associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/DeaRegistrationInfoPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeaRegistrationInfoModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/addresses/{id}: delete: tags: - ProvidersInfo summary: | Delete existing address for a provider operationId: ProvidersInfo_deleteAddress description: | Deletes an existing address associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - ProvidersInfo summary: | Get address for an existing provider operationId: ProvidersInfo_getAddress description: | Returns the address for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderAddressModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error put: tags: - ProvidersInfo summary: | Change an existing provider's address operationId: ProvidersInfo_updateAddress description: | Change an existing address associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAddressRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderAddressModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/info/emails/{id}: delete: tags: - ProvidersInfo summary: | Delete existing email for a provider operationId: ProvidersInfo_deleteEmail description: | Deletes an existing email associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error get: tags: - ProvidersInfo summary: | Get email for the existing provider operationId: ProvidersInfo_getEmail description: | Returns the email for a specific provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderEmailModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error put: tags: - ProvidersInfo summary: | Change an existing provider's email operationId: ProvidersInfo_updateEmail description: | Change an existing email associated with the specified provider. parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderEmailRequestModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderEmailModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /credentialing-requests/{requestId}: get: tags: - CredentialingRequests summary: | Get a specific credentialing request operationId: CredentialingRequests_getSpecificRequest description: | Returns the data for a specific credentialing request. parameters: - description: Identifier of the credentialing request to get the data for. name: requestId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error patch: tags: - CredentialingRequests summary: | Patch an existing credentialing request operationId: CredentialingRequests_updateProperties description: | Changes properties for an existing credentialing request. parameters: - name: requestId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestPatchModel' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /credentialing-requests/aggregations: get: tags: - CredentialingRequests summary: | Get provider credentialing requests aggregations operationId: CredentialingRequests_getAggregations description: | Returns aggregated counts for provider credentialing requests. parameters: - description: >- If set, the items will be filtered on providers with the specified deactivated status. name: providerDeactivated in: query schema: type: boolean responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestAggregationModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /credentialing-requests/{requestId}/events/{eventId}: get: tags: - CredentialingRequests summary: | Get a specific credentialing request event operationId: CredentialingRequests_specificEventData description: | Returns the data for a specific credentialing request event. parameters: - description: Identifier of the credentialing request associated to the event. name: requestId in: path required: true schema: type: string format: uuid - description: Identifier of the event to get the data for. name: eventId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestEventModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /datasets/matches/aggregations: get: tags: - Datasets summary: | Get dataset matches aggregations operationId: Datasets_getMatchesAggregations description: > Returns aggregated counts for dataset matches that require `user action` and for dataset matches that have been `accepted`. parameters: - description: >- If set, the items will be filtered on providers with the specified deactivated status. name: providerDeactivated in: query schema: type: boolean responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetMatchesAggregationsModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /datasets/{datasetType}/parameters/{providerId}: get: tags: - Datasets summary: | Get dataset scan parameters for a provider operationId: Datasets_getScanParameters description: > Returns the list of dataset scan parameters that will be used during a dataset scan. parameters: - description: The specific dataset type to get the scan parameters for. name: datasetType in: path required: true schema: 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 - AmericanHeartAssociation type: string - description: >- The identifier of the provider for which the parameters should be returned. name: providerId in: path required: true schema: type: string format: uuid - description: >- If set, the results will only return the parameters based on the specified parameter set else the parameters will be returned based on preferred dataset parameter. name: parameterSetId in: query schema: type: string format: uuid - description: >- If set, the results will only use the associated provider info to derive the parameters. name: referenceId in: query schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetsGetScanParametersResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /facilities/{facilityId}/info: get: tags: - GetFacilityInfo operationId: GetFacilityInfo_details parameters: - name: facilityId in: path required: true schema: type: string format: uuid - name: facilityInfoTypes in: query schema: type: array items: enum: - Npi - Dea - LiabilityInsurance - License - Accreditation - CmsCertification type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetFacilityInfoDetailsResponse' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /providers/{providerId}/credentialing-data: get: tags: - GetProviderCredentialingData operationId: GetProviderCredentialingData_details parameters: - name: providerId in: path required: true schema: type: string format: uuid - name: credentialingRequestId in: query schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CredentialingDataModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /provider-licenses/aggregations: get: tags: - Licenses summary: | Get provider licenses aggregations operationId: Licenses_getAggregations description: | Returns aggregated counts for provider licenses with different statuses. parameters: - name: providerDeactivated in: query schema: type: boolean responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ProviderLicenseAggregationsModel' '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /files/exports: get: tags: - Files summary: | List event log exports operationId: Files_listExportedEventLogs description: | Returns metadata for exported event logs. parameters: - description: >- If set the result is filtered to return only files whose path begin with the specified prefix. name: prefix in: query schema: maxLength: 640 minLength: 0 type: string - description: If set, only returns events from before this date. name: before in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `before` date and time too. name: beforeInclusive in: query schema: type: boolean - description: If set, only returns events from after this date. name: after in: query schema: type: string format: date-time - description: >- If set to `true`, will include events created exactly at `after` date and time too. name: afterInclusive in: query schema: type: boolean - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Path - CreatedAt type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Path - CreatedAt type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: type: integer format: int32 - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FilePageModel' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /datasets/nsc/schoolCodes: get: tags: - Datasets summary: | List schools operationId: Datasets_listSchools description: > Returns a page of schools that are supported by NSC. The codes originating from [National Student Clearinghouse](https://docs.studentclearinghouse.org/vs/participating-schools) parameters: - description: >- If set, the items will be filtered on schools with the specified name. name: name in: query schema: type: string - description: >- If set, the items will be filtered on schools with the specified code. name: code in: query schema: type: string - description: The number of items to include in a single page. name: count in: query schema: maximum: 1000 minimum: 1 type: integer format: int32 - description: The property by which the returned data will be sorted. name: sortedBy in: query schema: enum: - Name - Code type: string - description: >- If set, the properties and directions the returned data will be sorted by. name: sort in: query schema: type: object additionalProperties: type: object properties: Keys: enum: - Name - Code type: string Values: enum: - Asc - Desc type: string - description: The offset for the page to start. name: offset in: query deprecated: true schema: type: integer format: int32 - description: >- The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically. name: cursor in: query schema: type: string - description: The direction the returned data will be sorted by. name: sortDirection in: query schema: enum: - Asc - Desc type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SchoolCodePageModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '500': description: Server Error /datasets/matches/{matchId}: patch: tags: - Datasets summary: | Patch an existing dataset match operationId: Datasets_modifyMatchStatus description: > Allows you to reject, accept or restore a previous rejected dataset match. Only a match from the most recent scan can be patched. parameters: - description: Identifier of the dataset match to patch. name: matchId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/DatasetMatchPatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DatasetMatchModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /licenses/{licenseId}: patch: tags: - Licenses summary: | Patch an existing license operationId: Licenses_updateExistingLicense description: | Allows you to change a license's restriction or approved status. parameters: - description: Identifier of the license to patch. name: licenseId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/LicensePatchModel' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/LicenseModel' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /credentialing-requests/{requestId}/checklist: put: tags: - CredentialingRequests summary: | Create or replace a credentialing request checklist operationId: CredentialingRequests_replaceChecklist description: | Creates or replaces a checklist for a credentialing request. parameters: - name: requestId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialingRequestChecklistRequestModel' responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Server Error /datasets/scans/{scanId}/refresh: post: tags: - Datasets summary: | Refresh dataset scan operationId: Datasets_refreshScan description: > Triggers a refresh for an existing running continuous dataset scan. Currently only NPDB dataset supports it. For NPDB it will trigger Status request to fetch the latest available response from the site. parameters: - description: The identifier of the scan to trigger refresh for. name: scanId in: path required: true schema: type: string format: uuid responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '500': description: Server Error components: schemas: AbmsAddressRecord: type: object properties: city: type: string nullable: true stateOrProvince: type: string nullable: true postalCode: type: string nullable: true country: type: string nullable: true restrictions: type: string nullable: true AbmsCertificateInfo: type: object properties: name: type: string nullable: true type: type: string nullable: true status: type: string nullable: true maintenance: type: string nullable: true maintenanceRequired: type: string nullable: true issuance: type: array items: $ref: '#/components/schemas/AbmsCertificateIssuance' nullable: true recognition: type: array items: $ref: '#/components/schemas/AbmsCertificateRecognition' nullable: true AbmsCertificateIssuance: type: object properties: focus: type: string nullable: true duration: type: string nullable: true occurrence: type: string nullable: true issueDate: type: string format: date-time nullable: true issueDateAccuracy: type: string nullable: true expiryDate: type: string format: date-time nullable: true expiryDateAccuracy: type: string nullable: true scheduledUpdate: type: string format: date-time nullable: true scheduledUpdateAccuracy: type: string nullable: true status: type: string nullable: true notices: type: array items: $ref: '#/components/schemas/AbmsCertificateIssuanceNotice' nullable: true AbmsCertificateIssuanceNotice: type: object properties: category: type: string nullable: true details: type: string nullable: true AbmsCertificateRecognition: type: object properties: status: type: string nullable: true name: type: string nullable: true type: type: string nullable: true duration: type: string nullable: true issueDate: type: string format: date-time issueDateAccuracy: type: string nullable: true expiryDate: type: string format: date-time nullable: true expiryDateAccuracy: type: string nullable: true scheduledUpdate: type: string format: date-time nullable: true scheduledUpdateAccuracy: type: string nullable: true AbmsCertificationInfo: type: object properties: recognitionOrganization: type: string nullable: true certificationBoard: type: string nullable: true maintenance: type: string nullable: true maintenanceRequired: type: string nullable: true certificateInfo: type: array items: $ref: '#/components/schemas/AbmsCertificateInfo' nullable: true AbmsDatasetRecord: type: object properties: uniqueId: type: array items: $ref: '#/components/schemas/AbmsMemberId' nullable: true name: $ref: '#/components/schemas/AbmsNameRecord' address: $ref: '#/components/schemas/AbmsAddressRecord' educationInfo: type: array items: $ref: '#/components/schemas/AbmsEducationInfo' nullable: true certificationInfo: type: array items: $ref: '#/components/schemas/AbmsCertificationInfo' nullable: true occupationInfo: $ref: '#/components/schemas/AbmsOccupationInfo' personalInfo: $ref: '#/components/schemas/AbmsPersonalInfo' extensibleInfo: $ref: '#/components/schemas/AbmsExtensibleInfo' restrictions: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid AbmsDisclaimerInfo: type: object properties: certificationBoard: type: string nullable: true disclaimer: type: string nullable: true AbmsEducationInfo: type: object properties: degree: type: string nullable: true endDate: type: string format: date-time nullable: true endDateAccuracy: type: string nullable: true AbmsExtensibleInfo: type: object properties: disclaimerInfo: type: array items: $ref: '#/components/schemas/AbmsDisclaimerInfo' nullable: true AbmsMemberId: type: object properties: id: type: string nullable: true domain: type: string nullable: true AbmsNameRecord: type: object properties: givenName: type: array items: type: string nullable: true familyName: type: string nullable: true generationIdentifier: type: string nullable: true AbmsOccupationInfo: type: object properties: restrictions: type: string nullable: true startDate: type: string format: date-time nullable: true startDateAccuracy: type: string nullable: true status: type: string nullable: true AbmsPersonalInfo: type: object properties: restrictions: type: string nullable: true physicalStatus: type: string nullable: true dateOfBirth: type: string format: date-time nullable: true dateOfBirthAccuracy: type: string nullable: true dateOfBirthRestriction: type: string nullable: true deceasedDate: type: string format: date-time nullable: true AccessTokenModel: type: object properties: id: description: Unique identifier of the access token. type: string format: uuid lastUserAgent: description: The user agent of the remote user that last used this access token. type: string lastIpAddress: description: The IP address of the remote user that last used this access token. type: string lastUsed: description: The timestamp when this access token was last used. type: string format: date-time isCurrent: description: Set to true if this access token was used in the current request. type: boolean expiresAt: type: string format: date-time AccessTokenPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Id type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The audit log entries in the current page. type: array items: $ref: '#/components/schemas/AccessTokenModel' sortedBy: description: The property by which the data is sorted. enum: - Id type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X lastUserAgent: string lastIpAddress: string lastUsed: '2019-08-24T14:15:22.0000000Z' isCurrent: true expiresAt: '2019-08-24T14:15:22.0000000Z' sortedBy: Id sortDirection: Asc sort: Id: Asc AddressModel: required: - addressLine1 - city - state - zipCode type: object properties: state: 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 type: string zipCode: minLength: 1 type: string city: minLength: 1 type: string addressLine1: minLength: 1 type: string addressLine2: type: string nullable: true AlertAggregationsModel: type: object properties: active: description: The total number of active alerts. type: integer format: int32 dismissed: description: The total number of dismissed alerts. type: integer format: int32 licenseChanged: description: The total number of active `License Changed` alerts. type: integer format: int32 licenseExpiresSoon: description: The total number of active `License Expires Soon` alerts. type: integer format: int32 licenseExpired: description: The total number of active `License Expired` alerts. type: integer format: int32 npiRecordChanged: description: The total number of active `NPI Record Changed` alerts. type: integer format: int32 profileImportCompleted: description: The total number of active `Profile Import Completed` alerts. type: integer format: int32 AlertData: type: object properties: messageTemplate: description: >- An informative human readable message describing the action in the audit log entry. type: string messageParams: description: >- Collection of key/value pairs containing parameters to be replaced in `messageTemplate`. type: object additionalProperties: type: string nullable: true data: type: object additionalProperties: type: string nullable: true AlertModel: type: object properties: type: description: The type of event that led to this alert. enum: - LicenseChanged - LicenseExpiresSoon - LicenseExpired - NpiRecordChanged - ProfileImportCompleted type: string providerId: description: Identifier of the provider related to this alert. type: string format: uuid provider: $ref: '#/components/schemas/ProviderModel' entityType: description: If set, the type of the entity that `EntityId` refers to. enum: - License - Verification - Alert - NpiRecord - Note - BoardCertification - BoardCertificationVerification - DeaVerification - DatasetScan - DatasetRecord - File - ProfileImport - NpdbVerificationRequest type: string entityId: description: Identifier of the related entity that's relevant to this alert type. type: string format: uuid data: $ref: '#/components/schemas/AlertData' timestamp: description: The date and time when this alert was triggered. type: string format: date-time dismissalTimestamp: description: The date and time when this alert was dismissed, if at all. type: string format: date-time dismissalNote: description: >- The note supplied as reason for dismissal, if and when this alert was dismissed. type: string id: description: Unique identifier for this alert. type: string format: uuid AlertPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Timestamp type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The audit log entries in the current page. type: array items: $ref: '#/components/schemas/AlertModel' sortedBy: description: The property by which the data is sorted. enum: - Timestamp type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - type: LicenseChanged providerId: 4834bcdc-4a64-444d-966b-1a6fe381da24 entityType: License entityId: 156e622c-6cdf-4c27-9bc9-2f2db69919f5 data: messageTemplate: string messageParams: property1: string property2: string data: property1: string property2: string timestamp: '2019-08-24T14:15:22.0000000Z' dismissalTimestamp: '2019-08-24T14:15:22.0000000Z' dismissalNote: string id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X sortedBy: Timestamp sortDirection: Asc sort: Timestamp: Asc AliasModel: type: object properties: firstName: type: string nullable: true lastName: type: string nullable: true AttachLicenseRequestModel: required: - licenseTypeId - state type: object properties: licenseNumber: type: string nullable: true licenseTypeId: type: string format: uuid firstName: type: string nullable: true lastName: type: string nullable: true state: 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 type: string taxonomyCode: type: string nullable: true restrictionStatus: enum: - None - Restricted - Unrestricted type: string approvedStatus: enum: - Pending - 'Yes' - 'No' type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedLicenseInfoModel' skipVerification: type: boolean isCurrentlyPracticing: type: boolean nullable: true isPrimary: type: boolean prescriptiveAuthority: enum: - RequiredMet - RequiredNotMet - NotRequired type: string nullable: true collaboratingProviderId: type: string format: uuid nullable: true AuthResponseModel: type: object properties: tokenId: description: >- Unique identifier for this token. This can be used to invalidate a token. type: string format: uuid token: $ref: '#/components/schemas/SensitiveString' email: description: >- The e-mail address of the user. It will either be the same e-mail address used on the password authentication or the e-mail address of the Google account in the case of Google authentication. type: string role: $ref: '#/components/schemas/UserRoleModel' expiresAt: description: Expiration time of the access token. type: string format: date-time persistenceHint: enum: - Persistent - Ephemeral type: string example: tokenId: 0847312d-19fe-49d2-9e21-5825735b511a token: MtetyFcIW...xgXXX-Z4yy BaseUserModel: type: object properties: id: description: The unique identifier of this user. type: string format: uuid email: description: The email of this user. type: string firstName: description: The firstname of this user. type: string lastName: description: The lastname of this user. type: string BoardCertificateResult: type: object properties: boardName: type: string nullable: true certificateStatus: type: string nullable: true isExpired: type: boolean nullable: true issued: type: string format: date-time nullable: true expires: type: string format: date-time nullable: true mocParticipation: type: boolean nullable: true additionalProperties: $ref: '#/components/schemas/FlexibleDataModel' BoardCertification: type: object properties: boardName: type: string nullable: true status: type: string nullable: true isExpired: type: boolean nullable: true issued: type: string format: date-time nullable: true expires: type: string format: date-time nullable: true mocParticipation: type: boolean nullable: true additionalProperties: $ref: '#/components/schemas/FlexibleDataModel' BoardCertificationDatasetRecord: type: object properties: boardCertificationNumber: type: string nullable: true additionalProperties: $ref: '#/components/schemas/FlexibleDataModel' certifications: type: array items: $ref: '#/components/schemas/BoardCertification' nullable: true screenshots: type: array items: type: string nullable: true attachments: type: array items: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid fullName: type: string nullable: true BoardCertificationInfoModel: type: object properties: lastUpdatedAt: description: The date and time when the object was created or modified. type: string format: date-time id: description: Unique identifier associated with this board certification type: string format: uuid type: description: Board certification type. enum: - AmericanBoardofMedicalSpecialties - NationalBoardforCertifiedCounselors - AmericanBoardofClinicalSocialWork - AmericanSpeechLanguageHearingAssociation - AmericanNursesCredentialingCenter - AmericanAcademyofNursePractitioners - AmericanOsteopathicAssociation - AmericanMedicalAssociation - NationalBoardofCertificationandRecertificationforNurseAnesthetists - AmericanAssociationofCriticalCareNurses - AmericanMidwiferyCertificationBoard - AmericanBoardofPodiatricMedicine - AmericanBoardofOralImplantology - AmericanBoardofOralMedicine - AmericanBoardofOrofacialPain - AmericanDentalBoardofAnesthesiology - AmericanBoardofDentalPublicHealth - AmericanBoardofPediatricDentistry - AmericanBoardofPeriodontology - AmericanBoardofInternalMedicine - NationalCommissiononCertificationofPhysicianAssistants - AmericanBoardofAllergyandImmunology - AmericanBoardofAnesthesiology - AmericanBoardofColonandRectalSurgery - AmericanBoardofDermatology - AmericanBoardofEmergencyMedicine - AmericanBoardofFamilyMedicine - AmericanBoardofGeneticsandGenomics - AmericanBoardofNeurologicalSurgery - AmericanBoardofNuclearMedicine - AmericanBoardofObstetricsandGynecology - AmericanBoardofOphthalmology - AmericanBoardofOrthopaedicSurgery - AmericanBoardofOtolaryngologyHeadandNeckSurgery - AmericanBoardofPathology - AmericanBoardofPediatrics - AmericanBoardofPhysicalMedicineandRehabilitation - AmericanBoardofPlasticSurgery - AmericanBoardofPreventiveMedicine - AmericanBoardofProfessionalPsychology - AmericanBoardofPsychiatryandNeurology - AmericanBoardofRadiology - AmericanBoardofSurgery - AmericanBoardofThoracicSurgery - AmericanBoardofUrology - AmericanOptometricAssociation - AssociationofSocialWorkBoards - AmericanBoardofFootandAnkleSurgery - AmericanBoardofOralandMaxillofacialPathology - AmericanBoardofOralandMaxillofacialSurgery - AmericanBoardofOrthodontics - AmericanBoardofEndodontics - AmericanBoardofProsthodontics - NationalBoardforCertificationinOccupationalTherapy - BehaviorAnalystCertificationBoard - InternationalBoardofLactationConsultantExaminers - CommissionOnDieteticRegistration - NationalCertificationCommissionforAcupunctureandOrientalMedicine - PediatricNursingCertification - NationalCertificationCorporation - OncologyNursingCertificationCorporation - AmericanBoardOfCardiovascularMedicine - AmericanAcademyOfHIVMedicine - NationalBoardOfPhysiciansAndSurgeons - BoardOfPharmacySpecialties - AmericanBoardofOralandMaxillofacialRadiology - AmericanBoardofGeneralDentistry - NationalAssociationofSchoolPsychologists - NationalPhlebotomyAssociation - NationalCenterForCompetencyTesting - AmericanRegistryofRadiologyTechnologists - DentalAssistingNationalBoard - AmericanMedicalCertificationAssociation - AmericanBoardofAddictionMedicine - AmericanRegistryForDiagnosticMedicalSonography - AmericanBoardofMultipleSpecialtiesinPodiatry - AmericanBoardOfObesityMedicine - NationalCommissionForCertificationOfAnesthesiologistAssistants - CardiovascularCredentialingInternational - NationalBoardOfEchocardiography - AmericanAlliedHealth - AmericanMedicalTechnologists - NationalAssociationForHealthProfessionals - NationalHealthCareerAssociation - NationalPhlebotomyCertificationExamination - NationalAssociationOfPhlebotomyTechnicians - NationalHealthcareCertificationOrganization - NationalPerformanceSpecialists - NationalRegistryOfAlliedHealthProfessionals - BoardofCertificationforEmergencyNursing type: string firstName: description: >- Provider first name mentioned on the board certification. This field will be used for board certification lookup. type: string lastName: description: >- Provider last name mentioned on the board certification. This field will be used for board certification lookup. type: string boardCertificationNumber: description: >- A unique Id provided by certification board to the provider. This will be used for board certification lookup. type: string specialty: type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedBoardCertificationInfoModel' isPrimary: description: >- If the flag is set, certification will be set as primary for the provider. type: boolean BoardCertificationInfoPatchModel: type: object properties: firstName: description: >- Provider first name mentioned on the board certification. This field will be used for board certification lookup. type: string lastName: description: >- Provider last name mentioned on the board certification. This field will be used for board certification lookup. type: string isPrimary: description: >- If the flag is set, certification will be set as primary for the provider. type: boolean boardCertificationNumber: description: >- A unique Id provided by certification board to the provider. This will be used for board certification lookup. type: string specialty: type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedBoardCertificationInfoModel' BoardCertificationInfoRequestModel: required: - type type: object properties: type: description: Board certification type. enum: - AmericanBoardofMedicalSpecialties - NationalBoardforCertifiedCounselors - AmericanBoardofClinicalSocialWork - AmericanSpeechLanguageHearingAssociation - AmericanNursesCredentialingCenter - AmericanAcademyofNursePractitioners - AmericanOsteopathicAssociation - AmericanMedicalAssociation - NationalBoardofCertificationandRecertificationforNurseAnesthetists - AmericanAssociationofCriticalCareNurses - AmericanMidwiferyCertificationBoard - AmericanBoardofPodiatricMedicine - AmericanBoardofOralImplantology - AmericanBoardofOralMedicine - AmericanBoardofOrofacialPain - AmericanDentalBoardofAnesthesiology - AmericanBoardofDentalPublicHealth - AmericanBoardofPediatricDentistry - AmericanBoardofPeriodontology - AmericanBoardofInternalMedicine - NationalCommissiononCertificationofPhysicianAssistants - AmericanBoardofAllergyandImmunology - AmericanBoardofAnesthesiology - AmericanBoardofColonandRectalSurgery - AmericanBoardofDermatology - AmericanBoardofEmergencyMedicine - AmericanBoardofFamilyMedicine - AmericanBoardofGeneticsandGenomics - AmericanBoardofNeurologicalSurgery - AmericanBoardofNuclearMedicine - AmericanBoardofObstetricsandGynecology - AmericanBoardofOphthalmology - AmericanBoardofOrthopaedicSurgery - AmericanBoardofOtolaryngologyHeadandNeckSurgery - AmericanBoardofPathology - AmericanBoardofPediatrics - AmericanBoardofPhysicalMedicineandRehabilitation - AmericanBoardofPlasticSurgery - AmericanBoardofPreventiveMedicine - AmericanBoardofProfessionalPsychology - AmericanBoardofPsychiatryandNeurology - AmericanBoardofRadiology - AmericanBoardofSurgery - AmericanBoardofThoracicSurgery - AmericanBoardofUrology - AmericanOptometricAssociation - AssociationofSocialWorkBoards - AmericanBoardofFootandAnkleSurgery - AmericanBoardofOralandMaxillofacialPathology - AmericanBoardofOralandMaxillofacialSurgery - AmericanBoardofOrthodontics - AmericanBoardofEndodontics - AmericanBoardofProsthodontics - NationalBoardforCertificationinOccupationalTherapy - BehaviorAnalystCertificationBoard - InternationalBoardofLactationConsultantExaminers - CommissionOnDieteticRegistration - NationalCertificationCommissionforAcupunctureandOrientalMedicine - PediatricNursingCertification - NationalCertificationCorporation - OncologyNursingCertificationCorporation - AmericanBoardOfCardiovascularMedicine - AmericanAcademyOfHIVMedicine - NationalBoardOfPhysiciansAndSurgeons - BoardOfPharmacySpecialties - AmericanBoardofOralandMaxillofacialRadiology - AmericanBoardofGeneralDentistry - NationalAssociationofSchoolPsychologists - NationalPhlebotomyAssociation - NationalCenterForCompetencyTesting - AmericanRegistryofRadiologyTechnologists - DentalAssistingNationalBoard - AmericanMedicalCertificationAssociation - AmericanBoardofAddictionMedicine - AmericanRegistryForDiagnosticMedicalSonography - AmericanBoardofMultipleSpecialtiesinPodiatry - AmericanBoardOfObesityMedicine - NationalCommissionForCertificationOfAnesthesiologistAssistants - CardiovascularCredentialingInternational - NationalBoardOfEchocardiography - AmericanAlliedHealth - AmericanMedicalTechnologists - NationalAssociationForHealthProfessionals - NationalHealthCareerAssociation - NationalPhlebotomyCertificationExamination - NationalAssociationOfPhlebotomyTechnicians - NationalHealthcareCertificationOrganization - NationalPerformanceSpecialists - NationalRegistryOfAlliedHealthProfessionals - BoardofCertificationforEmergencyNursing type: string firstName: description: >- Provider first name mentioned on the board certification. This field will be used for board certification lookup. type: string lastName: description: >- Provider last name mentioned on the board certification. This field will be used for board certification lookup. type: string isPrimary: description: >- If the flag is set, certification will be set as primary for the provider. type: boolean boardCertificationNumber: description: >- A unique Id provided by certification board to the provider. This will be used for board certification lookup. type: string specialty: type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedBoardCertificationInfoModel' BoardCertificationModel: type: object properties: providerId: description: Identifier of the provider associated with this board certification. type: string format: uuid jobStatus: description: >- 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 type: string currentVerificationStatus: enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedBoardCertificationInfoModel' queryInputs: $ref: '#/components/schemas/BoardCertificationQueryInputs' id: description: Unique identifier for this specific board certification. type: string format: uuid currentVerification: $ref: '#/components/schemas/BoardCertificationVerificationModel' source: $ref: '#/components/schemas/BoardCertificationSourceModel' isPrimary: description: >- If the flag is set, certification will be set as primary for the provider. type: boolean BoardCertificationQueryInputs: type: object properties: npi: type: integer format: int64 nullable: true boardCertificationNumber: type: string nullable: true BoardCertificationSourceModel: type: object properties: id: description: Unique identifier associated with this board certification source. type: string format: uuid name: description: Board certification source name. type: string availability: description: >- Availability indicator of the source. Only sources that are `Available` should be used for board certification verifications. enum: - Available - Disabled - ComingSoon type: string isDegraded: description: >- The sources we use for verifications are not hosted by Verifiable. In some cases we detect the source to be unavailable. In that case `isDegraded` will be set to `true`. type: boolean url: description: The URL used to fetch the certification data for this source. type: string format: uri BoardCertificationVerificationModel: type: object properties: originalStatus: description: >- The original status as our board certification verification process determined. Unlike `status` the `originalStatus` can never change. enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string status: description: >- The current status for this board certification verification. If you patch the verification status (in case the status is `NeedsReview`) this property will be updated, but `originalStatus` will remain the same. enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string started: description: >- Timestamp of when the board certification verification started processing. type: string format: date-time processingTime: description: >- The duration in milliseconds it took to process the board certification verification from start to end. type: integer format: int64 results: description: >- Array of verification records returned by the source that match the inputs. type: array items: $ref: '#/components/schemas/BoardCertificationVerificationResult' correctResultIndex: description: >- In case there is more than 1 result you can patch the verification and specify which of the records is the correct match by setting `correctResultIndex` to the appropriate index matching the index in the `results` array. type: integer format: int32 export: description: >- Once a board certification verification is in an 'end state' a PDF export will be generated. Once the PDF is generated this property will contain the path to that export. That path can be used to [download the file](https://api.discovery.verifiable.com). Please note that the process to generate an export is asynchronous and it can take several seconds after a verification is completed before the export is ready. type: string id: description: Unique identifier for this board certification verification. type: string format: uuid BoardCertificationVerificationResult: type: object properties: name: type: string nullable: true boardCertificationNumber: type: string nullable: true additionalProperties: $ref: '#/components/schemas/FlexibleDataModel' certificates: type: array items: $ref: '#/components/schemas/BoardCertificateResult' nullable: true screenshots: type: array items: type: string nullable: true problems: type: array items: enum: - NameMismatch type: string nullable: true CaqhLoginInfoModel: type: object properties: lastUpdatedAt: description: The date and time when the object was created or modified. type: string format: date-time caqhId: description: ' CAQH provider ID.' type: string username: description: CAQH username. type: string password: $ref: '#/components/schemas/SensitiveString' CaqhLoginInfoRequestModel: type: object properties: caqhId: type: string nullable: true username: type: string nullable: true password: $ref: '#/components/schemas/SensitiveString' CaqhProfile.AbilityToPerformJob: type: object properties: illegalDrugUse: type: boolean nullable: true illegalDrugUseExplanation: type: string nullable: true chemicalSubstancesUse: type: boolean nullable: true chemicalSubstancesUseExplanation: type: string nullable: true poseARisk: type: boolean nullable: true poseARiskExplanation: type: string nullable: true unableToPerformFunctions: type: boolean nullable: true unableToPerformFunctionsExplanation: type: string nullable: true CaqhProfile.Alias: type: object properties: description: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true suffix: type: string nullable: true endDate: type: string format: date-time nullable: true startDate: type: string format: date-time nullable: true CaqhProfile.Arrangements: type: object properties: description: type: string nullable: true hospitalName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' status: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true email: type: string nullable: true phone: type: string nullable: true groupName: type: string nullable: true organizationNpi: type: integer format: int64 nullable: true otherHospitalName: type: string nullable: true admittingProvider: type: string nullable: true CaqhProfile.BillingContactInfo: type: object properties: firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true suffix: type: string nullable: true phone: type: string nullable: true email: type: string nullable: true fax: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' CaqhProfile.CaqhAddress: type: object properties: streetLine1: type: string nullable: true streetLine2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true country: type: string nullable: true province: type: string nullable: true county: type: string nullable: true zipCode: type: string nullable: true CaqhProfile.CaqhDisclosureInfo: type: object properties: licensure: $ref: '#/components/schemas/CaqhProfile.Licensure' hospitalPrivilegesAndOtherAffiliations: $ref: >- #/components/schemas/CaqhProfile.HospitalPrivilegesAndOtherAffiliations education: $ref: '#/components/schemas/CaqhProfile.DisclosureEducation' deaCds: $ref: '#/components/schemas/CaqhProfile.DeaCds' medicareMedicaid: $ref: '#/components/schemas/CaqhProfile.MedicareMedicaid' otherSanctions: $ref: '#/components/schemas/CaqhProfile.OtherSanctions' liabilityInsurance: $ref: '#/components/schemas/CaqhProfile.LiabilityInsurance' malpracticeHistory: type: array items: $ref: '#/components/schemas/CaqhProfile.Malpractice' nullable: true criminalHistory: $ref: '#/components/schemas/CaqhProfile.CriminalHistory' abilityToPerformJob: $ref: '#/components/schemas/CaqhProfile.AbilityToPerformJob' CaqhProfile.CaqhHeaders: type: object properties: caqhDataSummaryDate: type: string format: date-time nullable: true caqhProviderId: type: string nullable: true lastReattestationDate: type: string format: date-time nullable: true CaqhProfile.CaqhProviderProfileModel: type: object properties: type: enum: - Npi - Caqh type: string readOnly: true reportPath: type: string nullable: true headers: $ref: '#/components/schemas/CaqhProfile.CaqhHeaders' prepare: $ref: '#/components/schemas/CaqhProfile.PrepareInfo' personalInformation: $ref: '#/components/schemas/CaqhProfile.PersonalInfo' professionalIdentificationNumbers: $ref: '#/components/schemas/CaqhProfile.ProfessionalIdentificationNumbers' education: $ref: '#/components/schemas/CaqhProfile.EducationInfo' trainingInformation: $ref: '#/components/schemas/CaqhProfile.TrainingInfo' specialtyInformation: $ref: '#/components/schemas/CaqhProfile.SpecialtyInfo' practiceLocations: $ref: '#/components/schemas/CaqhProfile.PracticeLocations' hospitalAffiliations: $ref: '#/components/schemas/CaqhProfile.HospitalAffiliations' credentialingInformation: type: array items: $ref: '#/components/schemas/CaqhProfile.CredentialingInfo' nullable: true insuranceInformation: type: array items: $ref: '#/components/schemas/CaqhProfile.InsuranceInfo' nullable: true workHistoryInformation: $ref: '#/components/schemas/CaqhProfile.WorkHistoryInfo' referencesInformation: type: array items: $ref: '#/components/schemas/CaqhProfile.ReferencesInfo' nullable: true disclosureInformation: $ref: '#/components/schemas/CaqhProfile.DisclosureInfo' documentInformation: $ref: '#/components/schemas/CaqhProfile.DocumentInfo' CaqhProfile.CdsRegistration: type: object properties: state: type: string nullable: true cds: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true isUnlimited: type: boolean nullable: true limitationsDescription: type: string nullable: true CaqhProfile.Cme: type: object properties: hasCme: type: boolean nullable: true CaqhProfile.ContactInfo: type: object properties: firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true suffix: type: string nullable: true phone: type: string nullable: true email: type: string nullable: true fax: type: string nullable: true CaqhProfile.CredentialingInfo: type: object properties: firstName: type: string nullable: true lastName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' phone: type: string nullable: true fax: type: string nullable: true email: type: string nullable: true isPrimaryCredentialingContact: type: boolean nullable: true locationType: type: string nullable: true location: type: string nullable: true contactHours: type: string nullable: true contactTitle: type: string nullable: true CaqhProfile.CriminalHistory: type: object properties: felony: type: boolean nullable: true felonyExplanation: type: string nullable: true misdemeanor: type: boolean nullable: true misdemeanorExplanation: type: string nullable: true courtMartialed: type: boolean nullable: true courtMartialedExplanation: type: string nullable: true CaqhProfile.CulturalCompetencyTraining: type: object properties: hasCompletedCulturalCompetencyTraining: type: boolean nullable: true CaqhProfile.DeaCds: type: object properties: limitations: type: boolean nullable: true limitationsExplanation: type: string nullable: true CaqhProfile.DeaRegistration: type: object properties: number: type: string nullable: true state: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true isLimited: type: boolean nullable: true alternatePrescriberName: type: string nullable: true dateApplicationSubmitted: type: string format: date-time nullable: true hasXWaiver: type: boolean nullable: true xWaiverNumber: type: string nullable: true isAcceptingNewMatPatients: type: boolean nullable: true matPanelSize: type: string nullable: true CaqhProfile.DemographicInfo: type: object properties: gender: type: string nullable: true race: type: string nullable: true birthDate: type: string format: date-time nullable: true birthCity: type: string nullable: true birthState: type: string nullable: true birthCountry: type: string nullable: true isUsCitizen: type: boolean nullable: true citizenshipCountry: type: string nullable: true CaqhProfile.DisclosureEducation: type: object properties: trainingProgramDiscipline: type: boolean nullable: true trainingProgramDisciplineExplanation: type: string nullable: true boardCertificationRevoked: type: boolean nullable: true boardCertificationRevokedExplanation: type: string nullable: true boardCertificationUnderInvestigation: type: boolean nullable: true boardCertificationUnderInvestigationExplanation: type: string nullable: true trainingProgramUnderInvestigation: type: boolean nullable: true trainingProgramUnderInvestigationExplanation: type: string nullable: true CaqhProfile.DisclosureInfo: type: object properties: caqh: $ref: '#/components/schemas/CaqhProfile.CaqhDisclosureInfo' CaqhProfile.Document: type: object properties: documentUrl: type: string nullable: true documentName: type: string nullable: true state: type: string nullable: true expirationDate: type: string format: date-time nullable: true download: $ref: '#/components/schemas/CaqhProfile.DocumentDownload' CaqhProfile.DocumentDownload: type: object properties: downloadStatus: enum: - Completed - Failed type: string fileName: type: string nullable: true fileId: type: string format: uuid nullable: true CaqhProfile.DocumentInfo: type: object properties: downloadFolder: type: string nullable: true documents: type: array items: $ref: '#/components/schemas/CaqhProfile.Document' nullable: true CaqhProfile.Education: type: object properties: schoolName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' phone: type: string nullable: true degree: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true areaOfTraining: type: string nullable: true completed: type: boolean nullable: true graduationDate: type: string format: date-time nullable: true disciplinaryAction: type: string nullable: true certificateAwarded: type: string nullable: true CaqhProfile.EducationInfo: type: object properties: graduateType: type: string nullable: true professionalSchoolInformation: type: array items: $ref: '#/components/schemas/CaqhProfile.Education' nullable: true undergraduateEducation: type: array items: $ref: '#/components/schemas/CaqhProfile.Education' nullable: true CaqhProfile.Emails: type: object properties: primaryEmail: type: string nullable: true personalEmail: type: string nullable: true ccEmail1: type: string nullable: true ccEmail2: type: string nullable: true CaqhProfile.EmploymentGap: type: object properties: startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true gapExplanation: type: string nullable: true reason: type: string nullable: true CaqhProfile.EmploymentInfo: type: object properties: title: type: string nullable: true employerName: type: string nullable: true department: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' phone: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true isCurrentEmployer: type: boolean nullable: true reasonForDeparture: type: string nullable: true CaqhProfile.GroupMailingAddress: type: object properties: streetLine1: type: string nullable: true streetLine2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true country: type: string nullable: true province: type: string nullable: true county: type: string nullable: true zipCode: type: string nullable: true groupMedicaidNumber: type: string nullable: true groupMedicareNumber: type: string nullable: true organizationNpi: type: string nullable: true typeOfPractice: type: string nullable: true CaqhProfile.HospitalAffiliations: type: object properties: hasAdmittingPrivileges: type: boolean nullable: true hasAdmittingArrangements: type: boolean nullable: true hasNonAdmittingAffiliations: type: boolean nullable: true explanation: type: string nullable: true admittingPrivileges: type: array items: $ref: '#/components/schemas/CaqhProfile.Privileges' nullable: true admittingArrangements: type: array items: $ref: '#/components/schemas/CaqhProfile.Arrangements' nullable: true CaqhProfile.HospitalPrivilegesAndOtherAffiliations: type: object properties: clinicalPrivilegesLimitations: type: boolean nullable: true clinicalPrivilegesLimitationsExplanation: type: string nullable: true privilegesWhileUnderInvestigation: type: boolean nullable: true privilegesWhileUnderInvestigationExplanation: type: string nullable: true terminatedForCause: type: boolean nullable: true terminatedForCauseExplanation: type: string nullable: true CaqhProfile.Identifiers: type: object properties: ssn: $ref: '#/components/schemas/SensitiveString' fnin: type: string nullable: true fninCountry: type: string nullable: true upin: type: string nullable: true npi: type: string nullable: true CaqhProfile.InsuranceInfo: type: object properties: policyNumber: type: string nullable: true originalEffectiveDate: type: string format: date-time nullable: true currentEffectiveDate: type: string format: date-time nullable: true currentExpirationDate: type: string format: date-time nullable: true carrierName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' phone: type: string nullable: true phoneExtension: type: string nullable: true isUnlimitedCoverage: type: boolean nullable: true coverageType: type: string nullable: true occurrenceCoverageAmount: type: string nullable: true aggregateCoverageAmount: type: string nullable: true includesTailCoverage: type: boolean nullable: true isIndividualCoverage: type: boolean nullable: true isSelfInsured: type: boolean nullable: true CaqhProfile.LiabilityInsurance: type: object properties: liabilityCoverageLimitations: type: boolean nullable: true liabilityCoverageLimitationsExplanation: type: string nullable: true surchargeOrHighRisk: type: boolean nullable: true surchargeOrHighRiskExplanation: type: string nullable: true CaqhProfile.License: type: object properties: state: type: string nullable: true isCurrentlyPracticingInState: type: boolean nullable: true licenseNumber: type: string nullable: true type: type: string nullable: true status: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true isUnlimited: type: boolean nullable: true CaqhProfile.Licensure: type: object properties: licenseLimitations: type: boolean nullable: true licenseLimitationsExplanation: type: string nullable: true licenseChallenge: type: boolean nullable: true licenseChallengeExplanation: type: string nullable: true CaqhProfile.LocationGeneralInfo: type: object properties: officeType: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true isCurrentlyPracticingAtLocation: type: string nullable: true explanation: type: string nullable: true practiceName: type: string nullable: true departmentName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' email: type: string nullable: true isCorrespondenceLocation: type: string nullable: true website: type: string nullable: true CaqhProfile.LocationInfo: type: object properties: generalInformation: $ref: '#/components/schemas/CaqhProfile.LocationGeneralInfo' mailingAddress: $ref: '#/components/schemas/CaqhProfile.GroupMailingAddress' phoneNumbers: $ref: '#/components/schemas/CaqhProfile.PhoneNumbers' taxInformation: type: array items: $ref: '#/components/schemas/CaqhProfile.TaxInfo' nullable: true officeHours: type: array items: $ref: '#/components/schemas/CaqhProfile.OfficeHours' nullable: true practiceLimitations: $ref: '#/components/schemas/CaqhProfile.PracticeLimitations' patients: $ref: '#/components/schemas/CaqhProfile.PatientsInfo' officeManagerContact: $ref: '#/components/schemas/CaqhProfile.OfficeManagerContact' billingContact: $ref: '#/components/schemas/CaqhProfile.BillingContactInfo' remittance: $ref: '#/components/schemas/CaqhProfile.RemittanceInfo' telehealth: $ref: '#/components/schemas/CaqhProfile.TelehealthInfo' CaqhProfile.MailingAddress: type: object properties: streetLine1: type: string nullable: true streetLine2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true country: type: string nullable: true province: type: string nullable: true county: type: string nullable: true zipCode: type: string nullable: true email: type: string nullable: true phone: type: string nullable: true CaqhProfile.Malpractice: type: object properties: liabilityActions: type: boolean nullable: true liabilityActionsExplanation: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' claimResolutionDate: type: string format: date-time nullable: true claimStatus: type: string nullable: true dateClaimFiled: type: string format: date-time nullable: true dateOfOccurrence: type: string format: date-time nullable: true descriptionOfAllegations: type: string nullable: true descriptionOfInjury: type: string nullable: true resultedInDeath: type: string nullable: true insuranceCarrierName: type: string nullable: true numberOfCodefendants: type: string nullable: true phone: type: string nullable: true policyNumber: type: string nullable: true resolutionMethod: type: string nullable: true settlementAmount: type: string nullable: true isIncludedInNpdb: type: boolean nullable: true primaryDefendant: type: string nullable: true CaqhProfile.MedicareMedicaid: type: object properties: limitations: type: boolean nullable: true CaqhProfile.Name: type: object properties: firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true suffix: type: string nullable: true CaqhProfile.OfficeHours: type: object properties: day: type: string nullable: true endTime: type: string format: timespan nullable: true startTime: type: string format: timespan nullable: true CaqhProfile.OfficeManagerContact: type: object properties: firstName: type: string nullable: true lastName: type: string nullable: true phone: type: string nullable: true fax: type: string nullable: true email: type: string nullable: true isCredentialingContact: type: string nullable: true CaqhProfile.OtherSanctions: type: object properties: subjectOfInvestigation: type: boolean nullable: true subjectOfInvestigationExplanation: type: string nullable: true reportedToNpdb: type: boolean nullable: true reportedToNpdbExplanation: type: string nullable: true sanctions: type: boolean nullable: true sanctionsExplanation: type: string nullable: true illegalMisconduct: type: boolean nullable: true illegalMisconductExplanation: type: string nullable: true militaryAgencyLimitations: type: boolean nullable: true militaryAgencyLimitationsExplanation: type: string nullable: true CaqhProfile.PatientsInfo: type: object properties: isAcceptingNewPatients: type: boolean nullable: true isAcceptingNewMedicarePatients: type: boolean nullable: true isAcceptingNewMedicaidPatients: type: boolean nullable: true CaqhProfile.PersonalInfo: type: object properties: name: $ref: '#/components/schemas/CaqhProfile.Name' otherName: type: array items: $ref: '#/components/schemas/CaqhProfile.Alias' nullable: true homeAddress: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' mailingAddress: $ref: '#/components/schemas/CaqhProfile.MailingAddress' primaryMethodOfContact: $ref: '#/components/schemas/CaqhProfile.Emails' phoneNumbers: $ref: '#/components/schemas/CaqhProfile.PhoneNumbers' personalIdentificationNumbers: $ref: '#/components/schemas/CaqhProfile.Identifiers' demographics: $ref: '#/components/schemas/CaqhProfile.DemographicInfo' emergencyContact: $ref: '#/components/schemas/CaqhProfile.ContactInfo' languages: type: string nullable: true otherLanguages: type: string nullable: true CaqhProfile.PhoneNumbers: type: object properties: homePhone: type: string nullable: true personalCellPhone: type: string nullable: true fax: type: string nullable: true appointmentPhone: type: string nullable: true CaqhProfile.PracticeLimitations: type: object properties: ageMax: type: string nullable: true ageMin: type: string nullable: true gender: type: string nullable: true CaqhProfile.PracticeLocations: type: object properties: activeLocations: type: array items: $ref: '#/components/schemas/CaqhProfile.LocationInfo' nullable: true archivedLocations: type: array items: $ref: '#/components/schemas/CaqhProfile.LocationInfo' nullable: true CaqhProfile.PrepareInfo: type: object properties: nuccGrouping: type: string nullable: true providerType: type: string nullable: true practiceSetting: type: string nullable: true primaryPracticeState: type: string nullable: true otherPracticeStates: type: string nullable: true applicationType: type: string nullable: true CaqhProfile.Privileges: type: object properties: hospitalName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' isPrimaryHospital: type: boolean nullable: true type: type: string nullable: true status: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true reasonForDiscontinuance: type: string nullable: true annualAdmissionPercentage: type: string nullable: true numberOfAdmitsPerMonth: type: string nullable: true facilityType: type: string nullable: true isMilitaryHospital: type: boolean nullable: true isAmbulatorySurgeryCenter: type: boolean nullable: true isSecondaryHospital: type: boolean nullable: true otherHospitalName: type: string nullable: true department: type: string nullable: true contact: $ref: '#/components/schemas/CaqhProfile.ContactInfo' CaqhProfile.ProfessionalIdentificationNumbers: type: object properties: professionalLicenses: type: array items: $ref: '#/components/schemas/CaqhProfile.License' nullable: true deaRegistration: type: array items: $ref: '#/components/schemas/CaqhProfile.DeaRegistration' nullable: true cdsRegistration: type: array items: $ref: '#/components/schemas/CaqhProfile.CdsRegistration' nullable: true medicare: type: array items: $ref: '#/components/schemas/CaqhProfile.ProviderIdentifier' nullable: true medicaid: type: array items: $ref: '#/components/schemas/CaqhProfile.ProviderIdentifier' nullable: true ecfmg: type: string nullable: true ecfmgIssueDate: type: string format: date-time nullable: true dmap: type: string nullable: true flex: type: string nullable: true nationalBoardOfMedicalExaminers: type: string nullable: true prescriptiveAuthority: type: string nullable: true texasDps: type: string nullable: true CaqhProfile.ProviderIdentifier: type: object properties: number: type: string nullable: true state: type: string nullable: true CaqhProfile.ReferencesInfo: type: object properties: title: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true suffix: type: string nullable: true phone: type: string nullable: true email: type: string nullable: true fax: type: string nullable: true providerType: type: string nullable: true associationEndDate: type: string format: date-time nullable: true associationStartDate: type: string format: date-time nullable: true cell: type: string nullable: true relationship: type: string nullable: true yearsKnown: type: string nullable: true ipCode: type: string nullable: true department: type: string nullable: true facilityName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' CaqhProfile.RemittanceInfo: type: object properties: firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true suffix: type: string nullable: true phone: type: string nullable: true email: type: string nullable: true fax: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' billingDepartmentName: type: string nullable: true checkPayableTo: type: string nullable: true hasElectronicBillingCapabilities: type: boolean nullable: true CaqhProfile.Specialty: type: object properties: name: type: string nullable: true boardCertificationNumber: type: string nullable: true boardCertificationExpirationDate: type: string format: date-time nullable: true boardCertificationInitialCertificationDate: type: string format: date-time nullable: true boardCertificationLastCertificationDate: type: string format: date-time nullable: true boardCertificationName: type: string nullable: true subSpecialtyName: type: string nullable: true isBoardCertified: type: boolean nullable: true CaqhProfile.SpecialtyInfo: type: object properties: primarySpecialty: $ref: '#/components/schemas/CaqhProfile.Specialty' secondarySpecialty: $ref: '#/components/schemas/CaqhProfile.Specialty' additionalSpecialty: type: array items: $ref: '#/components/schemas/CaqhProfile.Specialty' nullable: true CaqhProfile.TaxInfo: type: object properties: taxId: type: string nullable: true taxIdType: type: string nullable: true isPrimaryTaxId: type: boolean nullable: true groupName: type: string nullable: true practiceNameOnW9: type: string nullable: true CaqhProfile.TelehealthInfo: type: object properties: hasTelehealthServices: type: boolean nullable: true CaqhProfile.Training: type: object properties: hospitalName: type: string nullable: true affiliatedSchoolName: type: string nullable: true address: $ref: '#/components/schemas/CaqhProfile.CaqhAddress' phone: type: string nullable: true email: type: string nullable: true fax: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true type: type: string nullable: true trainingType: type: string nullable: true programType: type: string nullable: true department: type: string nullable: true completed: type: boolean nullable: true specialty: type: string nullable: true completionDate: type: string format: date-time nullable: true directorName: type: string nullable: true disciplinaryActionsExplanation: type: string nullable: true CaqhProfile.TrainingGap: type: object properties: explanation: type: string nullable: true CaqhProfile.TrainingInfo: type: object properties: cme: $ref: '#/components/schemas/CaqhProfile.Cme' facultyPositions: type: string nullable: true fellowship: type: array items: $ref: '#/components/schemas/CaqhProfile.Training' nullable: true internship: type: array items: $ref: '#/components/schemas/CaqhProfile.Training' nullable: true otherTraining: type: array items: $ref: '#/components/schemas/CaqhProfile.Training' nullable: true residency: type: array items: $ref: '#/components/schemas/CaqhProfile.Training' nullable: true trainingGaps: $ref: '#/components/schemas/CaqhProfile.TrainingGap' culturalCompetencyTraining: $ref: '#/components/schemas/CaqhProfile.CulturalCompetencyTraining' CaqhProfile.WorkHistoryInfo: type: object properties: employmentInformationRecords: type: array items: $ref: '#/components/schemas/CaqhProfile.EmploymentInfo' nullable: true employmentGapRecords: type: array items: $ref: '#/components/schemas/CaqhProfile.EmploymentGap' nullable: true CertificateDatasetRecord: type: object properties: certificateType: type: string nullable: true certificateNumber: type: string nullable: true firstName: type: string nullable: true lastName: type: string nullable: true middleName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true certifyingOrganization: type: string nullable: true additionalProperties: $ref: '#/components/schemas/FlexibleDataModel' attachments: type: array items: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid fullName: type: string nullable: true CertificateInfoModel: type: object properties: lastUpdatedAt: type: string format: date-time id: type: string format: uuid type: enum: - AhaBasicLifeSupport - AhaAdvancedCardiacLifeSupport - AhaNeonatalAdvancedLifeSupport - AhaPediatricAdvancedLifeSupport type: string firstName: type: string nullable: true lastName: type: string nullable: true certificateNumber: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true certifyingOrganization: type: string nullable: true CertificateInfoPatchModel: type: object properties: firstName: type: string nullable: true lastName: type: string nullable: true certificateNumber: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true certifyingOrganization: type: string nullable: true CertificateInfoRequestModel: required: - certificateNumber - type type: object properties: type: enum: - AhaBasicLifeSupport - AhaAdvancedCardiacLifeSupport - AhaNeonatalAdvancedLifeSupport - AhaPediatricAdvancedLifeSupport type: string certificateNumber: minLength: 1 type: string firstName: type: string nullable: true lastName: type: string nullable: true issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true certifyingOrganization: type: string nullable: true ChecklistDetailsModel: type: object properties: organization: description: The organization of this credentialing request checklist. type: string providerType: description: The type of provider of this credentialing request checklist. type: string providerName: description: The name of the provider of this credentialing request checklist. type: string started: description: >- The timestamp at which this credentialing request checklist was started at. type: string format: date-time completed: description: >- The timestamp at which this credentialing request checklist was completed at. type: string format: date-time ChecklistDetailsRequestModel: type: object properties: organization: description: The organization of this credentialing request checklist. type: string providerType: description: The type of provider of this credentialing request checklist. type: string providerName: description: The name of the provider of this credentialing request checklist. type: string started: description: >- The timestamp at which this credentialing request checklist was started at. type: string format: date-time completed: description: >- The timestamp at which this credentialing request checklist was completed at. type: string format: date-time CmsPreclusionDatasetRecord: type: object properties: id: type: string format: uuid hash: type: string format: uuid firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true npiNumber: type: integer format: int64 nullable: true dateOfBirth: type: string format: date-time nullable: true address: type: string nullable: true businessName: type: string nullable: true general: type: string nullable: true speciality: type: string nullable: true ein: type: integer format: int64 nullable: true exclusionDate: type: string format: date-time nullable: true claimRejectionDate: type: string format: date-time nullable: true reinstatedDate: type: string format: date-time nullable: true lastUpdate: type: string format: date-time nullable: true Course: type: object properties: courseName: type: string nullable: true CourseOfStudy: type: object properties: courseName: type: string nullable: true ncescipCode: type: string nullable: true CredentialingDataModel: type: object properties: providerInfo: type: object additionalProperties: {} nullable: true licenseVerifications: type: array items: $ref: '#/components/schemas/LicenseVerificationModel' nullable: true datasetScans: type: array items: $ref: '#/components/schemas/DatasetScanModel' nullable: true files: type: array items: $ref: '#/components/schemas/FileModel' nullable: true profiles: type: array items: $ref: '#/components/schemas/ProviderProfileImportModel' nullable: true CredentialingRequestAggregationModel: type: object properties: total: description: The total number of credentialing requests. type: integer format: int32 aggregations: description: >- For each credentialing request event status, a count of credentialing requests with that status. type: object additionalProperties: type: integer format: int32 example: total: 54 aggregations: requestSubmitted: 8 requestInProgress: 3 additionalInformationRequested: 6 additionalInformationSubmitted: 7 cancellationRequested: 2 cancelled: 5 completed: 2 completedWithConcern: 9 unableToComplete: 4 secondAttemptMissingInfo: 5 thirdAttemptMissingInfo: 3 CredentialingRequestChecklistDatasetScanReference: type: object properties: datasetScanId: description: >- Unique identifier of the dataset scan id, this id must be linked to the provider of the credentialing request. type: string format: uuid CredentialingRequestChecklistFileReference: type: object properties: filePath: description: >- File path to a provider file, this path must be linked to the provider of the credentialing request. type: string CredentialingRequestChecklistItemModel: type: object properties: id: description: The unique identifier of this credentialing request checklist item. type: string format: uuid name: description: The name of this credentialing request checklist item. type: string confirmedAt: description: >- The timestamp at which this credentialing request checklist item was confirmed at. type: string format: date-time confirmedBy: description: >- The name of the user/entity that confirmed this credentialing request checklist item. type: string verifiedAt: description: >- The timestamp at which this credentialing request checklist item was verified at. type: string format: date-time status: description: The status of this credentialing request checklist item. type: string source: description: The source of this credentialing request checklist item. type: string references: $ref: '#/components/schemas/CredentialingRequestChecklistReference' CredentialingRequestChecklistItemRequestModel: required: - name - status type: object properties: name: description: The name of this credentialing request checklist item. minLength: 1 type: string status: description: The status of this credentialing request checklist item. minLength: 1 type: string confirmedAt: description: >- The timestamp at which this credentialing request checklist item was confirmed at. type: string format: date-time confirmedBy: description: >- The name of the user/entity that confirmed this credentialing request checklist item. type: string verifiedAt: description: >- The timestamp at which this credentialing request checklist item was verified at. type: string format: date-time source: description: The source of this credentialing request checklist item. type: string references: $ref: '#/components/schemas/CredentialingRequestChecklistReference' CredentialingRequestChecklistLicenseVerificationReference: type: object properties: licenseId: description: >- Unique identifier of the license id, this id must be linked to the provider of the credentialing request. type: string format: uuid licenseVerificationId: description: >- Unique identifier of the license verification id, this id must be linked to the license id. type: string format: uuid CredentialingRequestChecklistModel: type: object properties: id: description: The unique identifier of this credentialing request checklist. type: string format: uuid requestId: description: >- The credentialing request unique identifier to which this checklist is bound. type: string format: uuid notes: description: The notes if any of this credentialing request checklist. type: string items: description: >- An array of the items with references and details of this credentialing request checklist. type: array items: $ref: '#/components/schemas/CredentialingRequestChecklistItemModel' details: $ref: '#/components/schemas/ChecklistDetailsModel' CredentialingRequestChecklistProfileReference: type: object properties: profileId: description: >- Unique identifier of the provider profile id, this id must be linked to the provider of the credentialing request. type: string format: uuid CredentialingRequestChecklistProviderInfoReference: type: object properties: providerInfoId: description: >- Unique identifier of the provider info, this id must be linked to the provider of the credentialing request. type: string format: uuid providerInfoType: description: Types of provider info supported. enum: - BasicInfo - Caqh - LiabilityInsurance - Education - Training - WorkHistory - DeaRegistrations - Licenses - BoardCertifications - Certificates type: string CredentialingRequestChecklistReference: type: object properties: providerInfo: description: >- If set, array with pairs of provider information ids and provider information types linked to the provider of the credentialing request. type: array items: $ref: >- #/components/schemas/CredentialingRequestChecklistProviderInfoReference licenseVerifications: description: >- If set, array with pairs of license ids and license verifications ids linked to the provider of the credentialing request. type: array items: $ref: >- #/components/schemas/CredentialingRequestChecklistLicenseVerificationReference datasetScans: description: >- If set, array with dataset scan ids linked to the provider of the credentialing request. type: array items: $ref: >- #/components/schemas/CredentialingRequestChecklistDatasetScanReference files: description: >- If set, array with file paths linked to the provider of the credentialing request. type: array items: $ref: '#/components/schemas/CredentialingRequestChecklistFileReference' profiles: description: >- If set, array with profiles linked to the provider of the credentialing request. type: array items: $ref: '#/components/schemas/CredentialingRequestChecklistProfileReference' CredentialingRequestChecklistRequestModel: type: object properties: notes: description: The notes of this credentialing request checklist if any. type: string items: description: The items of this credentialing request checklist if any. type: array items: $ref: '#/components/schemas/CredentialingRequestChecklistItemRequestModel' details: $ref: '#/components/schemas/ChecklistDetailsRequestModel' CredentialingRequestEventFileModel: type: object properties: path: description: The path to the file. type: string type: description: The type of the attachment. enum: - CredentialingPacket type: string CredentialingRequestEventModel: type: object properties: description: description: The description of this credentialing request event. type: string id: description: The unique identifier of this credentialing request event. type: string format: uuid note: description: The note of this credentialing request event. type: string timestamp: description: The timestamp when this credentialing request event was created. type: string format: date-time status: description: >- The status of this credentialing request event. Only the following statuses are available for self-managed requests: `"RequestInProgress"`, `"Cancelled"` and `"Completed"`. enum: - RequestSubmitted - RequestInProgress - AdditionalInformationRequested - AdditionalInformationSubmitted - CancellationRequested - Cancelled - Completed - CompletedWithConcern - UnableToComplete - SecondAttemptMissingInfo - ThirdAttemptMissingInfo type: string attachments: description: Files attached to this credentialing request event. type: array items: $ref: '#/components/schemas/CredentialingRequestEventFileModel' user: $ref: '#/components/schemas/CredentialingRequestEventUserModel' CredentialingRequestEventRequestModel: required: - status type: object properties: note: description: The note of this credentialing request event. type: string status: description: >- The status of this credentialing request event. Only the following statuses are available for self-managed requests: `"RequestInProgress"`, `"Cancelled"` and `"Completed"`. enum: - RequestSubmitted - RequestInProgress - AdditionalInformationRequested - AdditionalInformationSubmitted - CancellationRequested - Cancelled - Completed - CompletedWithConcern - UnableToComplete - SecondAttemptMissingInfo - ThirdAttemptMissingInfo type: string attachments: type: array items: $ref: '#/components/schemas/CredentialingRequestEventFileModel' CredentialingRequestEventUserModel: type: object properties: id: description: The unique identifier of this user. type: string format: uuid email: description: The email of this user. type: string CredentialingRequestModel: type: object properties: id: description: Unique identifier of the credentialing request. type: string format: uuid provider: $ref: '#/components/schemas/ProviderBaseModel' facility: $ref: '#/components/schemas/FacilityModel' type: description: The type of credentialing request. enum: - Initial - ReCredentialing type: string createdAt: description: The timestamp when this credentialing request was created. type: string format: date-time currentEvent: $ref: '#/components/schemas/CredentialingRequestEventModel' allEvents: description: All events associated with this credentialing request. type: array items: $ref: '#/components/schemas/CredentialingRequestEventModel' priority: description: The priority of credentialing request. enum: - Low - Medium - High - Urgent type: string isSelfManaged: description: If the flag is set, this is a self-managed credentialing request. type: boolean checklist: $ref: '#/components/schemas/CredentialingRequestChecklistModel' owner: $ref: '#/components/schemas/BaseUserModel' example: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X provider: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X firstName: string lastName: string dateOfBirth: '2019-08-24T14:15:22.0000000Z' ssn: '***' credentialingStatus: string credentialedDate: '2019-08-24T14:15:22.0000000Z' npi: 0 deactivated: true type: Initial createdAt: '2019-08-24T14:15:22.0000000Z' currentEvent: description: string id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X note: string timestamp: '2019-08-24T14:15:22.0000000Z' status: RequestSubmitted attachments: [] user: {} allEvents: - {} priority: Low isSelfManaged: true checklist: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X requestId: d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6 notes: string items: [] details: {} owner: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X email: string firstName: string lastName: string CredentialingRequestPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Id - CreatedAt - Priority - CurrentEventStatus - CurrentEventDate - ProviderId - ProviderFirstName - ProviderLastName - ProviderCredentialingStatus - FacilityId - FacilityName type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The entries in the current page. type: array items: $ref: '#/components/schemas/CredentialingRequestModel' sortedBy: description: The property by which the data is sorted. enum: - Id - CreatedAt - Priority - CurrentEventStatus - CurrentEventDate - ProviderId - ProviderFirstName - ProviderLastName - ProviderCredentialingStatus - FacilityId - FacilityName type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X provider: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X firstName: string lastName: string dateOfBirth: '2019-08-24T14:15:22.0000000Z' ssn: '***' credentialingStatus: string credentialedDate: '2019-08-24T14:15:22.0000000Z' npi: 0 type: Initial createdAt: '2019-08-24T14:15:22.0000000Z' currentEvent: description: string id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X note: string timestamp: '2019-08-24T14:15:22.0000000Z' status: RequestSubmitted attachments: - path: string type: CredentialingPacket user: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X email: string allEvents: - description: string id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X note: string timestamp: '2019-08-24T14:15:22.0000000Z' status: RequestSubmitted attachments: - path: string type: CredentialingPacket user: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X email: string priority: Low isSelfManaged: true sortedBy: Id sortDirection: Asc sort: Id: Asc CreatedAt: Desc Priority: Asc CredentialingRequestPatchModel: type: object properties: priority: description: If set, changes the priority of this credentialing request. enum: - Low - Medium - High - Urgent type: string ownerId: description: >- If set, changes the assigned owner of this credentialing request. The owner needs to be a user with appropriate permissions to the organization. type: string format: uuid CredentialingRequestRequestModel: type: object properties: providerId: description: >- If credentialing a provider, the unique identifier of the provider associated with this credentialing request. Mutually exclusive with facilityId. type: string format: uuid facilityId: description: >- If credentialing a facility, the unique identifier of the facility associated with this credentialing request. Mutually exclusive with providerId. type: string format: uuid type: description: >- The type of credentialing request. If not specified, this will default to `Initial`. enum: - Initial - ReCredentialing type: string priority: description: >- The priority of credentialing request. If not specified, this will default to `Medium`. enum: - Low - Medium - High - Urgent type: string isSelfManaged: description: >- If the flag is set, self-managed credentialing request will be created. type: boolean example: providerId: 4834bcdc-4a64-444d-966b-1a6fe381da24 type: Initial priority: Low isSelfManaged: true DatasetMatchData: type: object properties: positiveParameters: description: >- Array of parameters used in the scan which have an explicit positive hit on this record. type: array items: $ref: '#/components/schemas/IProviderParameter' negativeParameters: description: >- Array of parameters used in the scan which have an explicit negative hit on this record. type: array items: $ref: '#/components/schemas/IProviderParameter' record: description: >- The matched data. This model is different for each dataset. Refer to [Dataset Records](https://api.discovery.verifiable.com) for an overview of models for each dataset. The models are also returned in JSON schema in the [GetDataset](https://api.discovery.verifiable.com) operation. DatasetMatchModel: type: object properties: id: type: string format: uuid datasetTimestamp: description: >- The timestamp when the dataset was last updated in our system at the time of this scan. type: string format: date-time recordTimestamp: description: >- The timestamp when this record was last updated in our system at the time of this scan. type: string format: date-time data: $ref: '#/components/schemas/DatasetMatchData' scanId: description: >- The identifier of the scan to which this match belongs. Not set if `scan` is populated. type: string format: uuid scan: $ref: '#/components/schemas/DatasetScanModel' userActionNeeded: description: Boolean indicating if action is needed for this match. type: boolean isIgnored: description: Set to true if this match was ignored for the associated provider. type: boolean matchScore: $ref: '#/components/schemas/MatchScore' userActionResolution: enum: - Accept - Reject type: string userActionResolutionNote: type: string matchRelevance: enum: - Low - Medium - High type: string createdTimestamp: description: >- Indicates the time that the match was added to the scan. Only populated for matches on or after January 25th 2024. type: string format: date-time obsoleteTimestamp: description: >- Indicates the time that the match became obsolete. This only occurs when a scan with a `status` of `Active` determines that the match is now obsolete due to changes in primary source data. type: string format: date-time DatasetMatchPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Id - MatchRelevance type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The entries in the current page. type: array items: $ref: '#/components/schemas/DatasetMatchModel' sortedBy: description: The property by which the data is sorted. enum: - Id - MatchRelevance type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - datasetTimestamp: '2019-08-24T14:15:22.0000000Z' recordTimestamp: '2019-08-24T14:15:22.0000000Z' data: positiveParameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name negativeParameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name scanId: 83d71394-faa2-4b6c-b13b-6d3118de459e scan: parameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X started: '2019-08-24T14:15:22.0000000Z' completed: '2019-08-24T14:15:22.0000000Z' type: Sam status: Pending providerId: 4834bcdc-4a64-444d-966b-1a6fe381da24 trigger: Manual options: parameterSetId: 4da0bbf1-9705-456b-b2bc-910c426536c6 referenceId: 8502eb05-558d-4480-8511-c1011710b340 failureReason: messageTemplate: string messageParams: property1: string property2: string matches: - {} userActionNeeded: true isIgnored: true matchScore: score: 0 recommendation: Mismatch sortedBy: Id sortDirection: Asc sort: Id: Asc DatasetMatchPatchModel: type: object properties: userActionResolutionNote: description: An optional reason on why this record is accepted or rejected. type: string userActionResolution: description: >- User resolution for the match. To revert previous resolution, it should be set to `null` enum: - Accept - Reject type: string DatasetMatchesAggregationModel: type: object properties: total: description: The total number of dataset matches. type: integer format: int32 aggregations: description: For each dataset tag, a count of dataset matches with that tag. type: object additionalProperties: type: integer format: int32 example: total: 140 aggregations: sanctionsAndExclusions: 30 nsc: 15 npi: 20 npdb: 10 dea: 25 certificates: 35 boardCertifications: 5 DatasetMatchesAggregationsModel: type: object properties: userActionNeeded: $ref: '#/components/schemas/DatasetMatchesAggregationModel' accepted: $ref: '#/components/schemas/DatasetMatchesAggregationModel' example: userActionNeeded: total: 140 aggregations: sanctionsAndExclusions: 30 nsc: 15 npi: 20 npdb: 10 dea: 25 certificates: 35 boardCertifications: 5 accepted: total: 140 aggregations: sanctionsAndExclusions: 30 nsc: 15 npi: 20 npdb: 10 dea: 25 certificates: 35 boardCertifications: 5 DatasetModel: type: object properties: tags: description: >- Tags associated to this dataset. Tags are used to group or identity the similar datasets. Currently supported tags are: "Sanctions and Exclusions", "Board Certifications", "NPI" type: array items: type: string readOnly: true name: description: Non-technical, display friendly, name for this dataset. type: string readOnly: true type: description: The dataset type to which this metadata applies. 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 - AmericanHeartAssociation type: string readOnly: true parameterSets: description: Array of parameter sets that are supported by this dataset type: array items: $ref: '#/components/schemas/ParameterSet' status: $ref: '#/components/schemas/DatasetStatus' monitoringIntervals: description: The intervals at which the dataset is being monitored. type: array items: enum: - Continuous - Daily - Weekly - Monthly - Yearly type: string readOnly: true lastUpdated: description: Timestamp on when the dataset was last updated. type: string format: date-time readOnly: true schema: description: >- The JSON schema of the records in this dataset. The models can also be found [here](https://api.discovery.verifiable.com). readOnly: true properties: description: >- Any additional properties associated with this dataset. For example, `StateSanctionsAndExclusions` provides the list of primary source(s) this dataset encapsulates via the `Sources` property. type: object additionalProperties: {} readOnly: true capabilities: description: >- Indicates the capabilities for this dataset. Currently the only capability that can differ per dataset is if records can be ignored or not. type: object additionalProperties: type: boolean readOnly: true maintenanceWindows: description: >- Array with the CRON descriptions that explain when this dataset type will be in maintenance window. When a dataset is in a maintenance window the requests sent to it will be delayed until it is over. type: array items: $ref: '#/components/schemas/MaintenanceDowntimeCronDescription' hasPassThroughFee: description: >- Indicates whether the dataset source charges a pass-through fee for a verification. type: boolean readOnly: true DatasetMonitorModel: type: object properties: id: type: string format: uuid type: description: >- Monitoring type for this monitor object. The license identifier and dataset type will be set based on this type. enum: - Dataset - License type: string monitoringInterval: description: The interval at which the data is being monitored. enum: - Continuous - Daily - Weekly - Monthly - Yearly type: string nextMonitoringDate: description: The next date on which this data is scheduled to be monitored. type: string format: date-time lastMonitoringDate: description: The date on which this data was monitored last time. type: string format: date-time providerId: description: The identifier of the provider that is associated with this monitor. type: string format: uuid datasetType: description: The dataset type that is associated with this monitor, if any. 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 - AmericanHeartAssociation type: string options: $ref: '#/components/schemas/DatasetScanOptions' lastVerification: $ref: '#/components/schemas/DatasetScanModel' DatasetPageModel: type: object properties: previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The event log entries in the current page. type: array items: $ref: '#/components/schemas/DatasetModel' sortedBy: description: The property by which the data is sorted. enum: - Name - Type type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Name - Type type: string Values: enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - tags: - string name: string type: Sam parameterSets: - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X supportedParameterTypes: - Name requiredParameterTypes: - Name isPreferred: true status: expectedProcessingTime: 0 monitoringIntervals: - Daily lastUpdated: '2019-08-24T14:15:22.0000000Z' properties: {} capabilities: property1: true property2: true maintenanceWindows: - description: string expression: string hasPassThroughFee: false sortedBy: Name sortDirection: Asc sort: Name: Asc Type: Desc DatasetScanModel: type: object properties: parameters: description: >- 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. type: array items: $ref: '#/components/schemas/IProviderParameter' id: description: Unique identifier for this dataset scan. type: string format: uuid started: description: Timestamp when this scan was started. type: string format: date-time completed: description: >- Timestamp at which the scan was completed or failed. If empty the scan is still running. type: string format: date-time type: description: 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 - AmericanHeartAssociation type: string status: description: >- 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 type: string providerId: description: >- The identifier of the provider that is associated with this scan, if any. type: string format: uuid provider: description: The provider model that is associated with this scan, if any. deprecated: true trigger: description: >- 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 type: string options: $ref: '#/components/schemas/DatasetScanOptions' failureReason: $ref: '#/components/schemas/FailureModel' statusDescription: {} matches: description: Array of records that match the input data for this scan. type: array items: $ref: '#/components/schemas/DatasetMatchModel' monitoringMetadata: $ref: '#/components/schemas/MonitoringMetadata' verifiedAt: description: >- Indicates the most recent time that the verification was performed successfully. type: string format: date-time DatasetScanOptions: type: object properties: parameterSetId: description: >- Set this to override the default parameters that will be used for a dataset scan. If a parameterSetId isn’t specified, we will use the default/preferred parameter set. type: string format: uuid referenceId: description: >- Set this to a provider info that will be used during the dataset scan, if a reference id isn’t supplied, we will use the global provider data points like NPI, SSN, DOB, Name, Aliases etc. type: string format: uuid DatasetScanPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Id - ProviderId - Started - Completed - Type type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The entries in the current page. type: array items: $ref: '#/components/schemas/DatasetScanModel' sortedBy: description: The property by which the data is sorted. enum: - Id - ProviderId - Started - Completed - Type type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - datasetTimestamp: '2019-08-24T14:15:22.0000000Z' recordTimestamp: '2019-08-24T14:15:22.0000000Z' data: positiveParameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name negativeParameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name scanId: 83d71394-faa2-4b6c-b13b-6d3118de459e scan: parameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X started: '2019-08-24T14:15:22.0000000Z' completed: '2019-08-24T14:15:22.0000000Z' type: Sam status: Pending providerId: 4834bcdc-4a64-444d-966b-1a6fe381da24 trigger: Manual options: parameterSetId: 4da0bbf1-9705-456b-b2bc-910c426536c6 referenceId: 8502eb05-558d-4480-8511-c1011710b340 failureReason: messageTemplate: string messageParams: property1: string property2: string matches: - {} monitoringMetadata: monitoringInterval: Monthly lastMonitoringDate: '2019-08-24T14:15:22.0000000Z' nextMonitoringDate: '2019-08-24T14:15:22.0000000Z' monitorId: c26980a6-b967-4775-b2ae-fd35a2a71496 verifiedAt: '2019-08-24T14:15:22.0000000Z' userActionNeeded: true isIgnored: true matchScore: score: 0 recommendation: Mismatch sortedBy: Id sortDirection: Asc sort: Id: Asc DatasetScanRequestModel: type: object properties: type: description: The specific dataset that will be 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 - AmericanHeartAssociation type: string providerId: description: Identifier of the provider containing data properties to scan for. type: string format: uuid options: $ref: '#/components/schemas/DatasetScanOptions' DatasetStatus: type: object properties: expectedProcessingTime: description: >- The duration in seconds it may take to complete a dataset scan from start to end. type: number format: double DateOfAttendance: type: object properties: beginDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true DeaDatasetRecord: type: object properties: businessActivityCode: type: string nullable: true drugSchedules: type: string nullable: true expirationDate: type: string format: date-time additionalCompanyInfo: type: string nullable: true address1: type: string nullable: true address2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true zipCode: type: string nullable: true businessActivitySubCode: type: string nullable: true paymentIndicator: enum: - Paid - Exempt type: string active: type: boolean deax: $ref: '#/components/schemas/DeaxModel' degree: type: string nullable: true stateLicenseNumber: type: string nullable: true stateControlledSubstanceLicenseNumber: type: string nullable: true businessActivity: type: string nullable: true readOnly: true id: type: string format: uuid hash: type: string format: uuid registrationNumber: type: string nullable: true fullName: type: string nullable: true DeaRegistrationInfoModel: type: object properties: lastUpdatedAt: type: string format: date-time id: type: string format: uuid registrationNumber: type: string nullable: true DeaRegistrationInfoPatchModel: required: - registrationNumber type: object properties: registrationNumber: minLength: 1 type: string DeaRegistrationInfoRequestModel: required: - registrationNumber type: object properties: registrationNumber: minLength: 1 type: string DeaxModel: type: object properties: number: type: string nullable: true certifiedPatientLimit: type: integer format: int32 Degree: type: object properties: nameOnSchoolRecord: $ref: '#/components/schemas/NameOnSchoolRecord' officialNameOfSchool: type: string nullable: true schoolType: type: string nullable: true schoolCode: type: string nullable: true schoolDivision: type: string nullable: true branchCode: type: string nullable: true jointInstitution: type: string nullable: true degreeTitle: type: string nullable: true awardDate: type: string format: date-time nullable: true majorCoursesOfStudy: type: array items: $ref: '#/components/schemas/CourseOfStudy' nullable: true minorCoursesOfStudy: type: array items: $ref: '#/components/schemas/CourseOfStudy' nullable: true majorOptions: type: array items: $ref: '#/components/schemas/Course' nullable: true majorConcentrations: type: array items: $ref: '#/components/schemas/Course' nullable: true academicHonors: type: string nullable: true honorsProgram: type: string nullable: true otherHonors: type: string nullable: true dateOfAttendance: $ref: '#/components/schemas/DateOfAttendance' graduated: type: boolean nullable: true DismissRequestModel: type: object properties: dismissalNote: description: A note that explains why this alert was dismissed. type: string DmfDatasetRecord: type: object properties: fullName: type: string nullable: true deceased: type: boolean deceasedStateOnRecord: type: string nullable: true dateOfDeath: type: string format: date-time nullable: true lastKnowState: type: string nullable: true lastKnowZipCode: type: string nullable: true lastKnowCountry: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid dateOfBirth: type: string format: date-time nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true EducationModel: type: object properties: lastUpdatedAt: description: The date and time when the object was created or modified. type: string format: date-time id: description: Unique identifier associated with this education type: string format: uuid ecfmgNumber: description: Educational Commission for Foreign Medical Graduates number type: string ecfmgIssueDate: description: Timestamp when the certificate was issued type: string format: date-time graduateType: description: Degree program type enum: - Undergraduate - Professional - FifthPathway type: string schoolName: description: Name of school type: string schoolCode: description: >- School code as defined by the National Student Clearinghouse Participation List type: string branchCode: type: string startDate: description: Timestamp when this provider started their degree program type: string format: date-time endDate: description: Timestamp when this provider finished their degree program type: string format: date-time completed: description: >- Identifies if this provider completed their graduate education at this school type: boolean degree: description: Degree awarded type: string EducationPatchModel: type: object properties: ecfmgNumber: description: Educational Commission for Foreign Medical Graduates number type: string ecfmgIssueDate: description: Timestamp when the certificate was issued type: string format: date-time graduateType: description: Degree program type enum: - Undergraduate - Professional - FifthPathway type: string schoolName: description: Name of school type: string schoolCode: description: >- School code as defined by the National Student Clearinghouse Participation List type: string startDate: description: Timestamp when this provider started their degree program type: string format: date-time endDate: description: Timestamp when this provider finished their degree program type: string format: date-time completed: description: >- Identifies if this provider completed their graduate education at this school type: boolean degree: description: Degree awarded type: string EducationRequestModel: type: object properties: ecfmgNumber: description: Educational Commission for Foreign Medical Graduates number type: string ecfmgIssueDate: description: Timestamp when the certificate was issued type: string format: date-time graduateType: description: Degree program type enum: - Undergraduate - Professional - FifthPathway type: string schoolName: description: Name of school type: string schoolCode: description: >- School code as defined by the [National Student Clearinghouse](https://www.studentclearinghouse.org/colleges/degreeverify/degreeverify-schools/) type: string branchCode: type: string startDate: description: Timestamp when this provider started their degree program type: string format: date-time endDate: description: Timestamp when this provider finished their degree program type: string format: date-time completed: description: >- Identifies if this provider completed their graduate education at this school type: boolean degree: description: Degree awarded type: string EmailModel: type: object properties: email: type: string nullable: true type: enum: - Unspecified - Personal - Work type: string Enrollment: type: object properties: enrollments: type: array items: $ref: '#/components/schemas/EnrollmentInfo' nullable: true studentAddress: $ref: '#/components/schemas/NscAddress' EnrollmentInfo: type: object properties: enrollmentStatus: type: string nullable: true termBeginDate: type: string format: date-time nullable: true termEndDate: type: string format: date-time nullable: true schoolCertifiedOn: type: string format: date-time nullable: true anticipatedGraduationDate: type: string format: date-time nullable: true EventLogModel: type: object properties: id: description: Unique identifier of the event. type: string format: uuid timestamp: description: The date & time of the event. type: string format: date-time type: description: The type of the event indicating if it was system or user initiated. enum: - System - Request - Legacy type: string messageTemplate: description: >- Human readable description of the event that occurred. To be used in conjunction with `messageParameters`. type: string messageParameters: description: >- If the `messageTemplate` contains parameters, this object will contain the values to be used to replace those parameters. correlationId: description: >- The correlation identifier associated with the request. Verifiable staff can use this for further troubleshooting. type: string format: uuid context: description: >- Any relevant contextual data for the event. For events of type `Request` this will contain `request` and `user` data. In addition most events will include an array of `relatedEntities` with identifiers of objects that are related to this specific event. EventLogPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Timestamp - Type type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The event log entries in the current page. type: array items: $ref: '#/components/schemas/EventLogModel' sortedBy: description: The property by which the data is sorted. enum: - Timestamp - Type type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 20 count: 1 totalCount: 1 items: - id: 50587ba5-ed48-4430-b9fd-6b4518979a84 timestamp: '2021-10-04T14:21:45.6433130Z' type: Request messageTemplate: Viewed event log context: user: id: 40b87c94-e279-4412-933b-6dc87980bc31 role: admin email: john.doe@verifiable.com request: route: log/events method: GET operation: ListEventLogEntries timeTaken: 6 userAgent: PostmanRuntime/7.28.4 queryString: includeReadEvents=true userTokenId: defbffb0-861e-4b4b-b899-b9452ef0089b responseType: application/json; charset=utf-8 routeTemplate: log/events userIpAddress: 0.0.0.1 responseStatusCode: 200 relatedEntities: [] sortedBy: Timestamp sortDirection: Desc sort: Timestamp: Desc FacilityModel: type: object properties: id: type: string format: uuid name: description: The name of this facility. type: string createdAt: description: Timestamp when this facility was created. type: string format: date-time deactivated: description: If set, the facility is deactivated. type: boolean parentFacilityId: type: string format: uuid dba: description: The DBA of this facility. type: string addressLine1: description: The street address of this facility. type: string addressLine2: description: The secondary address information of this facility. type: string city: description: The city in which the facility address is located. type: string state: description: The state in which the facility address is located. 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 type: string zipCode: description: The postal code associated with the facility address. type: string phoneNumber: description: Phone number associated with the facility. type: string faxNumber: description: Fax number associated with the facility. type: string groupTaxId: description: The group tax id associated with the facility. type: string facilityTaxId: description: The tax id associated with the facility. type: string contactName: description: The contact name associated with the facility. type: string contactEmail: description: The contact email associated with the facility. type: string FailureModel: description: >- 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. type: object properties: messageTemplate: description: >- An informative human readable message describing the verification failure. type: string messageParams: description: >- Collection of key/value pairs containing parameters to be replaced in `messageTemplate`. type: object additionalProperties: type: string nullable: true FileModel: type: object properties: id: description: Unique identifier for this file. type: string format: uuid providerId: description: If set, the provider to which this file is associated. type: string format: uuid createdAt: description: The time when the file was created. type: string format: date-time createdByUserId: description: The identifier of the user who created the file. type: string format: uuid createdByUserEmail: description: The e-mail of the user who created the file. type: string path: description: Path to the file. type: string size: description: The size of the file. type: integer format: int32 FilePageModel: type: object properties: sort: type: object additionalProperties: type: object properties: Keys: enum: - Path - CreatedAt type: string Values: enum: - Asc - Desc type: string nullable: true previousCursor: type: string nullable: true nextCursor: type: string nullable: true nextOffset: type: integer format: int32 nullable: true pageSize: type: integer format: int32 count: type: integer format: int32 totalCount: type: integer format: int32 nullable: true items: type: array items: $ref: '#/components/schemas/FileModel' nullable: true sortedBy: enum: - Path - CreatedAt type: string nullable: true sortDirection: enum: - Asc - Desc type: string nullable: true FlexibleDataModel: type: object properties: type: description: The schema type for `data`. enum: - Form - Table - Section type: string data: description: >- The actual data for this property. The schema can change depending on `type`. See the [Flexible Data Model](/reference/overview/#section/Common-Concepts/flexible-data-model) for more information. FountainApplicantModel: type: object properties: id: type: string format: uuid email: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true date_of_birth: type: string format: date-time nullable: true data: type: object additionalProperties: {} nullable: true stage: $ref: '#/components/schemas/FountainStage' funnel: $ref: '#/components/schemas/FountainFunnel' secure_data: type: object additionalProperties: {} nullable: true FountainFunnel: type: object properties: title: type: string nullable: true id: type: string format: uuid FountainStage: type: object properties: title: type: string nullable: true id: type: string format: uuid FountainWebhookRequestModel: type: object properties: applicant: $ref: '#/components/schemas/FountainApplicantModel' FountainWebhookResponseModel: type: object properties: requestId: type: string format: uuid GoogleAuthModel: type: object properties: code: $ref: '#/components/schemas/SensitiveString' timeToLive: description: >- If set, the created token will expire after the duration specified by this parameter. Note that the token will still be expired after 4 weeks of no use, regardless of the time to live. Additionally there might be a limit set for your organization. If the requested time-to-live exceeds this limit the token will be capped to that limit. type: string format: timespan token: $ref: '#/components/schemas/SensitiveString' example: code: 4/yU4cQZT...4z7U4UmAI timeToLive: '00:30:00' GroupModel: required: - name type: object properties: id: description: Unique identifier associated with this group. type: string format: uuid name: description: The name associated with this group. minLength: 1 type: string npi: description: NPI number associated with this group. type: integer format: int64 taxId: description: Tax ID number associated with this group. type: string remitAddress: $ref: '#/components/schemas/AddressModel' GroupPatchModel: type: object properties: name: description: If set, the group's `name` will be updated with this value. type: string npi: description: If set, the group's `npi` will be updated with this value. type: integer format: int64 taxId: description: If set, the group's `taxId` will be updated with this value. type: string remitAddress: $ref: '#/components/schemas/AddressModel' example: name: string npi: 1234567890 GroupPayerRelationPatchModel: type: object properties: add: description: >- Collection of unique payer plan identifiers. If set, new relations between the group and specified payer plan in this collection will be created. type: array items: type: string format: uuid remove: description: >- Collection of unique payer plan identifiers. If set, the existing relations between the group and specified payer plan in this collection will be removed. type: array items: type: string format: uuid example: add: - 5d03a731-b9b5-45b9-b67e-06bb44369102 - ea82c3cc-9206-4d22-a501-5dd6624457d3 remove: - 2b159576-92f6-453e-aaf6-822402536e02 GroupProviderRelationPatchModel: type: object properties: add: description: >- Collection of unique provider identifiers. If set, new relations between the group and specified provider in this collection will be created. type: array items: type: string format: uuid remove: description: >- Collection of unique provider identifiers. If set, the existing relations between the group and specified provider in this collection will be removed. type: array items: type: string format: uuid example: add: - 5d03a731-b9b5-45b9-b67e-06bb44369102 - ea82c3cc-9206-4d22-a501-5dd6624457d3 remove: - 2b159576-92f6-453e-aaf6-822402536e02 GroupRequestModel: required: - name type: object properties: name: description: The name associated with this group. minLength: 1 type: string npi: description: NPI number associated with this group. type: integer format: int64 taxId: description: Tax ID number associated with this group. type: string remitAddress: $ref: '#/components/schemas/AddressModel' IProviderParameter: oneOf: - $ref: '#/components/schemas/ProviderAddressParameter' - $ref: '#/components/schemas/ProviderBoardCertificationNumberParameter' - $ref: '#/components/schemas/ProviderCaqhId' - $ref: '#/components/schemas/ProviderCaqhLoginInfoParameter' - $ref: '#/components/schemas/ProviderCertificateParameter' - $ref: '#/components/schemas/ProviderDateOfBirthParameter' - $ref: '#/components/schemas/ProviderDeaParameter' - $ref: '#/components/schemas/ProviderEducationParameter' - $ref: '#/components/schemas/ProviderLicenseParameter' - $ref: '#/components/schemas/ProviderNameParameter' - $ref: '#/components/schemas/ProviderNpiParameter' - $ref: '#/components/schemas/ProviderSsnParameter' - $ref: '#/components/schemas/ProviderTypeParameter' discriminator: propertyName: type mapping: ProviderAddress: '#/components/schemas/ProviderAddressParameter' ProviderBoardCertificationNumber: '#/components/schemas/ProviderBoardCertificationNumberParameter' ProviderCaqhId: '#/components/schemas/ProviderCaqhId' ProviderCaqhLoginInfo: '#/components/schemas/ProviderCaqhLoginInfoParameter' ProviderCertificate: '#/components/schemas/ProviderCertificateParameter' ProviderDateOfBirth: '#/components/schemas/ProviderDateOfBirthParameter' ProviderDea: '#/components/schemas/ProviderDeaParameter' ProviderEducation: '#/components/schemas/ProviderEducationParameter' ProviderLicense: '#/components/schemas/ProviderLicenseParameter' ProviderName: '#/components/schemas/ProviderNameParameter' ProviderNpi: '#/components/schemas/ProviderNpiParameter' ProviderSsn: '#/components/schemas/ProviderSsnParameter' ProviderType: '#/components/schemas/ProviderTypeParameter' IdCheckAddress: type: object properties: addressSource: type: string nullable: true countyCode: type: string nullable: true countyCodeDesc: type: string nullable: true countryCode: type: string nullable: true street: type: string nullable: true line2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true zip: type: string nullable: true zip4: type: string nullable: true firstReportedDate: type: string format: date-time lastReportedDate: type: string format: date-time totalOccurrences: type: integer format: int32 activeOccurrences: type: integer format: int32 grade: type: string nullable: true gradeDesc: type: string nullable: true refId: type: integer format: int32 rank: type: string nullable: true IdCheckDatasetRecord: type: object properties: aliases: type: array items: $ref: '#/components/schemas/IdCheckProviderAlias' nullable: true ssn: type: string nullable: true requestReportReferenceNumber: type: string nullable: true ssnIssuedFrom: type: string format: date-time ssnIssuedTo: type: string format: date-time ssnIssuedState: type: string nullable: true ssnIssuedState2: type: string nullable: true ssnIssuedState3: type: string nullable: true ssnSource: type: string nullable: true svcCode: type: string nullable: true svcCodeDesc: type: string nullable: true addresses: type: array items: $ref: '#/components/schemas/IdCheckAddress' nullable: true ssnMatchCode: type: string nullable: true ssnMatchCodeDescription: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid dateOfBirth: type: string format: date-time nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true IdCheckProviderAlias: type: object properties: firstReportedDate: type: string format: date-time totalOccurrences: type: integer format: int32 activeOccurrences: type: integer format: int32 lastReportedDate: type: string format: date-time firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true InvalidateAllAccessTokensRequestModel: type: object properties: invalidateCurrent: type: boolean tokenIds: type: array items: type: string format: uuid nullable: true LiabilityInsuranceModel: type: object properties: lastUpdatedAt: description: The date and time when the object was created or modified. type: string format: date-time id: description: Unique identifier associated with this insurance type: string format: uuid name: description: Name of insurance type: string isSelfInsured: description: Indicates whether the provider is self insured type: boolean originalEffectiveDate: description: Timestamp of when the initial insurance coverage became effective type: string format: date-time currentEffectiveDate: description: Timestamp of when the current insurance coverage became effective type: string format: date-time currentExpirationDate: description: Timestamp of when the current insurance expires type: string format: date-time coverageType: description: Insurance type of coverage enum: - Individual - Shared - Occurrence - ClaimsMade type: string isUnlimitedCoverage: description: Does this insurance have unlimited coverage? type: boolean includesTailCoverage: description: Indicates tail coverage status type: boolean occurrenceCoverageAmount: description: Amount of coverage provided by this insurance per occurrence type: number format: double aggregateCoverageAmount: description: Amount of aggregated coverage provided by this insurance type: number format: double policyNumber: description: Insurance policy number type: string LiabilityInsurancePatchModel: type: object properties: name: description: Name of insurance type: string isSelfInsured: description: Indicates whether the provider is self insured type: boolean originalEffectiveDate: description: Timestamp of when the initial insurance coverage became effective type: string format: date-time currentEffectiveDate: description: Timestamp of when the current insurance coverage became effective type: string format: date-time currentExpirationDate: description: Timestamp of when the current insurance expires type: string format: date-time coverageType: description: Insurance type of coverage enum: - Individual - Shared - Occurrence - ClaimsMade type: string isUnlimitedCoverage: description: Does this insurance have unlimited coverage? type: boolean includesTailCoverage: description: Indicates tail coverage status type: boolean occurrenceCoverageAmount: description: Amount of coverage provided by this insurance per occurrence type: number format: double aggregateCoverageAmount: description: Amount of aggregated coverage provided by this insurance type: number format: double policyNumber: description: Insurance policy number type: string LiabilityInsuranceRequestModel: type: object properties: name: description: Name of insurance type: string isSelfInsured: description: Indicates whether the provider is self insured type: boolean originalEffectiveDate: description: Timestamp of when the initial insurance coverage became effective type: string format: date-time currentEffectiveDate: description: Timestamp of when the current insurance coverage became effective type: string format: date-time currentExpirationDate: description: Timestamp of when the current insurance expires type: string format: date-time coverageType: description: Insurance type of coverage enum: - Individual - Shared - Occurrence - ClaimsMade type: string isUnlimitedCoverage: description: Does this insurance have unlimited coverage? type: boolean includesTailCoverage: description: Indicates tail coverage status type: boolean occurrenceCoverageAmount: description: Amount of coverage provided by this insurance per occurrence type: number format: double aggregateCoverageAmount: description: Amount of aggregated coverage provided by this insurance type: number format: double policyNumber: description: Insurance policy number type: string LicenseModel: type: object properties: providerId: description: Identifier of the provider associated with this license. type: string format: uuid licenseNumber: description: The license number used when attaching this license to the provider. type: string firstName: description: >- Provider first name number used when attaching this license to the provider. type: string lastName: description: Provider last name used when attaching this license to the provider. type: string state: description: 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 type: string jobStatus: description: >- 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 type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedLicenseInfoModel' currentVerificationStatus: description: Status of the last requested verification for this license. enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string currentVerification: $ref: '#/components/schemas/LicenseVerificationModel' restrictionStatus: description: Restriction status for the license. `None` is a default value. enum: - None - Restricted - Unrestricted type: string approvedStatus: description: Approval status for the license. `Pending` is a default value. enum: - Pending - 'Yes' - 'No' type: string isPrimary: description: If the flag is set, license will be set as primary for the provider. type: boolean id: description: Unique identifier for this specific license. type: string format: uuid isCurrentlyPracticing: description: >- Indicates whether the provider is currently practicing in this state. type: boolean prescriptiveAuthority: description: >- 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 type: string collaboratingProviderId: description: >- Identifier describing the provider who fulfills the license's collaborative practice agreement or protocol requirement. type: string format: uuid licenseType: $ref: '#/components/schemas/SimplifiedLicenseTypeModel' LicenseMonitorModel: type: object properties: id: type: string format: uuid type: description: >- Monitoring type for this monitor object. The license identifier and dataset type will be set based on this type. enum: - Dataset - License type: string monitoringInterval: description: The interval at which the data is being monitored. enum: - Continuous - Daily - Weekly - Monthly - Yearly type: string nextMonitoringDate: description: The next date on which this data is scheduled to be monitored. type: string format: date-time lastMonitoringDate: description: The date on which this data was monitored last time. type: string format: date-time providerId: description: The identifier of the provider that is associated with this monitor. type: string format: uuid licenseId: description: The identifier of the license that is associated with this monitor. type: string format: uuid lastVerification: $ref: '#/components/schemas/LicenseVerificationModel' LicensePatchModel: type: object properties: restrictionStatus: description: >- If set, the license's restriction status will be updated with this value. enum: - None - Restricted - Unrestricted type: string approvedStatus: description: >- If set, the license's approved status will be updated with this value. enum: - Pending - 'Yes' - 'No' type: string nonVerifiedInfo: $ref: '#/components/schemas/NonVerifiedLicenseInfoModel' isCurrentlyPracticing: description: >- If set, the license's `isCurrentlyPracticing` flag will be updated with this value. type: boolean isPrimary: description: >- If set, the license's `isPrimary` flag will be updated with this value. type: boolean prescriptiveAuthority: enum: - RequiredMet - RequiredNotMet - NotRequired type: string collaboratingProviderId: type: string format: uuid example: restrictionStatus: NotRestricted approvedStatus: 'Yes' LicenseSourceStatusModel: type: object properties: issue: description: >- License source issue type. Set only if the license source is presenting any issue during verification. enum: - PossibleIssue - SourceIssue - AutomationIssue - AutomationDegraded type: string averageProcessingTime: description: >- Average processing time for a license verification (based on verifications over last 24 hrs). type: number format: double averageFailureRate: description: >- Average license verification failure rate for a license verification (based on verifications over last 24 hrs). type: number format: double LicenseVerificationAttachmentModel: type: object properties: file: $ref: '#/components/schemas/FileModel' type: enum: - DisciplinaryAction - VerificationLetter type: string source: description: The original url for the file, taken from the verification source. type: string downloadStatus: description: The status of the download. ´Downloaded´ or ´Failed´ enum: - Downloaded - Failed type: string failureReason: $ref: '#/components/schemas/FailureModel' LicenseVerificationDiffModel: type: object properties: old: $ref: '#/components/schemas/LicenseVerificationModel' new: $ref: '#/components/schemas/LicenseVerificationModel' diff: description: >- Diff in [jsondiffpatch](https://github.com/benjamine/jsondiffpatch) format. LicenseVerificationModel: type: object properties: originalStatus: description: >- The original status as our license verification process determined. Unlike `status` the `originalStatus` can never change. enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string status: description: >- The current status for this license verification. If you patch the license verification status (in case the status is `NeedsReview`) this property will be updated, but `originalStatus` will remain the same. enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string trigger: description: >- Set to `Manual` if the verification is triggered by a user or `Monitor` if the verification was triggered by the monitoring system. enum: - Manual - Monitor type: string started: description: Timestamp of when the license verification started processing. type: string format: date-time processingTime: description: >- The duration in milliseconds it took to process the license verification from start to end. type: integer format: int64 results: description: >- Array of verification records returned by the source that match the license number. type: array items: $ref: '#/components/schemas/LicenseVerificationResultModel' verificationSource: $ref: '#/components/schemas/VerificationSourceModel' failureReason: $ref: '#/components/schemas/FailureModel' correctResultIndex: description: >- In case there is more than 1 result you can patch the verification and specify which of the records is the correct match by setting `correctResultIndex` to the appropriate index matching the index in the `results` array. type: integer format: int32 export: description: >- Once a license verification is in an 'end state' a PDF export will be generated. Once the PDF is generated this property will contain the path to that export. That path can be used to [download the file](https://api.discovery.verifiable.com). Please note that the process to generate an export is asynchronous and it can take several seconds after a verification is completed before the export is ready. type: string id: description: Unique identifier for this license verification. type: string format: uuid monitoringMetadata: $ref: '#/components/schemas/MonitoringMetadata' LicenseVerificationParameters: type: object properties: requiredParameters: description: >- List of parameters required to run a license verification. Missing data for a required parameter will result into a failed verification. type: array items: enum: - LicenseNumber - Name type: string optionalParameters: description: >- List of optional parameters that may be used to improve the verification result quality by applying additional filters. type: array items: enum: - LicenseNumber - Name type: string LicenseVerificationResolutionModel: type: object properties: status: description: The correct status for this license verification. enum: - Found - Failed - NeedsReview - NotFound - Pending - Working type: string correctResultIndex: description: >- The correct result index for this license verification (if applicable). type: integer format: int32 example: status: Found correctResultIndex: 0 LicenseVerificationResultModel: type: object properties: name: description: Name of the provider as indicated by the source. type: string licenseType: description: Textual description of the license type as indicated by the source. type: string licenseStatus: description: >- Textual description of the license status as indicated by the source. type: string licenseNumber: description: License number as indicated by the source. type: string address: description: Address of the license holder as indicated by the source. type: string issued: description: Timestamp when the license was issued as indicated by the source. type: string format: date-time expires: description: Timestamp when the license expires as indicated by the source. type: string format: date-time screenshots: description: >- Array of paths to screenshots that where taken as proof of the license verification. type: array items: type: string attachments: description: >- Array of attachments related to the verification that where taken from the source. type: array items: $ref: '#/components/schemas/LicenseVerificationAttachmentModel' disciplinaryActions: $ref: '#/components/schemas/FlexibleDataModel' additionalProperties: $ref: '#/components/schemas/FlexibleDataModel' problems: description: >- Array of problems that resulted in a `NeedsReview` status for the license verification. type: array items: enum: - NameMismatch - LicenseTypeMismatch type: string matchScore: $ref: '#/components/schemas/MatchScore' MaintenanceDowntimeCronDescription: type: object properties: description: type: string nullable: true expression: type: string nullable: true isUnderMaintenanceInTheNextHour: type: boolean expiresIn: type: string format: timespan nullable: true MatchScore: type: object properties: score: type: number format: double recommendation: enum: - Mismatch - Match type: string MedicareOptOutDatasetRecord: type: object properties: speciality: type: string nullable: true effectiveDate: type: string format: date-time endDate: type: string format: date-time eligibleToOrderAndRefer: type: boolean id: type: string format: uuid hash: type: string format: uuid address: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true npiNumber: type: integer format: int64 nullable: true MonitorModel: oneOf: - $ref: '#/components/schemas/DatasetMonitorModel' - $ref: '#/components/schemas/LicenseMonitorModel' discriminator: propertyName: type mapping: Dataset: '#/components/schemas/DatasetMonitorModel' License: '#/components/schemas/LicenseMonitorModel' MonitorPageModel: type: object properties: sort: type: object additionalProperties: type: object properties: Keys: enum: - Type - NextMonitoringDate type: string Values: enum: - Asc - Desc type: string nullable: true previousCursor: type: string nullable: true nextCursor: type: string nullable: true nextOffset: type: integer format: int32 nullable: true pageSize: type: integer format: int32 count: type: integer format: int32 totalCount: type: integer format: int32 nullable: true items: type: array items: $ref: '#/components/schemas/MonitorModel' nullable: true sortedBy: enum: - Type - NextMonitoringDate type: string nullable: true sortDirection: enum: - Asc - Desc type: string nullable: true MonitorPatchModel: type: object properties: monitoringInterval: description: If set, this will update the monitoring interval for this monitor. enum: - Continuous - Daily - Weekly - Monthly - Yearly type: string nextMonitoringDate: description: >- If set, this will update the next date at which the data will be monitored. type: string format: date-time triggerImmediateVerification: type: boolean MonitorRequestModel: required: - providerId - type type: object properties: type: description: >- Specify monitoring type, will be used for validation and creating monitor. This will be used along with license id or dataset type enum: - Dataset - License type: string providerId: description: Provider identifier for which the monitor is to be created. type: string format: uuid datasetType: description: Specify dataset type for which the monitor is to be created. 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 - AmericanHeartAssociation type: string licenseId: description: Specify license identifier for which the monitor is to be created. type: string format: uuid monitoringInterval: description: If set, this will update the monitoring interval for this monitor. enum: - Continuous - Daily - Weekly - Monthly - Yearly type: string nextMonitoringDate: description: >- If set, this will update the next date at which the data will be monitored. type: string format: date-time options: $ref: '#/components/schemas/DatasetScanOptions' triggerImmediateVerification: type: boolean MonitoringMetadata: type: object properties: monitoringInterval: description: The interval at which the data is being monitored. enum: - Continuous - Daily - Weekly - Monthly - Yearly type: string lastMonitoringDate: description: The previous date on which this data was monitored, if any. type: string format: date-time nextMonitoringDate: description: The next date on which this data is scheduled to be monitored. type: string format: date-time monitorId: description: Unique identifier of the monitor. type: string format: uuid NameOnSchoolRecord: type: object properties: suffix: type: string nullable: true firstName: type: string nullable: true lastName: type: string nullable: true middleName: type: string nullable: true NoContentResult: type: object properties: statusCode: type: integer format: int32 NonVerifiedBoardCertificationInfoModel: type: object properties: initialCertificationDate: description: Initial certification date for this board certificate. type: string format: date-time recertificationDate: description: Last recertification date for this board certificate. type: string format: date-time expirationDate: description: Expiration date for this board certificate. type: string format: date-time NonVerifiedLicenseInfoModel: type: object properties: issueDate: type: string format: date-time nullable: true expirationDate: type: string format: date-time nullable: true status: type: string nullable: true NormalizedAddress: type: object properties: state: 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 type: string nullable: true zipCode: type: string nullable: true city: type: string nullable: true addressLine: type: string nullable: true NpdbDatasetRecord: type: object properties: subjectInformation: $ref: '#/components/schemas/NpdbSubjectInformation' queryInformation: $ref: '#/components/schemas/NpdbQueryInformation' reports: type: array items: $ref: '#/components/schemas/NpdbReportInformation' nullable: true reportPaths: type: array items: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid NpdbEnrollmentStatus: type: object properties: status: type: string nullable: true startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true NpdbInformationReported: type: object properties: type: enum: - Aar - Mmpr - Jocr type: string readOnly: true NpdbOccupationAndLicensure: type: object properties: type: type: string nullable: true number: type: string nullable: true state: 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 type: string nullable: true NpdbProfessionalSchoolInformation: type: object properties: name: type: string nullable: true yearOfGraduation: type: string nullable: true NpdbQueryInformation: type: object properties: statutesQueried: type: array items: type: string nullable: true queryType: enum: - OneTimeQuery - ContinuousQuery - CancellationQuery - StatusQuery - RenewQuery - UpdateQuery type: string entityName: type: string nullable: true entityDbId: type: string nullable: true authorizedSubmitter: $ref: '#/components/schemas/NpdbSubmitterInformation' NpdbReportInformation: type: object properties: dcn: type: string nullable: true previousDcn: type: string nullable: true reportingEntity: $ref: '#/components/schemas/NpdbReportingEntityInformation' subject: $ref: '#/components/schemas/NpdbReportSubjectInformation' informationReported: type: array items: $ref: '#/components/schemas/NpdbInformationReported' nullable: true subjectStatement: type: string nullable: true subjectStatementDate: type: string format: date-time nullable: true disputeStatus: enum: - ReportDisputed - ReviewRequested - ReconsiderationRequested - DecisionReached type: string nullable: true originalSubmission: type: string format: date-time mostRecentChange: type: string format: date-time nullable: true NpdbReportSubjectInformation: type: object properties: name: type: string nullable: true otherNames: type: array items: type: string nullable: true gender: type: string nullable: true dateOfBirth: type: string format: date-time organizationName: type: string nullable: true organizationTypeCode: type: string nullable: true workAddress: $ref: '#/components/schemas/NormalizedAddress' homeAddress: $ref: '#/components/schemas/NormalizedAddress' license: type: string nullable: true organizationType: type: string nullable: true ssn: type: array items: $ref: '#/components/schemas/SensitiveString' nullable: true occupationAndLicensure: $ref: '#/components/schemas/NpdbOccupationAndLicensure' otherOccupationAndLicensure: type: array items: $ref: '#/components/schemas/NpdbOccupationAndLicensure' nullable: true enrollmentStatuses: type: array items: $ref: '#/components/schemas/NpdbEnrollmentStatus' nullable: true deceased: type: boolean nullable: true npi: type: array items: type: string nullable: true professionalSchools: type: array items: $ref: '#/components/schemas/NpdbProfessionalSchoolInformation' nullable: true dea: type: array items: type: string nullable: true healthCareEntities: type: array items: type: string nullable: true occupationFieldOfLicensure: type: string nullable: true stateLicenseNumber: type: string nullable: true NpdbReportingEntityInformation: type: object properties: name: type: string nullable: true additionalName: type: string nullable: true address: $ref: '#/components/schemas/NormalizedAddress' officeOrName: type: string nullable: true titleOrDepartment: type: string nullable: true phone: type: string nullable: true entityReference: type: string nullable: true NpdbSubjectInformation: type: object properties: name: type: string nullable: true otherNames: type: array items: type: string nullable: true gender: type: string nullable: true dateOfBirth: type: string format: date-time organizationName: type: string nullable: true organizationTypeCode: type: string nullable: true workAddress: $ref: '#/components/schemas/NormalizedAddress' homeAddress: $ref: '#/components/schemas/NormalizedAddress' license: type: string nullable: true organizationType: type: string nullable: true ssn: type: array items: $ref: '#/components/schemas/SensitiveString' nullable: true occupationAndLicensure: $ref: '#/components/schemas/NpdbOccupationAndLicensure' otherOccupationAndLicensure: type: array items: $ref: '#/components/schemas/NpdbOccupationAndLicensure' nullable: true enrollmentStatuses: type: array items: $ref: '#/components/schemas/NpdbEnrollmentStatus' nullable: true NpdbSubmitterInformation: type: object properties: title: type: string nullable: true name: type: string nullable: true phone: type: string nullable: true date: type: string format: date-time nullable: true NpdbUpdateRequestRejectedWebhook: type: object properties: message: description: The reason why the update request was rejected by NPDB. type: string providerId: description: >- The identifier of the provider that is associated with the NPDB update request. type: string format: uuid npdbVerificationRequestId: description: >- The identifier of the active NPDB continuous query associated with the NPDB update request. type: string format: uuid rejectedParameters: type: array items: $ref: '#/components/schemas/IProviderParameter' NpiDatasetRecord: type: object properties: enumerationType: type: string nullable: true isDeactivated: type: boolean deactivationReason: type: string nullable: true basic: $ref: '#/components/schemas/NpiProfile.NpiBasicModel' otherNames: type: array items: $ref: '#/components/schemas/NpiProfile.OtherName' nullable: true addresses: type: array items: $ref: '#/components/schemas/NpiProfile.Address' nullable: true practiceLocations: type: array items: $ref: '#/components/schemas/NpiProfile.Address' nullable: true taxonomies: type: array items: $ref: '#/components/schemas/NpiProfile.Taxonomy' nullable: true identifiers: type: array items: $ref: '#/components/schemas/NpiProfile.Identifier' nullable: true id: type: string format: uuid hash: type: string format: uuid firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true npiNumber: type: integer format: int64 nullable: true NpiName: type: object properties: type: description: The name type as indicated by the NPI record. enum: - Other - Primary - Former - Professional type: string lastName: description: The last (family) name of the license holder. type: string firstName: description: The first (given) name of the license holder. type: string middleName: description: If applicable, the middle name of the license holder. type: string namePrefix: description: If applicable, the name prefix of the license holder. type: string nameSuffix: description: If applicable, the name suffix of the license holder. type: string credential: description: If applicable, the credential used by the license holder. type: string NpiProfile.Address: type: object properties: addressLine1: type: string nullable: true addressLine2: type: string nullable: true state: 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 type: string nullable: true postalCode: type: string nullable: true countryCode: type: string nullable: true city: type: string nullable: true telephoneNumber: type: string nullable: true faxNumber: type: string nullable: true purpose: enum: - Location - Mailing - Primary - Secondary type: string nullable: true updateDate: type: string format: date-time nullable: true NpiProfile.Identifier: type: object properties: description: type: string nullable: true number: type: string nullable: true code: type: string nullable: true state: 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 type: string nullable: true issuer: type: string nullable: true NpiProfile.NpiBasicModel: type: object properties: replacementNpi: type: integer format: int64 nullable: true ein: type: string nullable: true organizationName: type: string nullable: true lastName: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true namePrefix: type: string nullable: true nameSuffix: type: string nullable: true credential: type: string nullable: true enumerationDate: type: string format: date-time nullable: true lastUpdateDate: type: string format: date-time nullable: true certificationDate: type: string format: date-time nullable: true isSoleProprietor: type: boolean nullable: true isOrganizationalSubpart: type: boolean nullable: true parentOrganizationLbn: type: string nullable: true parentOrganizationTin: type: string nullable: true authorizedOfficialNamePrefix: type: string nullable: true authorizedOfficialNameSuffix: type: string nullable: true authorizedOfficialCredential: type: string nullable: true authorizedOfficialFirstName: type: string nullable: true authorizedOfficialLastName: type: string nullable: true authorizedOfficialMiddleName: type: string nullable: true authorizedOfficialTelephoneNumber: type: string nullable: true authorizedOfficialTitleOrPosition: type: string nullable: true deactivationDate: type: string format: date-time nullable: true reactivationDate: type: string format: date-time nullable: true gender: type: string nullable: true status: type: string nullable: true name: type: string nullable: true NpiProfile.NpiProviderProfileModel: type: object properties: type: enum: - Npi - Caqh type: string readOnly: true npiNumber: type: integer format: int64 enumerationType: type: string nullable: true basic: $ref: '#/components/schemas/NpiProfile.NpiBasicModel' otherNames: type: array items: $ref: '#/components/schemas/NpiProfile.OtherName' nullable: true addresses: type: array items: $ref: '#/components/schemas/NpiProfile.Address' nullable: true practiceLocations: type: array items: $ref: '#/components/schemas/NpiProfile.Address' nullable: true taxonomies: type: array items: $ref: '#/components/schemas/NpiProfile.Taxonomy' nullable: true identifiers: type: array items: $ref: '#/components/schemas/NpiProfile.Identifier' nullable: true isDeactivated: type: boolean deactivationReason: type: string nullable: true NpiProfile.OtherName: type: object properties: nameTypeCode: type: string nullable: true lastName: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true credential: type: string nullable: true type: type: string nullable: true organizationName: type: string nullable: true NpiProfile.Taxonomy: type: object properties: description: type: string nullable: true code: type: string nullable: true license: type: string nullable: true state: 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 type: string nullable: true isPrimary: type: boolean nullable: true taxonomyGroup: type: string nullable: true NpiRecordAddress: type: object properties: type: description: The address type as indicated by the NPI record. enum: - Location - Mailing type: string addressLine1: description: Textual representation of the address. type: string addressLine2: description: >- If applicable, a second line of textual representation of the address. type: string city: description: The city in which the address is located. type: string state: description: Abbreviation of the state in which the city is located. type: string zip: description: The postal code associated with the address. type: string country: description: Country code of the country in which the city is located. type: string phone: description: Phone number associated with the address. type: string fax: description: Fax number associated with the address. type: string NpiRecordDataModel: type: object properties: id: description: >- The unique identifier for this NPI record at the timestamp this record was last updated. type: string format: uuid number: description: The 10 digit NPI number describing this NPI record. type: integer format: int64 addresses: description: Array of addresses associated with this NPI record. type: array items: $ref: '#/components/schemas/NpiRecordAddress' certificationDate: description: Date on which the licensee was certified. type: string format: date-time enumerationDate: description: The enumeration date as indicated on the NPI record. type: string format: date-time lastUpdated: description: Timestamp when this record was last updated. type: string format: date-time names: description: Array of names associated with this NPI record. type: array items: $ref: '#/components/schemas/NpiName' isSoleProprietor: description: Indicates if the licensee is a sole proprietor or not. type: boolean gender: description: The gender of the licensee. enum: - Unknown - Male - Female type: string otherIdentifiers: description: Array of other identifiers which are related to the license. type: array items: $ref: '#/components/schemas/NpiRecordIdentifier' taxonomies: description: >- Array of federal taxonomy codes that describe the classification of the license. type: array items: $ref: '#/components/schemas/NpiRecordTaxonomy' isActive: description: Indicates if the NPI record is active or not. type: boolean deactivationReason: description: If applicable, this specifies why the record is deactivated. type: string NpiRecordIdentifier: type: object properties: type: description: The identifier type as indicated by the NPI record. enum: - Other - Medicaid type: string identifier: description: The unique identifier associated with this particular identifier. type: string issuer: description: The issuer that issued the license associated with this identifier. type: string state: description: The state in which this license was issued. type: string NpiRecordTaxonomy: type: object properties: description: description: >- The federal taxonomy display name associated with taxonomy code for this NPI record. type: string code: description: The federal taxonomy code associated with this NPI record. type: string licenseNumber: description: The license number associated with this taxonomy code. type: string isPrimary: description: Indicates if the license is a primary license or not. type: boolean state: description: The state in which this license was issued. type: string group: description: If applicable, a taxonomy code of the group this belong to. type: string NscAddress: type: object properties: address1: type: string nullable: true address2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true zipCode: type: string nullable: true province: type: string nullable: true postalCode: type: string nullable: true country: type: string nullable: true NscDatasetRecord: type: object properties: degreeDetails: type: array items: $ref: '#/components/schemas/Degree' nullable: true enrollmentDetails: type: array items: $ref: '#/components/schemas/Enrollment' nullable: true transaction: $ref: '#/components/schemas/Transaction' previousNames: type: array items: $ref: '#/components/schemas/PersonName' nullable: true id: type: string format: uuid hash: type: string format: uuid dateOfBirth: type: string format: date-time nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true OfacAddressRecord: type: object properties: addressRemarks: type: string nullable: true address: type: string nullable: true OfacAlternateIdentityRecord: type: object properties: identityNumber: type: integer format: int64 type: type: string nullable: true remarks: type: string nullable: true fullName: type: string nullable: true OfacDatasetRecord: type: object properties: title: type: string nullable: true identityNumber: type: integer format: int64 type: enum: - Individual - Unknown type: string program: type: string nullable: true remarks: type: string nullable: true addresses: type: array items: $ref: '#/components/schemas/OfacAddressRecord' nullable: true alternateIdentities: type: array items: $ref: '#/components/schemas/OfacAlternateIdentityRecord' nullable: true id: type: string format: uuid hash: type: string format: uuid dateOfBirth: type: string format: date-time nullable: true fullName: type: string nullable: true OigExclusionsDatasetRecord: type: object properties: businessName: type: string nullable: true general: type: string nullable: true specialty: type: string nullable: true upin: type: integer format: int32 nullable: true exclusionType: type: string nullable: true exclusionDate: type: string format: date-time id: type: string format: uuid hash: type: string format: uuid address: type: string nullable: true dateOfBirth: type: string format: date-time nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true npiNumber: type: integer format: int64 nullable: true OigFugitivesDatasetRecord: type: object properties: status: type: string nullable: true id: type: string format: uuid hash: type: string format: uuid dateOfBirth: type: string format: date-time nullable: true fullName: type: string nullable: true ParameterSet: type: object properties: id: description: Unique identifier for this parameter set. type: string format: uuid supportedParameterTypes: description: >- Array of parameter types that are supported by the dataset during a scan. uniqueItems: true type: array items: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string requiredParameterTypes: description: >- Array of parameter types that are required by this dataset for the scans to execute. If these parameters cannot be resolved, the scan will fail. uniqueItems: true type: array items: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string isPreferred: description: >- Set to true if this parameter set will be used to run a scan if no parameter set is specified when initiating a [dataset scan](https://api.discovery.verifiable.com). type: boolean PasswordAuthModel: required: - email - password type: object properties: email: description: The email address of a previously registered user. minLength: 1 type: string password: $ref: '#/components/schemas/SensitiveString' newPassword: $ref: '#/components/schemas/SensitiveString' timeToLive: description: >- If set, the created token will expire after the duration specified by this parameter. Note that the token will still be expired after 4 weeks of no use, regardless of the time to live. Additionally there might be a limit set for your organization. If the requested time-to-live exceeds this limit the token will be capped to that limit. type: string format: timespan example: email: john.doe@mail.com password: secret newPassword: even-more-secret timeToLive: '00:30:00' PasswordResetRequestModel: required: - newPassword - token type: object properties: token: $ref: '#/components/schemas/SensitiveString' newPassword: $ref: '#/components/schemas/SensitiveString' PasswordUpdateModel: required: - newPassword type: object properties: password: description: The password associated with the current user. type: string newPassword: description: A new password to associate with the current user. minLength: 1 type: string example: password: secret newPassword: even-more-secret PayerModel: required: - name type: object properties: id: description: Unique identifier associated with this payer. type: string format: uuid name: description: The name associated with this payer. minLength: 1 type: string PayerPatchModel: type: object properties: name: description: If set, the payer's `name` will be updated with this value. type: string example: name: string PayerPlanModel: type: object properties: id: description: Unique identifier associated with this payer plan. type: string format: uuid name: description: The name associated with this payer plan. type: string payerId: description: Id of the payer assosiated with this plan type: string format: uuid state: description: US state 2-letter code associated with this payer plan. 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 type: string displayName: description: >- Name displayed in lists in the format of {Payer name} - {Payer plan name} type: string readOnly: true PayerPlanPatchModel: type: object properties: name: description: If set, the payer's `name` will be updated with this value. type: string payerId: description: >- If set, the Id of the payer assosiated with this plan will be updated with this value. type: string format: uuid state: description: >- If specified, US state 2-letter code will be set for this payer plan. 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 type: string example: name: string PayerPlanRequestModel: required: - payerId type: object properties: name: description: The name associated with this payer plan. type: string payerId: description: Id of the payer assosiated with this plan type: string format: uuid state: description: The state associated with this payer plan. 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 type: string PayerRequestModel: required: - name type: object properties: name: description: The name associated with this payer. minLength: 1 type: string PersonName: type: object properties: lastName: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true ProblemDetails: type: object properties: title: type: string nullable: true type: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} ProfileMergeRecordAddressModel: type: object properties: state: 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 type: string nullable: true zipCode: type: string nullable: true city: type: string nullable: true addressLine1: type: string nullable: true addressLine2: type: string nullable: true type: enum: - Unspecified - Home - Work type: string ProfileMergeRecordBasicInfoDataModel: required: - firstName - lastName type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true emails: type: array items: $ref: '#/components/schemas/EmailModel' nullable: true npi: type: integer format: int64 nullable: true firstName: minLength: 1 type: string lastName: minLength: 1 type: string aliases: type: array items: $ref: '#/components/schemas/AliasModel' nullable: true dateOfBirth: type: string format: date nullable: true phone: type: string nullable: true providerTypeId: type: string format: uuid nullable: true caqhId: type: string nullable: true ssn: $ref: '#/components/schemas/SensitiveString' addresses: type: array items: $ref: '#/components/schemas/ProfileMergeRecordAddressModel' nullable: true languages: type: array items: type: string nullable: true ProfileMergeRecordBoardCertificationDataModel: type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true boardCertificationType: enum: - AmericanBoardofMedicalSpecialties - NationalBoardforCertifiedCounselors - AmericanBoardofClinicalSocialWork - AmericanSpeechLanguageHearingAssociation - AmericanNursesCredentialingCenter - AmericanAcademyofNursePractitioners - AmericanOsteopathicAssociation - AmericanMedicalAssociation - NationalBoardofCertificationandRecertificationforNurseAnesthetists - AmericanAssociationofCriticalCareNurses - AmericanMidwiferyCertificationBoard - AmericanBoardofPodiatricMedicine - AmericanBoardofOralImplantology - AmericanBoardofOralMedicine - AmericanBoardofOrofacialPain - AmericanDentalBoardofAnesthesiology - AmericanBoardofDentalPublicHealth - AmericanBoardofPediatricDentistry - AmericanBoardofPeriodontology - AmericanBoardofInternalMedicine - NationalCommissiononCertificationofPhysicianAssistants - AmericanBoardofAllergyandImmunology - AmericanBoardofAnesthesiology - AmericanBoardofColonandRectalSurgery - AmericanBoardofDermatology - AmericanBoardofEmergencyMedicine - AmericanBoardofFamilyMedicine - AmericanBoardofGeneticsandGenomics - AmericanBoardofNeurologicalSurgery - AmericanBoardofNuclearMedicine - AmericanBoardofObstetricsandGynecology - AmericanBoardofOphthalmology - AmericanBoardofOrthopaedicSurgery - AmericanBoardofOtolaryngologyHeadandNeckSurgery - AmericanBoardofPathology - AmericanBoardofPediatrics - AmericanBoardofPhysicalMedicineandRehabilitation - AmericanBoardofPlasticSurgery - AmericanBoardofPreventiveMedicine - AmericanBoardofProfessionalPsychology - AmericanBoardofPsychiatryandNeurology - AmericanBoardofRadiology - AmericanBoardofSurgery - AmericanBoardofThoracicSurgery - AmericanBoardofUrology - AmericanOptometricAssociation - AssociationofSocialWorkBoards - AmericanBoardofFootandAnkleSurgery - AmericanBoardofOralandMaxillofacialPathology - AmericanBoardofOralandMaxillofacialSurgery - AmericanBoardofOrthodontics - AmericanBoardofEndodontics - AmericanBoardofProsthodontics - NationalBoardforCertificationinOccupationalTherapy - BehaviorAnalystCertificationBoard - InternationalBoardofLactationConsultantExaminers - CommissionOnDieteticRegistration - NationalCertificationCommissionforAcupunctureandOrientalMedicine - PediatricNursingCertification - NationalCertificationCorporation - OncologyNursingCertificationCorporation - AmericanBoardOfCardiovascularMedicine - AmericanAcademyOfHIVMedicine - NationalBoardOfPhysiciansAndSurgeons - BoardOfPharmacySpecialties - AmericanBoardofOralandMaxillofacialRadiology - AmericanBoardofGeneralDentistry - NationalAssociationofSchoolPsychologists - NationalPhlebotomyAssociation - NationalCenterForCompetencyTesting - AmericanRegistryofRadiologyTechnologists - DentalAssistingNationalBoard - AmericanMedicalCertificationAssociation - AmericanBoardofAddictionMedicine - AmericanRegistryForDiagnosticMedicalSonography - AmericanBoardofMultipleSpecialtiesinPodiatry - AmericanBoardOfObesityMedicine - NationalCommissionForCertificationOfAnesthesiologistAssistants - CardiovascularCredentialingInternational - NationalBoardOfEchocardiography - AmericanAlliedHealth - AmericanMedicalTechnologists - NationalAssociationForHealthProfessionals - NationalHealthCareerAssociation - NationalPhlebotomyCertificationExamination - NationalAssociationOfPhlebotomyTechnicians - NationalHealthcareCertificationOrganization - NationalPerformanceSpecialists - NationalRegistryOfAlliedHealthProfessionals - BoardofCertificationforEmergencyNursing type: string nullable: true boardCertificationNumber: type: string nullable: true isPrimary: type: boolean nullable: true initialCertificationDate: type: string format: date nullable: true recertificationDate: type: string format: date nullable: true expirationDate: type: string format: date nullable: true ProfileMergeRecordData: oneOf: - $ref: '#/components/schemas/ProfileMergeRecordBasicInfoDataModel' - $ref: '#/components/schemas/ProfileMergeRecordBoardCertificationDataModel' - $ref: '#/components/schemas/ProfileMergeRecordDeaRegistrationDataModel' - $ref: '#/components/schemas/ProfileMergeRecordEducationDataModel' - $ref: '#/components/schemas/ProfileMergeRecordLiabilityInsuranceDataModel' - $ref: '#/components/schemas/ProfileMergeRecordLicenseDataModel' - $ref: '#/components/schemas/ProfileMergeRecordTrainingDataModel' - $ref: '#/components/schemas/ProfileMergeRecordWorkHistoryDataModel' discriminator: propertyName: type mapping: BasicInfo: '#/components/schemas/ProfileMergeRecordBasicInfoDataModel' BoardCertification: '#/components/schemas/ProfileMergeRecordBoardCertificationDataModel' DeaRegistration: '#/components/schemas/ProfileMergeRecordDeaRegistrationDataModel' Education: '#/components/schemas/ProfileMergeRecordEducationDataModel' LiabilityInsurance: '#/components/schemas/ProfileMergeRecordLiabilityInsuranceDataModel' License: '#/components/schemas/ProfileMergeRecordLicenseDataModel' Training: '#/components/schemas/ProfileMergeRecordTrainingDataModel' WorkHistory: '#/components/schemas/ProfileMergeRecordWorkHistoryDataModel' ProfileMergeRecordDeaRegistrationDataModel: required: - registrationNumber type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true registrationNumber: minLength: 1 type: string ProfileMergeRecordEducationDataModel: required: - completed - graduateType type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true graduateType: enum: - Undergraduate - Professional - FifthPathway type: string degree: type: string nullable: true completed: type: boolean startDate: type: string format: date nullable: true endDate: type: string format: date nullable: true schoolName: type: string nullable: true schoolCode: type: string nullable: true ecfmgNumber: type: string nullable: true ecfmgIssueDate: type: string format: date nullable: true ProfileMergeRecordLiabilityInsuranceDataModel: required: - coverageType type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true name: type: string nullable: true coverageType: enum: - Individual - Shared - Occurrence - ClaimsMade type: string policyNumber: type: string nullable: true isSelfInsured: type: boolean originalEffectiveDate: type: string format: date nullable: true currentEffectiveDate: type: string format: date nullable: true currentExpirationDate: type: string format: date nullable: true isUnlimitedCoverage: type: boolean includesTailCoverage: type: boolean occurenceCoverageAmount: type: number format: double nullable: true aggregateCoverageAmount: type: number format: double nullable: true ProfileMergeRecordLicenseDataModel: required: - licenseNumber - licenseTypeId - state type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true state: 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 type: string licenseTypeId: type: string format: uuid licenseNumber: minLength: 1 type: string isPrimary: type: boolean nullable: true status: type: string nullable: true issueDate: type: string format: date nullable: true expirationDate: type: string format: date nullable: true isCurrentlyPracticing: type: boolean nullable: true ProfileMergeRecordTrainingDataModel: type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true trainingType: enum: - Internship - Residency - Fellowship type: string institutionName: type: string nullable: true schoolName: type: string nullable: true schoolCode: type: string nullable: true completed: type: boolean nullable: true startDate: type: string format: date nullable: true endDate: type: string format: date nullable: true ProfileMergeRecordWorkHistoryDataModel: type: object properties: type: enum: - BasicInfo - License - DeaRegistration - Education - Training - LiabilityInsurance - WorkHistory - BoardCertification type: string readOnly: true workHistoryType: enum: - Employment - Gap type: string name: type: string nullable: true jobTitle: type: string nullable: true address: $ref: '#/components/schemas/ProfileMergeRecordAddressModel' phone: type: string nullable: true startDate: type: string format: date nullable: true endDate: type: string format: date nullable: true isCurrentEmployer: type: boolean nullable: true departureReason: type: string nullable: true gapExplanation: type: string nullable: true ProviderAddressModel: required: - addressLine1 - city - state - zipCode type: object properties: state: description: Abbreviation of the state in which the city is located. 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 type: string zipCode: description: The postal code associated with the address. minLength: 1 type: string city: description: The city in which the address is located. minLength: 1 type: string addressLine1: description: The street address. minLength: 1 type: string addressLine2: description: The secondary address information. type: string type: description: The type of address. enum: - Unspecified - Home - Work type: string id: description: Unique identifier for this address. type: string format: uuid ProviderAddressParameter: type: object properties: addressType: enum: - Unspecified - Home - Work type: string addressLine: type: string nullable: true addressLine2: type: string nullable: true city: type: string nullable: true state: 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 type: string zipCode: type: string nullable: true type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderAddressRequestModel: required: - addressLine1 - city - state - type - zipCode type: object properties: state: 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 type: string zipCode: minLength: 1 type: string city: minLength: 1 type: string addressLine1: minLength: 1 type: string addressLine2: type: string nullable: true type: enum: - Unspecified - Home - Work type: string ProviderAggregationsModel: type: object properties: total: description: The total number of providers. type: integer format: int32 aggregations: description: >- For each state that a provider can have, a count of providers in that state. example: total: 100 aggregations: NeedsReview: 2 ExpiresSoon: 10 Expired: 0 Monitored: 100 NotMonitored: 0 ProviderAliasModel: type: object properties: firstName: description: The first (given) name of this alias. type: string lastName: description: The last (family) name of this alias. type: string id: description: Unique identifier for this alias. type: string format: uuid ProviderAliasRequestModel: required: - firstName - lastName type: object properties: firstName: description: The first (given) name of this alias. minLength: 1 type: string lastName: description: The last (family) name of this alias. minLength: 1 type: string ProviderBaseModel: required: - credentialingStatus - firstName - lastName type: object properties: id: type: string format: uuid firstName: minLength: 1 type: string lastName: minLength: 1 type: string dateOfBirth: type: string format: date-time nullable: true ssn: $ref: '#/components/schemas/SensitiveString' credentialingStatus: minLength: 1 type: string credentialedDate: type: string format: date-time nullable: true npi: type: integer format: int64 nullable: true deactivated: type: boolean ProviderBoardCertificationNumberParameter: type: object properties: boardCertificationNumber: type: string nullable: true type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderCaqhId: type: object properties: caqhProviderId: type: integer format: int64 type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderCaqhLoginInfoParameter: type: object properties: username: type: string nullable: true password: $ref: '#/components/schemas/SensitiveString' type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderCertificateParameter: type: object properties: certificateType: enum: - AhaBasicLifeSupport - AhaAdvancedCardiacLifeSupport - AhaNeonatalAdvancedLifeSupport - AhaPediatricAdvancedLifeSupport type: string nullable: true certificateNumber: type: string nullable: true type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderConfigurableReportModel: type: object properties: id: description: The unique identifier of the report entity. type: string format: uuid providerId: description: The unique identifier of the provider associated with the report. type: string format: uuid type: description: Format of the report file. For now only PDF is supported. enum: - Pdf type: string startedAt: description: Timestamp when the report was started. type: string format: date-time completedAt: description: Timestamp when the report was completed. type: string format: date-time status: description: Status of the report job. enum: - Pending - Working - Completed - Failed type: string failureReason: $ref: '#/components/schemas/FailureModel' path: description: The path where report will be stored. type: string data: $ref: '#/components/schemas/ReportData' credentialingRequestId: description: >- The id of credentialing request which check list will be used for report generation. Latest verification data will be used by default if null. type: string format: uuid ProviderDateOfBirthParameter: type: object properties: dateOfBirth: type: string format: date-time type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderDeaParameter: type: object properties: registrationNumber: type: string nullable: true type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderEducationParameter: type: object properties: graduationYear: type: integer format: int32 nullable: true schoolName: type: string nullable: true schoolCode: type: string nullable: true branchCode: type: string nullable: true degree: type: string nullable: true type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderEmailModel: type: object properties: email: description: The email associated with the provider. type: string type: description: The type of the email. enum: - Unspecified - Personal - Work type: string id: description: Unique identifier for this specific email. type: string format: uuid ProviderEmailRequestModel: required: - email - type type: object properties: email: description: The email associated with the provider. minLength: 1 type: string type: description: The type of the email. enum: - Unspecified - Personal - Work type: string ProviderEnrollmentModel: type: object properties: id: description: Unique identifier associated with this provider enrollment. type: string format: uuid payerPlanId: description: Payer Plan Id associated with this provider enrollment. type: string format: uuid groupId: description: Group Id associated with this provider enrollment. type: string format: uuid providerId: description: Provider Id associated with this provider enrollment. type: string format: uuid enrollmentStatus: description: Status of the enrollment. enum: - NotSubmitted - Submitted - Enrolled - Denied type: string submissionDate: description: Submission Date associated with this provider enrollment. type: string format: date-time closedDate: description: Closed Date associated with this provider enrollment. type: string format: date-time effectiveDate: description: Effective Date associated with this provider enrollment. type: string format: date-time networkStatus: description: Network Status associated with this provider enrollment. enum: - None - Par - NonPar type: string specialistType: description: Specialist Type associated with this provider enrollment. enum: - None - Pcp - Specialist type: string externalProviderPlanId: description: '`ProviderId` in external system.' type: string comments: type: string payerPlanModel: $ref: '#/components/schemas/PayerPlanModel' groupModel: $ref: '#/components/schemas/GroupModel' ProviderEnrollmentPageModel: type: object properties: sort: type: object additionalProperties: type: object properties: Keys: enum: - Id - NetworkStatus - EnrollmentStatus - SpecialistType - SubmissionDate - EffectiveDate - PayerPlanName type: string Values: enum: - Asc - Desc type: string nullable: true previousCursor: type: string nullable: true nextCursor: type: string nullable: true nextOffset: type: integer format: int32 nullable: true pageSize: type: integer format: int32 count: type: integer format: int32 totalCount: type: integer format: int32 nullable: true items: type: array items: $ref: '#/components/schemas/ProviderEnrollmentModel' nullable: true sortedBy: enum: - Id - NetworkStatus - EnrollmentStatus - SpecialistType - SubmissionDate - EffectiveDate - PayerPlanName type: string nullable: true sortDirection: enum: - Asc - Desc type: string nullable: true ProviderEnrollmentPatchModel: type: object properties: payerPlanId: description: >- If set, the provider enrollment's `PayerPlanId` will be updated with this value. type: string format: uuid groupId: description: >- If set, the provider enrollment's `GroupId` will be updated with this value. type: string format: uuid providerId: description: >- If set, the provider enrollment's `ProviderId` will be updated with this value. type: string format: uuid enrollmentStatus: description: >- If set, the provider enrollment's `EnrollmentStatus` will be updated with this value. enum: - NotSubmitted - Submitted - Enrolled - Denied type: string submissionDate: description: >- If set, the provider enrollment's `SubmissionDate` will be updated with this value. type: string format: date-time closedDate: description: >- If set, the provider enrollment's `ClosedDate` will be updated with this value. type: string format: date-time effectiveDate: description: >- If set, the provider enrollment's `EffectiveDate` will be updated with this value. type: string format: date-time networkStatus: description: >- If set, the provider enrollment's `NetworkStatus` will be updated with this value. enum: - None - Par - NonPar type: string specialistType: description: >- If set, the provider enrollment's `SpecialistType` will be updated with this value. enum: - None - Pcp - Specialist type: string externalProviderPlanId: description: >- If set, the provider enrollment's `ProviderId` in external system will be updated with this value. type: string comments: description: >- If set, the provider enrollment's `Comments` will be updated with this value. type: string example: PayerPlanId: 1704B2EA-098D-4A70-969F-70A5F6B336DE EnrollmentStatus: NotSubmitted SubmissionDate: 2000-12-31 23:59 ProviderEnrollmentRequestModel: required: - groupId - payerPlanId - providerId type: object properties: effectiveDate: description: Effective Date associated with this provider enrollment. type: string format: date-time enrollmentStatus: description: Status of the enrollment. enum: - NotSubmitted - Submitted - Enrolled - Denied type: string groupId: description: Group Id associated with this provider enrollment. type: string format: uuid providerId: description: Provider Id associated with this provider enrollment. type: string format: uuid networkStatus: description: Network Status associated with this provider enrollment. enum: - None - Par - NonPar type: string payerPlanId: description: Payer Plan Id associated with this provider enrollment. type: string format: uuid specialistType: description: Specialist Type associated with this provider enrollment. enum: - None - Pcp - Specialist type: string submissionDate: description: Submission Date associated with this provider enrollment. type: string format: date-time closedDate: description: Closed Date associated with this provider enrollment. type: string format: date-time externalProviderPlanId: description: '`ProviderId` in external system.' type: string comments: description: Comments associated with this provider enrollment. type: string example: groupId: 30e82ca1-59e2-4c68-a83b-58ff84e665d2 providerId: ab9aede4-5b9c-428f-8ee1-752892801a02 payerPlanId: 1704b2ea-098d-4a70-969f-70a5f6b336de enrollmentStatus: NotSubmitted submissionDate: 2000-12-31 23:59 ProviderLicenseAggregationsModel: type: object properties: total: description: The total number of provider licenses. type: integer format: int32 aggregations: description: >- For each state that a provider license can have, a count of provider licenses in that state. type: object additionalProperties: type: integer format: int32 example: total: 100 aggregations: Active: 2 Expired: 10 ExpiresSoon: 5 DisciplinaryActions: 15 Found: 80 NotFound: 20 UnableToVerify: 40 NeedsReview: 30 ProviderLicenseModel: type: object properties: provider: $ref: '#/components/schemas/ProviderBaseModel' license: $ref: '#/components/schemas/SimpleLicenseBaseModel' ProviderLicensePageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - ProviderFirstName - ProviderLastName - LicenseState - LicenseExpirationDate type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The providers licenses in the current page. type: array items: $ref: '#/components/schemas/ProviderLicenseModel' sortedBy: description: The property by which the data is sorted. enum: - ProviderFirstName - ProviderLastName - LicenseState - LicenseExpirationDate type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - provider: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X firstName: string lastName: string dateOfBirth: '2019-08-24T14:15:22.0000000Z' ssn: '***' credentialingStatus: string credentialedDate: '2019-08-24T14:15:22.0000000Z' npi: 0 license: providerId: 4834bcdc-4a64-444d-966b-1a6fe381da24 number: string state: AL isPrimary: true id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X isCurrentlyPracticing: true status: string expiryDate: '2019-08-24T14:15:22.0000000Z' verificationStatus: Verified licenseTypeId: acac9426-ab93-4f79-a277-f4ccd1b60206 licenseTypeName: string approvedStatus: Pending sortedBy: ProviderFirstName sortDirection: Asc sort: ProviderFirstName: Asc ProviderLastName: Desc ProviderLicenseParameter: type: object properties: licenseTypeId: type: string format: uuid state: 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 type: string number: type: string nullable: true isPrimary: type: boolean type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderModel: required: - credentialingStatus - firstName - lastName type: object properties: id: description: Unique identifier associated with this provider. type: string format: uuid firstName: description: The first (given) name associated with this provider. minLength: 1 type: string lastName: description: The last (family) name associated with this provider. minLength: 1 type: string dateOfBirth: description: The date of birth of this provider. type: string format: date-time ssn: $ref: '#/components/schemas/SensitiveString' credentialingStatus: description: >- The name of credentialing status. The default value is 'Data Collection'. minLength: 1 type: string credentialedDate: description: Date this provider was originally credentialed type: string format: date-time npi: type: integer format: int64 deactivated: description: >- If set, the provider is deactivated. Verifications and profile imports can't be triggered for the inactive provider. type: boolean aliases: description: A list of aliases that this provider is also known by. type: array items: $ref: '#/components/schemas/ProviderAliasModel' addresses: description: >- If set, the provider's `addresses` will be updated with this value. To remove the addresses pass an empty array. type: array items: $ref: '#/components/schemas/ProviderAddressModel' emails: description: >- If set, the provider's `emails` will be updated with this value. To remove the emails pass an empty array. type: array items: $ref: '#/components/schemas/ProviderEmailModel' phone: description: Primary phone number associated with this provider type: string languages: description: A list of languages, other than English, this provider speaks. type: array items: type: string recredentialedDates: description: A list of dates when this provider was re-credentialed. type: array items: type: string format: date-time providerType: $ref: '#/components/schemas/ProviderTypeModel' createdAt: description: Timestamp when this provider was created. type: string format: date-time ProviderNameParameter: type: object properties: firstName: type: string nullable: true lastName: type: string nullable: true type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderNotesModel: type: object properties: providerId: description: Identifier of the provider related to this note. type: string format: uuid timestamp: description: The date and time when this note was created or last changed. type: string format: date-time note: description: The contents of the note. type: string id: description: Unique identifier for this note. type: string format: uuid alert: $ref: '#/components/schemas/AlertModel' ProviderNotesRequestModel: required: - note type: object properties: note: description: The contents of the note. minLength: 1 type: string ProviderNpiParameter: type: object properties: number: type: integer format: int64 type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Id - LastName - FirstName - CredentialingStatus - CredentialedDate type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The providers in the current page. type: array items: $ref: '#/components/schemas/ProviderModel' sortedBy: description: The property by which the data is sorted. enum: - Id - LastName - FirstName - CredentialingStatus - CredentialedDate type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X firstName: string lastName: string dateOfBirth: '2019-08-24T14:15:22.0000000Z' ssn: '***' credentialingStatus: string credentialedDate: '2019-08-24T14:15:22.0000000Z' npi: 0 aliases: - id: 9b4c12e8-02c5-4107-a524-c02416d43079 firstName: string lastName: string addresses: - id: e57c9ee4-807d-456a-bf32-623280064ca5 state: AL zipCode: string city: string addressLine1: string addressLine2: string type: Unspecified emails: - id: 1d46ecfe-5ce4-4b9c-aaba-3543e15d36d1 email: string type: Unspecified phone: string languages: - string recredentialedDates: - '2019-08-24T14:15:22.0000000Z' providerType: id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X name: string sortedBy: Id sortDirection: Asc sort: Id: Asc FirstName: Asc LastName: Asc CredentialingStatus: Desc ProviderPatchModel: type: object properties: firstName: description: If set, the provider's `firstName` will be updated with this value. type: string lastName: description: If set, the provider's `lastName` will be updated with this value. type: string dateOfBirth: description: >- If set, the provider's `dateOfBirth` will be updated with this value. type: string format: date-time ssn: $ref: '#/components/schemas/SensitiveString' npi: type: integer format: int64 aliases: description: >- If set, the provider's `aliases` will be updated with this value. To remove the aliases pass an empty array. type: array items: $ref: '#/components/schemas/ProviderAliasRequestModel' credentialingStatus: description: >- If set, the provider's `credentialingStatus` will be updated with this value. type: string emails: description: >- If set, the provider's `emails` will be updated with this value. To remove the emails pass an empty array. type: array items: $ref: '#/components/schemas/ProviderEmailRequestModel' addresses: description: >- If set, the provider's `addresses` will be updated with this value. To remove the addresses pass an empty array. type: array items: $ref: '#/components/schemas/ProviderAddressRequestModel' phone: description: Primary phone number associated with this provider type: string languages: description: A list of languages, other than English, this provider speaks. type: array items: type: string credentialedDate: description: Date this provider was originally credentialed type: string format: date-time recredentialedDates: description: A list of dates when this provider was re-credentialed. type: array items: type: string format: date-time providerTypeId: description: Provider type id associated with this provider. type: string format: uuid deactivated: description: >- If set to true, the provider will be deactivated. If set to false, the provider will be activated. type: boolean ProviderProfileImportModel: type: object properties: parameters: type: array items: $ref: '#/components/schemas/IProviderParameter' id: description: Unique identifier associated with this provider profile import. type: string format: uuid providerId: description: The provider unique identifier associated with this profile import. type: string format: uuid source: description: Source of the import. enum: - Npi - Caqh type: string started: description: TimeStamp of this import when started type: string format: date-time completed: description: >- TimeStamp of this import when completed or `null` if is still in progress. type: string format: date-time status: description: >- 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 type: string trigger: description: Type of trigger for this import. enum: - Manual type: string failureCode: description: >- 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 type: string failureReason: $ref: '#/components/schemas/FailureModel' profile: $ref: '#/components/schemas/ProviderProfileModel' ProviderProfileImportPageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Id - Source - Status - Completed - Started type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The provider profile imports in the current page. type: array items: $ref: '#/components/schemas/ProviderProfileImportModel' sortedBy: description: The property by which the data is sorted. enum: - Id - Source - Status - Completed - Started type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - parameters: - addressType: Unspecified addressLine: string city: string state: AL zipCode: string type: Name id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X providerId: 4834bcdc-4a64-444d-966b-1a6fe381da24 source: Npi started: '2019-08-24T14:15:22.0000000Z' completed: '2019-08-24T14:15:22.0000000Z' status: Pending trigger: Manual failureCode: DatabaseError failureReason: messageTemplate: string messageParams: property1: string property2: string profile: type: Npi npiNumber: 0 enumerationType: string basic: replacementNpi: 0 ein: string organizationName: string lastName: string firstName: string middleName: string namePrefix: string nameSuffix: string credential: string enumerationDate: '2019-08-24T14:15:22.0000000Z' lastUpdateDate: '2019-08-24T14:15:22.0000000Z' certificationDate: '2019-08-24T14:15:22.0000000Z' isSoleProprietor: true isOrganizationalSubpart: true parentOrganizationLbn: string parentOrganizationTin: string authorizedOfficialNamePrefix: string authorizedOfficialNameSuffix: string authorizedOfficialCredential: string authorizedOfficialFirstName: string authorizedOfficialLastName: string authorizedOfficialMiddleName: string authorizedOfficialTelephoneNumber: string authorizedOfficialTitleOrPosition: string deactivationDate: '2019-08-24T14:15:22.0000000Z' reactivationDate: '2019-08-24T14:15:22.0000000Z' gender: string status: string name: string otherNames: - nameTypeCode: string lastName: string firstName: string middleName: string prefix: string suffix: string credential: string type: string organizationName: string addresses: - addressLine1: string addressLine2: string state: AL postalCode: string countryCode: string city: string telephoneNumber: string faxNumber: string purpose: Location updateDate: '2019-08-24T14:15:22.0000000Z' practiceLocations: - addressLine1: string addressLine2: string state: AL postalCode: string countryCode: string city: string telephoneNumber: string faxNumber: string purpose: Location updateDate: '2019-08-24T14:15:22.0000000Z' taxonomies: - description: string code: string license: string state: AL isPrimary: true taxonomyGroup: string identifiers: - description: string number: string code: string state: AL issuer: string isDeactivated: true deactivationReason: string sortedBy: Id sortDirection: Asc sort: Id: Asc Source: Desc Status: Asc Completed: Desc ProviderProfileImportRequestModel: required: - providerId - source type: object properties: providerId: description: The provider unique identifier associated with this profile import. type: string format: uuid source: description: Source of the import. enum: - Npi - Caqh type: string ProviderProfileImportSourceModel: type: object properties: source: description: The source for provider profile import. enum: - Npi - Caqh type: string readOnly: true name: description: The name of provider profile import source. type: string readOnly: true requiredParameterTypes: description: Required parameters to run the profile import. uniqueItems: true type: array items: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderProfileImportSourcePageModel: type: object properties: previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The provider profile import sources in the current page. type: array items: $ref: '#/components/schemas/ProviderProfileImportSourceModel' sortedBy: description: The property by which the data is sorted. enum: - Name - Source type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Name - Source type: string Values: enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - source: Npi name: string requiredParameterTypes: - Name sortedBy: Name sortDirection: Asc sort: Name: Asc Source: Desc ProviderProfileModel: oneOf: - $ref: '#/components/schemas/NpiProfile.NpiProviderProfileModel' - $ref: '#/components/schemas/CaqhProfile.CaqhProviderProfileModel' discriminator: propertyName: type mapping: Npi: '#/components/schemas/NpiProfile.NpiProviderProfileModel' Caqh: '#/components/schemas/CaqhProfile.CaqhProviderProfileModel' ProviderReportRequestModel: type: object properties: sections: description: Report sections to generate. type: array items: enum: - BasicInfo - NpiNumber - DeaRegistrations - Licenses - BoardCertifications - LiabilityInsurance - EducationAndTraining - WorkHistory - SanctionsAndExclusions - CaqhProfile type: string datasetTypes: description: Source types for `SanctionsAndExclusions` section. type: array items: enum: - Sam - MedicareOptOut - OigFugitives - OfacSdn - OfacConsolidated - OigExclusions - StateSanctionsAndExclusions - Npdb - Dmf - CmsPreclusion type: string deaRecordNumbers: description: >- DEA record numbers associated with the provider to include in the report. type: array items: type: string licenseIds: description: >- Unique license identifiers associated with the provider to include in the report. type: array items: type: string format: uuid boardCertificateIds: description: >- Unique board certificate identifiers associated with the provider to include in the report. type: array items: type: string format: uuid example: sections: - BasicInfo - SanctionsAndExclusions datasetTypes: - Sam - MedicareOptOut - OigFugitives deaRecordNumbers: - FM12345678 - BA7654321 boardCertificateIds: - 006f84a8-939b-45ed-906b-a6eeb883a112 - 68b7fbd5-3397-441c-b9f5-ce7d89148a7b licenseIds: - bb6a2d28-b215-4f1c-ba2c-2d4ddb352787 ProviderRequestModel: type: object properties: firstName: description: The first (given) name of the provider. type: string lastName: description: The last (family) name of the provider. type: string dateOfBirth: description: The date of birth of this provider. type: string format: date-time ssn: $ref: '#/components/schemas/SensitiveString' npi: type: integer format: int64 aliases: description: A list of aliases that this provider is also known by. type: array items: $ref: '#/components/schemas/ProviderAliasRequestModel' credentialingStatus: description: >- The name of credentialing status. The default value is 'Data Collection'. type: string emails: description: A list with provider emails. type: array items: $ref: '#/components/schemas/ProviderEmailRequestModel' addresses: description: A list with provider addresses. type: array items: $ref: '#/components/schemas/ProviderAddressRequestModel' phone: description: Primary phone number associated with this provider type: string languages: description: A list of languages, other than English, this provider speaks. type: array items: type: string credentialedDate: description: Date this provider was originally credentialed type: string format: date-time recredentialedDates: description: A list of dates when this provider was re-credentialed. type: array items: type: string format: date-time providerTypeId: description: Provider type id associated with this provider. type: string format: uuid deactivated: description: >- If set to true, the provider will be deactivated. If set to false, the provider will be activated. type: boolean example: firstName: string lastName: string dateOfBirth: '2000-08-24' ssn: '123456789' ProviderSsnParameter: type: object properties: ssn: $ref: '#/components/schemas/SensitiveString' type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ProviderTypeModel: type: object properties: id: description: Unique identifier associated with this provider type. type: string format: uuid name: description: Associated provider type name. type: string ProviderTypeParameter: type: object properties: name: type: string nullable: true typeId: type: string format: uuid type: enum: - Name - Npi - DateOfBirth - Ssn - License - Address - Education - CaqhLoginInfo - BoardCertificationNumber - Dea - Certificate - CaqhId - ProviderType type: string readOnly: true ReportData: type: object properties: state: description: Context state for the report. RequestPasswordResetRequestModel: required: - email type: object properties: email: minLength: 1 type: string format: email SalesforceDocumentRequestRequestModel: required: - document - relatedIds type: object properties: document: description: >- Path to the document (stored in this organization) to be uploaded to Salesforce. minLength: 1 type: string pathOnClient: type: string relatedIds: description: >- Array of Salesforce identifiers to which the uploaded content document will be linked. type: array items: type: string salesforceOrganizationId: type: string SamDatasetRecord: type: object properties: classification: enum: - Unknown - Firm - Individual - SpecialEntityDesignation - Vessel type: string openDataFlag: type: boolean duns: type: string nullable: true uei: type: string nullable: true exclusionProgram: enum: - Unknown - Reciprocal - Nonreciprocal - Procurement - NonProcurement type: string excludingAgency: type: string nullable: true ctCode: type: string nullable: true exclusionType: type: string nullable: true additionalComments: type: string nullable: true activeDate: type: string format: date-time nullable: true terminationDate: type: string format: date-time nullable: true recordStatus: enum: - Active - Inactive type: string crossReference: type: string nullable: true samNumber: type: string nullable: true cage: type: string nullable: true creationDate: type: string format: date-time nullable: true id: type: string format: uuid hash: type: string format: uuid address: type: string nullable: true fullName: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true npiNumber: type: integer format: int64 nullable: true SanctionsAndExclusionsReportInfoModel: type: object properties: date: description: The time when the report was created. type: string format: date-time path: description: Path to the report. type: string SchoolCodeModel: type: object properties: code: description: Education Federal School Code associated with the school. type: string branchCode: description: 2 digit number that identified the specific area of the school. type: string name: description: Name of the school. type: string state: description: State associated with the school. 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 type: string city: description: City associated with the school. type: string SchoolCodePageModel: type: object properties: sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Name - Code type: string Values: enum: - Asc - Desc type: string previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The schools in the current page. type: array items: $ref: '#/components/schemas/SchoolCodeModel' sortedBy: description: The property by which the data is sorted. enum: - Name - Code type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string SensitiveString: description: >- If `includeSensitiveInfo` query parameter set to true the value will be shown in the response, otherwise it will be masked with *. type: object example: '***' SimpleLicenseBaseModel: type: object properties: providerId: type: string format: uuid number: type: string nullable: true state: 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 type: string isPrimary: type: boolean id: type: string format: uuid isCurrentlyPracticing: type: boolean status: type: string nullable: true issueDate: type: string format: date-time nullable: true expiryDate: type: string format: date-time nullable: true verificationStatus: enum: - Verified - Unverified type: string nullable: true licenseTypeId: type: string format: uuid licenseTypeName: type: string nullable: true approvedStatus: enum: - Pending - 'Yes' - 'No' type: string restrictionStatus: enum: - None - Restricted - Unrestricted type: string nonVerifiedInfoIssueDate: type: string format: date-time nullable: true nonVerifiedInfoExpirationDate: type: string format: date-time nullable: true nonVerifiedInfoStatus: type: string nullable: true SimplifiedLicenseTypeModel: type: object properties: id: description: Unique identifier associated with this license type. type: string format: uuid taxonomy: description: Unique taxonomy code associated with this license type. type: string name: description: Descriptive name for this license type. type: string aliases: description: Aliases used by different sources. type: array items: type: string abbreviations: description: License type name abbreviations. type: array items: type: string states: description: List of states for which license verification is supported. type: array items: 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 type: string deprecated: true verificationParameters: description: Description of parameters required to run verifications. type: object additionalProperties: $ref: '#/components/schemas/LicenseVerificationParameters' deprecated: true sources: description: >- A list of parameters and other verification-related information per state. type: array items: $ref: '#/components/schemas/SimplifiedLicenseTypeSourceModel' SimplifiedLicenseTypePageModel: type: object properties: previousCursor: description: >- The value to use for `cursor` to get to the previous paginated page. `null` will be returned if it's the first page. type: string nextCursor: description: >- The value to use for `cursor` to get to the next paginated page. `null` will be returned if it's the last page. type: string nextOffset: description: >- The value to use for `offset` to get the next page following the current page or `null` if this page is the last. type: integer format: int32 deprecated: true pageSize: description: The maximum number of items included in this page. type: integer format: int32 count: description: The number of items in this page. type: integer format: int32 totalCount: description: The total number of items in all pages combined. type: integer format: int32 items: description: The providers in the current page. type: array items: $ref: '#/components/schemas/SimplifiedLicenseTypeModel' sortedBy: description: The property by which the data is sorted. enum: - Taxonomy - Name type: string sortDirection: description: The direction in which the data is sorted. enum: - Asc - Desc type: string sort: description: The properties and directions the data is sorted by. type: object additionalProperties: type: object properties: Keys: enum: - Taxonomy - Name type: string Values: enum: - Asc - Desc type: string example: previousCursor: string nextCursor: string nextOffset: 0 pageSize: 0 count: 0 totalCount: 0 items: - id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X taxonomy: string name: string aliases: - string abbreviations: - string states: - AL verificationParameters: AL: requiredParameters: - LicenseNumber optionalParameters: [] sources: - state: AL requiredParameters: - LicenseNumber optionalParameters: [] hasPassThroughFee: true sortedBy: Taxonomy sortDirection: Asc sort: Taxonomy: Asc Name: Desc SimplifiedLicenseTypeSourceModel: type: object properties: state: description: >- The state the verification information relates to for the given license type. 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 type: string requiredParameters: description: >- List of parameters required to run a license verification. Missing data for a required parameter will result in a failed verification. type: array items: enum: - LicenseNumber - Name type: string optionalParameters: description: >- List of optional parameters that may be used to improve the verification result quality by applying additional filters. type: array items: enum: - LicenseNumber - Name type: string hasPassThroughFee: description: >- Indicates whether the source for this state + license type combination charges a pass-through fee for a verification. type: boolean SimplifiedLicenseTypeStatusModel: type: object properties: licenseTypeId: type: string format: uuid state: 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 type: string status: $ref: '#/components/schemas/LicenseSourceStatusModel' maintenanceWindows: description: >- Array with the CRON descriptions that explain when this license type will be in maintenance window. When a license type is in a maintenance window the requests sent to it will be delayed until it is over. type: array items: $ref: '#/components/schemas/MaintenanceDowntimeCronDescription' SimplifiedLicenseTypeStatusPageModel: type: object properties: previousCursor: type: string nullable: true nextCursor: type: string nullable: true nextOffset: type: integer format: int32 nullable: true pageSize: type: integer format: int32 count: type: integer format: int32 totalCount: type: integer format: int32 nullable: true items: type: array items: $ref: '#/components/schemas/SimplifiedLicenseTypeStatusModel' nullable: true sortedBy: enum: - State type: string nullable: true sortDirection: enum: - Asc - Desc type: string nullable: true sort: type: object additionalProperties: type: object properties: Keys: enum: - State type: string Values: enum: - Asc - Desc type: string nullable: true StateSanctionsAndExclusionsExclusionDetails: type: object properties: startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true period: type: string nullable: true reason: type: string nullable: true authority: type: string nullable: true providerId: type: string nullable: true StateSanctionsAndExclusionsProviderAlias: type: object properties: fullName: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true StateSanctionsAndExclusionsRecord: type: object properties: source: $ref: '#/components/schemas/StateSanctionsAndExclusionsSource' providerType: type: string nullable: true aliases: type: array items: $ref: '#/components/schemas/StateSanctionsAndExclusionsProviderAlias' nullable: true exclusionDetails: $ref: '#/components/schemas/StateSanctionsAndExclusionsExclusionDetails' additionalInfo: type: object additionalProperties: type: string nullable: true nullable: true id: type: string format: uuid hash: type: string format: uuid address: type: string nullable: true dateOfBirth: type: string format: date-time nullable: true fullName: type: string nullable: true firstName: type: string nullable: true middleName: type: string nullable: true lastName: type: string nullable: true prefix: type: string nullable: true suffix: type: string nullable: true npiNumber: type: integer format: int64 nullable: true StateSanctionsAndExclusionsSource: type: object properties: state: 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 type: string name: type: string nullable: true TrainingModel: type: object properties: lastUpdatedAt: description: The date and time when the object was created or modified. type: string format: date-time id: description: Unique identifier associated with this training type: string format: uuid trainingType: description: The type of training pursued enum: - Internship - Residency - Fellowship type: string institutionName: description: Name of the institution where training occurred type: string schoolCode: description: >- School code as defined by the National Student Clearinghouse Participation List type: string schoolName: description: Affiliated Medical School Name type: string startDate: description: Timestamp when this provider started the training program type: string format: date-time endDate: description: Timestamp when this provider finished the training program type: string format: date-time completed: description: >- Identifies if this provider completed the training program at this institution type: boolean TrainingPatchModel: type: object properties: trainingType: description: The type of training pursued enum: - Internship - Residency - Fellowship type: string institutionName: description: Name of the institution where training occurred type: string schoolCode: description: >- School code as defined by the National Student Clearinghouse Participation List type: string schoolName: description: Affiliated Medical School Name type: string startDate: description: Timestamp when this provider started the training program type: string format: date-time endDate: description: Timestamp when this provider finished the training program type: string format: date-time completed: description: >- Identifies if this provider completed the training program at this institution type: boolean TrainingRequestModel: type: object properties: trainingType: description: The type of training pursued enum: - Internship - Residency - Fellowship type: string institutionName: description: Name of the institution where training occurred type: string schoolCode: description: >- School code as defined by the National Student Clearinghouse Participation List type: string schoolName: description: Affiliated Medical School Name type: string startDate: description: Timestamp when this provider started the training program type: string format: date-time endDate: description: Timestamp when this provider finished the training program type: string format: date-time completed: description: >- Identifies if this provider completed the training program at this institution type: boolean Transaction: type: object properties: orderId: type: string nullable: true transactionId: type: string nullable: true transactionStatus: type: string nullable: true transactionDescription: type: string nullable: true dateRequested: type: string format: date-time nullable: true dateNotified: type: string format: date-time nullable: true requestedBy: type: string nullable: true UserRoleModel: type: object properties: id: type: string format: uuid name: type: string nullable: true permissions: type: object additionalProperties: enum: - None - Read - Write - Allowed type: string nullable: true VerificationSourceModel: type: object properties: name: description: Name of the licensing organization. type: string url: description: The URL used to fetch the license data for this source. type: string hasPassThroughFee: description: >- Indicates whether the source charges a pass-through fee for a verification. type: boolean WebhookLogModel: type: object properties: type: description: The event type that should trigger this webhook. enum: - VerificationCompleted - ExportCompleted - LicenseExpiresSoon - LicenseExpired - LicenseChanged - NpiChanged - BoardCertificationVerificationCompleted - BoardCertificationExportCompleted - DatasetScanCompleted - LicenseStatusChanged - ProviderStatusChanged - ProviderProfileImportCompleted - CredentialingRequestChanged - GenerateReport - DatasetScanMatchesChanged - NpdbUpdateRequestRejected type: string url: description: >- The URL we will make an HTTP POST request to when an event of `type` occurs. type: string format: uri timestamp: description: The timestamp when this webhook was created. type: string format: date-time status: description: >- The status of this webhook. Could be one of the following: Triggered, Completed, or Failed enum: - Triggered - Completed - Failed type: string attempt: description: >- The current attempt to call this webhook could be in the range from one to ten. Where ten is the max and last attempt. type: integer format: int32 failureReason: description: >- If set, the failure reason explaining why we could not call this webhook. type: string payload: description: >- If set, the payload of this webhook. Which is a serialized object as JSON. type: string responseStatus: description: >- If set, the response HTTP status code of this webhook. e.g: 2xx, 4xx, 5xx type: integer format: int32 responseTime: description: If set, the response time it took to complete this webhook. type: integer format: int32 responsePayload: description: If set, the response HTTP payload of this webhook. As a string type: string responseHeaders: description: If set, the response HTTP headers associated with this webhook. id: description: Unique identifier associated with this webhook. type: string format: uuid traceId: description: >- Trace identifier associated with this webhook. This identifier is unique per webhook we trigger, but each attempt to call the webhook shares the same identifier. type: string format: uuid webhookId: type: string format: uuid WebhookModel: type: object properties: id: description: Unique identifier associated with this webhook. type: string format: uuid type: description: The event type that should trigger this webhook. enum: - VerificationCompleted - ExportCompleted - LicenseExpiresSoon - LicenseExpired - LicenseChanged - NpiChanged - BoardCertificationVerificationCompleted - BoardCertificationExportCompleted - DatasetScanCompleted - LicenseStatusChanged - ProviderStatusChanged - ProviderProfileImportCompleted - CredentialingRequestChanged - GenerateReport - DatasetScanMatchesChanged - NpdbUpdateRequestRejected type: string url: description: >- The URL we will make an HTTP POST request to when an event of `type` occurs. type: string format: uri allowInsecureUrl: description: >- Set to true if the webhook was created to allow insecure URLs that use no SSL or self signed certificates. type: boolean includeSensitiveInfo: description: >- If set to false, the sensitive info will be masked in the webhook payload. The default value is true. type: boolean WebhookPatchModel: type: object properties: url: description: >- The URL we will make an HTTP POST request to when an event of `type` occurs. type: string format: uri secret: description: >- An optional secret which will be passed in the `X-Secret` header to the webhook callback URL. type: string allowInsecureUrl: description: >- Set to true to allow insecure callback URLs such as URLs without SSL or URLs with self signed certificates. type: boolean includeSensitiveInfo: description: >- If set to false, the sensitive info will be masked in the webhook payload. The default value is true. type: boolean WebhookRequestModel: required: - type - url type: object properties: type: description: The event type that should trigger this webhook. enum: - VerificationCompleted - ExportCompleted - LicenseExpiresSoon - LicenseExpired - LicenseChanged - NpiChanged - BoardCertificationVerificationCompleted - BoardCertificationExportCompleted - DatasetScanCompleted - LicenseStatusChanged - ProviderStatusChanged - ProviderProfileImportCompleted - CredentialingRequestChanged - GenerateReport - DatasetScanMatchesChanged - NpdbUpdateRequestRejected type: string url: description: >- The URL we will make an HTTP POST request to when an event of `type` occurs. type: string format: uri secret: description: >- An optional secret which will be passed in the `X-Secret` header to the webhook callback URL. type: string allowInsecureUrl: description: >- Set to true to allow insecure callback URLs such as URLs without SSL or URLs with self signed certificates. type: boolean includeSensitiveInfo: description: >- If set to false, the sensitive info will be masked in the webhook payload. The default value is true. type: boolean WebhookResponse: oneOf: - $ref: '#/components/schemas/NpdbUpdateRequestRejectedWebhook' - $ref: '#/components/schemas/ProviderModel' - $ref: '#/components/schemas/ProviderConfigurableReportModel' - $ref: '#/components/schemas/ProviderProfileImportModel' - $ref: '#/components/schemas/NpiRecordDataModel' - $ref: '#/components/schemas/LicenseModel' - $ref: '#/components/schemas/BoardCertificationModel' - $ref: '#/components/schemas/DatasetScanModel' - $ref: '#/components/schemas/CredentialingRequestModel' discriminator: propertyName: type mapping: NpdbUpdateRequestRejectedWebhook: '#/components/schemas/NpdbUpdateRequestRejectedWebhook' ProviderModel: '#/components/schemas/ProviderModel' ProviderConfigurableReportModel: '#/components/schemas/ProviderConfigurableReportModel' ProviderProfileImportModel: '#/components/schemas/ProviderProfileImportModel' NpiRecordDataModel: '#/components/schemas/NpiRecordDataModel' LicenseModel: '#/components/schemas/LicenseModel' BoardCertificationModel: '#/components/schemas/BoardCertificationModel' DatasetScanModel: '#/components/schemas/DatasetScanModel' CredentialingRequestModel: '#/components/schemas/CredentialingRequestModel' WebhooksLogPageModel: type: object properties: sort: type: object additionalProperties: type: object properties: Keys: enum: - Timestamp type: string Values: enum: - Asc - Desc type: string nullable: true previousCursor: type: string nullable: true nextCursor: type: string nullable: true nextOffset: type: integer format: int32 nullable: true pageSize: type: integer format: int32 count: type: integer format: int32 totalCount: type: integer format: int32 nullable: true items: type: array items: $ref: '#/components/schemas/WebhookLogModel' nullable: true sortedBy: enum: - Timestamp type: string nullable: true sortDirection: enum: - Asc - Desc type: string nullable: true WorkHistoryModel: type: object properties: lastUpdatedAt: description: The date and time when the object was created or modified. type: string format: date-time id: description: Unique identifier associated with this work history entry type: string format: uuid workHistoryType: description: '`Gap` identifies a time period when this provider was not employed' enum: - Employment - Gap type: string name: description: Name or employer type: string jobTitle: description: Job title while working for this employer type: string address: $ref: '#/components/schemas/ProviderAddressModel' phone: description: Employer phone number type: string startDate: description: Timestamp when this provider started working for the employer type: string format: date-time endDate: description: Timestamp when this provider finished working for the employer type: string format: date-time isCurrentEmployer: description: Identifies if the provider is currently employed by the employer type: boolean departureReason: description: Reason provider left this employer type: string gapExplanation: description: >- If work history type is set to Gap provider must explain reason for the gap in employment type: string WorkHistoryPatchModel: type: object properties: workHistoryType: description: '`Gap` identifies a time period when this provider was not employed' enum: - Employment - Gap type: string name: description: Name or employer type: string jobTitle: description: Job title while working for this employer type: string address: $ref: '#/components/schemas/ProviderAddressModel' phone: description: Employer phone number type: string startDate: description: Timestamp when this provider started working for the employer type: string format: date-time endDate: description: Timestamp when this provider finished working for the employer type: string format: date-time isCurrentEmployer: description: Identifies if the provider is currently employed by the employer type: boolean departureReason: description: Reason provider left this employer type: string gapExplanation: description: >- If work history type is set to Gap provider must explain reason for the gap in employment type: string WorkHistoryRequestModel: type: object properties: workHistoryType: description: '`Gap` identifies a time period when this provider was not employed' enum: - Employment - Gap type: string name: description: Name or employer type: string jobTitle: description: Job title while working for this employer type: string address: $ref: '#/components/schemas/ProviderAddressRequestModel' phone: description: Employer phone number type: string startDate: description: Timestamp when this provider started working for the employer type: string format: date-time endDate: description: Timestamp when this provider finished working for the employer type: string format: date-time isCurrentEmployer: description: Identifies if the provider is currently employed by the employer type: boolean departureReason: description: Reason provider left this employer type: string gapExplanation: description: >- If work history type is set to Gap provider must explain reason for the gap in employment type: string LicensesTriggerVerificationRequest: type: array items: title: Unique license identifier to run verififcation. type: string format: uuid CognitoFormsWebhookReceiveDataRequest: {} ProvidersListProviderTypesResponse: type: array items: $ref: '#/components/schemas/ProviderTypeModel' ProvidersGenerateReportResponse: type: string format: binary ProvidersInfoGetResponse: type: object additionalProperties: {} ProvidersInfoListBoardCertificationsResponse: type: array items: $ref: '#/components/schemas/BoardCertificationInfoModel' ProvidersInfoListCertificatesResponse: type: array items: $ref: '#/components/schemas/CertificateInfoModel' ProvidersInfoListLiabilityInsurancesResponse: type: array items: $ref: '#/components/schemas/LiabilityInsuranceModel' ProvidersInfoListEducationsResponse: type: array items: $ref: '#/components/schemas/EducationModel' ProvidersInfoListTrainingsResponse: type: array items: $ref: '#/components/schemas/TrainingModel' ProvidersInfoListWorkHistoryResponse: type: array items: $ref: '#/components/schemas/WorkHistoryModel' NotesListProviderNotesResponse: type: array items: $ref: '#/components/schemas/ProviderNotesModel' FilesDownloadFileResponse: type: string format: binary LicensesListVerificationsResponse: type: array items: $ref: '#/components/schemas/LicenseVerificationModel' GroupsGetAllResponse: type: array items: $ref: '#/components/schemas/GroupModel' PayersGetAllResponse: type: array items: $ref: '#/components/schemas/PayerModel' PayerPlansListResponse: type: array items: $ref: '#/components/schemas/PayerPlanModel' WebhooksListAllResponse: type: array items: $ref: '#/components/schemas/WebhookModel' ReportsListSanctionsAndExclusionsResponse: type: array items: $ref: '#/components/schemas/SanctionsAndExclusionsReportInfoModel' CredentialingRequestsAggregateProviderOwnersResponse: type: array items: $ref: '#/components/schemas/BaseUserModel' LicensesListFromProviderResponse: type: array items: $ref: '#/components/schemas/LicenseModel' ProvidersInfoListDeaRegistrationsResponse: type: array items: $ref: '#/components/schemas/DeaRegistrationInfoModel' ProvidersInfoListAddressesResponse: type: array items: $ref: '#/components/schemas/ProviderAddressModel' ProvidersInfoListAliasesResponse: type: array items: $ref: '#/components/schemas/ProviderAliasModel' ProvidersInfoListEmailsResponse: type: array items: $ref: '#/components/schemas/ProviderEmailModel' DatasetsGetScanParametersResponse: type: array items: $ref: '#/components/schemas/IProviderParameter' GetFacilityInfoDetailsResponse: type: object additionalProperties: {} x-tagGroups: - tags: - Authentication name: Authentication - tags: - Providers - ProvidersInfo - ProviderProfiles - Notes - Files name: Providers - tags: - Licenses - Datasets - NPI - DEA - BoardCertifications name: Verifications - tags: - Monitoring - Alerts name: Monitoring - tags: - CredentialingRequests name: Credentialing - tags: - Groups - Payers - PayerPlans - ProviderEnrollments name: Enrollment - tags: - Integrations - Webhooks name: Integrations - tags: - Audit name: Audits - tags: - Users name: Account - tags: - Reports name: Organizations - tags: - Dataset Records - Webhook Callbacks name: Models