generated: '2026-09-27' method: derived generator: derive-data-model.py source: - openapi/axuall-openapi.json notation: has_one = property $ref; has_many = array of $ref; belongs_to = _id field summary: entities: 145 entities_in_spec: 145 relationships: 160 entities: - name: ABMSBoardCertSchema fields: 2 - name: ActorSettings fields: 3 - name: AddressDeduplicationRequestSchema fields: 3 description: Request body for POST /address_deduplications. - name: AddressDeduplicationSchema fields: 2 description: 'Completed result: the target and its ranked candidates, in request order.' - name: AddressDeduplicationStatusSchema fields: 4 description: The state of a dispatched run, with the ranked result once it completes. - name: AddressDeduplicationTaskSchema fields: 1 description: The dispatched task id, for polling GET /address_deduplications/{task_id}. - name: AddressSchema fields: 6 - name: AddressSchema-Output fields: 7 description: A loosely structured postal address. Every field is optional. - name: AffiliationSchema fields: 8 - name: AffiliationsAddress fields: 7 - name: AgentChatRequestSchema fields: 8 description: Request body for POST /agent/chat. - name: AgentChatResponseSchema fields: 1 description: 'Response for POST /agent/chat: Flow task id for polling GET /agent/task/{task_id}.' - name: AgentConversationItemSchema fields: 4 description: Single conversation in list response. - name: AgentConversationsListSchema fields: 2 description: Response for GET /agent/conversations. - name: AgentMessageFeedbackRequestSchema fields: 2 description: Request body for POST .../messages/{message_id}/feedback. - name: AgentMessageFeedbackResponseSchema fields: 2 description: Response after recording message feedback. - name: AgentMessageSchema fields: 7 description: Single message in a conversation. - name: AgentSuggestPromptItemSchema fields: 5 description: One suggested starter prompt for AI chat. - name: AgentSuggestPromptsListSchema fields: 1 description: Response for GET /agent/suggest-prompts. - name: AgentTaskStatusSchema fields: 4 description: Response for GET /agent/task/{task_id}. - name: ApplicationRequirementSchema fields: 4 - name: ApplicationRequirementsSchema fields: 1 - name: AssignTaskMessage fields: 1 - name: AssignTaskRequestSchema fields: 3 - name: AssignWorkflowMessage fields: 1 - name: AssignWorkflowRequestSchema fields: 2 - name: AssignedTaskSchema fields: 8 - name: AttestedMetaData fields: 2 - name: AttestedReq fields: 7 - name: AttestedRequirementSchema fields: 1 - name: AuthError fields: 2 - name: AuthRequest fields: 4 - name: AuthResponse fields: 4 description: Authentication response contains a token which is valid for 24 hours - name: BasicInfo fields: 29 - name: BoardCertification fields: 24 - name: BoardCertificationSchema fields: 2 - name: CDSLicense fields: 14 description: Controlled Dangerous Substance (CDS) License information. - name: CancelTaskRequestSchema fields: 2 - name: Changes fields: 2 - name: ClinicianIdSchema fields: 2 description: One client-supplied clinician ID, optionally scoped to an external system. - name: ClinicianSettingsSchema fields: 6 - name: CredentialChange fields: 5 - name: CredentialDimensionOption fields: 3 - name: DEALicense fields: 19 description: DEA license information. - name: DEALicenseSchema fields: 2 - name: DeactivationSchema fields: 1 - name: Disclosures fields: 84 - name: Document fields: 9 - name: Education fields: 43 - name: EducationEntry fields: 6 - name: Expirable fields: 10 - name: FacilitiesSchema fields: 1 - name: FacilityEnrollmentReponse fields: 2 - name: FacilityEnrollmentSchema fields: 2 - name: FacilitySchema fields: 3 - name: Finding fields: 8 - name: FsmbBoardActionsV2 fields: 11 - name: FsmbDataV2 fields: 2 - name: FsmbDemographics fields: 5 - name: FsmbLicenseData fields: 9 description: State medical license information. This information has been verified using the - name: GenericErrorSchema fields: 1 - name: HTTPValidationError fields: 1 - name: HomeAddress fields: 6 - name: HospitalAffiliation fields: 30 - name: InviteExternalDelegateSchema fields: 1 description: Optional external delegate assigned during Admin Invite Clinician. - name: InviteSchema fields: 1 - name: LifeSupport fields: 10 - name: LifeSupportSchema fields: 1 - name: Malpractice fields: 3 - name: MalpracticePolicy fields: 14 - name: MedicaidID fields: 3 - name: MedicareID fields: 10 - name: MetaData fields: 6 - name: MonitoringProfile fields: 9 - name: MonitoringResultSet_Expirable_ fields: 4 - name: MonitoringResultSet_Finding_ fields: 4 - name: NPIID fields: 7 description: National Provider Identification (NPI) verified information - name: NameSchema-Input fields: 4 - name: NameSchema-Output fields: 4 - name: OngoingMonitoring fields: 7 - name: OngoingMonitoringFindingsReported fields: 6 - name: OngoingMonitoringHHS fields: 6 - name: OngoingMonitoringMedicaid fields: 7 - name: OngoingMonitoringMedicare fields: 6 - name: OngoingMonitoringNPDB fields: 19 - name: OngoingMonitoringOFAC fields: 6 - name: OngoingMonitoringSAM fields: 6 - name: OtherCertifications fields: 21 - name: OtherIDs fields: 3 - name: PaginatedResultsSchema_AssignedTaskSchema_ fields: 2 - name: PaginatedResultsSchema_SubscriberGroupTaskSchema_ fields: 2 - name: PaginatedResultsSchema_TaskSetSchema_ fields: 2 - name: PayerEnrollmentStatus fields: 4 - name: PayerEnrollmentStatusMedicareDME fields: 6 - name: PayerEnrollmentStatusMedicareHHA fields: 6 - name: PayerEnrollmentStatusMedicarePMD fields: 6 - name: PayerEnrollmentStatusMedicarePartB fields: 6 - name: ProfessionalIDs fields: 4 - name: ProviderFile fields: 9 - name: ProviderPrefillDemographicsSchema fields: 6 - name: ProviderPrefillIdentifiersSchema fields: 4 - name: ProviderPrefillSchema fields: 4 - name: ProviderPreviewSchema fields: 6 - name: ProviderProfile fields: 7 - name: ProviderRegistrationMessage fields: 1 - name: ProviderRegistrationRequestSchema fields: 27 - name: ProviderSearchResult fields: 17 - name: RankedAddressSchema fields: 10 description: One candidate with the ranking the agent gave it. - name: Reference fields: 10 - name: RelatedTaskSchema fields: 2 - name: Response_ApplicationRequirementsSchema_ fields: 2 - name: Response_AssignTaskMessage_ fields: 2 - name: Response_AssignWorkflowMessage_ fields: 2 - name: Response_AttestedRequirementSchema_ fields: 2 - name: Response_DeactivationSchema_ fields: 2 - name: Response_FacilitiesSchema_ fields: 2 - name: Response_InviteSchema_ fields: 2 - name: Response_ProviderRegistrationMessage_ fields: 2 - name: Response_SSOResponse_ fields: 2 - name: Response_ShareData_ fields: 2 - name: Response_WalletActor_ fields: 2 - name: SSOResponse fields: 1 - name: SelfAttestedChange fields: 4 - name: SendInviteRequestSchema fields: 21 - name: ShareData fields: 24 - name: StateLicense fields: 23 description: State medical license information. This information has been verified using the - name: StateLicenseSchema-Input fields: 2 - name: StateLicenseSchema-Output fields: 4 - name: SubscriberGroupTaskSchema fields: 7 - name: Supplemental fields: 0 description: Collection of supplemental questions gathered from the practitioner - name: Task fields: 5 - name: TaskQuestion fields: 3 description: 'Answer is dynamic, see following examples:' - name: TaskResponse fields: 5 - name: TaskSetSchema fields: 3 - name: Training fields: 7 - name: TrainingProgram fields: 28 - name: UniversityTranscriptSchema fields: 4 - name: ValidationError fields: 3 - name: Verification fields: 5 - name: VerifiedWorkHistoryAddress fields: 5 - name: WalletActor fields: 9 - name: WorkHistory fields: 39 - name: WorkHistoryAddress fields: 7 - name: WorkHistorySchema fields: 7 - name: app__routes__address_deduplications__AddressSchema fields: 7 description: A loosely structured postal address. Every field is optional. relationships: - from: AddressDeduplicationRequestSchema to: app__routes__address_deduplications__AddressSchema type: has_one via: target - from: AddressDeduplicationRequestSchema to: app__routes__address_deduplications__AddressSchema type: has_many via: candidates - from: AddressDeduplicationSchema to: AddressSchema-Output type: has_one via: target - from: AddressDeduplicationSchema to: RankedAddressSchema type: has_many via: candidates - from: AddressDeduplicationStatusSchema to: Task type: belongs_to via: task_id - from: AddressDeduplicationStatusSchema to: AddressDeduplicationSchema type: has_one via: result - from: AddressDeduplicationTaskSchema to: Task type: belongs_to via: task_id - from: AffiliationSchema to: WorkHistory type: belongs_to via: work_history_id - from: AffiliationSchema to: AffiliationsAddress type: has_one via: address - from: AgentChatResponseSchema to: Task type: belongs_to via: task_id - from: AgentConversationsListSchema to: AgentConversationItemSchema type: has_many via: conversations - from: AgentSuggestPromptsListSchema to: AgentSuggestPromptItemSchema type: has_many via: suggest_prompts - from: ApplicationRequirementsSchema to: ApplicationRequirementSchema type: has_many via: app_reqs - from: AssignTaskRequestSchema to: Task type: belongs_to via: task_id - from: AssignedTaskSchema to: Task type: belongs_to via: task_id - from: BasicInfo to: MetaData type: has_one via: verified.axuall_id.meta - from: BoardCertification to: MetaData type: has_one via: verified.board_certification.meta - from: CDSLicense to: MetaData type: has_one via: verified.cds.meta - from: CDSLicense to: AttestedMetaData type: has_one via: attested.cds.meta - from: CancelTaskRequestSchema to: Task type: belongs_to via: task_id - from: Changes to: CredentialChange type: has_many via: credential_changes - from: Changes to: SelfAttestedChange type: has_many via: self_attested_changes - from: DEALicense to: MetaData type: has_one via: verified.dea.meta - from: DEALicense to: AttestedMetaData type: has_one via: attested.dea.meta - from: Disclosures to: Document type: has_one via: attested.caqh|licensure.revoked.document - from: Disclosures to: Document type: has_one via: attested.caqh|licensure.challenged.document - from: Disclosures to: Document type: has_one via: attested.caqh|privileges.revoked.document - from: Disclosures to: Document type: has_one via: attested.caqh|privileges.surrendered.document - from: Disclosures to: Document type: has_one via: attested.caqh|privileges.terminated.document - from: Disclosures to: Document type: has_one via: attested.caqh|education.probation.document - from: Disclosures to: Document type: has_one via: attested.caqh|education.withdrawn.document - from: Disclosures to: Document type: has_one via: attested.caqh|education.revoked.document - from: Disclosures to: Document type: has_one via: attested.caqh|education.surrendered.document - from: Disclosures to: Document type: has_one via: attested.caqh|dea.revoked.document - from: Disclosures to: Document type: has_one via: attested.caqh|medicare.excluded.document - from: Disclosures to: Document type: has_one via: attested.caqh|sanctions.investigation.document - from: Disclosures to: Document type: has_one via: attested.caqh|sanctions.npdb.document - from: Disclosures to: Document type: has_one via: attested.caqh|sanctions.sanctioned.document - from: Disclosures to: Document type: has_one via: attested.caqh|sanctions.misconduct.document - from: Disclosures to: Document type: has_one via: attested.caqh|sanctions.military.document - from: Disclosures to: Document type: has_one via: attested.caqh|liability.canceled.document - from: Disclosures to: Document type: has_one via: attested.caqh|liability.surcharge.document - from: Disclosures to: Document type: has_one via: attested.caqh|malpractice.actions.document - from: Disclosures to: Document type: has_one via: attested.caqh|criminal.felony.document - from: Disclosures to: Document type: has_one via: attested.caqh|criminal.misdemeanor.document - from: Disclosures to: Document type: has_one via: attested.caqh|criminal.court-martial.document - from: Disclosures to: Document type: has_one via: attested.caqh|ability.drugs.document - from: Disclosures to: Document type: has_one via: attested.caqh|ability.chemicals.document - from: Disclosures to: Document type: has_one via: attested.caqh|ability.risk.document - from: Disclosures to: Document type: has_one via: attested.caqh|ability.unable.document - from: Disclosures to: Document type: has_one via: attested.caqh|military.military.document - from: Disclosures to: Document type: has_one via: attested.caqh|military.former.document - from: Document to: MetaData type: has_one via: meta - from: Education to: MetaData type: has_one via: verified.university_transcript.meta - from: Education to: MetaData type: has_one via: verified.nsc.meta - from: Education to: AttestedMetaData type: has_one via: attested.education.meta - from: Expirable to: MonitoringProfile type: has_one via: profile - from: Expirable to: Verification type: has_one via: verification - from: FacilitiesSchema to: FacilitySchema type: has_many via: facilities - from: Finding to: MonitoringProfile type: has_one via: profile - from: Finding to: Verification type: has_one via: verification - from: FsmbDataV2 to: FsmbDemographics type: has_one via: demographics - from: FsmbLicenseData to: MetaData type: has_one via: meta - from: HTTPValidationError to: ValidationError type: has_many via: detail - from: HospitalAffiliation to: AttestedMetaData type: has_one via: attested.affiliations.meta - from: HospitalAffiliation to: MetaData type: has_one via: verified_hospital_affiliations.meta - from: LifeSupport to: MetaData type: has_one via: verified.life_support.meta - from: Malpractice to: MalpracticePolicy type: has_many via: policies - from: MalpracticePolicy to: AttestedMetaData type: has_one via: attested_meta - from: MedicaidID to: AttestedMetaData type: has_one via: attested.medicaid.attested_meta - from: MedicareID to: MetaData type: has_one via: verified.medicare.meta - from: MedicareID to: AttestedMetaData type: has_one via: attested.medicare.meta - from: MonitoringResultSet_Expirable_ to: Expirable type: has_many via: results - from: MonitoringResultSet_Finding_ to: Finding type: has_many via: results - from: NPIID to: MetaData type: has_one via: verified.npi.meta - from: OngoingMonitoring to: OngoingMonitoringNPDB type: has_many via: npdb - from: OngoingMonitoring to: OngoingMonitoringHHS type: has_one via: hhs_oig - from: OngoingMonitoring to: OngoingMonitoringMedicaid type: has_many via: medicaid - from: OngoingMonitoring to: OngoingMonitoringMedicare type: has_one via: medicare_participation - from: OngoingMonitoring to: OngoingMonitoringSAM type: has_one via: sam_participation - from: OngoingMonitoring to: OngoingMonitoringOFAC type: has_one via: ofac - from: OngoingMonitoring to: OngoingMonitoringFindingsReported type: has_one via: monitoring - from: OngoingMonitoringFindingsReported to: MetaData type: has_one via: verified.monitoring.meta - from: OngoingMonitoringHHS to: MetaData type: has_one via: verified.hhs_oig.meta - from: OngoingMonitoringMedicaid to: MetaData type: has_one via: verified.medicaid.meta - from: OngoingMonitoringMedicare to: MetaData type: has_one via: verified.medicare_participation.meta - from: OngoingMonitoringNPDB to: MetaData type: has_one via: verified.npdb.meta - from: OngoingMonitoringOFAC to: MetaData type: has_one via: verified.ofac.meta - from: OngoingMonitoringSAM to: MetaData type: has_one via: verified.sam_participation.meta - from: OtherIDs to: MedicareID type: has_one via: medicare - from: OtherIDs to: MedicaidID type: has_one via: medicaid - from: OtherIDs to: NPIID type: has_one via: npi - from: PaginatedResultsSchema_AssignedTaskSchema_ to: AssignedTaskSchema type: has_many via: results - from: PaginatedResultsSchema_SubscriberGroupTaskSchema_ to: SubscriberGroupTaskSchema type: has_many via: results - from: PaginatedResultsSchema_TaskSetSchema_ to: TaskSetSchema type: has_many via: results - from: PayerEnrollmentStatus to: PayerEnrollmentStatusMedicarePartB type: has_one via: medicare_part_b - from: PayerEnrollmentStatus to: PayerEnrollmentStatusMedicareDME type: has_one via: medicare_dme - from: PayerEnrollmentStatus to: PayerEnrollmentStatusMedicareHHA type: has_one via: medicare_hha - from: PayerEnrollmentStatus to: PayerEnrollmentStatusMedicarePMD type: has_one via: medicare_pmd - from: PayerEnrollmentStatusMedicareDME to: MetaData type: has_one via: verified.participation_reported.meta - from: PayerEnrollmentStatusMedicareHHA to: MetaData type: has_one via: verified.participation_reported.meta - from: PayerEnrollmentStatusMedicarePMD to: MetaData type: has_one via: verified.participation_reported.meta - from: PayerEnrollmentStatusMedicarePartB to: MetaData type: has_one via: verified.participation_reported.meta - from: ProfessionalIDs to: StateLicense type: has_many via: state_licenses - from: ProfessionalIDs to: DEALicense type: has_many via: dea - from: ProfessionalIDs to: CDSLicense type: has_many via: cds - from: ProviderPrefillSchema to: ProviderPrefillDemographicsSchema type: has_one via: demographics - from: ProviderPrefillSchema to: ProviderPrefillIdentifiersSchema type: has_one via: identifiers - from: ProviderPrefillSchema to: FacilitySchema type: has_many via: facilities - from: ProviderPreviewSchema to: NameSchema-Output type: has_one via: name - from: ProviderPreviewSchema to: StateLicenseSchema-Output type: has_many via: state_licenses - from: ProviderPreviewSchema to: DEALicenseSchema type: has_many via: dea_licenses - from: ProviderPreviewSchema to: ABMSBoardCertSchema type: has_many via: abms_board_certifications - from: ProviderRegistrationRequestSchema to: AddressSchema type: has_one via: address - from: ProviderRegistrationRequestSchema to: UniversityTranscriptSchema type: has_one via: university_transcript - from: Reference to: AttestedMetaData type: has_one via: attested.references.meta - from: RelatedTaskSchema to: Task type: belongs_to via: task_id - from: Response_ApplicationRequirementsSchema_ to: ApplicationRequirementsSchema type: has_one via: data - from: Response_AssignTaskMessage_ to: AssignTaskMessage type: has_one via: data - from: Response_AssignWorkflowMessage_ to: AssignWorkflowMessage type: has_one via: data - from: Response_AttestedRequirementSchema_ to: AttestedRequirementSchema type: has_one via: data - from: Response_DeactivationSchema_ to: DeactivationSchema type: has_one via: data - from: Response_FacilitiesSchema_ to: FacilitiesSchema type: has_one via: data - from: Response_InviteSchema_ to: InviteSchema type: has_one via: data - from: Response_ProviderRegistrationMessage_ to: ProviderRegistrationMessage type: has_one via: data - from: Response_SSOResponse_ to: SSOResponse type: has_one via: data - from: Response_ShareData_ to: ShareData type: has_one via: data - from: Response_WalletActor_ to: WalletActor type: has_one via: data - from: SendInviteRequestSchema to: ClinicianSettingsSchema type: has_one via: settings - from: ShareData to: BasicInfo type: has_one via: basic_info - from: ShareData to: HomeAddress type: has_one via: home_address - from: ShareData to: ProfessionalIDs type: has_one via: professional_ids - from: ShareData to: OtherIDs type: has_one via: other_ids - from: ShareData to: BoardCertification type: has_many via: board_certifications - from: ShareData to: OtherCertifications type: has_one via: other_certifications - from: ShareData to: HospitalAffiliation type: has_many via: hospital_affiliations - from: ShareData to: WorkHistory type: has_many via: work_history - from: ShareData to: Reference type: has_many via: references - from: ShareData to: Malpractice type: has_one via: malpractice_insurance - from: ShareData to: Disclosures type: has_one via: disclosures - from: ShareData to: Supplemental type: has_one via: supplemental - from: ShareData to: Document type: has_many via: documents - from: ShareData to: Document type: has_many via: signatures - from: ShareData to: OngoingMonitoring type: has_one via: ongoing_monitoring - from: ShareData to: LifeSupport type: has_many via: life_support - from: ShareData to: FsmbDataV2 type: has_one via: fsmb_info - from: ShareData to: PayerEnrollmentStatus type: has_one via: payer_enrollment_status - from: ShareData to: TaskResponse type: has_many via: task_responses - from: StateLicense to: MetaData type: has_one via: verified.state_license.meta - from: StateLicense to: AttestedMetaData type: has_one via: attested.state_license.meta - from: Task to: Document type: has_many via: documents - from: Task to: TaskQuestion type: has_many via: questions - from: TaskSetSchema to: RelatedTaskSchema type: has_many via: tasks - from: TrainingProgram to: MetaData type: has_one via: verified.training.meta - from: TrainingProgram to: AttestedMetaData type: has_one via: attested.training.meta - from: WalletActor to: ActorSettings type: has_one via: settings - from: WorkHistory to: AttestedMetaData type: has_one via: attested.work_history.meta - from: WorkHistory to: VerifiedWorkHistoryAddress type: has_one via: verified.work_number.address - from: WorkHistory to: MetaData type: has_one via: verified.work_number.meta - from: WorkHistorySchema to: WorkHistoryAddress type: has_one via: address