openapi: 3.2.0 info: title: Axuall Providers API version: 2.144.89 servers: - url: https://api.axuall.net tags: - name: Providers paths: /v2/provider_preview: get: tags: - Providers summary: Provider Preview description: 'Instantly retrieve available information for a clinician. This can include qualified name, state licenses, dea licenses, and ABMS board certifications for Physicians. Please note this information is subject to availability and not always comprehensive. Only NPIs belonging to an individual clinician are supported. Organizational NPIs and deactivated NPIs are rejected with a 400.' operationId: provider_preview_v2_provider_preview_get security: - HTTPBearer: [] parameters: - name: npi in: query required: true schema: type: string description: The NPI of the practitioner title: Npi description: The NPI of the practitioner - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: ' Successfully retrieved a complete or partial response for the clinician''s NPI ' content: application/json: schema: $ref: '#/components/schemas/ProviderPreviewSchema' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/provider_prefill: get: tags: - Providers summary: Provider Prefill operationId: provider_prefill_v2_provider_prefill_get security: - HTTPBearer: [] parameters: - name: provider_id in: query required: true schema: type: string description: Provider identifier value title: Provider Id description: Provider identifier value - name: id_type in: query required: true schema: $ref: '#/components/schemas/ProviderPrefillIdType' description: Identifier type description: Identifier type - name: include_facilities in: query required: false schema: type: boolean default: false title: Include Facilities - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Invite prefill payload from existing clinician or NPPES fallback content: application/json: schema: $ref: '#/components/schemas/ProviderPrefillSchema' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers: get: tags: - Providers summary: List Providers description: 'List available providers with the ability to search and filter to help find a provider. Provide as many of the optional query parameters as possible in order to narrow the results.' operationId: list_providers_v2_providers_get security: - HTTPBearer: [] parameters: - name: name in: query required: false schema: anyOf: - type: string - type: 'null' examples: Jane Smith title: Name - name: provider_id in: query required: false schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' examples: '1730051129' title: Provider Id - name: state_license_number in: query required: false schema: anyOf: - type: string - type: 'null' examples: PA12345 title: State License Number - name: dea_license_number in: query required: false schema: anyOf: - type: string - type: 'null' examples: R12345 title: Dea License Number - name: date_of_birth in: query required: false schema: anyOf: - type: string pattern: ^[0-1][0-9]-[0-3][0-9]-[1-2][0-9]{3} - type: 'null' examples: 04-30-1990 title: Date Of Birth - name: provider_type in: query required: false schema: anyOf: - type: string - type: 'null' examples: Osteopathic Physician (DO) title: Provider Type - name: registration_status in: query required: false schema: anyOf: - $ref: '#/components/schemas/RegistrationStatus' - type: 'null' description: Registration status of provider examples: account_shared title: Registration Status description: Registration status of provider - name: invitation_status in: query required: false schema: anyOf: - $ref: '#/components/schemas/InvitationStatus' - type: 'null' description: Invitation status of provider examples: invitation_sent title: Invitation Status description: Invitation status of provider - name: id_verified in: query required: false schema: anyOf: - $ref: '#/components/schemas/IDVerifiedStatus' - type: 'null' description: The status of ID Verification of the provider examples: complete title: Id Verified description: The status of ID Verification of the provider - name: app_req_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: UUID of app_req_id of provider examples: f472da53-adee-4e5f-b59d-b2a51b63859a title: App Req Id description: UUID of app_req_id of provider - name: app_req_status in: query required: false schema: anyOf: - $ref: '#/components/schemas/AppReqStatus' - type: 'null' description: The status of app_reqs to be returned/filtered. If None, returns app reqs with all statuses. examples: active title: App Req Status description: The status of app_reqs to be returned/filtered. If None, returns app reqs with all statuses. - name: min_last_wallet_shared in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Min timestamp, in UTC, of the last time a provider manually shared their wallet to a subscriber. examples: '2026-09-24T18:57:41.591510Z' title: Min Last Wallet Shared description: Min timestamp, in UTC, of the last time a provider manually shared their wallet to a subscriber. - name: max_last_wallet_shared in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Max timestamp, in UTC, of the last time a provider manually shared their wallet to a subscriber. examples: '2026-09-25T18:57:41.591542Z' title: Max Last Wallet Shared description: Max timestamp, in UTC, of the last time a provider manually shared their wallet to a subscriber. - name: min_last_share_refresh in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Min timestamp, in UTC, of when all verification jobs were completed after a clinician shares. This timestamp indicates when a clinician is ready for import. examples: '2026-09-24T18:57:41.591565Z' title: Min Last Share Refresh description: Min timestamp, in UTC, of when all verification jobs were completed after a clinician shares. This timestamp indicates when a clinician is ready for import. - name: max_last_share_refresh in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Max timestamp, in UTC, of when all verification jobs were completed after a clinician shares. This timestamp indicates when a clinician is ready for import. examples: '2026-09-25T18:57:41.591588Z' title: Max Last Share Refresh description: Max timestamp, in UTC, of when all verification jobs were completed after a clinician shares. This timestamp indicates when a clinician is ready for import. - name: min_last_task_completed_at in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Min timestamp, in UTC, of the last time a provider's task was completed. examples: '2026-09-24T18:57:41.591610Z' title: Min Last Task Completed At description: Min timestamp, in UTC, of the last time a provider's task was completed. - name: max_last_task_completed_at in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Max timestamp, in UTC, of the last time a provider's task was completed. examples: '2026-09-25T18:57:41.591632Z' title: Max Last Task Completed At description: Max timestamp, in UTC, of the last time a provider's task was completed. - name: min_last_updated in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Min timestamp, in UTC, of the last time a provider's credentials were updated. examples: '2026-09-24T18:57:41.591654Z' title: Min Last Updated description: Min timestamp, in UTC, of the last time a provider's credentials were updated. - name: max_last_updated in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Max timestamp, in UTC, of the last time a provider's credentials were updated. examples: '2026-09-25T18:57:41.591676Z' title: Max Last Updated description: Max timestamp, in UTC, of the last time a provider's credentials were updated. - name: offset in: query required: false schema: anyOf: - type: integer - type: 'null' description: Page offset default: 0 title: Offset description: Page offset - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Page limit. Use -1 to disable pagination. default: 50 title: Limit description: Page limit. Use -1 to disable pagination. - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Successfully retrieved a list of possible matches based on query parameters. content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderSearchResult' title: Response List Providers V2 Providers Get '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - Providers summary: Register Provider description: 'Register a new provider with Axuall. If kicked off in un-engaged mode, this will trigger all possible verifications based on the supplied information and the chosen recipe. Either a NPI or NCSBN is required.' operationId: register_provider_v2_providers_post security: - HTTPBearer: [] parameters: - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProviderRegistrationRequestSchema' responses: '200': description: Instantiation request received. content: application/json: schema: $ref: '#/components/schemas/Response_ProviderRegistrationMessage_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}: get: tags: - Providers summary: Get Provider description: Provides identifying information for a provider operationId: get_provider_v2_providers__provider_id__get security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Provider's profile information content: application/json: schema: $ref: '#/components/schemas/ProviderProfile' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/files: get: tags: - Providers summary: List Provider Files description: 'Returns all accessible files for a provider which can be downloaded. All links expire after 30 minutes' operationId: list_provider_files_v2_providers__provider_id__files_get security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderFile' title: Response List Provider Files V2 Providers Provider Id Files Get '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/verified_share: get: tags: - Providers summary: Get Provider Verified Share description: 'The Verified Profile endpoint allows for retrieval of the latest verified data for a specific provider that has granted your organization access. Query Parameters: format: Optional output format. Supported values: - credential_stream: Apply field transformations and institution mappings - (none): Return data without transformations' operationId: get_provider_verified_share_v2_providers__provider_id__verified_share_get security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: format in: query required: false schema: type: string description: Output format (credential_stream) title: Format description: Output format (credential_stream) - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Response_ShareData_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/changes: get: tags: - Providers summary: List Provider Credential Changes description: Allows for retrieval of credential changes between two dates for a provider. operationId: list_provider_credential_changes_v2_providers__provider_id__changes_get security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: min_presented_at in: query required: true schema: type: string format: date description: Earliest date (UTC), inclusive, in range to check for changes to credentials. examples: '2026-09-18' title: Min Presented At description: Earliest date (UTC), inclusive, in range to check for changes to credentials. - name: max_presented_at in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Latest date (UTC), inclusive, in range to check for changes to credentials. If blank, then today's date. examples: '2026-09-25' title: Max Presented At description: Latest date (UTC), inclusive, in range to check for changes to credentials. If blank, then today's date. - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Changes' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/assign_task: post: tags: - Providers summary: Assign Task description: Assigns a task to a provider. operationId: assign_task_v2_providers__provider_id__assign_task_post security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignTaskRequestSchema' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Response_AssignTaskMessage_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/cancel_task: post: tags: - Providers summary: Cancel Task description: Cancel an assigned task for a provider. operationId: cancel_task_v2_providers__provider_id__cancel_task_post security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CancelTaskRequestSchema' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Response_AssignTaskMessage_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/workflows: post: tags: - Providers summary: Assign Workflow description: 'The Assign Workflow endpoint allows for a providers workflow status to be updated. Updating it, changes the status to pending. Workflow is the set of requirements for the provider to successfully complete their credentialing needs for a subscriber group.' operationId: assign_workflow_v2_providers__provider_id__workflows_post security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignWorkflowRequestSchema' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Response_AssignWorkflowMessage_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/deactivation: post: tags: - Providers summary: Deactivate Clinician description: 'The Deactivate Clinician endpoint takes a provider and marks them as pending_deactivation for the deactivations workflow' operationId: deactivate_clinician_v2_providers__provider_id__deactivation_post security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '202': description: The clinician was set to be deactivated content: application/json: schema: $ref: '#/components/schemas/DeactivationSchema' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/attested_reqirements: get: tags: - Providers summary: List Attested Requirements description: Retrieve all available Attested Requirement Configurations that are configured for a clinician. operationId: list_attested_requirements_v2_providers__provider_id__attested_reqirements_get security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Successfully fetched attested req list content: application/json: schema: $ref: '#/components/schemas/Response_AttestedRequirementSchema_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v2/providers/{provider_id}/facilities: get: tags: - Providers summary: List Provider Facilities description: Retrieve available facilities where a clinician can be privileged. operationId: list_provider_facilities_v2_providers__provider_id__facilities_get security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor responses: '200': description: Successfully fetched providers facilities content: application/json: schema: $ref: '#/components/schemas/Response_FacilitiesSchema_' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - Providers summary: Enroll Provider description: Enroll or unenroll a provider to/from facilities based on the provided data. operationId: enroll_provider_v2_providers__provider_id__facilities_post security: - HTTPBearer: [] parameters: - name: provider_id in: path required: true schema: anyOf: - type: string minLength: 10 maxLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id - name: x-axuall-actor in: header required: true schema: type: string format: uuid examples: - af12b4d1-6895-4f39-8215-71653a7cd4ca title: X-Axuall-Actor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FacilityEnrollmentSchema' responses: '202': description: Enrollment Request Accepted content: application/json: schema: $ref: '#/components/schemas/FacilityEnrollmentReponse' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '418': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/GenericErrorSchema' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: Response_FacilitiesSchema_: properties: success: type: boolean title: Success default: true data: anyOf: - $ref: '#/components/schemas/FacilitiesSchema' - type: 'null' type: object title: Response[FacilitiesSchema] AddressSchema: properties: line_1: type: string title: Line 1 example: 123 Main St line_2: anyOf: - type: string - type: 'null' title: Line 2 default: '' example: Suite 2 city: type: string title: City example: Mesa state: type: string title: State example: AZ zip: type: string title: Zip example: '85201' zip4: anyOf: - type: string - type: 'null' title: Zip4 default: '' example: '1234' type: object required: - line_1 - city - state - zip title: AddressSchema FileType: type: string enum: - artifact - attestation - document - signature - supplemental title: FileType description: 'File type categories artifact - File associated with a verified credential attestation - File associated with a providers attestations document - File uploaded and shared by a provider signature - File of a document with a provider''s signature supplemental - File associated with a providers supplemental information' MedicaidID: properties: attested.medicaid.participation: type: string title: Attested.Medicaid.Participation description: Whether or not the practitioner participates in Medicaid - as attested to by the practitioner default: '' example: '' attested.medicaid.number: additionalProperties: true type: object title: Attested.Medicaid.Number description: The Medicaid numbers of the practitioner default: '' example: {} attested.medicaid.attested_meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' type: object title: MedicaidID BoardCertification: properties: verified.board_certification.specialty_type: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Specialty Type description: The Specialty of the practitioner for the particular board certification. verified.board_certification.issue_date: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Issue Date description: The issue date of the board certification. example: '2011-07-14' verified.board_certification.expiration_date: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Expiration Date description: The expiration of the board certification. This is null if not applicable. example: '2020-12-01' verified.board_certification.complete: anyOf: - type: boolean - type: 'null' title: Verified.Board Certification.Complete description: Whether or not the board certification has been completed as verified by the primary source. default: true example: true verified.board_certification.additional_requirements_compliance_status: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Additional Requirements Compliance Status description: The MOC (ABMS) or OCC (AOIA) status from the board that has issued the certification. verified.board_certification.duration: anyOf: - $ref: '#/components/schemas/BoardCertificationDuration' - type: 'null' description: The duration type of the board certification. verified.board_certification.board_name: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Board Name description: The name of the medical board that has issued the certification. default: '' verified.board_certification.certification_number: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Certification Number description: The certification number of the board certification. default: '' verified.board_certification.external_board_name: anyOf: - type: string - type: 'null' title: Verified.Board Certification.External Board Name description: The external board name of the board certification. example: American Board of Internal Medicine - Gastroenterology verified.board_certification.external_board_code: anyOf: - type: string - type: 'null' title: Verified.Board Certification.External Board Code description: The external board code of the board certification. example: ABIMG verified.board_certification.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Board Certification.Artifact description: The expiration of the board certification. This will be a copy of the AMA or AOIA master file that is used as a primary source verification for the certification. This link will expire within 10 minutes of when the API call was made. verified.board_certification.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' verified.board_certification.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Board Certification.Dispute Details attested.board_certification.board_name: anyOf: - type: string - type: 'null' title: Attested.Board Certification.Board Name description: Board name as attested to by the practitioner example: ABPM attested.board_certification.number: anyOf: - type: string - type: 'null' title: Attested.Board Certification.Number description: Board certification number as attested to by the practitioner example: A123 attested.board_certification.certified: anyOf: - type: boolean - type: 'null' title: Attested.Board Certification.Certified description: Whether or not the practitioner is board certified. example: true attested.board_certification.exam_date: anyOf: - type: string - type: 'null' title: Attested.Board Certification.Exam Date description: The date of the board certification exam. example: '2025-02-01' attested.board_certification.exam_status: anyOf: - type: string - type: 'null' title: Attested.Board Certification.Exam Status description: The status of the board certification exam. example: pending attested.board_certification.explanation: anyOf: - type: string - type: 'null' title: Attested.Board Certification.Explanation description: An explanation for why the practitioner is not board certified. example: awaiting exam attested.board_certification.specialty_id: anyOf: - type: string - type: 'null' title: Attested.Board Certification.Specialty Id description: The specialty for the board certification. default: '' example: Internal Medicine attested.board_certification.external_board_name: anyOf: - type: string - type: 'null' title: Attested.Board Certification.External Board Name description: The external board name of the board certification. example: American Board of Internal Medicine - Gastroenterology attested.board_certification.external_board_code: anyOf: - type: string - type: 'null' title: Attested.Board Certification.External Board Code description: The external board code of the board certification. example: ABIMG external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: BoardCertification Response_AssignTaskMessage_: properties: success: type: boolean title: Success default: true data: anyOf: - $ref: '#/components/schemas/AssignTaskMessage' - type: 'null' type: object title: Response[AssignTaskMessage] BasicInfo: properties: verified.axuall_id.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Axuall Id.Artifact description: Axuall ID Proof artifact. This is usually an image of the practitioners drivers license. This link will expire within 10 minutes of when the API call was made. verified.axuall_id.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' verified.axuall_id.first_name: type: string title: Verified.Axuall Id.First Name description: The first name of the practitioner as presented in the digital credential. This field is has been verified through an approved ID verification method. verified.axuall_id.middle_name: anyOf: - type: string - type: 'null' title: Verified.Axuall Id.Middle Name description: The middle name of the practitioner as attested to by the practitioner. default: '' verified.axuall_id.last_name: type: string title: Verified.Axuall Id.Last Name description: The last name of the practitioner as presented in the digital credential. This field is has been verified through an approved ID verification method. verified.axuall_id.date_of_birth: type: string title: Verified.Axuall Id.Date Of Birth description: The date of birth of the practitioner. This field is verified by an approved method of ID verification. attested.basic_info.suffix: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Suffix description: The suffix of the practitioner as attested to by the practitioner. default: '' attested.basic_info.gender: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Gender description: Clinician's gender default: '' verified.ecfmg.number: anyOf: - type: string - type: 'null' title: Verified.Ecfmg.Number attested.basic_info.occupation_code: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Occupation Code default: N/A attested.basic_info.social_security: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Social Security description: The social security number of the practitioner. default: N/A attested.basic_info.other_names.first_name: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Other Names.First Name description: A first name used as an alias as attested to by the practitioner. attested.basic_info.other_names.middle_name: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Other Names.Middle Name description: A middle name used as an alias as attested to by the practitioner. attested.basic_info.other_names.last_name: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Other Names.Last Name description: A last name used as an alias as attested to by the practitioner. attested.basic_info.other_names.suffix: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Other Names.Suffix description: A suffix used as an alias as attested to by the practitioner. attested.basic_info.other_names.prefilled: anyOf: - type: boolean - type: 'null' title: Attested.Basic Info.Other Names.Prefilled attested.basic_info.alias_first_name: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Alias First Name default: N/A deprecated: true attested.basic_info.alias_last_name: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Alias Last Name default: N/A deprecated: true attested.basic_info.phone_number: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Phone Number description: The 10 digit phone number of the practitioner. default: N/A example: '7775551234' attested.basic_info.email: type: string title: Attested.Basic Info.Email default: N/A example: test@email.com attested.basic_info.place_of_birth.city: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Place Of Birth.City description: Clinician's city of birth default: '' example: Columbus attested.basic_info.place_of_birth.state: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Place Of Birth.State example: OH attested.basic_info.place_of_birth.country: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Place Of Birth.Country example: US attested.basic_info.race: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Race description: Clinician's race default: '' attested.basic_info.ethnicity: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Ethnicity description: Clinician's ethnicity default: '' attested.basic_info.languages: anyOf: - items: type: string type: array - type: 'null' title: Attested.Basic Info.Languages description: Clinician's language attested.basic_info.citizenship.0: anyOf: - type: string - type: 'null' title: Attested.Basic Info.Citizenship.0 description: Indexed list of citizenships. The suffix is the index number where index >= 0 example: United States of America external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention additionalProperties: true type: object required: - verified.axuall_id.first_name - verified.axuall_id.last_name - verified.axuall_id.date_of_birth title: BasicInfo Response_ProviderRegistrationMessage_: properties: success: type: boolean title: Success default: true data: anyOf: - $ref: '#/components/schemas/ProviderRegistrationMessage' - type: 'null' type: object title: Response[ProviderRegistrationMessage] OtherIDs: properties: medicare: anyOf: - $ref: '#/components/schemas/MedicareID' - type: 'null' medicaid: anyOf: - $ref: '#/components/schemas/MedicaidID' - type: 'null' npi: anyOf: - $ref: '#/components/schemas/NPIID' - type: 'null' type: object title: OtherIDs NameSchema-Output: properties: first_name: type: string title: First Name example: Jane middle_name: anyOf: - type: string - type: 'null' title: Middle Name example: Pizza last_name: type: string title: Last Name example: Dough suffix: anyOf: - type: string - type: 'null' title: Suffix example: Jr type: object required: - first_name - last_name title: NameSchema ShareData: properties: provider_id: anyOf: - type: string maxLength: 10 minLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id basic_info: $ref: '#/components/schemas/BasicInfo' home_address: $ref: '#/components/schemas/HomeAddress' professional_ids: $ref: '#/components/schemas/ProfessionalIDs' other_ids: anyOf: - $ref: '#/components/schemas/OtherIDs' - type: 'null' default: {} education: anyOf: - items: $ref: '#/components/schemas/Education' type: array - type: 'null' title: Education default: [] training: anyOf: - items: $ref: '#/components/schemas/Training' type: array - type: 'null' title: Training default: [] tasks: anyOf: - items: $ref: '#/components/schemas/Task' type: array - type: 'null' title: Tasks default: [] board_certifications: items: $ref: '#/components/schemas/BoardCertification' type: array title: Board Certifications default: [] other_certifications: anyOf: - $ref: '#/components/schemas/OtherCertifications' - type: 'null' hospital_affiliations: items: $ref: '#/components/schemas/HospitalAffiliation' type: array title: Hospital Affiliations default: [] work_history: items: $ref: '#/components/schemas/WorkHistory' type: array title: Work History default: [] references: items: $ref: '#/components/schemas/Reference' type: array title: References default: [] malpractice_insurance: anyOf: - $ref: '#/components/schemas/Malpractice' - type: 'null' disclosures: $ref: '#/components/schemas/Disclosures' default: {} supplemental: $ref: '#/components/schemas/Supplemental' default: {} documents: items: $ref: '#/components/schemas/Document' type: array title: Documents default: [] signatures: items: $ref: '#/components/schemas/Document' type: array title: Signatures default: [] ongoing_monitoring: $ref: '#/components/schemas/OngoingMonitoring' default: {} life_support: items: $ref: '#/components/schemas/LifeSupport' type: array title: Life Support default: [] fsmb: items: {} type: array title: Fsmb description: Deprecated. Replaced by `fsmb_info`. default: [] fsmb_info: $ref: '#/components/schemas/FsmbDataV2' default: {} payer_enrollment_status: $ref: '#/components/schemas/PayerEnrollmentStatus' default: {} task_responses: items: $ref: '#/components/schemas/TaskResponse' type: array title: Task Responses default: [] type: object required: - provider_id - basic_info - home_address - professional_ids title: ShareData FsmbDemographics: properties: school_name: type: string title: School Name description: Where the clinician went to medical school. example: Michigan State University College of Human Medicine city: type: string title: City description: The clinician's city. example: Morgantown state: type: string title: State description: The clinician's state as a two letter code. example: WV year_of_grad: anyOf: - type: integer - type: 'null' title: Year Of Grad description: The clinician's year of graduation. example: 1998 degree: type: string title: Degree description: The degree obtained by the clinician. example: MD type: object required: - school_name - city - state - degree title: FsmbDemographics Reference: properties: attested.references.id: anyOf: - type: string - type: 'null' title: Attested.References.Id description: The unique identifier for this reference record. Store it to match this record on a later share. attested.references.first_name: anyOf: - type: string - type: 'null' title: Attested.References.First Name description: The first name of the practitioner's reference default: '' example: Jayne attested.references.last_name: anyOf: - type: string - type: 'null' title: Attested.References.Last Name description: The last name of the practitioner's reference default: '' example: Doe attested.references.type: anyOf: - $ref: '#/components/schemas/ReferenceType' - type: 'null' description: The provider type of the practitioner's reference default: '' example: peer attested.references.email: anyOf: - type: string format: email - {} - type: 'null' title: Attested.References.Email description: The email of the practitioner's reference default: '' example: jayne.reliable@health.com attested.references.phone_number: anyOf: - type: string - type: 'null' title: Attested.References.Phone Number description: The phone number of the practitioner's reference default: '' example: '6153675555' attested.references.role: anyOf: - type: string - type: 'null' title: Attested.References.Role description: The role of the practitioner's reference default: '' example: Department Chair attested.references.evaluator_organization: anyOf: - type: string - type: 'null' title: Attested.References.Evaluator Organization description: The organization of the practitioner's reference default: '' example: Health System USA attested.references.occupation_code: anyOf: - type: string - type: 'null' title: Attested.References.Occupation Code description: The occupation code of the practitioner's reference default: '' example: DO attested.references.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' description: Meta data of attested reference type: object title: Reference InvitationStatus: type: string enum: - invitation_sent - invite_bounced - invite_canceled - in_process - application_submitted - account_shared - account_created - invite_bounced - reminder_sent - delegate_removed - delegate_revoked - delegate_granted - delegate_login - external_delegate_login title: InvitationStatus description: 'Invitation status based on provider events. ' OngoingMonitoringSAM: properties: verified.sam_participation.participation: type: boolean title: Verified.Sam Participation.Participation verified.sam_participation.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Sam Participation.Artifact verified.sam_participation.meta: $ref: '#/components/schemas/MetaData' verified.sam_participation.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Sam Participation.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.sam_participation.participation - verified.sam_participation.artifact - verified.sam_participation.meta title: OngoingMonitoringSAM Response_AssignWorkflowMessage_: properties: success: type: boolean title: Success default: true data: anyOf: - $ref: '#/components/schemas/AssignWorkflowMessage' - type: 'null' type: object title: Response[AssignWorkflowMessage] Response_ShareData_: properties: success: type: boolean title: Success default: true data: anyOf: - $ref: '#/components/schemas/ShareData' - type: 'null' type: object title: Response[ShareData] LifeSupportSchema: properties: aha_ecard: type: string title: Aha Ecard type: object required: - aha_ecard title: LifeSupportSchema FacilityEnrollmentReponse: properties: enrolled: items: type: string format: uuid type: array title: Enrolled description: List of facilities the clinician is enrolled in unenrolled: items: type: string format: uuid type: array title: Unenrolled description: List of facilities the clinician is unenrolled in type: object required: - enrolled - unenrolled title: FacilityEnrollmentReponse DEALicenseSchema: properties: state: type: string title: State example: OH license_number: type: string title: License Number example: DE1234 type: object required: - state - license_number title: DEALicenseSchema ProviderFile: properties: file_type: $ref: '#/components/schemas/FileType' description: Type of file url: type: string maxLength: 2083 minLength: 1 format: uri title: Url description: Link for file download created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Timestamp when the file was created expires_at: type: string format: date-time title: Expires At description: Expiration date of the file URL in UTC name: type: string title: Name description: Axuall defined file name external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Client defined file name if applicable readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention continuity_id: anyOf: - type: string - type: 'null' title: Continuity Id description: An ID that stays constant for the same credential even as its data changes. artifact_id: anyOf: - type: string - type: 'null' title: Artifact Id description: Unique ID of the artifact type: object required: - file_type - url - expires_at - name title: ProviderFile Disclosures: properties: attested.caqh|licensure.revoked: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Licensure.Revoked description: Practitioners attestation with regards to license revocation. example: false attested.caqh|licensure.revoked.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Licensure.Revoked.Explanation description: '' example: '' attested.caqh|licensure.revoked.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|licensure.challenged: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Licensure.Challenged description: Practitioners attestation with regards to challenges of their license(s). example: false attested.caqh|licensure.challenged.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Licensure.Challenged.Explanation description: '' example: '' attested.caqh|licensure.challenged.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|privileges.revoked: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Privileges.Revoked description: Practitioners attestation with regards to privilege revocation. example: false attested.caqh|privileges.revoked.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Privileges.Revoked.Explanation description: '' example: '' attested.caqh|privileges.revoked.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|privileges.surrendered: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Privileges.Surrendered description: Practitioners attestation with regards to surrendering of privileges. example: false attested.caqh|privileges.surrendered.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Privileges.Surrendered.Explanation description: '' example: '' attested.caqh|privileges.surrendered.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|privileges.terminated: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Privileges.Terminated description: Practitioners attestation with regards to termination of privileges. example: false attested.caqh|privileges.terminated.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Privileges.Terminated.Explanation description: '' example: '' attested.caqh|privileges.terminated.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|education.probation: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Education.Probation description: Practitioners attestation with regards to probation actions taken during education. example: false attested.caqh|education.probation.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Education.Probation.Explanation description: '' example: '' attested.caqh|education.probation.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|education.withdrawn: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Education.Withdrawn description: Practitioners attestation with regards to voluntary withdrawal from education. example: false attested.caqh|education.withdrawn.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Education.Withdrawn.Explanation description: '' example: '' attested.caqh|education.withdrawn.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|education.revoked: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Education.Revoked description: Practitioners attestation with regards to board certification revocation. example: false attested.caqh|education.revoked.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Education.Revoked.Explanation description: '' example: '' attested.caqh|education.revoked.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|education.surrendered: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Education.Surrendered description: Practitioners attestation with regards to surrendering of board certification. example: false attested.caqh|education.surrendered.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Education.Surrendered.Explanation description: '' example: '' attested.caqh|education.surrendered.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|dea.revoked: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Dea.Revoked description: Practitioners attestation with regards to revocation of DEA License. example: false attested.caqh|dea.revoked.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Dea.Revoked.Explanation description: '' example: '' attested.caqh|dea.revoked.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|medicare.excluded: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Medicare.Excluded description: Practitioners attestation of whether or not they are excluded from federal programs. example: false attested.caqh|medicare.excluded.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Medicare.Excluded.Explanation description: '' example: '' attested.caqh|medicare.excluded.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|sanctions.investigation: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Sanctions.Investigation description: Practitioners attestation of whether they are undergoing a health system investigation. example: false attested.caqh|sanctions.investigation.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Sanctions.Investigation.Explanation description: '' example: '' attested.caqh|sanctions.investigation.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|sanctions.npdb: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Sanctions.Npdb description: Practitioners attestation of whether or not they have sanctions present on their NPDB report. example: false attested.caqh|sanctions.npdb.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Sanctions.Npdb.Explanation description: '' example: '' attested.caqh|sanctions.npdb.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|sanctions.sanctioned: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Sanctions.Sanctioned description: Practitioners attestation of whether or not they are being investigated by a federal agency. example: false attested.caqh|sanctions.sanctioned.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Sanctions.Sanctioned.Explanation description: '' example: '' attested.caqh|sanctions.sanctioned.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|sanctions.misconduct: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Sanctions.Misconduct description: Practitioners attestation of whether or not they have pled guilty to misconduct. example: false attested.caqh|sanctions.misconduct.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Sanctions.Misconduct.Explanation description: '' example: '' attested.caqh|sanctions.misconduct.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|sanctions.military: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Sanctions.Military description: Practitioners attestation of whether or not they have been sanctioned by a military hospital. example: false attested.caqh|sanctions.military.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Sanctions.Military.Explanation description: '' example: '' attested.caqh|sanctions.military.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|liability.canceled: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Liability.Canceled description: Practitioners attestation of whether their professional liability coverage has ever been cancelled. example: false attested.caqh|liability.canceled.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Liability.Canceled.Explanation description: '' example: '' attested.caqh|liability.canceled.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|liability.surcharge: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Liability.Surcharge description: Practitioners attestation of whether they have been assessed a surcharge for their professional liability. example: false attested.caqh|liability.surcharge.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Liability.Surcharge.Explanation description: '' example: '' attested.caqh|liability.surcharge.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|malpractice.actions: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Malpractice.Actions description: Practitioners attestation of whether they have had professional liability actions within the last 10 years. example: false attested.caqh|malpractice.actions.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Malpractice.Actions.Explanation description: '' example: '' attested.caqh|malpractice.actions.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|criminal.felony: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Criminal.Felony description: Practitioners attestation of whether they have pled guilty to a felony. example: false attested.caqh|criminal.felony.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Criminal.Felony.Explanation description: '' example: '' attested.caqh|criminal.felony.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|criminal.misdemeanor: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Criminal.Misdemeanor description: Practitioners attestation of whether they have pled guilty to a misdemeanor. example: false attested.caqh|criminal.misdemeanor.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Criminal.Misdemeanor.Explanation description: '' example: '' attested.caqh|criminal.misdemeanor.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|criminal.court-martial: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Criminal.Court-Martial description: Practitioners attestation of whether they have been court martialled. example: false attested.caqh|criminal.court-martial.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Criminal.Court-Martial.Explanation description: '' example: '' attested.caqh|criminal.court-martial.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|ability.drugs: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Ability.Drugs description: Practitioners attestation of whether they are currently engaged in the illegal use of drugs. example: false attested.caqh|ability.drugs.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Ability.Drugs.Explanation description: '' example: '' attested.caqh|ability.drugs.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|ability.chemicals: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Ability.Chemicals description: Practitioners attestation to the use of chemical substance. example: false attested.caqh|ability.chemicals.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Ability.Chemicals.Explanation description: '' example: '' attested.caqh|ability.chemicals.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|ability.risk: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Ability.Risk description: Practitioners attestation of whether they believe they would pose a risk to the safety of a patient. example: false attested.caqh|ability.risk.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Ability.Risk.Explanation description: '' example: '' attested.caqh|ability.risk.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|ability.unable: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Ability.Unable description: Practitioners attestation of whether they are able to perform the essential functions of a practitioner example: false attested.caqh|ability.unable.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Ability.Unable.Explanation description: '' example: '' attested.caqh|ability.unable.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|military.military: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Military.Military description: Practitioners attestation of whether they are currently on active duty in the military or military reserve. example: '' attested.caqh|military.military.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Military.Military.Explanation description: '' example: '' attested.caqh|military.military.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' attested.caqh|military.former: anyOf: - type: boolean - type: 'null' title: Attested.Caqh|Military.Former description: Practitioners attestation of whether they have left active military service within the last five years. example: '' attested.caqh|military.former.explanation: anyOf: - type: string - type: 'null' title: Attested.Caqh|Military.Former.Explanation description: '' example: '' attested.caqh|military.former.document: anyOf: - $ref: '#/components/schemas/Document' - type: 'null' description: '' example: '' type: object title: Disclosures EducationEntry: properties: institution_name: type: string title: Institution Name description: Name of institution institution_code: type: string title: Institution Code description: NSC Code graduation_year: anyOf: - type: integer minimum: 1900.0 - type: 'null' title: Graduation Year example: 2004 graduation_month: anyOf: - type: integer maximum: 12.0 minimum: 1.0 - type: 'null' title: Graduation Month degree_level: $ref: '#/components/schemas/DegreeLevelEnum' description: Level of degree (graduate or undergraduate) highest_practicing_degree: anyOf: - type: boolean - type: 'null' title: Highest Practicing Degree default: false type: object required: - institution_name - institution_code - degree_level title: EducationEntry OngoingMonitoringHHS: properties: verified.hhs_oig.participation: type: boolean title: Verified.Hhs Oig.Participation verified.hhs_oig.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Hhs Oig.Artifact verified.hhs_oig.meta: $ref: '#/components/schemas/MetaData' verified.hhs_oig.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Hhs Oig.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.hhs_oig.participation - verified.hhs_oig.artifact - verified.hhs_oig.meta title: OngoingMonitoringHHS PayerEnrollmentStatusMedicarePartB: properties: verified.participation_reported.active: type: boolean title: Verified.Participation Reported.Active verified.participation_reported.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Participation Reported.Artifact verified.participation_reported.meta: $ref: '#/components/schemas/MetaData' verified.participation_reported.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Participation Reported.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.participation_reported.active - verified.participation_reported.artifact - verified.participation_reported.meta title: PayerEnrollmentStatusMedicarePartB ABMSBoardCertSchema: properties: board: type: string title: Board example: American Board of Medicine specialty: type: string title: Specialty example: Internal Medicine type: object required: - board - specialty title: ABMSBoardCertSchema CredentialChange: properties: values_hash: type: string title: Values Hash description: A hash that only changes if the values section of an entry has changed. record_type: type: string title: Record Type description: The type of credential. latest_value: additionalProperties: true type: object title: Latest Value description: The values from the latest available data in the date range chosen last_updated: type: string format: date-time title: Last Updated description: Timestamp when the last change occurred, within the specified date range. continuity_id: anyOf: - type: string - type: 'null' title: Continuity Id description: An ID that stays constant for the same credential even as its data changes. type: object required: - values_hash - record_type - latest_value - last_updated title: CredentialChange ProfessionalIDs: properties: state_licenses: items: $ref: '#/components/schemas/StateLicense' type: array title: State Licenses default: [] dea: items: $ref: '#/components/schemas/DEALicense' type: array title: Dea default: [] cds: items: $ref: '#/components/schemas/CDSLicense' type: array title: Cds default: [] rn_licenses: items: {} type: array title: Rn Licenses default: [] type: object title: ProfessionalIDs AffiliationsAddress: properties: line_1: anyOf: - type: string - type: 'null' title: Line 1 default: '' example: 123 Main St line_2: anyOf: - type: string - type: 'null' title: Line 2 default: '' example: Suite 2 city: type: string title: City example: Mesa state: type: string title: State example: AZ zip: anyOf: - type: string - type: 'null' title: Zip default: '' example: '85201' zip4: anyOf: - type: string - type: 'null' title: Zip4 default: '' example: '1234' country: anyOf: - type: string - type: 'null' title: Country default: '' example: United States type: object required: - city - state title: AffiliationsAddress DeactivationSchema: properties: status: type: string title: Status description: The status of the clinician type: object required: - status title: DeactivationSchema Changes: properties: credential_changes: items: $ref: '#/components/schemas/CredentialChange' type: array title: Credential Changes self_attested_changes: items: $ref: '#/components/schemas/SelfAttestedChange' type: array title: Self Attested Changes type: object required: - credential_changes - self_attested_changes title: Changes HospitalAffiliation: properties: attested.affiliations.id: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Id description: The unique identifier for this affiliation record. Store it to match this record on a later share. attested.affiliations.name: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Name description: Hospital name as attested to by the practitioner example: Local Area Hospital attested.affiliations.start_date: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Start Date description: Start date of affiliation as attested to by the practitioner example: 2021-09 attested.affiliations.start_date_full: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Start Date Full description: Full start date (YYYY-MM-DD) of affiliation. The day defaults to 01 when it is not provided. example: '2021-09-01' attested.affiliations.end_date: anyOf: - type: string - type: 'null' title: Attested.Affiliations.End Date description: End date of affiliation as attested to by the practitioner example: 2022-01 attested.affiliations.end_date_full: anyOf: - type: string - type: 'null' title: Attested.Affiliations.End Date Full description: Full end date (YYYY-MM-DD) of affiliation. The day defaults to the last day of the month when it is not provided. example: '2022-01-31' attested.affiliation.address_line1.number: anyOf: - type: string - type: 'null' title: Attested.Affiliation.Address Line1.Number description: Street number part of the institution address as attested to by the practitioner example: '1542' attested.affiliations.street_address: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Street Address description: Street address part of the institution address as attested to by the practitioner example: Main Street attested.affiliations.address_line1: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Address Line1 description: Address line 1 of the institution as attested to by the practitioner example: 1541 Main Street attested.affiliations.address_line2: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Address Line2 description: Address line 2 of the institution as attested to by the practitioner example: Suite 2 attested.affiliations.address_city: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Address City description: City of the institution as attested to by the practitioner example: Cleveland attested.affiliations.address_state: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Address State description: State of the institution as attested to by the practitioner example: OH attested.affiliations.address_zip: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Address Zip description: Zip code of the institution as attested to by the practitioner example: '44241' attested.affiliations.address_country: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Address Country description: Country of the institution as attested to by the practitioner example: US attested.affiliations.phone_number: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Phone Number description: Phone number of the institution as attested to by the practitioner example: '1235551234' attested.affiliations.external_institution_code: anyOf: - type: string - type: 'null' title: Attested.Affiliations.External Institution Code description: External institution code example: fjas981234alsijoamwe89234 attested.affiliations.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' description: Meta data of attested hospital affiliation attested.affiliations.external_id: anyOf: - type: string - type: 'null' title: Attested.Affiliations.External Id description: External ID for the work history attested.affiliations.source: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Source description: Source of the attested affiliation attested.affiliations.status: anyOf: - type: string - type: 'null' title: Attested.Affiliations.Status description: Status of the attested data verified.hospital_affilation.start_date: anyOf: - type: string - type: 'null' title: Verified.Hospital Affilation.Start Date description: Start date of affiliation as verified by a primary source. example: 2019-08 verified.hospital_affilation.end_date: anyOf: - type: string - type: 'null' title: Verified.Hospital Affilation.End Date description: End date of affiliation as verified by a primary source example: 2021-01 verified.hospital_affilation.department: anyOf: - type: string - type: 'null' title: Verified.Hospital Affilation.Department description: Department of affiliation as verified by a primary source example: '' verified.hospital_affiliations.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Hospital Affiliations.Artifact description: Primary source artifact verified_hospital_affiliations.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: Meta data of artifact verified.affiliations.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Affiliations.Dispute Details hospital_id: anyOf: - type: string - type: 'null' title: Hospital Id description: Axuall generated identifier for affiliation institution_id: anyOf: - type: string - type: 'null' title: Institution Id description: Axuall institution UUID for the affiliated hospital external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: HospitalAffiliation OngoingMonitoringNPDB: properties: verified.npdb.facility_name: anyOf: - type: string - type: 'null' title: Verified.Npdb.Facility Name description: The name of the facility on the practitioner's NPDB report. example: Example Medical Center verified.npdb.db_subject_id: anyOf: - type: string - type: 'null' title: Verified.Npdb.Db Subject Id description: Unique identifier assigned to a healthcare practitioner within the National Practitioner Data Bank example: '300034015920999' verified.npdb.report_dcn: anyOf: - type: string - type: 'null' title: Verified.Npdb.Report Dcn description: Report Data Bank Control Number example: '5500002854704414' verified.npdb.enrollment_status: anyOf: - type: string - type: 'null' title: Verified.Npdb.Enrollment Status description: Clinician’s enrollment status example: active verified.npdb.enrollment_start_date: anyOf: - type: string - type: 'null' title: Verified.Npdb.Enrollment Start Date description: Clinician’s enrollment start date example: '2024-12-09T12:46:05.738211' verified.npdb.enrollment_end_date: anyOf: - type: string - type: 'null' title: Verified.Npdb.Enrollment End Date description: Clinician’s enrollment end date example: '2024-12-20T12:46:05.738211' verified.npdb.medical_malpractice_payment_report: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Medical Malpractice Payment Report description: Presence of medical malpractice claims on the practitioner's NPDB report. example: false verified.npdb.state_licensure_action: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.State Licensure Action description: Presence of state licensure actions (inclusive of revocations and challenges) on the practitioner's NPDB report. example: false verified.npdb.exclusion_or_debarrment_action: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Exclusion Or Debarrment Action description: '' example: false verified.npdb.government_administrative_action: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Government Administrative Action description: '' example: false verified.npdb.clinical_privileges_action: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Clinical Privileges Action description: Presence of privilege actions (inclusive of revocations and challenges) on the practitioner's NPDB report. example: false verified.npdb.health_plan_action: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Health Plan Action description: '' example: false verified.npdb.professional_society_action: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Professional Society Action description: Presence of specialty board actions on the pracititioners NPDB report. example: false verified.npdb.dea_federal_license_action: anyOf: - type: string - type: 'null' title: Verified.Npdb.Dea Federal License Action description: Presence of DEA actions (inclusive of revocations and challenges) on the practitioner's NPDB report. example: '' verified.npdb.judgement_or_conviction_report: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Judgement Or Conviction Report description: Presence of judgement or convinction reports on the practitioner's NPDB report. example: false verified.npdb.peer_review_org_actions: anyOf: - type: boolean - type: 'null' title: Verified.Npdb.Peer Review Org Actions description: 'Presence of peer review actions on the practitioner''s NPDB report. ' example: false verified.npdb.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Npdb.Artifact description: '' example: '' verified.npdb.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: '' example: '' verified.npdb.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Npdb.Dispute Details type: object title: OngoingMonitoringNPDB NPIID: properties: verified.npi.number: type: string title: Verified.Npi.Number description: The NPI number of the practitioner verified.npi.status: type: string title: Verified.Npi.Status description: The NPI status of the practitioner. verified.npi.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Npi.Artifact description: Axuall NPPES Proof artifact verified.npi.meta: $ref: '#/components/schemas/MetaData' verified.npi.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Npi.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.npi.number - verified.npi.status - verified.npi.meta title: NPIID description: National Provider Identification (NPI) verified information SelfAttestedChange: properties: record_type: type: string title: Record Type description: The type of document. key_name: type: string title: Key Name description: The name of the key. latest_value: additionalProperties: true type: object title: Latest Value description: The values from the latest available data in the date range chosen continuity_id: anyOf: - type: string - type: 'null' title: Continuity Id description: An ID that stays constant for the same attested data even as its data changes. type: object required: - record_type - key_name - latest_value title: SelfAttestedChange OngoingMonitoringMedicaid: properties: verified.medicaid.participation: type: boolean title: Verified.Medicaid.Participation verified.medicaid.state: type: string title: Verified.Medicaid.State verified.medicaid.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Medicaid.Artifact verified.medicaid.meta: $ref: '#/components/schemas/MetaData' verified.medicaid.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Medicaid.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.medicaid.participation - verified.medicaid.state - verified.medicaid.artifact - verified.medicaid.meta title: OngoingMonitoringMedicaid WorkHistorySchema: properties: id: anyOf: - type: string - type: 'null' title: Id institution: anyOf: - type: string - type: 'null' title: Institution description: Instition name default: '' example: Friendly Medical Center address: anyOf: - $ref: '#/components/schemas/WorkHistoryAddress' - type: 'null' position: anyOf: - type: string - type: 'null' title: Position default: '' example: Medical Doctor department: anyOf: - type: string - type: 'null' title: Department default: '' example: Department of Oncology start_date: type: string pattern: ^[0-1][0-9]/[1-2][0-9]{3}$ title: Start Date example: 12/1999 end_date: anyOf: - type: string pattern: ^[0-1][0-9]/[1-2][0-9]{3}$ - type: 'null' title: End Date example: 11/2022 type: object required: - start_date title: WorkHistorySchema NameSchema-Input: properties: first_name: type: string title: First Name middle_name: anyOf: - type: string - type: 'null' title: Middle Name default: '' last_name: type: string title: Last Name suffix: anyOf: - type: string - type: 'null' title: Suffix default: '' type: object required: - first_name - last_name title: NameSchema BoardCertificationDuration: type: string enum: - lifetime - continuous - time_limited title: BoardCertificationDuration FacilitiesSchema: properties: facilities: items: $ref: '#/components/schemas/FacilitySchema' type: array title: Facilities default: [] type: object title: FacilitiesSchema TaskResponse: properties: name: type: string title: Name description: Unique name of the task response default: '' question: anyOf: - type: string - type: 'null' title: Question description: Question of the task response default: '' answer: anyOf: - {} - type: 'null' title: Answer description: Answer of the task response default: '' type: anyOf: - type: string - type: 'null' title: Type description: Type of the task response default: '' task: anyOf: - type: string - type: 'null' title: Task description: Name of the task default: '' type: object title: TaskResponse AttestedReq: properties: profile: anyOf: - items: type: string type: array - type: 'null' title: Profile documents: anyOf: - items: type: string type: array - type: 'null' title: Documents questions: anyOf: - items: type: string type: array - type: 'null' title: Questions docusign_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Docusign Details aha_certification: anyOf: - type: boolean - type: 'null' title: Aha Certification optional_documents: anyOf: - items: type: string type: array - type: 'null' title: Optional Documents other_certifications: anyOf: - items: type: string type: array - type: 'null' title: Other Certifications type: object title: AttestedReq TaskType: type: string enum: - enroll - work_history - question - document - signature - privileging title: TaskType HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError StateLicense: properties: verified.state_license.license_number: anyOf: - type: string - type: 'null' title: Verified.State License.License Number description: The State medical license number of the practitioner example: '12.32132' verified.state_license.number: anyOf: - type: string - type: 'null' title: Verified.State License.Number description: 'Added for backwards compatability. The State medical license number of the practitioner. ' example: '12.32132' verified.state_license.state: anyOf: - type: string - type: 'null' title: Verified.State License.State description: The issuing state of the State medical license of the practitioner example: OH verified.state_license.type: anyOf: - type: string - type: 'null' title: Verified.State License.Type description: The clinician’s degree associated with the state license, if provided example: MD verified.state_license.initial_date: anyOf: - type: string - type: 'null' title: Verified.State License.Initial Date description: The initial date of the State medical license of the practitioner example: '2020-06-01' verified.state_license.expiration_date: anyOf: - type: string - type: 'null' title: Verified.State License.Expiration Date description: The expiration date of the State medical license of the practitioner example: '2024-06-01' verified.state_license.board_actions: anyOf: - type: boolean - type: 'null' title: Verified.State License.Board Actions description: The presence of board actions of the State medical license of the practitioner example: true verified.state_license.license_status: anyOf: - type: string - type: 'null' title: Verified.State License.License Status description: The status of the State medical license of the practitioner default: '' example: ACTIVE verified.state_license.compact_status: anyOf: - type: string - type: 'null' title: Verified.State License.Compact Status description: License current compact status default: '' example: multi-state verified.state_license.institution: anyOf: - type: string - type: 'null' title: Verified.State License.Institution description: The licensing institution default: '' example: Ohio State Board of Medicine verified.state_license.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.State License.Artifact verified.state_license.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' verified.state_license.dispute_details: anyOf: - type: string - type: 'null' title: Verified.State License.Dispute Details attested.state_license.license_number: anyOf: - type: string - type: 'null' title: Attested.State License.License Number description: License number as attested to by the practitioner example: A123412 attested.state_license.state: anyOf: - type: string - type: 'null' title: Attested.State License.State description: State of license as attested to by the practitioner example: AX attested.state_license.type: anyOf: - type: string - type: 'null' title: Attested.State License.Type description: The clinician’s degree associated with the state license, if provided example: PA attested.state_license.initial_date: anyOf: - type: string - type: 'null' title: Attested.State License.Initial Date description: The initial date of the state medical license of the practitioner as supplied by FSMB. example: '1993-03-18' attested.state_license.expiration_date: anyOf: - type: string - type: 'null' title: Attested.State License.Expiration Date description: The expiration date of the state medical license of the practitioner as supplied by FSMB. example: '2023-09-01' attested.state_license.license_status: anyOf: - type: string - type: 'null' title: Attested.State License.License Status description: The license status of the state medical license of the practitioner as supplied by FSMB. example: INACTIVE attested.state_license.institution: anyOf: - type: string - type: 'null' title: Attested.State License.Institution description: The licensing institution of the state medical license of the practitioner as supplied by FSMB or the provider. example: State Medical Board of Arizona attested.state_license.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: StateLicense description: 'State medical license information. This information has been verified using the pertinent state license website or attested to by the practitioner.' CancelTaskRequestSchema: properties: dry_run: anyOf: - type: boolean - type: 'null' title: Dry Run description: Useful for testing purposes. When set to `true`, Axuall will not actually update data. default: false task_id: type: string format: uuid title: Task Id description: UUID of task example: a891a626-7b8e-4728-8731-c0b837916e49 type: object required: - task_id title: CancelTaskRequestSchema IDVerifiedStatus: type: string enum: - complete - incomplete title: IDVerifiedStatus ProviderPrefillSource: type: string enum: - existing_clinician - nppes - resume_reader title: ProviderPrefillSource ClinicianIdSchema: properties: external_id: type: string maxLength: 255 minLength: 1 title: External Id description: The clinician's ID in the external system. example: CS-10042 external_system: anyOf: - type: string - type: 'null' enum: - credential_stream - custom - echo - modio - onbase - symplr title: External System description: External system this ID belongs to. Omit to use the subscriber group's configured default external system; omitting it when no default is configured is a validation error. type: object required: - external_id title: ClinicianIdSchema description: 'One client-supplied clinician ID, optionally scoped to an external system. Always nested under a ``clinician_ids`` list. ``external_id`` is the DAL''s own column name -- ``external_clinician_ids`` inherits it from the mixin it shares with the affiliation, education and role mapping tables -- and keeping it here means a request entry passes through ``normalize_clinician_ids`` and into the ``user_creator`` job body without remapping.' ProviderPrefillIdentifiersSchema: properties: id_type: $ref: '#/components/schemas/ProviderPrefillIdType' npi: anyOf: - type: string - type: 'null' title: Npi example: '1234567890' ncsbn: anyOf: - type: string - type: 'null' title: Ncsbn example: '12345678' clinician_id: anyOf: - type: string - type: 'null' title: Clinician Id description: The clinician's ID for this client's default external system, or null when they hold none for it. Only ever populated for the `existing_clinician` source; NPPES and resume-reader prefills have no clinician ID to offer. example: CS-10042 type: object required: - id_type title: ProviderPrefillIdentifiersSchema WorkHistoryAddress: properties: line_1: anyOf: - type: string - type: 'null' title: Line 1 default: '' example: 123 Main St line_2: anyOf: - type: string - type: 'null' title: Line 2 default: '' example: Suite 2 city: type: string title: City example: Mesa state: type: string title: State example: AZ zip: anyOf: - type: string - type: 'null' title: Zip default: '' example: '85201' zip4: anyOf: - type: string - type: 'null' title: Zip4 default: '' example: '1234' country: anyOf: - type: string - type: 'null' title: Country default: '' example: United States type: object required: - city - state title: WorkHistoryAddress AssignWorkflowMessage: properties: message: type: string title: Message type: object required: - message title: AssignWorkflowMessage PayerEnrollmentStatusMedicareHHA: properties: verified.participation_reported.active: type: boolean title: Verified.Participation Reported.Active verified.participation_reported.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Participation Reported.Artifact verified.participation_reported.meta: $ref: '#/components/schemas/MetaData' verified.participation_reported.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Participation Reported.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.participation_reported.active - verified.participation_reported.artifact - verified.participation_reported.meta title: PayerEnrollmentStatusMedicareHHA Response_AttestedRequirementSchema_: properties: success: type: boolean title: Success default: true data: anyOf: - $ref: '#/components/schemas/AttestedRequirementSchema' - type: 'null' type: object title: Response[AttestedRequirementSchema] StateLicenseSchema-Input: properties: state: type: string maxLength: 2 minLength: 2 title: State example: PA license_number: type: string title: License Number type: object required: - state - license_number title: StateLicenseSchema MedicareID: properties: verified.medicare.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Medicare.Artifact verified.medicare.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' verified.medicare.participation: anyOf: - type: boolean - type: 'null' title: Verified.Medicare.Participation description: Whether or not the practitioner participates in Medicare - as verified through the appropriate website example: '' verified.medicare.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Medicare.Dispute Details attested.medicare.participation: anyOf: - type: string - type: 'null' title: Attested.Medicare.Participation description: Whether or not the practitioner participates in Medicare - as attested to by the practitioner default: '' example: '' attested.medicare.number: anyOf: - type: string - type: 'null' title: Attested.Medicare.Number description: Medicare number - as attested to by the practitioner default: '' example: '' attested.medicare.state: anyOf: - type: string - type: 'null' title: Attested.Medicare.State description: Medicare state - as attested to by the practitioner default: '' example: '' attested.medicare.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: MedicareID FacilityEnrollmentSchema: properties: enroll: items: type: string format: uuid type: array title: Enroll description: List of facilities to enroll or enroll the clinician from unenroll: items: type: string format: uuid type: array title: Unenroll description: List of facilities to enroll or unenroll the clinician from type: object required: - enroll - unenroll title: FacilityEnrollmentSchema FsmbBoardActionsV2: properties: order_id: type: string title: Order Id description: The ID number for the board action. example: '' order_category_description: type: string title: Order Category Description description: The category description for the Board Order, e.g., Loss of license. example: LL term_days: anyOf: - type: string - type: 'null' title: Term Days description: The duration of the action in days. example: '29' term_years: anyOf: - type: string - type: 'null' title: Term Years description: The duration of the action in Years. example: '1' order_date: anyOf: - type: string format: date - type: 'null' title: Order Date description: The date the order was issued. example: '2020-11-10' order_effective_date: anyOf: - type: string format: date - type: 'null' title: Order Effective Date description: The date the order was effective example: '2020-11-12' action_effective_date: anyOf: - type: string format: date - type: 'null' title: Action Effective Date description: The date the action was effective example: '2021-03-01' basis_code: type: string title: Basis Code description: The code of the basis for the Board Order. example: B0151 basis_code_description: anyOf: - type: string - type: 'null' title: Basis Code Description description: The description of the basis for the Board Order. example: Conviction Relating to Controlled Substances action_code: type: string title: Action Code description: The code of the action taken from the Board Order. example: A0002 action_code_description: type: string title: Action Code Description description: A description of the state board action. example: ASSESSED A FINE type: object required: - order_id - order_category_description - basis_code - action_code - action_code_description title: FsmbBoardActionsV2 PayerEnrollmentStatusMedicareDME: properties: verified.participation_reported.active: type: boolean title: Verified.Participation Reported.Active verified.participation_reported.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Participation Reported.Artifact verified.participation_reported.meta: $ref: '#/components/schemas/MetaData' verified.participation_reported.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Participation Reported.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.participation_reported.active - verified.participation_reported.artifact - verified.participation_reported.meta title: PayerEnrollmentStatusMedicareDME BoardCertificationSchema: properties: board_name: type: string enum: - ANCC - AANP - NCCPA - NBCRNA - AANPCB - AAMFT - AACN - AANA - ABCOP - ABCP - ABCS - ABCSW - ABDPH - ABE - ABFAS - ABGC - ABNM - ABO - ABOMP - ABOMS - ABOI - ABOM - ABOP - ABPD - ABPTS - ABPS - ABPM - ABPP - ABP - ABPN - ABRET - ABSA - ABWM - AMCB - AOC - ARRT - ASCP - ASHA - BACB - BCBA - BCD - BBS - BPS - CCCSLP - CBDCE - NCCAOM - CNIM - CAA - CDA - CHT - COA - CPFDA - CRNFA - CDR - DANB - NASC - NAPNES - NASW - NBCOT - NBCC - NBSTSA - NCCT - NCBAHM - NCBTMB - NCCAP - NCC - NCCAA - NCCSA - NSAA - NPLEX - ONCC - PNCB - RBT - NBRC - WOCNCB title: Board Name board_number: anyOf: - type: string - type: 'null' title: Board Number description: An applicable board certification number example: A12345 type: object required: - board_name title: BoardCertificationSchema ProviderRegistrationRequestSchema: properties: dry_run: anyOf: - type: boolean - type: 'null' title: Dry Run description: Useful for testing purposes. When set to `true`, Axuall will not register the practitioner. default: false first_name: type: string title: First Name middle_name: anyOf: - type: string - type: 'null' title: Middle Name default: '' last_name: type: string title: Last Name date_of_birth: type: string format: date title: Date Of Birth social_security_number: type: string pattern: ^[0-9]{3}-[0-9]{2}-[0-9]{4}$ title: Social Security Number example: 111-11-1111 email_address: type: string format: email title: Email Address example: provider@email.com address: $ref: '#/components/schemas/AddressSchema' aliases: anyOf: - items: $ref: '#/components/schemas/NameSchema-Input' type: array - type: 'null' title: Aliases default: [] app_req_id: type: string format: uuid title: App Req Id description: ID of application requirement facilities: items: type: string format: uuid type: array title: Facilities description: List of facilities to associate with the provider labels: anyOf: - items: type: string maxLength: 255 description: Labels (e.g. tags) used for marking providers to help make those providers easily searchable. example: Initial Appointment type: array - type: 'null' title: Labels default: [] add_to_my_clinicians: type: boolean title: Add To My Clinicians default: false npi: anyOf: - type: string maxLength: 10 minLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: 'null' title: Npi ncsbn: anyOf: - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' - type: 'null' title: Ncsbn degree: type: string enum: - AA - APA - ATC - AUD - BCBA - CAA - CCP - CGC - CNIM - CNM - CNS - CO - CPO - CRNA - CST - DA - DC - DDS - DMD - DO - DPM - EDD - EMT - IBCLC - IONM - LAC - LADC - LBS - LCPC - LCSW - LISW - LMFT - LMHC - LMSW - LMT - LPC - LPCC - LPE - LPN - LSW - MA - MBBS - MD - MPSY - ND - NP - OD - OT - OTA - PA - PHARMD - PHD - PSYD - PT - PTA - RBT - RD - RDA - RN - RNFA - RRA - RT - SA - SFA - SLP - SLPA title: Degree example: MD affiliations: anyOf: - items: $ref: '#/components/schemas/AffiliationSchema' type: array - type: 'null' title: Affiliations default: [] work_history: anyOf: - items: $ref: '#/components/schemas/WorkHistorySchema' type: array - type: 'null' title: Work History default: [] university_transcript: anyOf: - $ref: '#/components/schemas/UniversityTranscriptSchema' - type: 'null' education: anyOf: - items: $ref: '#/components/schemas/EducationEntry' type: array - type: 'null' title: Education default: [] state_licenses: anyOf: - items: $ref: '#/components/schemas/StateLicenseSchema-Input' type: array - type: 'null' title: State Licenses default: [] dea_licenses: anyOf: - items: $ref: '#/components/schemas/StateLicenseSchema-Input' type: array - type: 'null' title: Dea Licenses default: [] cds_licenses: anyOf: - items: $ref: '#/components/schemas/StateLicenseSchema-Input' type: array - type: 'null' title: Cds Licenses default: [] rn_licenses: anyOf: - items: $ref: '#/components/schemas/StateLicenseSchema-Input' type: array - type: 'null' title: Rn Licenses default: [] board_certifications: anyOf: - items: $ref: '#/components/schemas/BoardCertificationSchema' type: array - type: 'null' title: Board Certifications default: [] life_support: anyOf: - items: $ref: '#/components/schemas/LifeSupportSchema' type: array - type: 'null' title: Life Support default: [] clinician_ids: anyOf: - items: $ref: '#/components/schemas/ClinicianIdSchema' type: array - type: 'null' title: Clinician Ids description: Optional client clinician IDs to record at onboarding. At most one entry per external system. Entries omitting `external_system` are stamped with the subscriber group's configured default. example: - external_id: CS-10042 external_system: credential_stream type: object required: - first_name - last_name - date_of_birth - social_security_number - email_address - address - app_req_id - facilities - degree title: ProviderRegistrationRequestSchema FsmbLicenseData: properties: state: anyOf: - type: string - type: 'null' title: State description: State of license as attested to by the practitioner example: OH institution: anyOf: - type: string - type: 'null' title: Institution description: The licensing institution default: '' example: Ohio State Board of Medicine license_number: anyOf: - type: string - type: 'null' title: License Number description: Licence number as attested to by the practitioner example: A123412 license_status: anyOf: - type: string - type: 'null' title: License Status description: The status of the State medical license of the practitioner default: '' example: ACTIVE initial_date: anyOf: - type: string - type: 'null' title: Initial Date description: The initial date of the State medical license of the practitioner example: '2020-06-01' expiration_date: anyOf: - type: string - type: 'null' title: Expiration Date description: The expiration date of the State medical license of the practitioner example: '2024-06-01' artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Artifact meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' board_actions: anyOf: - items: $ref: '#/components/schemas/FsmbBoardActionsV2' type: array - type: 'null' title: Board Actions description: A list of Board Actions of the State medical license of the practitioner default: [] type: object title: FsmbLicenseData description: 'State medical license information. This information has been verified using the pertinent state license website or attested to by the practitioner.' UniversityTranscriptSchema: properties: institution: type: string title: Institution description: Name of institution code: anyOf: - type: string - type: 'null' title: Code description: NSC Code graduation_month: anyOf: - type: integer maximum: 12.0 minimum: 1.0 - type: 'null' title: Graduation Month graduation_year: anyOf: - type: integer minimum: 1900.0 - type: 'null' title: Graduation Year example: 2004 type: object required: - institution title: UniversityTranscriptSchema DegreeLevelEnum: type: string enum: - graduate - undergraduate title: DegreeLevelEnum Task: properties: id: type: string format: uuid title: Id description: Task identifier name: type: string title: Name description: Client provided name of task type: $ref: '#/components/schemas/TaskType' documents: items: $ref: '#/components/schemas/Document' type: array title: Documents description: Downloadable documents associated with the task default: [] questions: items: $ref: '#/components/schemas/TaskQuestion' type: array title: Questions description: Collection of question and answers from a question style task default: [] type: object required: - id - name - type title: Task HomeAddress: properties: attested.home_address.line1: type: string title: Attested.Home Address.Line1 description: The first line of the residential address as attested to by the practitioner. default: N/A attested.home_address.line2: anyOf: - type: string - type: 'null' title: Attested.Home Address.Line2 description: The second line of the residential address as attested to by the practitioner. default: '' attested.home_address.city: type: string title: Attested.Home Address.City description: The name of the city in which the practitioner resides. default: N/A attested.home_address.state: type: string title: Attested.Home Address.State description: The 2 letter state code of the state in which the practitioner resides. default: N/A attested.home_address.zip: type: string title: Attested.Home Address.Zip description: The zip code that corresponds with the residential address of the practitioner. default: N/A attested.home_address.zip4: type: string title: Attested.Home Address.Zip4 description: The last 4 digits of the zipe code that corresponds with the residential address of the practitioner. default: N/A type: object title: HomeAddress OngoingMonitoringFindingsReported: properties: verified.monitoring.findings_reported: type: boolean title: Verified.Monitoring.Findings Reported verified.monitoring.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Monitoring.Artifact verified.monitoring.meta: $ref: '#/components/schemas/MetaData' verified.monitoring.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Monitoring.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.monitoring.findings_reported - verified.monitoring.artifact - verified.monitoring.meta title: OngoingMonitoringFindingsReported MetaData: properties: verification_type: anyOf: - type: string - type: 'null' title: Verification Type description: Verification method of credential example: automatic source: anyOf: - type: string - type: 'null' title: Source description: Source of credential information example: Ohio Board of Medicine most_recent_verification: anyOf: - type: string format: date-time - type: 'null' title: Most Recent Verification description: Most recent verification date of credential initial_verification_date: anyOf: - type: string format: date-time - type: 'null' title: Initial Verification Date description: Initial verification date of credential continuity_id: anyOf: - type: string - type: 'null' title: Continuity Id description: An ID that stays constant for the same credential even as its data changes. example: state_medical_board_of_maryland:d93012 values_hash: anyOf: - type: string - type: 'null' title: Values Hash description: A hash of the values in the credential. This is used to detect changes to the credential. type: object title: MetaData RegistrationStatus: type: string enum: - pending - invitation_sent - in_progress - account_shared title: RegistrationStatus description: Inferred status based on provider events FsmbDataV2: properties: demographics: anyOf: - $ref: '#/components/schemas/FsmbDemographics' - type: 'null' state_licenses: anyOf: - items: $ref: '#/components/schemas/FsmbLicenseData' type: array - type: 'null' title: State Licenses default: [] type: object title: FsmbDataV2 PayerEnrollmentStatusMedicarePMD: properties: verified.participation_reported.active: type: boolean title: Verified.Participation Reported.Active verified.participation_reported.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Participation Reported.Artifact verified.participation_reported.meta: $ref: '#/components/schemas/MetaData' verified.participation_reported.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Participation Reported.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.participation_reported.active - verified.participation_reported.artifact - verified.participation_reported.meta title: PayerEnrollmentStatusMedicarePMD ProviderRegistrationMessage: properties: message: type: string title: Message type: object required: - message title: ProviderRegistrationMessage AffiliationSchema: properties: institution: type: string title: Institution example: Medical Center of Health id: anyOf: - type: string - type: 'null' title: Id hospital_id: anyOf: - type: string - type: 'null' title: Hospital Id work_history_id: anyOf: - type: string - type: 'null' title: Work History Id start_date: anyOf: - type: string pattern: ^[0-1][0-9]/[1-2][0-9]{3}$ - type: 'null' title: Start Date example: 12/1999 end_date: anyOf: - type: string pattern: ^[0-1][0-9]/[1-2][0-9]{3}$ - type: 'null' title: End Date example: 11/2022 address: anyOf: - $ref: '#/components/schemas/AffiliationsAddress' - type: 'null' type: anyOf: - type: string - type: 'null' title: Type default: affiliation type: object required: - institution title: AffiliationSchema SubscriptionBillingStatus: type: string enum: - cancelled - deactivated - activated - deactivation_failed - cancellation_failed - deactivating - cancelling - pending title: SubscriptionBillingStatus description: Inferred subscription status based on provider billing status SubscriptionStatus: type: string enum: - pending - active - inactive - adding - addition_failed - terminating - termination_failed - pending_termination title: SubscriptionStatus MalpracticePolicy: properties: insurer_name: anyOf: - type: string - type: 'null' title: Insurer Name description: The name of the insurance company through which insurance is obtained. default: N/A external_institution_code: anyOf: - type: string - type: 'null' title: External Institution Code description: External institution code for the insurance carrier from the external system. policy_number: anyOf: - type: string - type: 'null' title: Policy Number description: The policy number for the insurance. default: N/A original_effective_date: anyOf: - type: string - type: 'null' title: Original Effective Date description: The retroactively effective date for the insurance. default: N/A effective_date: anyOf: - type: string - type: 'null' title: Effective Date description: The effective date for the insurance. default: N/A expiration_date: anyOf: - type: string - type: 'null' title: Expiration Date description: The date on which malpractice insurance will expire. default: N/A occurence_coverage: anyOf: - type: string - type: 'null' title: Occurence Coverage description: The dollar amount of coverage per occurence. default: N/A aggregate_coverage: anyOf: - type: string - type: 'null' title: Aggregate Coverage description: The total dollar amount of coverage. default: N/A document: anyOf: - type: string - type: 'null' title: Document description: The url for the malpractice insurance facesheet image. attested.malpractice.id: anyOf: - type: string - type: 'null' title: Attested.Malpractice.Id description: The unique identifier for this malpractice policy record. Store it to match this record on a later share. id: anyOf: - type: string - type: 'null' title: Id description: 'Deprecated: use `attested.malpractice.id`, which carries the same value. The unique identifier for this malpractice policy. Used to associate this policy to specific work history records.' deprecated: true attested_meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' description: Meta data of attested malpractice policy attested_status: anyOf: - type: string - type: 'null' title: Attested Status description: Status of the attested data attested_source: anyOf: - type: string - type: 'null' title: Attested Source description: Source of the attested data type: object title: MalpracticePolicy ProviderPrefillDemographicsSchema: properties: first_name: anyOf: - type: string - type: 'null' title: First Name example: Jane middle_name: anyOf: - type: string - type: 'null' title: Middle Name example: A last_name: anyOf: - type: string - type: 'null' title: Last Name example: Dough email: anyOf: - type: string - type: 'null' title: Email example: jane@example.com degree: anyOf: - type: string - type: 'null' title: Degree example: MD suffix: anyOf: - type: string - type: 'null' title: Suffix example: Jr type: object title: ProviderPrefillDemographicsSchema GenericErrorSchema: properties: detail: type: string title: Detail example: The request could not be completed because... type: object required: - detail title: GenericErrorSchema WorkHistoryType: type: string enum: - Employed - Gap title: WorkHistoryType DEALicense: properties: verified.dea.number: anyOf: - type: string - type: 'null' title: Verified.Dea.Number description: The DEA number of the practitioner example: FZ12345 verified.dea.expiration_date: anyOf: - type: string - type: 'null' title: Verified.Dea.Expiration Date description: The expiration date of the DEA license of the practitioner example: '2025-05-01' verified.dea.payment_indicator: anyOf: - type: string - type: 'null' title: Verified.Dea.Payment Indicator description: The DEA payment indicator of registration of the practitioner example: P verified.dea.drug_schedule: anyOf: - type: string - type: 'null' title: Verified.Dea.Drug Schedule description: The DEA drug schedule of the practitioner example: 1 22N 33N 4 5 verified.dea.drug_schedule_formatted: anyOf: - type: string - type: 'null' title: Verified.Dea.Drug Schedule Formatted description: The DEA drug schedule formatted as a comma separated list of values example: 1,2,2N,3,3N,4,5 verified.dea.activity: anyOf: - type: string - type: 'null' title: Verified.Dea.Activity description: The DEA activity of a practitioner example: Active verified.dea.patients_permitted: anyOf: - type: string - type: 'null' title: Verified.Dea.Patients Permitted description: The DEA patients permitted (DEA-X only) of the practitioner default: N/A example: '30' verified.dea.uin: anyOf: - type: string - type: 'null' title: Verified.Dea.Uin description: The DEA UIN (DEA-X only) of registration of the practitioner default: N/A example: XW12345 verified.dea.state: anyOf: - type: string - type: 'null' title: Verified.Dea.State description: The DEA state of registration of the practitioner example: OH verified.dea.address: anyOf: - additionalProperties: true type: object - type: 'null' title: Verified.Dea.Address description: The DEA address affiliated with the registration of the practitioner verified.dea.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Dea.Artifact verified.dea.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' verified.dea.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Dea.Dispute Details attested.dea.license_number: anyOf: - type: string - type: 'null' title: Attested.Dea.License Number description: The DEA number as attested to by the practitioner example: FZ12345 attested.dea.state: anyOf: - type: string - type: 'null' title: Attested.Dea.State description: The DEA state of registration as attested to by the practitioner example: OH attested.dea.institution: anyOf: - type: string - type: 'null' title: Attested.Dea.Institution description: The DEA institution of registration as attested to by the practitioner example: Drug Enforcement Administration attested.dea.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: DEALicense description: 'DEA license information. This information has been verified using the DEA as a primary source.' Training: properties: verified.training.institution_name: anyOf: - type: string - type: 'null' title: Verified.Training.Institution Name description: The institution at which the training occurred as verified by a primary source verified.training.complete: anyOf: - type: boolean - type: 'null' title: Verified.Training.Complete description: The state of the training as verified by the primary source example: true verified_dispute_details: anyOf: - type: string - type: 'null' title: Verified Dispute Details attested.training.institution_name: anyOf: - type: string - type: 'null' title: Attested.Training.Institution Name description: The institution at which the training occurred as attested to by the practitioner example: '' institution_id: anyOf: - type: string - type: 'null' title: Institution Id description: Axuall institution UUID for the training institution training.external_institution_code: anyOf: - type: string - type: 'null' title: Training.External Institution Code description: External institution code from the external system programs: anyOf: - items: $ref: '#/components/schemas/TrainingProgram' type: array - type: 'null' title: Programs default: [] type: object title: Training AssignTaskMessage: properties: message: type: string title: Message type: object required: - message title: AssignTaskMessage CDSLicense: properties: verified.cds.number: anyOf: - type: string - type: 'null' title: Verified.Cds.Number description: The Controlled Dangerous Substances license number example: '2501234' verified.cds.expiration_date: anyOf: - type: string - type: 'null' title: Verified.Cds.Expiration Date description: The expiration date of the CDS license of the practitioner example: '2027-01-01' verified.cds.issue_date: anyOf: - type: string - type: 'null' title: Verified.Cds.Issue Date description: The issue date of the CDS license of the practitioner example: '2022-02-20' verified.cds.state: anyOf: - type: string - type: 'null' title: Verified.Cds.State description: 'The issuing state of the CDS license of the practitioner ' example: OH verified.cds.institution: anyOf: - type: string - type: 'null' title: Verified.Cds.Institution description: The licensing institution of the CDS license example: Ohio State Board of Pharmacy verified.cds.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Cds.Artifact verified.cds.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' verified.cds.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Cds.Dispute Details attested.cds.number: anyOf: - type: string - type: 'null' title: Attested.Cds.Number description: The CDS license number as attested to by the practitioner example: '2501234' attested.cds.state: anyOf: - type: string - type: 'null' title: Attested.Cds.State description: State of the CDS license as attested to by the practitioner example: OH attested.cds.institution: anyOf: - type: string - type: 'null' title: Attested.Cds.Institution description: The licensing institution of the CDS license as attested to by the practitioner example: Ohio State Board of Pharmacy attested.cds.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: CDSLicense description: 'Controlled Dangerous Substance (CDS) License information. This information has been verified against the pertinent CDS website.' Supplemental: properties: {} additionalProperties: true type: object title: Supplemental description: 'Collection of supplemental questions gathered from the practitioner Keys will be in the format of `attested.schema|section.attribute` Values will be of type `object`' Document: properties: url: type: string maxLength: 2083 minLength: 1 format: uri title: Url description: Expiring URL for document download name: anyOf: - type: string - type: 'null' title: Name description: Stored name of document document_id: anyOf: - type: string format: uuid - type: string - type: 'null' title: Document Id description: Unique identifier for the document default: '' document_type: anyOf: - type: string - type: 'null' title: Document Type description: Stored document type for the document created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Date and time of when the document was created/uploaded expires_at: type: string format: date-time title: Expires At description: Expiration date and time of URL external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: Meta information for the document type: object required: - url - expires_at title: Document LifeSupport: properties: verified.life_support.training_type: type: string title: Verified.Life Support.Training Type description: The training type (BLS, ACLS, PALS, NRP or NIHSS NIH Stroke Scale Certifications) of the life support certification as verified by a primary source. example: Basic Life Support verified.life_support.training_reference: type: string title: Verified.Life Support.Training Reference description: The eCard number associated with the life support certification as verified by a primary source. example: '123456789012' verified.life_support.issue_date: type: string format: date title: Verified.Life Support.Issue Date description: The issue date of the life support certification as verified through a primary source. example: '2020-01-01' verified.life_support.expiration_date: type: string format: date title: Verified.Life Support.Expiration Date description: The expiration date of the life support certification as verified through a primary source. example: '2022-12-31' verified.life_support.verifier: type: string title: Verified.Life Support.Verifier description: The validator of the life support certification as verified through a primary source. default: American Heart Association example: American Heart Association verified.life_support.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Life Support.Artifact verified.life_support.meta: $ref: '#/components/schemas/MetaData' verified.life_support.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Life Support.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.life_support.training_type - verified.life_support.training_reference - verified.life_support.issue_date - verified.life_support.expiration_date - verified.life_support.artifact - verified.life_support.meta title: LifeSupport AttestedRequirementSchema: properties: attested_reqs: anyOf: - items: $ref: '#/components/schemas/AttestedReq' type: array - type: 'null' title: Attested Reqs description: attested requirements for each application requirement per given user default: - {} example: - aha_certification: true documents: - resume - headshot docusign_details: template_id: cf0974c4-d209-4fe6-8ce5-d4e236601c18 template_recipient: '16423863' optional_documents: - cme-ceu - doa - dhs other_certifications: - advanced_cardiac_life_support - advanced_life_support_ob - advanced_trauma_life_support - basic_life_support - cpr - neonatal_advanced_life_support - neonatal_resuscitation_program - pediatric_advanced_life_support profile: - basic_info - education - address - work_history - university_transcript - dea - board_cert - axuall-signature - malpractice - professional_history - other_certifications questions: - caqh|licensure.revoked - caqh|licensure.challenged - caqh|privileges.revoked - caqh|privileges.surrendered - caqh|privileges.terminated - caqh|education.probation - caqh|education.withdrawn - caqh|education.revoked - caqh|education.surrendered - caqh|dea.revoked - caqh|medicare.excluded - caqh|sanctions.investigation - caqh|sanctions.npdb - caqh|sanctions.sanctioned - caqh|sanctions.misconduct - caqh|sanctions.military - caqh|liability.canceled - caqh|liability.surcharge - caqh|malpractice.actions - caqh|criminal.felony - caqh|criminal.misdemeanor - caqh|criminal.court-martial - caqh|ability.drugs - caqh|ability.chemicals - caqh|ability.risk - caqh|ability.unable - caqh|military.military - caqh|military.former - aha_certification: true documents: - resume - headshot docusign_details: template_id: cf0974c4-d209-4fe6-8ce5-d4e236601c18 template_recipient: '16423863' optional_documents: - cme-ceu - doa - dhs other_certifications: - advanced_cardiac_life_support - advanced_life_support_ob - advanced_trauma_life_support - basic_life_support - cpr - neonatal_advanced_life_support - neonatal_resuscitation_program - pediatric_advanced_life_support profile: - basic_info - education - address - work_history - university_transcript - dea - board_cert - axuall-signature - malpractice - professional_history - other_certifications questions: - caqh|licensure.revoked - caqh|licensure.challenged - caqh|privileges.revoked - caqh|privileges.surrendered - caqh|privileges.terminated - caqh|education.probation - caqh|education.withdrawn - caqh|education.revoked - caqh|education.surrendered - caqh|dea.revoked - caqh|medicare.excluded - caqh|sanctions.investigation - caqh|sanctions.npdb - caqh|sanctions.sanctioned - caqh|sanctions.misconduct - caqh|sanctions.military - caqh|liability.canceled - caqh|liability.surcharge - caqh|malpractice.actions - caqh|criminal.felony - caqh|criminal.misdemeanor - caqh|criminal.court-martial - caqh|ability.drugs - caqh|ability.chemicals - caqh|ability.risk - caqh|ability.unable - caqh|military.military - caqh|military.former type: object title: AttestedRequirementSchema AttestedMetaData: properties: continuity_id: anyOf: - type: string - type: 'null' title: Continuity Id description: An ID that stays constant for the same credential even as its data changes. example: state_medical_board_of_maryland:d93012 values_hash: anyOf: - type: string - type: 'null' title: Values Hash description: A hash of the values in the attested data. This is used to detect changes to the data. type: object title: AttestedMetaData OngoingMonitoring: properties: npdb: items: $ref: '#/components/schemas/OngoingMonitoringNPDB' type: array title: Npdb default: [] hhs_oig: anyOf: - $ref: '#/components/schemas/OngoingMonitoringHHS' - type: 'null' medicaid: items: $ref: '#/components/schemas/OngoingMonitoringMedicaid' type: array title: Medicaid default: [] medicare_participation: anyOf: - $ref: '#/components/schemas/OngoingMonitoringMedicare' - type: 'null' sam_participation: anyOf: - $ref: '#/components/schemas/OngoingMonitoringSAM' - type: 'null' ofac: anyOf: - $ref: '#/components/schemas/OngoingMonitoringOFAC' - type: 'null' monitoring: anyOf: - $ref: '#/components/schemas/OngoingMonitoringFindingsReported' - type: 'null' type: object title: OngoingMonitoring VerifiedWorkHistoryAddress: properties: addr1: anyOf: - type: string - type: 'null' title: Addr1 description: Address line 1 addr2: anyOf: - type: string - type: 'null' title: Addr2 description: Address line 2 city: anyOf: - type: string - type: 'null' title: City description: Address city state: anyOf: - type: string - type: 'null' title: State description: Address state postal_code: anyOf: - type: string - type: 'null' title: Postal Code description: Address zip code type: object title: VerifiedWorkHistoryAddress OtherCertifications: properties: attested.basic_life_support.answer: anyOf: - type: boolean - type: 'null' title: Attested.Basic Life Support.Answer description: '' example: true attested.basic_life_support.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Basic Life Support.Expiration description: '' example: '2023-04-03' attested.basic_life_support.url: anyOf: - type: string - type: 'null' title: Attested.Basic Life Support.Url description: '' default: '' attested.cpr.answer: anyOf: - type: boolean - type: 'null' title: Attested.Cpr.Answer description: '' default: false example: true attested.cpr.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Cpr.Expiration description: '' example: '2024-05-14' attested.cpr.url: anyOf: - type: string - type: 'null' title: Attested.Cpr.Url description: '' default: '' attested.advanced_cardiac_life_support.answer: anyOf: - type: boolean - type: 'null' title: Attested.Advanced Cardiac Life Support.Answer description: '' example: true attested.advanced_cardiac_life_support.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Advanced Cardiac Life Support.Expiration description: '' example: '2023-07-14' attested.advanced_cardiac_life_support.url: anyOf: - type: string - type: 'null' title: Attested.Advanced Cardiac Life Support.Url description: '' default: '' attested.neonatal_advanced_life_support.answer: anyOf: - type: boolean - type: 'null' title: Attested.Neonatal Advanced Life Support.Answer description: '' example: true attested.neonatal_advanced_life_support.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Neonatal Advanced Life Support.Expiration description: '' example: '2024-03-10' attested.neonatal_advanced_life_support.url: anyOf: - type: string - type: 'null' title: Attested.Neonatal Advanced Life Support.Url description: '' attested.advanced_life_support_ob.answer: anyOf: - type: boolean - type: 'null' title: Attested.Advanced Life Support Ob.Answer description: '' example: true attested.advanced_life_support_ob.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Advanced Life Support Ob.Expiration description: '' example: '2023-09-11' attested.advanced_life_support_ob.url: anyOf: - type: string - type: 'null' title: Attested.Advanced Life Support Ob.Url description: '' attested.advanced_trauma_life_support.answer: anyOf: - type: boolean - type: 'null' title: Attested.Advanced Trauma Life Support.Answer description: '' example: true attested.advanced_trauma_life_support.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Advanced Trauma Life Support.Expiration description: '' example: '2029-12-30' attested.advanced_trauma_life_support.url: anyOf: - type: string - type: 'null' title: Attested.Advanced Trauma Life Support.Url description: '' attested.pediatric_advanced_life_support.answer: anyOf: - type: boolean - type: 'null' title: Attested.Pediatric Advanced Life Support.Answer description: '' example: true attested.pediatric_advanced_life_support.expiration: anyOf: - type: string format: date - type: 'null' title: Attested.Pediatric Advanced Life Support.Expiration description: '' example: '2023-10-31' attested.pediatric_advanced_life_support.url: anyOf: - type: string - type: 'null' title: Attested.Pediatric Advanced Life Support.Url description: '' type: object title: OtherCertifications TrainingProgram: properties: verified.training.id: anyOf: - type: string - type: 'null' title: Verified.Training.Id description: The unique identifier for the verified training record. Verified training is a primary-source credential rather than an attested record, so this is the Axuall proof id. Store it to match this record on a later share. verified.training.training_type: anyOf: - type: string - type: 'null' title: Verified.Training.Training Type description: The training type as verified by a primary source example: Residency verified.training.start_date: anyOf: - type: string - type: 'null' title: Verified.Training.Start Date description: The training start date as verified by a primary source example: '2014-04-15' verified.training.start_date_full: anyOf: - type: string - type: 'null' title: Verified.Training.Start Date Full description: Full start date (YYYY-MM-DD) of training as verified by a primary source example: '2014-04-15' verified.training.end_date: anyOf: - type: string - type: 'null' title: Verified.Training.End Date description: The training end date as verified by a primary source example: '2015-04-14' verified.training.specialty: anyOf: - type: string - type: 'null' title: Verified.Training.Specialty description: The training specialty as verified by a primary source example: GENERAL SURGERY verified.training.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Training.Artifact description: The training artifact from the primary source verified.training.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: The training artifact meta data verified.training.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Training.Dispute Details verified.training.is_current: anyOf: - type: boolean - type: 'null' title: Verified.Training.Is Current description: Whether or not this work history record is current verified.training.external_training_institution_name: anyOf: - type: string - type: 'null' title: Verified.Training.External Training Institution Name description: Combination of the institution and specialty separated by a dash example: University of Miami/Jackson Health System - OBSTETRICS & GYNECOLOGY attested.training.id: anyOf: - type: string - type: 'null' title: Attested.Training.Id description: The unique identifier for this attested training record. Store it to match this record on a later share. attested.training.training_type: anyOf: - type: string - type: 'null' title: Attested.Training.Training Type description: The training type as attested to by the practitioner example: residency attested.training.start_date: anyOf: - type: string - type: 'null' title: Attested.Training.Start Date description: The training start date as attested to by the practitioner example: 04/2020 attested.training.start_date_full: anyOf: - type: string - type: 'null' title: Attested.Training.Start Date Full description: Full start date (YYYY-MM-DD) of training. The day defaults to 01 when it is not provided. example: '2020-04-01' attested.training.end_date: anyOf: - type: string - type: 'null' title: Attested.Training.End Date description: The training end date as attested to by the practitioner example: 03/2021 attested.training.end_date_full: anyOf: - type: string - type: 'null' title: Attested.Training.End Date Full description: Full end date (YYYY-MM-DD) of training. The day defaults to the last day of the month when it is not provided. example: '2021-03-31' attested.training.external_training_institution_name: anyOf: - type: string - type: 'null' title: Attested.Training.External Training Institution Name description: The institution name example: University of Miami/Jackson Health System external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention attested.training.is_current: anyOf: - type: boolean - type: 'null' title: Attested.Training.Is Current description: Whether or not this work history record is current attested.training.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' description: Meta data of attested training program attested.training.external_id: anyOf: - type: string - type: 'null' title: Attested.Training.External Id description: The external ID of the training program attested.training.status: anyOf: - type: string - type: 'null' title: Attested.Training.Status description: The status of the attested data attested.training.source: anyOf: - type: string - type: 'null' title: Attested.Training.Source description: The source of the attested data attested.training.external_type_code: anyOf: - type: string - type: 'null' title: Attested.Training.External Type Code description: The external type code of the training program attested.training.external_institution_code: anyOf: - type: string - type: 'null' title: Attested.Training.External Institution Code description: The external institution code of the training program institution_id: anyOf: - type: string - type: 'null' title: Institution Id description: Axuall institution UUID for the training institution type: object title: TrainingProgram ReferenceType: type: string enum: - peer - clinical_supervisor title: ReferenceType AssignWorkflowRequestSchema: properties: dry_run: anyOf: - type: boolean - type: 'null' title: Dry Run description: Useful for testing purposes. When set to `true`, Axuall will not actually update data. default: false app_req: type: string format: uuid title: App Req description: UUID of app_req example: a891a626-7b8e-4728-8731-c0b837916e49 type: object required: - app_req title: AssignWorkflowRequestSchema ProviderPrefillSchema: properties: source: $ref: '#/components/schemas/ProviderPrefillSource' demographics: $ref: '#/components/schemas/ProviderPrefillDemographicsSchema' identifiers: $ref: '#/components/schemas/ProviderPrefillIdentifiersSchema' facilities: items: $ref: '#/components/schemas/FacilitySchema' type: array title: Facilities default: [] type: object required: - source - demographics - identifiers title: ProviderPrefillSchema WorkHistory: properties: attested.work_history.id: anyOf: - type: string - type: 'null' title: Attested.Work History.Id description: The unique identifier for this work history record. Store it to match this record on a later share. attested.work_history.name: anyOf: - type: string - type: 'null' title: Attested.Work History.Name description: The name of the health system at which the practioner was employed example: Johns Hopkins Bayview Medical Center, Inc. attested.work_history.department: anyOf: - type: string - type: 'null' title: Attested.Work History.Department description: The department of the health system in which that the practioner was employed example: '' attested.work_history.type: anyOf: - $ref: '#/components/schemas/WorkHistoryType' - type: 'null' description: Type of employment history record attested.work_history.explanation: anyOf: - type: string - type: 'null' title: Attested.Work History.Explanation description: Optional explanation provided by the practitioner for a gap in work history example: I was on sabatical attested.work_history.position: anyOf: - type: string - type: 'null' title: Attested.Work History.Position description: The position of the practitioner where they were employed example: MD attested.work_history.start_date: type: string title: Attested.Work History.Start Date description: The start date of the practitioner with regards to this employment or gap example: 2010-02 attested.work_history.start_date_full: anyOf: - type: string - type: 'null' title: Attested.Work History.Start Date Full description: The full start date of the practitioner with regards to this employment or gap example: '2010-02-01' attested.work_history.end_date: type: string title: Attested.Work History.End Date description: The end date of the practitioner with regards to this employment or gap example: 2012-11 attested.work_history.end_date_full: anyOf: - type: string - type: 'null' title: Attested.Work History.End Date Full description: Full end date (YYYY-MM-DD) of the employment or gap. The day defaults to the last day of the month when it is not provided. example: '2012-11-30' attested.work_history.address_line1: anyOf: - type: string - type: 'null' title: Attested.Work History.Address Line1 description: The first line of the employers address example: 123 North Main Street attested.work_history.address_line2: anyOf: - type: string - type: 'null' title: Attested.Work History.Address Line2 description: The second line of the employers address example: Suite 5B attested.work_history.address_city: anyOf: - type: string - type: 'null' title: Attested.Work History.Address City description: Employer address city example: Cleveland attested.work_history.address_state: anyOf: - type: string - type: 'null' title: Attested.Work History.Address State description: Employer address state example: OH attested.work_history.address_zip: anyOf: - type: string - type: 'null' title: Attested.Work History.Address Zip description: Employer address zip example: '44240' attested.work_history.address_country: anyOf: - type: string - type: 'null' title: Attested.Work History.Address Country description: Employer address country example: US attested.work_history.phone_number: anyOf: - type: string - type: 'null' title: Attested.Work History.Phone Number description: Employer phone number example: '' attested.work_history.is_current: anyOf: - type: boolean - type: 'null' title: Attested.Work History.Is Current description: Whether or not this work history record is current attested.malpractice.has_coverage: anyOf: - type: boolean - type: 'null' title: Attested.Malpractice.Has Coverage description: Clinician had malpractice coverage at this position attested.malpractice.no_coverage_reason: anyOf: - type: string - type: 'null' title: Attested.Malpractice.No Coverage Reason description: Reason for not having malpractice coverage example: This position was non-clinicial so I did not need malpractice coverage attested.malpractice.policy_id: anyOf: - type: string - type: 'null' title: Attested.Malpractice.Policy Id description: Malpractice Policy ID attested.work_history.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' description: Meta data of attested work history attested.work_history.external_id: anyOf: - type: string - type: 'null' title: Attested.Work History.External Id description: External ID for the work history attested.work_history.source: anyOf: - type: string - type: 'null' title: Attested.Work History.Source description: Source of the work history attested.work_history.status: anyOf: - type: string - type: 'null' title: Attested.Work History.Status description: Status of the attested data verified.work_number.name: anyOf: - type: string - type: 'null' title: Verified.Work Number.Name description: The health system as verified through a primary source example: Johns Hopkins Bayview Medical Center, Inc. verified.work_number.department: anyOf: - type: string - type: 'null' title: Verified.Work Number.Department description: The department of the health system as verified through a primary source example: '' verified.work_number.role: anyOf: - type: string - type: 'null' title: Verified.Work Number.Role description: The practitioner role as verified through a primary source example: OPTION RN II verified.work_number.status: anyOf: - type: string - type: 'null' title: Verified.Work Number.Status description: The status of the employment as verified through a primary source example: Inactive verified.work_number.address: anyOf: - $ref: '#/components/schemas/VerifiedWorkHistoryAddress' - type: 'null' description: The address of the health system as verified through a primary source verified.work_number.employer_code: anyOf: - type: string - type: 'null' title: Verified.Work Number.Employer Code description: The employer code of the health system as verified through a primary source example: '12301' verified.work_number.start_date: anyOf: - type: string - type: 'null' title: Verified.Work Number.Start Date description: The start date of the practitioner with regards to this employment as verified through a primary source example: 11/2008 verified.work_number.end_date: anyOf: - type: string - type: 'null' title: Verified.Work Number.End Date description: The end date of the practitioner with regards to this employment as verified through a primary source example: 02/2011 verified.work_number.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Work Number.Artifact description: The artifact url for the primary source verified.work_number.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: The meta information for this primary source artifact verified_dispute_details: anyOf: - type: string - type: 'null' title: Verified Dispute Details verified.work_number.is_current: anyOf: - type: boolean - type: 'null' title: Verified.Work Number.Is Current description: Whether or not this work history record is current external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: WorkHistory Malpractice: properties: self_insured: anyOf: - type: boolean - type: 'null' title: Self Insured carries_insurance: anyOf: - type: boolean - type: 'null' title: Carries Insurance policies: items: $ref: '#/components/schemas/MalpracticePolicy' type: array title: Policies description: Malpractice policies default: [] type: object title: Malpractice ProviderSearchResult: properties: first_name: anyOf: - type: string - type: 'null' title: First Name description: First name of provider default: '' example: John last_name: anyOf: - type: string - type: 'null' title: Last Name description: Last name of provider default: '' example: Jones date_of_birth: anyOf: - type: string - type: 'null' title: Date Of Birth description: Date of birth of provider example: 03-30-1930 provider_types: anyOf: - items: type: string type: array - type: 'null' title: Provider Types description: List of provider types example: - Osteopathic Physician (DO) - Physician (MD) tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: Tags associated with the provider as defined by the subscriber provider_id: anyOf: - type: string maxLength: 10 minLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' title: Provider Id registration_status: anyOf: - $ref: '#/components/schemas/RegistrationStatus' - type: 'null' description: The status of the provider's registration example: account_shared invitation_status: anyOf: - $ref: '#/components/schemas/InvitationStatus' - type: 'null' description: The status of the provider's invitation example: application_submitted subscription_status: anyOf: - $ref: '#/components/schemas/SubscriptionBillingStatus' - type: 'null' description: The status of the provider's subscription example: activated id_verified: anyOf: - $ref: '#/components/schemas/IDVerifiedStatus' - type: 'null' description: The status of the provider's ID verification example: complete app_reqs: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: App Reqs description: The app_req_ids applied to this provider (may be filtered by query params) example: - id: f472da53-adee-4e5f-b59d-b2a51b63859a name: Doctor Recipe Initial status: inactive - id: dc867ba1-b0ab-409f-9d1e-aac90b61615e name: Master Recipe status: active last_wallet_shared: anyOf: - type: string format: date-time - type: 'null' title: Last Wallet Shared description: Timestamp of the most recent manual share by a provider last_share_refresh: anyOf: - type: string format: date-time - type: 'null' title: Last Share Refresh description: Timestamp of when all verification jobs were completed after share last_updated: anyOf: - type: string format: date-time - type: 'null' title: Last Updated description: Timestamp of when the last presentation change occurred last_task_completed_at: anyOf: - type: string format: date-time - type: 'null' title: Last Task Completed At description: Timestamp of when the last task was completed licenses: anyOf: - additionalProperties: items: additionalProperties: type: string type: object type: array type: object - type: 'null' title: Licenses description: An object containing verified dea and state licenses cycle_type: anyOf: - type: string - type: 'null' title: Cycle Type description: The provider's most recently completed cycle type example: Initial type: object required: - provider_id title: ProviderSearchResult StateLicenseSchema-Output: properties: state: type: string title: State example: PA license_number: type: string title: License Number example: AS1234 status: type: string title: Status example: Active board_actions: type: boolean title: Board Actions example: false type: object required: - state - license_number - status - board_actions title: StateLicenseSchema FacilitySchema: properties: id: type: string format: uuid title: Id example: 78e4081d-1150-4957-88a4-4558cafc505d name: type: string title: Name example: Medical Center West Dunshire status: anyOf: - $ref: '#/components/schemas/SubscriptionStatus' - type: 'null' example: active type: object required: - id - name title: FacilitySchema ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError Education: properties: verified.cfmg.initial_year: anyOf: - type: string - type: 'null' title: Verified.Cfmg.Initial Year description: The Educational Commission for Foreign Medical Graduates (ECFMG) graduation year verified.ecfmg.number: anyOf: - type: string - type: 'null' title: Verified.Ecfmg.Number description: The Educational Commission for Foreign Medical Graduates (ECFMG) number verified.ecfmg.issue_date: anyOf: - type: string - type: 'null' title: Verified.Ecfmg.Issue Date description: The Educational Commission for Foreign Medical Graduates (ECFMG) certificate issue date example: '2010-10-14' verified.education.country: anyOf: - type: string - type: 'null' title: Verified.Education.Country description: The country of the educational institution as verified by a primary source example: Dominican Republic verified.education.foreign: anyOf: - type: boolean - type: 'null' title: Verified.Education.Foreign description: Whether the education was verified by a foreign medical graduate certification source (e.g. ECFMG) example: true verified.university_transcript.year: anyOf: - type: integer - type: 'null' title: Verified.University Transcript.Year description: The graduation year as verified by a primary source example: 2004 verified.university_transcript.name: anyOf: - type: string - type: 'null' title: Verified.University Transcript.Name description: The name of the graduate school as verified by a primary source example: University of State College of Medicine verified.university_transcript.degree: anyOf: - type: string - type: 'null' title: Verified.University Transcript.Degree description: The medical school degree as verified by the primary source example: MD verified.university_transcript.complete: anyOf: - type: boolean - type: 'null' title: Verified.University Transcript.Complete description: Wether or not the degree has been completed as verified by the primary source example: true verified.university_transcript.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.University Transcript.Artifact description: Axuall University Transcript Proof artifact. This is usually an image of the masterfile pulled from AMA, or AOIA verified.university_transcript.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: The verified university transcript meta data information attested.nsc.code: anyOf: - type: string - type: 'null' title: Attested.Nsc.Code description: The National Student Clearinghouse (NSC) code as attested to by the practitioner example: '' verified.nsc.city: anyOf: - type: string - type: 'null' title: Verified.Nsc.City description: The National Student Clearinghouse (NSC) city example: Pittsburgh verified.nsc.state: anyOf: - type: string - type: 'null' title: Verified.Nsc.State description: The National Student Clearinghouse (NSC) state example: PA attested.university_transcript.graduation_month: anyOf: - type: string - type: 'null' title: Attested.University Transcript.Graduation Month description: The graduation month as attested to by the practitioner example: '03' attested.education.institution: anyOf: - type: string - type: 'null' title: Attested.Education.Institution description: The university institution as attested to by the practitioner example: University State College of Medicine attested.education.facility_code: anyOf: - type: string - type: 'null' title: Attested.Education.Facility Code description: The unviersity institution facility code as attested to by the practitioner example: '' attested.education.graduation_date: anyOf: - type: string - type: 'null' title: Attested.Education.Graduation Date description: The university graduation date as attested to by the practitioner example: 03/2005 attested.education.start_date: type: string title: Attested.Education.Start Date description: The university start date as attested to by the practitioner default: '' example: 03/2005 attested.education.start_date_full: anyOf: - type: string - type: 'null' title: Attested.Education.Start Date Full description: Full start date (YYYY-MM-DD) of education. The day defaults to the first day of the month when it is not provided. example: '2005-03-01' attested.education.end_date_full: anyOf: - type: string - type: 'null' title: Attested.Education.End Date Full description: Full graduation/end date (YYYY-MM-DD) of education, derived from graduation_year/graduation_month/graduation_day. The day defaults to the last day of the month when it is not provided, and to December 31st when only the year is known. example: '2005-03-31' attested.education.facility_city: anyOf: - type: string - type: 'null' title: Attested.Education.Facility City description: City of educational institution as attested to by the practitioner example: Cleveland attested.education.facility_state: anyOf: - type: string - type: 'null' title: Attested.Education.Facility State description: State of educational institution as attested to by the practitioner example: Ohio attested.education.degree_level: anyOf: - type: string - type: 'null' title: Attested.Education.Degree Level description: Undergraduate or Graduate degree level as attested to by the practitioner example: Undergraduate attested.education.external_type_code: anyOf: - type: string - type: 'null' title: Attested.Education.External Type Code description: The education type code held by the source system, for records imported from an external system example: vMED attested.education.foreign_education: anyOf: - type: boolean - type: 'null' title: Attested.Education.Foreign Education description: Is educational institution outside the US or Canada as attested by the practitioner example: true attested.education.nursing_program: anyOf: - type: boolean - type: 'null' title: Attested.Education.Nursing Program description: Is educational institution a nursing program as attested by the practitioner example: true verified.nsc.attendance_start_date: anyOf: - type: string - type: 'null' title: Verified.Nsc.Attendance Start Date description: The National Student Clearinghouse (NSC) start date as as verified by the primary source example: '' verified.nsc.attendance_end_date: anyOf: - type: string - type: 'null' title: Verified.Nsc.Attendance End Date description: The National Student Clearinghouse (NSC) end date as verified by the primary source example: '' verified.nsc.institution: anyOf: - type: string - type: 'null' title: Verified.Nsc.Institution description: The National Student Clearinghouse (NSC) institution name as verified by the primary source example: UNIVERSITY OF CHICAGO verified.nsc.degree: anyOf: - type: string - type: 'null' title: Verified.Nsc.Degree description: The National Student Clearinghouse (NSC) degree name as verified by the primary source example: DOCTOR OF MEDICINE verified.nsc.first_name: anyOf: - type: string - type: 'null' title: Verified.Nsc.First Name description: The National Student Clearinghouse (NSC) degree recipient's first name as verified by the primary source example: Jane verified.nsc.last_name: anyOf: - type: string - type: 'null' title: Verified.Nsc.Last Name description: The National Student Clearinghouse (NSC) degree recipient's last name as verified by the primary source example: Dough verified.nsc.status: anyOf: - type: string - type: 'null' title: Verified.Nsc.Status description: The National Student Clearinghouse (NSC) degree status as verified by the primary source example: Degree Awarded verified.nsc.award_date: anyOf: - type: string - type: 'null' title: Verified.Nsc.Award Date description: The National Student Clearinghouse (NSC) degree award date as verified by the primary source example: '2002-05-01' verified.nsc.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Nsc.Artifact description: The National Student Clearinghouse (NSC) artifact from the primary source verified.nsc.meta: anyOf: - $ref: '#/components/schemas/MetaData' - type: 'null' description: The verified National Student Clearinghouse (NSC) meta data information verified_dispute_details: anyOf: - type: string - type: 'null' title: Verified Dispute Details institution_id: anyOf: - type: string - type: 'null' title: Institution Id description: Axuall institution UUID for the educational institution education.external_institution_code: anyOf: - type: string - type: 'null' title: Education.External Institution Code description: External institution code from the external system external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group attested.education.meta: anyOf: - $ref: '#/components/schemas/AttestedMetaData' - type: 'null' description: The attested education meta data information readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object title: Education ProviderProfile: properties: first_name: anyOf: - type: string - type: 'null' title: First Name description: First name of provider example: Jane last_name: anyOf: - type: string - type: 'null' title: Last Name description: Last name of provider example: Dough date_of_birth: anyOf: - type: string format: date - type: 'null' title: Date Of Birth description: Provider's date of birth example: '1990-01-01' email: type: string format: email title: Email description: Provider's email example: jane.dough@email.com npi: anyOf: - type: string maxLength: 10 minLength: 10 title: National Provider Identifier description: National Provider Identifier example: '1234567890' - type: 'null' title: Npi ncsbn: anyOf: - type: string title: National Council of State Boards of Nursing description: National Council of State Boards of Nursing ID example: '12345678' - type: 'null' title: Ncsbn id_verified: anyOf: - $ref: '#/components/schemas/IDVerifiedStatus' - type: 'null' description: The status of the providers identification verification type: object title: ProviderProfile OngoingMonitoringOFAC: properties: verified.ofac.participation: type: boolean title: Verified.Ofac.Participation verified.ofac.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Ofac.Artifact verified.ofac.meta: $ref: '#/components/schemas/MetaData' verified.ofac.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Ofac.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.ofac.participation - verified.ofac.artifact - verified.ofac.meta title: OngoingMonitoringOFAC AppReqStatus: type: string enum: - active - inactive - pending title: AppReqStatus PayerEnrollmentStatus: properties: medicare_part_b: anyOf: - $ref: '#/components/schemas/PayerEnrollmentStatusMedicarePartB' - type: 'null' medicare_dme: anyOf: - $ref: '#/components/schemas/PayerEnrollmentStatusMedicareDME' - type: 'null' medicare_hha: anyOf: - $ref: '#/components/schemas/PayerEnrollmentStatusMedicareHHA' - type: 'null' medicare_pmd: anyOf: - $ref: '#/components/schemas/PayerEnrollmentStatusMedicarePMD' - type: 'null' type: object title: PayerEnrollmentStatus ProviderPrefillIdType: type: string enum: - NPI - NCSBN title: ProviderPrefillIdType TaskQuestion: properties: label: type: string title: Label description: Input identifier text: type: string title: Text description: The Question text default: '' answer: title: Answer description: The providers answer(s) to a given question. Answer type is dynamic, changes with the question type type: object required: - label title: TaskQuestion description: "Answer is dynamic, see following examples:\n\n{\n \"answer\": {\n \"last\": \"r\",\n \"first\": \"t\"\n }\n}\n\n{\n \"answer\": {\n \"city\": \"d\",\n \"state\": \"d\",\n \"postal\": \"d\",\n \"addr_line1\": \"d\",\n \"addr_line2\": \"d\"\n }\n}\n\n{\n \"answer\": \"Simple String\"\n}" AssignTaskRequestSchema: properties: dry_run: anyOf: - type: boolean - type: 'null' title: Dry Run description: Useful for testing purposes. When set to `true`, Axuall will not actually update data. default: false task_id: type: string format: uuid title: Task Id description: UUID of task example: a891a626-7b8e-4728-8731-c0b837916e49 required_for_share: anyOf: - type: boolean - type: 'null' title: Required For Share description: If true, require that the task be completed by the provider. default: false type: object required: - task_id title: AssignTaskRequestSchema ProviderPreviewSchema: properties: name: $ref: '#/components/schemas/NameSchema-Output' degree: anyOf: - type: string - type: 'null' title: Degree example: MD date_of_birth: anyOf: - type: string - type: 'null' title: Date Of Birth example: 01-05-1970 state_licenses: items: $ref: '#/components/schemas/StateLicenseSchema-Output' type: array title: State Licenses default: [] dea_licenses: items: $ref: '#/components/schemas/DEALicenseSchema' type: array title: Dea Licenses default: [] abms_board_certifications: items: $ref: '#/components/schemas/ABMSBoardCertSchema' type: array title: Abms Board Certifications default: [] type: object required: - name title: ProviderPreviewSchema OngoingMonitoringMedicare: properties: verified.medicare_participation.participation: type: boolean title: Verified.Medicare Participation.Participation verified.medicare_participation.artifact: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri title: Axuall Credential Artifact description: Expiring link to download evidence for a credential example: https://axuall-primary-source-artifacts.s3.amazonaws.com/s3%3A//axuall-primary-source-artifacts/2022-12-07/2d4bd584-3a08-436e-85e2-bf0491d16061.pdf?... - type: 'null' title: Verified.Medicare Participation.Artifact verified.medicare_participation.meta: $ref: '#/components/schemas/MetaData' verified.medicare_participation.dispute_details: anyOf: - type: string - type: 'null' title: Verified.Medicare Participation.Dispute Details external_file_name: anyOf: - type: string - type: 'null' title: External File Name description: Stored custom name of document as defined by the subscriber group readable_file_name: anyOf: - type: string - type: 'null' title: Readable File Name description: Client determined file naming convention type: object required: - verified.medicare_participation.participation - verified.medicare_participation.artifact - verified.medicare_participation.meta title: OngoingMonitoringMedicare securitySchemes: HTTPBearer: type: http scheme: bearer x-provenance: method: harvested publisher: Axuall source: https://api.axuall.net/openapi.json note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json); stamped by stamp-openapi-provenance.py (roadmap#793)