{"openapi":"3.1.0","info":{"title":"Health Harbor","description":"\nHealth Harbor's API handles calls to insurance for your providers so you don't have to.\n\nThis simple API supports a few operations:\n* **Create an inquiry** to call insurance for a provider.\n* **Read an inquiry** to get the status and results for a previously submitted inquiry.\n\nEach operation is supported in bulk or individually. In addition to typical patient and practice information needed to complete an inquiry, each operation also supports:\n* an 'external_id' parameter which you can define and pass in with your creation request. This is useful for tracking a specific subgroup of inquiries. For instance, you can assign a unique external id to all inquiries for a specific provider on your platform.\n\nFor example, the most common use case is to request benefits for certain procedure codes for a patient. You can do this by creating an inquiry with the patient's insurance information, the provider's information, and the procedure codes you want to check along with CODE_LOOKUP_BENEFITS as the query. We will then check benefits for those procedure codes and return the results to you.\n\nWe've also started creating customized queries for our customers so they can specify certain follow-up questions or specific information they want outside the scope of a typical benefits request. Contact alan@healthharbor.co, and we'll set one up for you.\n\n","termsOfService":"https://docs.google.com/document/d/1sOPgtPktx4YWc-p5YXWIztGEWusDG4wsP_txWhjpwNw/edit?usp=sharing","contact":{"name":"Support","email":"support@healthharbor.co"},"version":"0.1.0"},"paths":{"/api/v0/auth/token":{"post":{"summary":"Login For Access Token","operationId":"login_for_access_token_api_v0_auth_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_for_access_token_api_v0_auth_token_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/medical/inquiries":{"get":{"summary":"Get Medical Inquiries","operationId":"get_medical_inquiries_api_v0_medical_inquiries_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":200,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalMedicalInquiry"},"title":"Response Get Medical Inquiries Api V0 Medical Inquiries Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Medical Inquiry","operationId":"create_medical_inquiry_api_v0_medical_inquiries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMedicalInquiryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquiryCreationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/medical/inquiries/{id}":{"get":{"summary":"Get Medical Inquiry","operationId":"get_medical_inquiry_api_v0_medical_inquiries__id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMedicalInquiry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Medical Inquiry","operationId":"delete_medical_inquiry_api_v0_medical_inquiries__id__delete","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquiryDeletionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/medical/batch_inquiries":{"post":{"summary":"Create Medical Inquiries","operationId":"create_medical_inquiries_api_v0_medical_batch_inquiries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalMedicalInquiryRequest"},"title":"New Inquiries"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InquiryCreationResponse"},"title":"Response Create Medical Inquiries Api V0 Medical Batch Inquiries Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/dental/inquiries":{"get":{"summary":"Get Dental Inquiries","operationId":"get_dental_inquiries_api_v0_dental_inquiries_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":200,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDentalInquiry"},"title":"Response Get Dental Inquiries Api V0 Dental Inquiries Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Dental Inquiry","operationId":"create_dental_inquiry_api_v0_dental_inquiries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDentalInquiryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquiryCreationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/dental/inquiries/{id}":{"get":{"summary":"Get Dental Inquiry","operationId":"get_dental_inquiry_api_v0_dental_inquiries__id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDentalInquiry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Dental Inquiry","operationId":"delete_dental_inquiry_api_v0_dental_inquiries__id__delete","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquiryDeletionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/dental/batch_inquiries":{"post":{"summary":"Create Dental Inquiries","operationId":"create_dental_inquiries_api_v0_dental_batch_inquiries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalDentalInquiryRequest"},"title":"New Inquiries"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InquiryCreationResponse"},"title":"Response Create Dental Inquiries Api V0 Dental Batch Inquiries Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/subscription/":{"get":{"summary":"Get Subscriptions","operationId":"get_subscriptions_api_v0_subscription__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}]},"post":{"summary":"Set Or Update Subscription","operationId":"set_or_update_subscription_api_v0_subscription__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCreationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}]},"delete":{"summary":"Delete Subscription","operationId":"delete_subscription_api_v0_subscription__delete","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}]}},"/api/v0/mental_health/inquiries":{"get":{"summary":"Get Mental Health Inquiries","operationId":"get_mental_health_inquiries_api_v0_mental_health_inquiries_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":200,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalMentalHealthInquiry"},"title":"Response Get Mental Health Inquiries Api V0 Mental Health Inquiries Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Mental Health Inquiry","operationId":"create_mental_health_inquiry_api_v0_mental_health_inquiries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMentalHealthInquiryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquiryCreationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/mental_health/inquiries/{id}":{"get":{"summary":"Get Mental Health Inquiry","operationId":"get_mental_health_inquiry_api_v0_mental_health_inquiries__id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMentalHealthInquiry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Mental Health Inquiry","operationId":"delete_mental_health_inquiry_api_v0_mental_health_inquiries__id__delete","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquiryDeletionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/mental_health/batch_inquiries":{"post":{"summary":"Create Mental Health Inquiries","operationId":"create_mental_health_inquiries_api_v0_mental_health_batch_inquiries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalMentalHealthInquiryRequest"},"title":"New Inquiries"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InquiryCreationResponse"},"title":"Response Create Mental Health Inquiries Api V0 Mental Health Batch Inquiries Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/patient-calls/call":{"post":{"summary":"Create Patient Call","operationId":"create_patient_call_api_v0_patient_calls_call_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalPatientCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientCallCreationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/patient-calls/batch-calls":{"post":{"summary":"Create Patient Batch Calls","operationId":"create_patient_batch_calls_api_v0_patient_calls_batch_calls_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalPatientCallRequest"},"title":"New Calls"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatientCallCreationResponse"},"title":"Response Create Patient Batch Calls Api V0 Patient Calls Batch Calls Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/patient-calls/calls/":{"get":{"summary":"Get Patient Calls","operationId":"get_patient_calls_api_v0_patient_calls_calls__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":200,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalPatientCall"},"title":"Response Get Patient Calls Api V0 Patient Calls Calls  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/patient-calls/calls/{id}":{"get":{"summary":"Get Patient Call","operationId":"get_patient_call_api_v0_patient_calls_calls__id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalPatientCall"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Patient Call","operationId":"delete_patient_call_api_v0_patient_calls_calls__id__delete","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientCallDeletionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/knowledge_entries":{"get":{"summary":"Get Knowledge Entries","description":"List knowledge entries for your team, optionally scoped to one practice.","operationId":"get_knowledge_entries_api_v0_inbound_calls_knowledge_entries_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"practice_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeBank"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Knowledge Entry","description":"Create a knowledge entry the assistant may answer callers from.\n\nPass resolved_gap_ids to close the gaps this entry answers in the same\ncall.","operationId":"create_knowledge_entry_api_v0_inbound_calls_knowledge_entries_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeEntryCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeEntry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/knowledge_entries/{entry_id}":{"get":{"summary":"Get Knowledge Entry","description":"Fetch a single knowledge entry belonging to your team.","operationId":"get_knowledge_entry_api_v0_inbound_calls_knowledge_entries__entry_id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"entry_id","in":"path","required":true,"schema":{"type":"string","title":"Entry Id"}},{"name":"practice_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeEntry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Knowledge Entry","description":"Update a knowledge entry's text or scope.\n\nAn omitted question or answer keeps its current value, but scope is a full\nreplacement: leave practice_id out and the entry widens to the whole\norganization. Pass resolved_gap_ids to close the gaps this entry answers\nin the same call.","operationId":"update_knowledge_entry_api_v0_inbound_calls_knowledge_entries__entry_id__put","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"entry_id","in":"path","required":true,"schema":{"type":"string","title":"Entry Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeEntryUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeEntry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Knowledge Entry","description":"Delete a knowledge entry.","operationId":"delete_knowledge_entry_api_v0_inbound_calls_knowledge_entries__entry_id__delete","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"entry_id","in":"path","required":true,"schema":{"type":"string","title":"Entry Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeEntryDeletionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/knowledge_gaps":{"get":{"summary":"Get Knowledge Gaps","description":"List questions callers asked that no knowledge entry answers.\n\nOnly OPEN gaps come back by default, since a gap already marked ANSWERED\nor DISMISSED needs no further action. Pass show_resolved=true to see those\ntoo.","operationId":"get_knowledge_gaps_api_v0_inbound_calls_knowledge_gaps_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"practice_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id"}},{"name":"show_resolved","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Show Resolved"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalKnowledgeGap"},"title":"Response Get Knowledge Gaps Api V0 Inbound Calls Knowledge Gaps Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/knowledge_gaps/{gap_id}/dismiss":{"post":{"summary":"Dismiss Knowledge Gap","description":"Dismiss a knowledge gap that does not need an answer.\n\nAnswering a gap goes the other way round: name it in resolved_gap_ids when\nyou create or update the entry that covers it. Gaps cannot be reopened —\nOPEN is set only by post-call processing when an unanswered question first\nappears.","operationId":"dismiss_knowledge_gap_api_v0_inbound_calls_knowledge_gaps__gap_id__dismiss_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"gap_id","in":"path","required":true,"schema":{"type":"string","title":"Gap Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalKnowledgeGap"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/appointment_categories":{"get":{"summary":"Get Appointment Categories","description":"List appointment categories for your team, optionally including inactive ones.","operationId":"get_appointment_categories_api_v0_inbound_calls_appointment_categories_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"include_inactive","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Inactive"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAppointmentCategory"},"title":"Response Get Appointment Categories Api V0 Inbound Calls Appointment Categories Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Create Appointment Category","description":"Create an appointment category.","operationId":"create_appointment_category_api_v0_inbound_calls_appointment_categories_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategoryCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/appointment_categories/{category_id}":{"get":{"summary":"Get Appointment Category","description":"Fetch a single appointment category belonging to your team.","operationId":"get_appointment_category_api_v0_inbound_calls_appointment_categories__category_id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Appointment Category","description":"Update an appointment category. Omitted fields keep their current value.\n\nSetting is_active=false retires the category without deleting it; DELETE removes it outright.","operationId":"update_appointment_category_api_v0_inbound_calls_appointment_categories__category_id__put","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategoryUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Appointment Category","description":"Permanently delete an appointment category.\n\nTo retire a category while keeping its record, PUT is_active=false instead.","operationId":"delete_appointment_category_api_v0_inbound_calls_appointment_categories__category_id__delete","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentCategoryDeletionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/appointment_categories/{category_id}/activate":{"post":{"summary":"Activate Appointment Category","description":"Mark an appointment category active so callers can book it again.","operationId":"activate_appointment_category_api_v0_inbound_calls_appointment_categories__category_id__activate_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/appointment_categories/{category_id}/deactivate":{"post":{"summary":"Deactivate Appointment Category","description":"Retire an appointment category from booking while keeping its record.","operationId":"deactivate_appointment_category_api_v0_inbound_calls_appointment_categories__category_id__deactivate_post","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAppointmentCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/inbound_calls/organization_info":{"get":{"summary":"Get Organization Info","description":"Get organization and practice information for context injection.","operationId":"get_organization_info_api_v0_inbound_calls_organization_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalOrganizationInfo"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}]},"put":{"summary":"Update Organization Info","description":"Replace organization and practice information for context injection.\n\nEvery field is required: the payload replaces the stored record rather than\npatching it, so a caller changing one field reads the current info first.","operationId":"update_organization_info_api_v0_inbound_calls_organization_info_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalOrganizationInfo"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalOrganizationInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}]}},"/api/v0/transcript/{call_log_id}":{"get":{"summary":"Get Transcript Presigned Url","description":"Generate a presigned URL for accessing a transcript file and redirect to it.\n\nThis endpoint:\n1. Finds the transcript file for the given call_log_id\n2. Generates a presigned URL that lasts 1 hour\n3. Redirects to the presigned URL (or returns JSON if json=true)\n\nArgs:\n    call_log_id: The call log ID for which to retrieve the transcript\n    user: Authenticated user (required)\n    json: If True, return JSON response instead of redirecting (default: False)\n\nReturns:\n    Redirect to presigned URL (default) or JSON with the presigned URL (if json=true)\n\nRaises:\n    HTTPException: If the transcript is not found or cannot be accessed","operationId":"get_transcript_presigned_url_api_v0_transcript__call_log_id__get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"call_log_id","in":"path","required":true,"schema":{"type":"string","title":"Call Log Id"}},{"name":"json","in":"query","required":false,"schema":{"type":"boolean","description":"Return JSON instead of redirecting to the presigned URL","default":false,"title":"Json"},"description":"Return JSON instead of redirecting to the presigned URL"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/verification":{"get":{"tags":["Transcripts"],"summary":"Get transcript verifications","description":"Get transcript verification results for an inquiry. This endpoint retrieves all transcript verification results for a given inquiry, including verifications from all associated call logs.","operationId":"get_transcript_verifications_api_v0_verification_get","security":[{"OAuth2PasswordBearer":[]},{"HTTPBasic":[]}],"parameters":[{"name":"inquiry_id","in":"query","required":true,"schema":{"type":"string","description":"Inquiry ID to get all verifications for","title":"Inquiry Id"},"description":"Inquiry ID to get all verifications for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptVerificationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/debug/recent":{"get":{"summary":"Get Recent Conversations","operationId":"get_recent_conversations_debug_recent_get","security":[{"LoginManager":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/copilot/skip_the_line":{"get":{"summary":"Skip The Line","operationId":"skip_the_line_copilot_skip_the_line_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/copilot/mental_health_callbacks":{"get":{"summary":"Mental Health Callbacks","operationId":"mental_health_callbacks_copilot_mental_health_callbacks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/copilot/new_anon_call":{"post":{"summary":"Place New Call","operationId":"place_new_call_copilot_new_anon_call_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewCallRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/copilot/new_anon_call_mental_health":{"post":{"summary":"Place New Call Mental Health","operationId":"place_new_call_mental_health_copilot_new_anon_call_mental_health_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NewCallRequestV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/copilot/buy_calls":{"get":{"summary":"Buy Calls","operationId":"buy_calls_copilot_buy_calls_get","parameters":[{"name":"phone_number","in":"query","required":true,"schema":{"type":"string","title":"Phone Number"}},{"name":"bulk","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Bulk"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/copilot/stripe_webhook":{"post":{"summary":"Webhooks","operationId":"webhooks_copilot_stripe_webhook_post","parameters":[{"name":"stripe-signature","in":"header","required":false,"schema":{"type":"string","title":"Stripe-Signature"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/manual_calls/new_call/{inquiry_id}":{"get":{"summary":"New Call","operationId":"new_call_manual_calls_new_call__inquiry_id__get","security":[{"LoginManager":[]}],"parameters":[{"name":"inquiry_id","in":"path","required":true,"schema":{"type":"string","title":"Inquiry Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"New Call Post","operationId":"new_call_post_manual_calls_new_call__inquiry_id__post","security":[{"LoginManager":[]}],"parameters":[{"name":"inquiry_id","in":"path","required":true,"schema":{"type":"string","title":"Inquiry Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/continuous_copilot/dashboard":{"get":{"summary":"Dashboard","description":"Route to display the dashboard showing status of all representatives","operationId":"dashboard_continuous_copilot_dashboard_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"LoginManager":[]}]}},"/continuous_copilot/representative_portal":{"get":{"summary":"Representative Portal","description":"Route to display the representative's portal with clock in/out buttons","operationId":"representative_portal_continuous_copilot_representative_portal_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"LoginManager":[]}]}},"/continuous_copilot/mark_completed":{"post":{"summary":"Mark Completed","description":"Handle marking current inquiry as completed successfully","operationId":"mark_completed_continuous_copilot_mark_completed_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"LoginManager":[]}]}},"/continuous_copilot/mark_callback_required":{"post":{"summary":"Mark Callback","description":"Handle marking current inquiry as needing callback","operationId":"mark_callback_continuous_copilot_mark_callback_required_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"LoginManager":[]}]}},"/continuous_copilot/start_waiting_for_next_call":{"post":{"summary":"Start Waiting For Next Call","description":"Handle representative clocking in. Sets current inquiry to done and goes to next.","operationId":"start_waiting_for_next_call_continuous_copilot_start_waiting_for_next_call_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"LoginManager":[]}]}},"/continuous_copilot/clock_out":{"post":{"summary":"Clock Out","description":"Handle representative clocking out","operationId":"clock_out_continuous_copilot_clock_out_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"LoginManager":[]}]}},"/bcbs_lookup/":{"get":{"summary":"Bcbs Lookup Page","description":"Display the BCBS lookup webpage.","operationId":"bcbs_lookup_page_bcbs_lookup__get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/bcbs_lookup/lookup":{"post":{"summary":"Bcbs Lookup","description":"Lookup BCBS insurance provider and phone number from member ID prefix.","operationId":"bcbs_lookup_bcbs_lookup_lookup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BCBSLookupRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BCBSLookupResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"summary":"Home","operationId":"home__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/product":{"get":{"summary":"Product","operationId":"product_product_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/pricing":{"get":{"summary":"Pricing","operationId":"pricing_pricing_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/copilot":{"get":{"summary":"Copilot","operationId":"copilot_copilot_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/security":{"get":{"summary":"Security","operationId":"security_security_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/amba":{"get":{"summary":"Amba","operationId":"amba_amba_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/demo/payor":{"get":{"summary":"Demo Payor","operationId":"demo_payor_demo_payor_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/demo/inbound":{"get":{"summary":"Demo Inbound","operationId":"demo_inbound_demo_inbound_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/demo/inbound/moments":{"get":{"summary":"Demo Inbound Moments","operationId":"demo_inbound_moments_demo_inbound_moments_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/post_transfer_callback/{call_log_id}":{"post":{"summary":"Post Transfer Callback","operationId":"post_transfer_callback_post_transfer_callback__call_log_id__post","parameters":[{"name":"call_log_id","in":"path","required":true,"schema":{"type":"string","title":"Call Log Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/recording_callback/{call_log_id}":{"post":{"summary":"Recording Callback","operationId":"recording_callback_recording_callback__call_log_id__post","parameters":[{"name":"call_log_id","in":"path","required":true,"schema":{"type":"string","title":"Call Log Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"webhooks":{"dental_inquiry_update":{"post":{"summary":"Dental Inquiry Update","description":"At the specified frequency on the subscription, we will periodically send updates on any inquiries whose statuses have changed since the last update (e.g. Scheduled --> In Progress or In Progress --> Complete). The updates will be sent in the form of a list of inquiries. Please see documentation on the Bulk Get Dental Inquiries Route for more information about the response.\n\nA size limit of 1MB is assumed, so the responses may be broken up into multiple requests if necessary. It is also suggested that the client endpoint is idempotent as the same updates may occasionally be retried in cases of network failures.","operationId":"dental_inquiry_updatedental_inquiry_update_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InquirySubscriptionResponse"}}}}}}}},"components":{"schemas":{"AppointmentCategoryDeletionResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"category_id":{"type":"string","title":"Category Id"}},"type":"object","required":["success","category_id"],"title":"AppointmentCategoryDeletionResponse"},"BCBSLookupRequest":{"properties":{"member_id":{"type":"string","title":"Member Id"}},"type":"object","required":["member_id"],"title":"BCBSLookupRequest"},"BCBSLookupResponse":{"properties":{"member_id":{"type":"string","title":"Member Id"},"insurance_provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance Provider"},"phone_numbers":{"additionalProperties":{"type":"string"},"type":"object","title":"Phone Numbers"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["member_id","phone_numbers"],"title":"BCBSLookupResponse"},"Body_login_for_access_token_api_v0_auth_token_post":{"properties":{"grant_type":{"anyOf":[{"type":"string","pattern":"^password$"},{"type":"null"}],"title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","format":"password","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"format":"password","title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_login_for_access_token_api_v0_auth_token_post"},"CallDetails":{"properties":{"call_end_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call End Time"},"representative_name":{"type":"string","title":"Representative Name"},"reference_number":{"type":"string","title":"Reference Number"},"call_recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Recording Url"},"call_transcript_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Transcript Url"},"call_transcript":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Transcript"},"custom_answers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Custom Answers"}},"type":"object","required":["representative_name","reference_number"],"title":"CallDetails"},"ExternalAppointmentCategory":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier","examples":["550e8400-e29b-41d4-a716-446655440000"]},"name":{"type":"string","title":"Name","description":"Appointment category name","examples":["Initial Consultation"]},"duration_minutes":{"type":"integer","title":"Duration Minutes","description":"Appointment duration in minutes. Finds the next available time slot of this duration in the provider's calendar (e.g., if 20 minutes, could be 10:05am-10:25am or 10:19am-10:39am based on provider availability)","examples":[60]},"description":{"type":"string","title":"Description","description":"Description of the appointment category","examples":["First-time patient evaluation"]},"provider_ids":{"items":{"type":"string"},"type":"array","title":"Provider Ids","description":"List of provider IDs who can perform this appointment category","examples":[["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"]]},"min_lead_time_minutes":{"type":"integer","title":"Min Lead Time Minutes","description":"Minimum minutes in advance required to book this appointment category","examples":[1440]},"max_advance_days":{"type":"integer","title":"Max Advance Days","description":"Maximum days in advance this appointment category can be booked","examples":[90]},"buffer_minutes":{"type":"integer","title":"Buffer Minutes","description":"Buffer time in minutes to add after this appointment","examples":[15]},"new_patient_only":{"type":"boolean","title":"New Patient Only","description":"Whether this appointment category is restricted to new patients only","examples":[true]},"is_active":{"type":"boolean","title":"Is Active","description":"Whether this appointment category is currently active and bookable","examples":[true]},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"Timestamp when this appointment category was created","examples":["2024-01-15T10:30:00.000000Z"]},"last_updated_ts":{"type":"string","format":"date-time","title":"Last Updated Ts","description":"Timestamp when this appointment category was last updated","examples":["2024-03-20T14:45:00.000000Z"]}},"type":"object","required":["id","name","duration_minutes","description","provider_ids","min_lead_time_minutes","max_advance_days","buffer_minutes","new_patient_only","is_active","creation_ts","last_updated_ts"],"title":"ExternalAppointmentCategory","description":"External representation of an appointment category."},"ExternalAppointmentCategoryCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Appointment category name","examples":["Initial Consultation"]},"duration_minutes":{"type":"integer","title":"Duration Minutes","description":"Appointment duration in minutes","examples":[60]},"description":{"type":"string","title":"Description","description":"Description of the appointment category","examples":["First-time patient evaluation"]},"provider_ids":{"items":{"type":"string"},"type":"array","title":"Provider Ids","description":"List of provider IDs who can perform this appointment category","examples":[["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"]]},"min_lead_time_minutes":{"type":"integer","title":"Min Lead Time Minutes","description":"Minimum minutes in advance required to book this appointment category","default":0,"examples":[1440]},"max_advance_days":{"type":"integer","title":"Max Advance Days","description":"Maximum days in advance this appointment category can be booked","default":90,"examples":[90]},"buffer_minutes":{"type":"integer","title":"Buffer Minutes","description":"Buffer time in minutes to add after this appointment","default":0,"examples":[15]},"new_patient_only":{"type":"boolean","title":"New Patient Only","description":"Whether this appointment category is restricted to new patients only","default":false,"examples":[true]}},"type":"object","required":["name","duration_minutes","description","provider_ids"],"title":"ExternalAppointmentCategoryCreateRequest","description":"Request model for creating an appointment category. Server generates id, is_active defaults to True, timestamps are set automatically."},"ExternalAppointmentCategoryUpdateRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Unique identifier (can be provided in body or path)","examples":["550e8400-e29b-41d4-a716-446655440000"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Appointment category name","examples":["Initial Consultation"]},"duration_minutes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Minutes","description":"Appointment duration in minutes","examples":[60]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the appointment category","examples":["First-time patient evaluation"]},"provider_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Provider Ids","description":"List of provider IDs who can perform this appointment category","examples":[["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"]]},"min_lead_time_minutes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Lead Time Minutes","description":"Minimum minutes in advance required to book this appointment category","examples":[1440]},"max_advance_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Advance Days","description":"Maximum days in advance this appointment category can be booked","examples":[90]},"buffer_minutes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Buffer Minutes","description":"Buffer time in minutes to add after this appointment","examples":[15]},"new_patient_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"New Patient Only","description":"Whether this appointment category is restricted to new patients only","examples":[true]},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Whether this appointment category is currently active and bookable","examples":[true]}},"type":"object","title":"ExternalAppointmentCategoryUpdateRequest","description":"Request model for updating an appointment category. All fields optional for partial updates."},"ExternalClaimCodeDetails":{"properties":{"procedure_code":{"type":"string","title":"Procedure Code","description":"The procedure code on the claim line.","examples":["99213"]},"amount_paid":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount Paid","description":"The amount paid for this procedure code.","examples":[100.0]},"patient_responsibility":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Patient Responsibility","description":"The patient responsibility for this procedure code.","examples":[20.0]},"patient_applied_to_deductible":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Patient Applied To Deductible","description":"The amount applied to the patient deductible for this procedure code.","examples":[10.0]}},"type":"object","required":["procedure_code"],"title":"ExternalClaimCodeDetails"},"ExternalClaimInfo":{"properties":{"main_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Class","description":"The claim info subtype, e.g. ClaimApprovedInfo, ClaimDeniedInfo, ClaimUnprocessedInfo.","examples":["ClaimApprovedInfo"]},"date_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Service","description":"The date of service for the claim in MM-DD-YYYY format.","examples":["01-31-2020"]},"claim_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Summary","description":"A short summary of the claim status or outcome.","examples":["Claim paid"]},"date_received":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Received","description":"The date the claim was received in MM-DD-YYYY format.","examples":["01-31-2020"]},"date_processed_up_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Processed Up To","description":"The date the claim was last processed or worked in MM-DD-YYYY format.","examples":["01-31-2020"]},"turnaround_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turnaround Time","description":"Expected turnaround time for an unprocessed claim.","examples":["21 business days"]},"date_processed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Processed","description":"The date the claim was processed in MM-DD-YYYY format.","examples":["01-31-2020"]},"date_paid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Paid","description":"The date the claim was paid in MM-DD-YYYY format.","examples":["01-31-2020"]},"total_amount_paid":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Amount Paid","description":"The total amount paid on the claim.","examples":[100.0]},"adjustment_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adjustment Details","description":"Adjustment or payment notes for the claim.","examples":["Adjusted for deductible"]},"code_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalClaimCodeDetails"},"type":"array"},{"type":"null"}],"title":"Code Details","description":"Per-procedure-code payment details for the claim."},"claim_denial_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Denial Reason","description":"The reason the claim was denied.","examples":["Not covered due to frequency"]},"appeal_or_correction_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appeal Or Correction Info","description":"Information about appealing or correcting the claim."}},"type":"object","title":"ExternalClaimInfo"},"ExternalClaimNotFoundInfo":{"properties":{"patient_eligible_on_dos":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Patient Eligible On Dos","description":"Whether the patient was eligible on the date of service.","examples":[true]},"mailing_address_or_payer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mailing Address Or Payer Id","description":"Claims mailing address or payer ID when no claim was found."},"timely_filing_limit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timely Filing Limit","description":"Timely filing limit information when no claim was found."}},"type":"object","title":"ExternalClaimNotFoundInfo"},"ExternalClaimStatus":{"type":"string","enum":["NOT_FOUND","UNPROCESSED","APPROVED","DENIED"],"title":"ExternalClaimStatus"},"ExternalClaimsQueryResults":{"properties":{"call_details":{"items":{"$ref":"#/components/schemas/CallDetails"},"type":"array","title":"Call Details","description":"The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.","examples":[[{"call_end_time":"2024-03-01T06:00:00.0000Z","call_recording_url":"https://www.google.com/voice_recording.wav","reference_number":"2812129","representative_name":"Deborah M","transcript":"..."}]]},"status":{"$ref":"#/components/schemas/ExternalClaimStatus","description":"The overall status of the claim inquiry.","examples":["APPROVED"]},"similar_claim_dates":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Similar Claim Dates","description":"Similar claim dates of service in MM-DD-YYYY format, typically when the claim was not found.","examples":[["01-15-2020","01-31-2020"]]},"claims_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalClaimInfo"},"type":"array"},{"type":"null"}],"title":"Claims Info","description":"Details for matching claim(s) found during the inquiry."},"claim_not_found_info":{"anyOf":[{"$ref":"#/components/schemas/ExternalClaimNotFoundInfo"},{"type":"null"}],"description":"Additional information when no claim was found."}},"type":"object","required":["call_details","status"],"title":"ExternalClaimsQueryResults"},"ExternalDentalEligibilityQueryResults":{"properties":{"call_details":{"items":{"$ref":"#/components/schemas/CallDetails"},"type":"array","title":"Call Details","description":"The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.","examples":[[{"call_end_time":"2024-03-01T06:00:00.0000Z","call_recording_url":"https://www.google.com/voice_recording.wav","reference_number":"2812129","representative_name":"Deborah M","transcript":"..."}]]},"plan_information":{"anyOf":[{"$ref":"#/components/schemas/PlanInformation"},{"type":"null"}],"description":"The plan information for the patient including the plan type and effective date. Dates will be provided in MM-DD-YYYY format. Fields will only be included if applicable, for example, when the plan is not active, no other information will be provided.","examples":[{"effective_date":"10-01-2020","is_active":true,"is_calendar_year_plan":true,"is_primary_insurance":true,"is_provider_in_network":true,"plan_type":"PPO","termination_date":"10-31-2021"}]},"maximums":{"anyOf":[{"$ref":"#/components/schemas/Maximums"},{"type":"null"}],"description":"The maximums for the patient including the individual and family deductible and any annual coverage limits. Fields will only be included if applicable, for example, on individual plans, family information will not be available.","examples":[{"coverage_limit":"1000","coverage_limit_remaining":"800","family_deductible":"200","family_deductible_used":"100","individual_deductible":"100","individual_deductible_used":"80","orthodontics_coverage_limit":"1500"}]},"treatment_history":{"anyOf":[{"additionalProperties":{"items":{"$ref":"#/components/schemas/ExternalDentalTreatmentHistoryItem"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Treatment History","description":"The treatment history for the patient. The keys are dates in MM-DD-YYYY format and the values are a list of procedure codes performed on that date. See examples for more information.","examples":[{"10-01-2020":[{"procedure_code":"D1110","quadrant_numbers":[10],"surfaces":["occlusal"],"tooth_numbers":["17"]},{"procedure_code":"D1120","quadrant_numbers":[20],"surfaces":["distal"],"tooth_numbers":["A"]}]}]},"procedure_classes":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"$ref":"#/components/schemas/ExternalDentalProcedureCategory"},"type":"object"},{"type":"null"}],"title":"Procedure Classes","description":"A dict that maps from the different classes of procedures to their benefits. If a class is not covered, it may not have any other fields. See examples for more information.","examples":[{"DIAGNOSTIC":{"coverage_percentage":100.0,"is_covered":true},"IMPLANTS":{"is_covered":false}}]},"procedure_codes":{"anyOf":[{"items":{"prefixItems":[{"$ref":"#/components/schemas/ProcedureCodeInfo"},{"additionalProperties":true,"type":"object"}],"type":"array","maxItems":2,"minItems":2},"type":"array"},{"type":"null"}],"title":"Procedure Codes","description":"A list that contains information from the different procedure codes and the requested benefits information for that code. See examples for more information.","examples":[[[{"procedure_code":"D1110","procedure_name":"Prophylaxis"},{"coverage_percentage":100.0,"frequency_limitations":"1 every 6 floating months","is_covered":true,"is_prior_auth_required":true,"more_info":"","prior_auth_info":"Call United Healthcare at 555-123-1234"}],[{"procedure_code":"D1206","procedure_name":"Fluoride"},{"age_limit":16,"coverage_percentage":100.0,"frequency_limitations":"1 every calendar year","is_covered":true,"is_prior_auth_required":false,"more_info":""}],[{"procedure_code":"D6058","procedure_name":"Crowns"},{"coverage_percentage":50.0,"downgraded_info":"Downgraded to D6063 on molars.","frequency_limitations":"1 every 5 years","is_covered":true,"is_downgraded":true,"is_prior_auth_required":false,"more_info":"Prior authorization is not required, however, predetermination is highly recommended."}],[{"procedure_code":"D0364","procedure_name":"CT Scan"},{"is_covered":false,"more_info":""}]]]},"extra_info":{"anyOf":[{"$ref":"#/components/schemas/ExtraDentalInfo"},{"type":"null"}],"description":"Extra information about the patient's dental plan. Fields are omitted if not applicable.","examples":[{"deductible_applies_to_preventive":false,"has_pending_claims":true,"missing_tooth_clause":"coverage reduction of 50% for first 12 months","preventative_applies_to_maximum":true,"waiting_periods":"None"}]}},"type":"object","required":["call_details"],"title":"ExternalDentalEligibilityQueryResults"},"ExternalDentalEligibilitySearchQuery":{"type":"string","enum":["STANDARD","CODE_LOOKUP_BENEFITS","CODE_LOOKUP_FREQUENCIES","TREATMENT_HISTORY","DEDUCTIBLES_AND_MAXIMUMS","UNKNOWN"],"title":"ExternalDentalEligibilitySearchQuery"},"ExternalDentalInquiry":{"properties":{"id":{"type":"string","title":"Id","description":"unique generated (uuid4) id for the inquiry"},"status":{"$ref":"#/components/schemas/ExternalInquiryStatus","description":"status of the inquiry","examples":["SUCCESS"]},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"timestamp of when the inquiry was created","examples":["2020-01-01T00:00:00.000000Z"]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the call results","examples":["Benefits retrieved successfully."]},"results":{"anyOf":[{"$ref":"#/components/schemas/ExternalClaimsQueryResults"},{"$ref":"#/components/schemas/ExternalDentalEligibilityQueryResults"},{"type":"null"}],"title":"Results","description":"The output from the call containing the benefits or claims results.","examples":[]},"request":{"$ref":"#/components/schemas/ExternalDentalInquiryRequest","description":"The request that was used to create the inquiry."}},"type":"object","required":["id","status","creation_ts","request"],"title":"ExternalDentalInquiry"},"ExternalDentalInquiryRequest":{"properties":{"type":{"$ref":"#/components/schemas/ExternalInquiryType","description":"type of the inquiry","examples":["BENEFITS","CLAIMS_STATUS"]},"desired_completion_date":{"type":"string","title":"Desired Completion Date","description":"The requested completion date of the inquiry in MM-DD-YYYY format. Calls will typically be completed by the morning of the requested completion date, but in some cases may be completed earlier.","examples":["03-19-2024"]},"patient_name":{"type":"string","title":"Patient Name","description":"name of the patient","examples":["Alex Martin"]},"dob":{"type":"string","title":"Dob","description":"date of birth of the patient in MM-DD-YYYY format","examples":["01-31-2020"]},"member_id":{"type":"string","title":"Member Id","description":"member id of the patient","examples":["123456789"]},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id","description":"group id of the patient","examples":["123456"]},"insurance_in_network":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Insurance In Network","description":"whether or not the provider is in-network. If it is not known, leave this field blank and it will be determined."},"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi","description":"(deprecated, use billing_npi and rendering_npi instead) Ten digit NPI of the provider","examples":["1234567890"]},"billing_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Npi","description":"Ten digit NPI of the billing provider","examples":["1234567890"]},"rendering_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rendering Npi","description":"Ten digit NPI of the rendering provider","examples":["1234567890"]},"tax_id":{"type":"string","title":"Tax Id","description":"Nine digit tax id of the provider","examples":["123456789"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"An identifier which you can define and pass in with your creation request. This is useful for tracking a specific subgroup of inquiries. For instance, you can assign a unique external id to all inquiries for a specific provider on your platform."},"practice_billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Billing Address","description":"The billing address of the practice. If omitted, the address will be determined from the NPI.","examples":["123 Main St, New York, NY 10001"]},"diagnosis_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Diagnosis Codes","description":"Any diagnosis codes for the patient. If omitted, a general diagnosis code will be used.","examples":[["F41.1","F42.23"]]},"claims_date_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claims Date Of Service","description":"The date of service for the claim in MM-DD-YYYY format. Only used for claims inquiries.","examples":["01-31-2020"]},"claim_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Number","description":"The claim number for the inquiry if provided by the user. Only used for claims inquiries.","examples":["1234567890"]},"additional_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Info","description":"Any additional information about the inquiry that is not covered by the other fields. This can be used to pass in any additional information for the request. Please check with the Health Harbor team before using this field as it may not be incorporated into the inquiry unless we are already aware of it.","examples":["The patient is on a Medicare plan and we need to know their secondary insurance benefits."]},"call_script_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Script Id","description":"Optional ID of a call script belonging to your team. Use for eligibility/benefits inquiries to control which questions are asked. You can find call script IDs on the Accounts page in the dashboard. When provided, it must be a script your team created. For eligibility search, either benefits queries or this field may satisfy the requirement—see Health Harbor documentation.","examples":[null]},"insurance":{"anyOf":[{"$ref":"#/components/schemas/ExternalDentalInsuranceProvider"},{"type":"null"}],"description":"The insurance provider for the patient.","examples":["CIGNA"]},"benefits_query":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalDentalEligibilitySearchQuery"},"type":"array"},{"type":"null"}],"title":"Benefits Query","description":"The benefits queries for the inquiry if provided by the user. Can be either a pre-defined set of questions (e.g. STANDARD for returning patients) or an ad-hoc defined set of codes.","examples":[["CODE_LOOKUP_BENEFITS"],["STANDARD"]]},"benefits_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Benefits Codes","description":"Codes processed for a CODE_LOOKUP_BENEFITS or a CODE_LOOKUP_PRIOR_AUTH  benefits inquiry. The first character in the CDT codes (D) can be optionally omitted.","examples":[["D1110","D1120","1130"]]},"is_specialist":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Specialist","description":"The type of provider making the inquiry. If the provider is a specialist (e.g. periodontist, oral surgeon), set this to True. If the provider is a dentist, set this to False. Defaults to False if not provided.","examples":[true,false]},"insurance_payor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance Payor Id","description":"The payor id for the insurance. Usually five characters. For example, one payor id for Aetna is 60054.","examples":["60054"]}},"type":"object","required":["type","desired_completion_date","patient_name","dob","member_id","tax_id"],"title":"ExternalDentalInquiryRequest"},"ExternalDentalInsuranceProvider":{"type":"string","enum":["AETNA","HEALTHPLEX","HUMANA","METLIFE","UNITED_HEALTHCARE","UNKNOWN"],"title":"ExternalDentalInsuranceProvider"},"ExternalDentalProcedureCategory":{"type":"string","enum":["DIAGNOSTIC","PREVENTIVE","BASIC","ENDODONTICS","PERIODONTICS","ORAL_SURGERY","CROWNS","DENTURES","ORTHODONTICS","ADJUNCTIVE","IMPLANTS","MAJOR","UNKNOWN"],"title":"ExternalDentalProcedureCategory"},"ExternalDentalTreatmentHistoryItem":{"properties":{"procedure_code":{"type":"string","title":"Procedure Code","description":"5 digit CDT code that refers to a procedure performed on a patient.","examples":["D2140"]},"tooth_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tooth Numbers","description":"Integers from 1-32 that refers to particular teeth as designated by the ADA. For child teeth, the letters A-T will be used.","examples":[["15","17"],["A","G","T"]]},"surfaces":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Surfaces","description":"The surfaces for the tooth. Each surface applies to all the teeth in tooth_numbers. Surfaces are in {buccal, occlusal, distal, mesial, lingual, facial, incisal}. If the surface is not applicable, the field will be null.","examples":[["occlusal"]]},"quadrant_numbers":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Quadrant Numbers","description":"Integers in {10,20,30,40} that refer to a particular quadrant.","examples":[[10]]}},"type":"object","required":["procedure_code"],"title":"ExternalDentalTreatmentHistoryItem"},"ExternalInquiryStatus":{"type":"string","enum":["SCHEDULED","IN_PROGRESS","SUCCESS","UNSUCCESSFUL","CANCELLED","UNKNOWN"],"title":"ExternalInquiryStatus"},"ExternalInquiryType":{"type":"string","enum":["CLAIMS_STATUS","BENEFITS","UNKNOWN"],"title":"ExternalInquiryType"},"ExternalKnowledgeBank":{"properties":{"entries":{"items":{"$ref":"#/components/schemas/ExternalKnowledgeEntry"},"type":"array","title":"Entries","description":"List of knowledge entries the assistant draws on to answer callers","examples":[[{"answer":"We are open Monday-Friday 9am-5pm EST","creation_ts":"2024-01-01T00:00:00Z","id":"550e8400-e29b-41d4-a716-446655440000","last_updated_ts":"2024-01-01T00:00:00Z","question":"What are your office hours?"}]]},"org_info":{"items":{"$ref":"#/components/schemas/ExternalOrganizationInfo"},"type":"array","title":"Org Info","description":"Organization and practice information for context injection"}},"type":"object","required":["entries","org_info"],"title":"ExternalKnowledgeBank","description":"External representation of a knowledge bank combining entries and org info."},"ExternalKnowledgeEntry":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the knowledge entry","examples":["550e8400-e29b-41d4-a716-446655440000"]},"practice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id","description":"Practice this entry applies to, or null if it applies across the organization","examples":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"question":{"type":"string","title":"Question","description":"The question text that may trigger this answer. Does not require exact matching, semantically similar questions will also match.","examples":["What are your office hours?"]},"answer":{"type":"string","title":"Answer","description":"The answer content that the AI will use as source material. The AI will convey this information naturally in conversation.","examples":["We are open Monday-Friday 9am-5pm EST"]},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"ISO 8601 timestamp of when this entry was created","examples":["2024-01-01T00:00:00Z"]},"last_updated_ts":{"type":"string","format":"date-time","title":"Last Updated Ts","description":"ISO 8601 timestamp of when this entry was last updated","examples":["2024-03-01T12:00:00Z"]}},"type":"object","required":["id","practice_id","question","answer","creation_ts","last_updated_ts"],"title":"ExternalKnowledgeEntry","description":"External representation of a knowledge base entry."},"ExternalKnowledgeEntryCreateRequest":{"properties":{"question":{"type":"string","title":"Question","description":"The question text that may trigger this answer. Does not require exact matching, semantically similar questions will also match.","examples":["What are your office hours?"]},"answer":{"type":"string","title":"Answer","description":"The answer content that the AI will use as source material. The AI will convey this information naturally in conversation.","examples":["We are open Monday-Friday 9am-5pm EST"]},"practice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id","description":"Practice this entry applies to. Omit it to make the entry available to every practice in your organization.","examples":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"resolved_gap_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Resolved Gap Ids","description":"Knowledge gaps this entry answers. Each is marked ANSWERED and linked to the new entry, so the gaps close in the same call that writes the answer.","examples":[["7c9e6679-7425-40de-944b-e07fc1f90ae7"]]}},"type":"object","required":["question","answer"],"title":"ExternalKnowledgeEntryCreateRequest","description":"Request body for creating a knowledge base entry."},"ExternalKnowledgeEntryUpdateRequest":{"properties":{"question":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Question","description":"Replacement question text. Semantically similar caller questions will also match.","examples":["What are your office hours?"]},"answer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer","description":"Replacement answer content the AI will use as source material.","examples":["We are open Monday-Friday 9am-5pm EST"]},"practice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id","description":"Practice this entry applies to. Omit it to widen the entry to every practice in your organization.","examples":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"resolved_gap_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Resolved Gap Ids","description":"Knowledge gaps this entry now answers. Each is marked ANSWERED and linked to the entry. Omitting the field leaves existing links alone; a gap cannot be unlinked, because it cannot return to OPEN.","examples":[["7c9e6679-7425-40de-944b-e07fc1f90ae7"]]}},"type":"object","title":"ExternalKnowledgeEntryUpdateRequest","description":"Request body for updating a knowledge base entry. Omitted fields keep their current value."},"ExternalKnowledgeGap":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the knowledge gap","examples":["7c9e6679-7425-40de-944b-e07fc1f90ae7"]},"practice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Id","description":"Practice ID if this gap is practice-specific, null if org-level","examples":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"question_text":{"type":"string","title":"Question Text","description":"The question text that callers asked but we could not answer. Semantically similar questions are grouped into a single gap.","examples":["Do you accept HSA payments?"]},"occurrence_count":{"type":"integer","title":"Occurrence Count","description":"Number of times this question, or a semantically similar one, has been asked","examples":[5]},"example_call_ids":{"items":{"type":"string"},"type":"array","title":"Example Call Ids","description":"List of call IDs where this question was asked","examples":[["3fa85f64-5717-4562-b3fc-2c963f66afa6","9b7e4a2c-8d1f-4e6b-9c3a-5f8e7d6c4b2a"]]},"status":{"$ref":"#/components/schemas/ExternalKnowledgeGapStatus","description":"Current status of this gap: OPEN, ANSWERED, or DISMISSED","examples":["OPEN"]},"resolved_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolved Entry Id","description":"ID of the knowledge entry that resolved this gap, set by naming the gap in resolved_gap_ids when you create or update that entry. Null unless the gap has been marked ANSWERED.","examples":["550e8400-e29b-41d4-a716-446655440000"]},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"ISO 8601 timestamp of when this gap was first identified","examples":["2024-01-01T00:00:00Z"]},"last_updated_ts":{"type":"string","format":"date-time","title":"Last Updated Ts","description":"ISO 8601 timestamp of when this gap was last updated","examples":["2024-03-01T12:00:00Z"]}},"type":"object","required":["id","practice_id","question_text","occurrence_count","example_call_ids","status","creation_ts","last_updated_ts"],"title":"ExternalKnowledgeGap","description":"External representation of a knowledge gap."},"ExternalKnowledgeGapStatus":{"type":"string","enum":["OPEN","ANSWERED","DISMISSED"],"title":"ExternalKnowledgeGapStatus"},"ExternalMedicalEligibilityQueryResults":{"properties":{"call_details":{"items":{"$ref":"#/components/schemas/CallDetails"},"type":"array","title":"Call Details","description":"The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.","examples":[[{"call_end_time":"2024-03-01T06:00:00.0000Z","call_recording_url":"https://www.google.com/voice_recording.wav","reference_number":"2812129","representative_name":"Deborah M","transcript":"..."}]]},"plan_information":{"anyOf":[{"$ref":"#/components/schemas/PlanInformation"},{"type":"null"}],"description":"The plan information for the patient including the plan type and effective date. Dates will be provided in MM-DD-YYYY format. Fields will only be included if applicable, for example, when the plan is not active, no other information will be provided.","examples":[{"effective_date":"10-01-2020","is_active":true,"is_calendar_year_plan":true,"is_primary_insurance":true,"is_provider_in_network":true,"plan_type":"PPO","termination_date":"10-31-2021"}]},"maximums":{"anyOf":[{"$ref":"#/components/schemas/Maximums"},{"type":"null"}],"description":"The maximums for the patient including the individual and family deductible and out of pocket maximums. Fields will only be included if applicable, for example, on individual plans, family information will not be available.","examples":[{"family_deductible":"200","family_deductible_used":"100","family_out_of_pocket_maximum":"2000","family_out_of_pocket_maximum_used":"1000","individual_deductible":"100","individual_deductible_used":"80","individual_out_of_pocket_maximum":"1000","individual_out_of_pocket_maximum_used":"800"}]},"procedure_classes":{"anyOf":[{"additionalProperties":{"additionalProperties":true,"type":"object"},"propertyNames":{"$ref":"#/components/schemas/ExternalMedicalProcedureCategory"},"type":"object"},{"type":"null"}],"title":"Procedure Classes","description":"A dict that maps from the different categories of procedures to their benefits. Categories will contain prior auth, deductibles, copay amounts, coinsurance percentages and any frequency limitations. See examples for more information","examples":[{"CHIROPRACTIC":{"is_covered":false,"more_info":""},"PHYSICAL_THERAPY":{"coinsurance_percentage":"30","copay_amount":"50.00","deductible_waived_reason":"Procedure is exempt from deductible","frequency_limitations":"None","is_covered":true,"is_deductible_waived":true,"is_prior_auth_required":true,"prior_auth_info":"Call Benefits Office at 555-999-1234."}}]},"procedure_codes":{"anyOf":[{"items":{"prefixItems":[{"$ref":"#/components/schemas/ProcedureCodeInfo"},{"additionalProperties":true,"type":"object"}],"type":"array","maxItems":2,"minItems":2},"type":"array"},{"type":"null"}],"title":"Procedure Codes","description":"A list that contains a tuple of procedure code information and their benefits. For medical, procedure codes, if covered, will contain deductible information, copays, coinsurance, frequency limitations and whether or not prior authorization is needed. Coinsurance refers to the patient's portion of the payment.","examples":[[[{"procedure_code":"94625","procedure_name":"Pulmonary Rehabilitation Coverage"},{"coinsurance_percentage":"20","copay_amount":"20.00","frequency_limitations":"Two visits per week","frequency_limitations_utilized":"3 of 24 visits used","is_covered":true,"is_deductible_waived":false,"is_prior_auth_required":true,"more_info":"Diagnosis of medium to severe COPD is required for coverage.","prior_auth_info":"Call United Healthcare at 555-123-1234"}],[{"procedure_code":"94626","procedure_name":"Pulmonary Rehabilitation Coverage"},{"is_covered":false,"more_info":""}]]]},"extra_info":{"anyOf":[{"$ref":"#/components/schemas/ExtraMedicalInfo"},{"type":"null"}],"description":"Extra information about the patient's medical plan. Fields are omitted if not applicable.","examples":[{"how_is_telehealth_covered":"$50 no deductible","is_telehealth_visit_covered":true,"visits_counted_as_one_if_same_day":true}]}},"type":"object","required":["call_details"],"title":"ExternalMedicalEligibilityQueryResults"},"ExternalMedicalEligibilitySearchQuery":{"type":"string","enum":["DEDUCTIBLES_AND_MAXIMUMS","PLAN_INFO","NETWORK_STATUS","CODE_LOOKUP_PRIOR_AUTH","CODE_LOOKUP_BENEFITS","PULMONARY_REHAB_COVERAGE","PRIOR_AUTH_PHYSICAL_THERAPY","WEIGHT_MANAGEMENT","HAILIE","SPEECH_THERAPY","OCCUPATIONAL_THERAPY","PHYSICAL_THERAPY","NEURO_PSYCH","TRIAL","UNKNOWN"],"title":"ExternalMedicalEligibilitySearchQuery"},"ExternalMedicalInquiry":{"properties":{"id":{"type":"string","title":"Id","description":"unique generated (uuid4) id for the inquiry"},"status":{"$ref":"#/components/schemas/ExternalInquiryStatus","description":"status of the inquiry","examples":["SUCCESS"]},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"timestamp of when the inquiry was created","examples":["2020-01-01T00:00:00.000000Z"]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the call results","examples":["Benefits retrieved successfully."]},"results":{"anyOf":[{"$ref":"#/components/schemas/ExternalClaimsQueryResults"},{"$ref":"#/components/schemas/ExternalMedicalEligibilityQueryResults"},{"type":"null"}],"title":"Results","description":"The output from the call containing the benefits or claims results.","examples":[]},"request":{"$ref":"#/components/schemas/ExternalMedicalInquiryRequest","description":"The request that was used to create the inquiry."}},"type":"object","required":["id","status","creation_ts","request"],"title":"ExternalMedicalInquiry"},"ExternalMedicalInquiryRequest":{"properties":{"type":{"$ref":"#/components/schemas/ExternalInquiryType","description":"type of the inquiry","examples":["BENEFITS","CLAIMS_STATUS"]},"desired_completion_date":{"type":"string","title":"Desired Completion Date","description":"The requested completion date of the inquiry in MM-DD-YYYY format. Calls will typically be completed by the morning of the requested completion date, but in some cases may be completed earlier.","examples":["03-19-2024"]},"patient_name":{"type":"string","title":"Patient Name","description":"name of the patient","examples":["Alex Martin"]},"dob":{"type":"string","title":"Dob","description":"date of birth of the patient in MM-DD-YYYY format","examples":["01-31-2020"]},"member_id":{"type":"string","title":"Member Id","description":"member id of the patient","examples":["123456789"]},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id","description":"group id of the patient","examples":["123456"]},"insurance_in_network":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Insurance In Network","description":"whether or not the provider is in-network. If it is not known, leave this field blank and it will be determined."},"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi","description":"(deprecated, use billing_npi and rendering_npi instead) Ten digit NPI of the provider","examples":["1234567890"]},"billing_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Npi","description":"Ten digit NPI of the billing provider","examples":["1234567890"]},"rendering_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rendering Npi","description":"Ten digit NPI of the rendering provider","examples":["1234567890"]},"tax_id":{"type":"string","title":"Tax Id","description":"Nine digit tax id of the provider","examples":["123456789"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"An identifier which you can define and pass in with your creation request. This is useful for tracking a specific subgroup of inquiries. For instance, you can assign a unique external id to all inquiries for a specific provider on your platform."},"practice_billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Billing Address","description":"The billing address of the practice. If omitted, the address will be determined from the NPI.","examples":["123 Main St, New York, NY 10001"]},"diagnosis_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Diagnosis Codes","description":"Any diagnosis codes for the patient. If omitted, a general diagnosis code will be used.","examples":[["F41.1","F42.23"]]},"claims_date_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claims Date Of Service","description":"The date of service for the claim in MM-DD-YYYY format. Only used for claims inquiries.","examples":["01-31-2020"]},"claim_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Number","description":"The claim number for the inquiry if provided by the user. Only used for claims inquiries.","examples":["1234567890"]},"additional_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Info","description":"Any additional information about the inquiry that is not covered by the other fields. This can be used to pass in any additional information for the request. Please check with the Health Harbor team before using this field as it may not be incorporated into the inquiry unless we are already aware of it.","examples":["The patient is on a Medicare plan and we need to know their secondary insurance benefits."]},"call_script_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Script Id","description":"Optional ID of a call script belonging to your team. Use for eligibility/benefits inquiries to control which questions are asked. You can find call script IDs on the Accounts page in the dashboard. When provided, it must be a script your team created. For eligibility search, either benefits queries or this field may satisfy the requirement—see Health Harbor documentation.","examples":[null]},"insurance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance","description":"The insurance provider for the patient. You must provide the name of the insurance provider or the payor id in order for the insurance to be identified.","examples":["United Healthcare"]},"benefits_query":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalMedicalEligibilitySearchQuery"},"type":"array"},{"type":"null"}],"title":"Benefits Query","description":"The specific set of benefits to query. These are customized for each customer. Contact alan@healthharbor.co for details.","examples":[["PULMONARY_REHAB_COVERAGE"]]},"benefits_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Benefits Codes","description":"Codes processed for a CODE_LOOKUP_BENEFITS or a CODE_LOOKUP_PRIOR_AUTH benefits inquiry.","examples":[["99395"]]},"benefits_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benefits Form Name","description":"The name of a custom form for your providers. Contact alan@healthharbor.co for details.","examples":[""]},"is_specialist":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Specialist","description":"The type of provider making the inquiry. If the provider is a specialist, set this to True. If the provider is a general PCP, set this to False.","examples":[true,false]},"place_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Place Of Service","description":"Where the service will be performed. This is typically one of a few places: the doctors office, telehealth, or in home. See this page for the full list: https://www.cms.gov/medicare/coding-billing/place-of-service-codes/code-sets ","examples":["doctors office","telehealth","in home"]},"billed_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Billed Amount","description":"The billed amount for the claim. Value should be a float with 2 decimal places. Only used for claims inquiries.","examples":[100.0,25.97]},"insurance_payor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance Payor Id","description":"The payor id for the insurance. Usually five characters. For example, one payor id for Aetna is 60054. You must provide the name of the insurance provider or the payor id in order for the insurance to be identified.","examples":["60054"]},"insurance_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance Phone Number","description":"The phone number used for identifying the insurance. This is optional, but highly recommended as it helps identify the provider more accurately in the cases of third party administrators (TPAs)."}},"type":"object","required":["type","desired_completion_date","patient_name","dob","member_id","tax_id"],"title":"ExternalMedicalInquiryRequest"},"ExternalMedicalProcedureCategory":{"type":"string","enum":["PHYSICAL_THERAPY","CHIROPRACTIC","UNKNOWN"],"title":"ExternalMedicalProcedureCategory"},"ExternalMentalHealthEligibilityQueryResults":{"properties":{"call_details":{"items":{"$ref":"#/components/schemas/CallDetails"},"type":"array","title":"Call Details","description":"The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.","examples":[[{"call_end_time":"2024-03-01T06:00:00.0000Z","call_recording_url":"https://www.google.com/voice_recording.wav","reference_number":"2812129","representative_name":"Deborah M","transcript":"..."}]]},"plan_information":{"anyOf":[{"$ref":"#/components/schemas/PlanInformation"},{"type":"null"}],"description":"The plan information for the patient including the plan type and effective date. Dates will be provided in MM-DD-YYYY format. Fields will only be included if applicable, for example, when the plan is not active, no other information will be provided.","examples":[{"effective_date":"10-01-2020","is_active":true,"is_calendar_year_plan":true,"is_primary_insurance":true,"is_provider_in_network":true,"plan_type":"PPO","termination_date":"10-31-2021"}]},"maximums":{"anyOf":[{"$ref":"#/components/schemas/Maximums"},{"type":"null"}],"description":"The maximums for the patient including the individual and family deductible and out of pocket maximums. Fields will only be included if applicable, for example, on individual plans, family information will not be available.","examples":[{"family_deductible":"200","family_deductible_used":"100","family_out_of_pocket_maximum":"2000","family_out_of_pocket_maximum_used":"1000","individual_deductible":"100","individual_deductible_used":"80","individual_out_of_pocket_maximum":"1000","individual_out_of_pocket_maximum_used":"800"}]},"procedure_codes":{"anyOf":[{"items":{"prefixItems":[{"$ref":"#/components/schemas/ProcedureCodeInfo"},{"additionalProperties":true,"type":"object"}],"type":"array","maxItems":2,"minItems":2},"type":"array"},{"type":"null"}],"title":"Procedure Codes","description":"A list that contains a tuple of procedure code information and their benefits. For mental health, procedure codes, if covered, will contain deductible information, copays, coinsurance, frequency limitations and whether or not prior authorization is needed. Coinsurance refers to the patient's portion of the payment.","examples":[[[{"procedure_code":"90832","procedure_name":"Psychotherapy (30 minutes)"},{"coinsurance_percentage":"20","copay_amount":"20.00","frequency_limitations":"Two visits per week","frequency_limitations_utilized":"0","is_covered":true,"is_deductible_waived":false,"is_prior_auth_required":true,"limitations":"Sessions must be a maximum of 30 minutes. Individual therapy only. Family is not covered","prior_auth_info":"Call United Healthcare at 555-123-1234"}]]]},"extra_info":{"anyOf":[{"$ref":"#/components/schemas/ExtraMedicalInfo"},{"type":"null"}],"description":"Extra information about the patient's medical plan. Fields are omitted if not applicable.","examples":[{"how_is_telehealth_covered":"$50 no deductible","is_telehealth_visit_covered":true,"visits_counted_as_one_if_same_day":true}]}},"type":"object","required":["call_details"],"title":"ExternalMentalHealthEligibilityQueryResults"},"ExternalMentalHealthEligibilitySearchQuery":{"type":"string","enum":["DEDUCTIBLES_AND_MAXIMUMS","PLAN_INFO","NETWORK_STATUS","CODE_LOOKUP_PRIOR_AUTH","CODE_LOOKUP_BENEFITS","OFFICE_VISIT_NEW_PATIENT","OFFICE_VISIT_RETURNING_PATIENT","PSYCHOTHERAPY","FAMILY_PSYCHOTHERAPY","GROUP_PSYCHOTHERAPY","ABA_COVERAGE","SPEECH_THERAPY","OCCUPATIONAL_THERAPY","PHYSICAL_THERAPY","NEURO_PSYCH","TRIAL","UNKNOWN"],"title":"ExternalMentalHealthEligibilitySearchQuery"},"ExternalMentalHealthInquiry":{"properties":{"id":{"type":"string","title":"Id","description":"unique generated (uuid4) id for the inquiry"},"status":{"$ref":"#/components/schemas/ExternalInquiryStatus","description":"status of the inquiry","examples":["SUCCESS"]},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"timestamp of when the inquiry was created","examples":["2020-01-01T00:00:00.000000Z"]},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"summary of the call results","examples":["Benefits retrieved successfully."]},"results":{"anyOf":[{"$ref":"#/components/schemas/ExternalClaimsQueryResults"},{"$ref":"#/components/schemas/ExternalMentalHealthEligibilityQueryResults"},{"type":"null"}],"title":"Results","description":"The output from the call containing the benefits or claims results.","examples":[]},"request":{"$ref":"#/components/schemas/ExternalMentalHealthInquiryRequest","description":"The request that was used to create the inquiry."}},"type":"object","required":["id","status","creation_ts","request"],"title":"ExternalMentalHealthInquiry"},"ExternalMentalHealthInquiryRequest":{"properties":{"type":{"$ref":"#/components/schemas/ExternalInquiryType","description":"type of the inquiry","examples":["BENEFITS","CLAIMS_STATUS"]},"desired_completion_date":{"type":"string","title":"Desired Completion Date","description":"The requested completion date of the inquiry in MM-DD-YYYY format. Calls will typically be completed by the morning of the requested completion date, but in some cases may be completed earlier.","examples":["03-19-2024"]},"patient_name":{"type":"string","title":"Patient Name","description":"name of the patient","examples":["Alex Martin"]},"dob":{"type":"string","title":"Dob","description":"date of birth of the patient in MM-DD-YYYY format","examples":["01-31-2020"]},"member_id":{"type":"string","title":"Member Id","description":"member id of the patient","examples":["123456789"]},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id","description":"group id of the patient","examples":["123456"]},"insurance_in_network":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Insurance In Network","description":"whether or not the provider is in-network. If it is not known, leave this field blank and it will be determined."},"npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Npi","description":"(deprecated, use billing_npi and rendering_npi instead) Ten digit NPI of the provider","examples":["1234567890"]},"billing_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Npi","description":"Ten digit NPI of the billing provider","examples":["1234567890"]},"rendering_npi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rendering Npi","description":"Ten digit NPI of the rendering provider","examples":["1234567890"]},"tax_id":{"type":"string","title":"Tax Id","description":"Nine digit tax id of the provider","examples":["123456789"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"An identifier which you can define and pass in with your creation request. This is useful for tracking a specific subgroup of inquiries. For instance, you can assign a unique external id to all inquiries for a specific provider on your platform."},"practice_billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Practice Billing Address","description":"The billing address of the practice. If omitted, the address will be determined from the NPI.","examples":["123 Main St, New York, NY 10001"]},"diagnosis_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Diagnosis Codes","description":"Any diagnosis codes for the patient. If omitted, a general diagnosis code will be used.","examples":[["F41.1","F42.23"]]},"claims_date_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claims Date Of Service","description":"The date of service for the claim in MM-DD-YYYY format. Only used for claims inquiries.","examples":["01-31-2020"]},"claim_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Claim Number","description":"The claim number for the inquiry if provided by the user. Only used for claims inquiries.","examples":["1234567890"]},"additional_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Info","description":"Any additional information about the inquiry that is not covered by the other fields. This can be used to pass in any additional information for the request. Please check with the Health Harbor team before using this field as it may not be incorporated into the inquiry unless we are already aware of it.","examples":["The patient is on a Medicare plan and we need to know their secondary insurance benefits."]},"call_script_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Script Id","description":"Optional ID of a call script belonging to your team. Use for eligibility/benefits inquiries to control which questions are asked. You can find call script IDs on the Accounts page in the dashboard. When provided, it must be a script your team created. For eligibility search, either benefits queries or this field may satisfy the requirement—see Health Harbor documentation.","examples":[null]},"insurance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance","description":"The insurance provider for the patient. You must provide the name of the insurance provider or the payor id in order for the insurance to be identified.","examples":["United Healthcare"]},"benefits_query":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalMentalHealthEligibilitySearchQuery"},"type":"array"},{"type":"null"}],"title":"Benefits Query","description":"The specific set of benefits to query. These are customized for each customer. Contact alan@healthharbor.co for details.","examples":[["PSYCHOTHERAPY","OFFICE_VISIT_NEW_PATIENT","CODE_LOOKUP_BENEFITS"]]},"benefits_codes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Benefits Codes","description":"Codes processed for a CODE_LOOKUP_BENEFITS or a CODE_LOOKUP_PRIOR_AUTH benefits inquiry.","examples":[["99203"]]},"benefits_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benefits Form Name","description":"The name of a custom form for your providers. Contact alan@healthharbor.co for details.","examples":[""]},"is_specialist":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Specialist","description":"The type of provider making the inquiry. If the provider is a specialist, set this to True. If the provider is a general PCP, set this to False. ","examples":[true,false]},"place_of_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Place Of Service","description":"Where the service will be performed. This is typically one of a few places: the doctors office, telehealth, in home, or an ambulatory surgical center. See this page for the full list: https://www.cms.gov/medicare/coding-billing/place-of-service-codes/code-sets ","examples":["doctors office","telehealth","in home","ambulatory surgical center"]},"billed_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Billed Amount","description":"The billed amount for the claim. Value should be a float with 2 decimal places. Only used for claims inquiries.","examples":[100.0,25.97]},"insurance_payor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insurance Payor Id","description":"The payor id for the insurance. Usually five characters. For example, one payor id for Aetna is 60054.","examples":["60054"]}},"type":"object","required":["type","desired_completion_date","patient_name","dob","member_id","tax_id"],"title":"ExternalMentalHealthInquiryRequest"},"ExternalOrganizationInfo":{"properties":{"org_summary":{"type":"string","title":"Org Summary","description":"Organization-wide summary describing what the organization does","examples":["Multi-location pediatric therapy practice serving children ages 2-18"]},"per_practice_summaries":{"items":{"$ref":"#/components/schemas/PracticeSummary"},"type":"array","title":"Per Practice Summaries","description":"List of practice-specific summaries","examples":[[{"practice_id":"practice_1","summary":"Main office in downtown; specializes in pediatric care"}]]},"not_covered_note":{"type":"string","title":"Not Covered Note","description":"Description of services not covered or offered","examples":["We do not provide emergency services or after-hours care"]}},"type":"object","required":["org_summary","per_practice_summaries","not_covered_note"],"title":"ExternalOrganizationInfo","description":"External representation of organization and practice information."},"ExternalPatientCall":{"properties":{"id":{"type":"string","title":"Id","description":"Unique generated (uuid4) id for the patient call"},"status":{"$ref":"#/components/schemas/ExternalInquiryStatus","description":"Status of the patient call","examples":["SUCCESS"]},"request":{"$ref":"#/components/schemas/ExternalPatientCallRequest","description":"The request that was used to create the call."},"outcome":{"anyOf":[{"$ref":"#/components/schemas/ExternalPatientCallOutcome"},{"type":"null"}],"description":"How the call concluded once complete. Null while the call is still in progress.","examples":["LIVE_ANSWERED"]},"voicemail_left":{"type":"boolean","title":"Voicemail Left","description":"True if a voicemail was left as a fallback when the patient did not answer.","default":false},"answers":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalPatientCallAnswer"},"type":"array"},{"type":"null"}],"title":"Answers","description":"Structured answers collected from the call script when the patient answered live."},"call_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Summary","description":"Short summary of the call outcome","examples":["Patient confirmed refill; pickup at main pharmacy."]},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url","description":"URL of the call recording, if your team is entitled to recordings."},"creation_ts":{"type":"string","format":"date-time","title":"Creation Ts","description":"Timestamp when the call was created","examples":["2020-01-01T00:00:00.000000Z"]},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At","description":"Timestamp when the call reached a terminal status","examples":["2020-01-01T00:05:00.000000Z"]}},"type":"object","required":["id","status","request","creation_ts"],"title":"ExternalPatientCall"},"ExternalPatientCallAnswer":{"properties":{"question_id":{"type":"string","title":"Question Id","description":"ID of the question from the call script","examples":["q_abc123"]},"question_text":{"type":"string","title":"Question Text","description":"Text of the question that was asked","examples":["Would you like to schedule a refill?"]},"answer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Answer","description":"Answer captured during the live call","examples":["Yes"]}},"type":"object","required":["question_id","question_text"],"title":"ExternalPatientCallAnswer"},"ExternalPatientCallOutcome":{"type":"string","enum":["LIVE_ANSWERED","VOICEMAIL_LEFT","NO_ANSWER","FAILED"],"title":"ExternalPatientCallOutcome"},"ExternalPatientCallRequest":{"properties":{"type":{"$ref":"#/components/schemas/ExternalPatientCallType","description":"Type of patient call. Currently only PATIENT_OUTREACH is supported.","default":"PATIENT_OUTREACH","examples":["PATIENT_OUTREACH"]},"patient_name":{"type":"string","title":"Patient Name","description":"Name of the patient to call","examples":["Alex Martin"]},"patient_phone":{"type":"string","title":"Patient Phone","description":"Phone number to dial. E.164 format preferred (e.g. +14155552671).","examples":["+14155552671"]},"desired_call_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Desired Call Ts","description":"When to place the call, as an ISO 8601 timestamp. If omitted, the call is scheduled to start within the next 5 minutes.","examples":["2024-03-19T14:30:00Z"]},"call_script_id":{"type":"string","title":"Call Script Id","description":"ID of a call script belonging to your team. Create and manage scripts in the dashboard under Call Scripts. The script defines the questions asked when the patient answers live.","examples":["script_abc123"]},"voice":{"$ref":"#/components/schemas/ExternalPatientCallVoice","description":"Cartesia voice used for the call and any voicemail. Allowed values: KRISPIN, RONALD, PRIYA, DEVANSH.","examples":["KRISPIN"]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"Optional identifier you define for tracking (e.g. provider or campaign id).","examples":["provider_123"]},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"Key/value pairs available to the agent while it runs the call script during the live call (e.g. medication name, appointment time). Also returned on the call response and webhooks.","examples":[{"appointment_date":"04-01-2024","medication":"Atorvastatin"}]},"leave_voicemail_if_no_answer":{"type":"boolean","title":"Leave Voicemail If No Answer","description":"If true, leave a voicemail when the patient does not answer. Voicemail is a fallback for unanswered calls, not a separate product.","default":true},"voicemail_script":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voicemail Script","description":"Message to leave if leave_voicemail_if_no_answer is true. Required when leave_voicemail_if_no_answer is true once the API is activated.","examples":["Hi, this is Riverside Family Medicine calling about your prescription refill. Please call us back at 555-0100."]}},"type":"object","required":["patient_name","patient_phone","call_script_id","voice"],"title":"ExternalPatientCallRequest"},"ExternalPatientCallType":{"type":"string","enum":["PATIENT_OUTREACH"],"title":"ExternalPatientCallType"},"ExternalPatientCallVoice":{"type":"string","enum":["KRISPIN","RONALD","PRIYA","DEVANSH"],"title":"ExternalPatientCallVoice","description":"Curated Cartesia voices available for patient calls.\n\nFriendly names map to internal Cartesia voice IDs when dialing is activated."},"ExternalTranscriptVerification":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the verification"},"inquiry_id":{"type":"string","title":"Inquiry Id","description":"The inquiry ID this verification belongs to"},"call_log_id":{"type":"string","title":"Call Log Id","description":"The call log ID this verification is for"},"verification_items":{"items":{"$ref":"#/components/schemas/ExternalVerificationItem"},"type":"array","title":"Verification Items","description":"List of individual verification items checked"},"creation_ts":{"type":"string","title":"Creation Ts","description":"Timestamp when the verification was created in ISO format"}},"type":"object","required":["id","inquiry_id","call_log_id","verification_items","creation_ts"],"title":"ExternalTranscriptVerification","description":"External representation of a transcript verification result."},"ExternalVerificationItem":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the verification item"},"description":{"type":"string","title":"Description","description":"Description of what is being verified"},"status":{"type":"string","title":"Status","description":"Status of the verification (e.g., MET, NOT_MET, UNCLEAR, NOT_APPLICABLE)"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence","description":"Evidence from the transcript supporting the status"},"reasoning":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning","description":"AI reasoning for the verification result"},"validation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Validation","description":"Value-accuracy check comparing the recorded result value against the transcript. Contains status, recorded_value, transcript_value, evidence, and reasoning. Null when no corresponding recorded value exists for this item."}},"type":"object","required":["name","description","status"],"title":"ExternalVerificationItem","description":"External representation of a verification item."},"ExtraDentalInfo":{"properties":{"waiting_periods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Waiting Periods"},"deductible_applies_to_preventive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Deductible Applies To Preventive"},"preventative_applies_to_maximum":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Preventative Applies To Maximum"},"missing_tooth_clause":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Missing Tooth Clause"},"has_pending_claims":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Pending Claims"},"do_limited_and_routine_exam_share_frequencies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Do Limited And Routine Exam Share Frequencies"},"do_all_exams_share_frequencies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Do All Exams Share Frequencies"},"is_treatment_allowed_same_day_as_exam":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Treatment Allowed Same Day As Exam"},"does_deductible_apply_to_xrays":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Does Deductible Apply To Xrays"},"does_pano_share_frequency_with_fmx":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Does Pano Share Frequency With Fmx"},"is_crown_claim_filed_on_seat_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Crown Claim Filed On Seat Date"},"is_four_quads_one_day_okay_srp_4341":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Four Quads One Day Okay Srp 4341"},"filing_deadline_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Filing Deadline Days"},"orthodontics_payment_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orthodontics Payment Frequency"},"orthodontics_age_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Age Limit"},"orthodontics_age_limit_applies_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orthodontics Age Limit Applies To"},"when_during_year_do_orthodontic_benefits_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"When During Year Do Orthodontic Benefits End"},"orthodontics_work_in_progress_covered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Orthodontics Work In Progress Covered"},"orthodontics_percentage_paid_at_banding":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Orthodontics Percentage Paid At Banding"},"are_orthodontics_remaining_payments_automatic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Are Orthodontics Remaining Payments Automatic"},"orthodontics_codes_included_in_maximum":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Orthodontics Codes Included In Maximum"},"are_orthodontic_records_billed_separately":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Are Orthodontic Records Billed Separately"},"custom_answers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Custom Answers"}},"type":"object","title":"ExtraDentalInfo"},"ExtraMedicalInfo":{"properties":{"benefit_max_per_year":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benefit Max Per Year"},"benefit_max_per_office_visit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benefit Max Per Office Visit"},"annual_max_number_of_visits":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Annual Max Number Of Visits"},"specialty_rx_benefits":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Specialty Rx Benefits"},"is_aba_autism_covered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Aba Autism Covered"},"is_cotreatment_allowed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Cotreatment Allowed"},"authorization_submission_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Submission Info"},"is_copay_subject_to_out_of_pocket":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Copay Subject To Out Of Pocket"},"will_copay_be_waived_if_oop_is_met":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Will Copay Be Waived If Oop Is Met"},"copay_for_home_visit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Copay For Home Visit"},"copay_for_center_visit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Copay For Center Visit"},"copay_for_telehealth_visit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Copay For Telehealth Visit"},"coinsurance_percentage_for_home_visit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coinsurance Percentage For Home Visit"},"coinsurance_percentage_for_center_visit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coinsurance Percentage For Center Visit"},"coinsurance_percentage_for_telehealth_visit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coinsurance Percentage For Telehealth Visit"},"is_deductible_waived_for_home_visit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Deductible Waived For Home Visit"},"is_deductible_waived_for_center_visit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Deductible Waived For Center Visit"},"is_deductible_waived_for_telehealth_visit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Deductible Waived For Telehealth Visit"},"is_aba_coverage_same_office_vs_home":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Aba Coverage Same Office Vs Home"},"do_we_need_to_request_a_special_authorization_for_telehealth_in_addition_to_usual_aba_authorization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Do We Need To Request A Special Authorization For Telehealth In Addition To Usual Aba Authorization"},"is_telehealth_visit_covered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Telehealth Visit Covered"},"how_is_telehealth_covered":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"How Is Telehealth Covered"},"copay_structure_per_category_or_per_visit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Copay Structure Per Category Or Per Visit"},"separate_copay_for_telehealth_and_codes_billed_together":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Separate Copay For Telehealth And Codes Billed Together"},"services_combined_with_other_therapies":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Services Combined With Other Therapies"},"exclusions_on_policy_for_services":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclusions On Policy For Services"},"is_combined_with_pt_ot":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Combined With Pt Ot"},"visits_counted_as_one_if_same_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visits Counted As One If Same Day"},"visit_limit_waived_with_asd_dx":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit Limit Waived With Asd Dx"},"custom_answers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Custom Answers"}},"type":"object","title":"ExtraMedicalInfo"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InquiryCreationResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"inquiry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inquiry Id"},"already_existed":{"type":"boolean","title":"Already Existed","default":false}},"type":"object","required":["success"],"title":"InquiryCreationResponse"},"InquiryDeletionResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"inquiry_id":{"type":"string","title":"Inquiry Id"}},"type":"object","required":["success","inquiry_id"],"title":"InquiryDeletionResponse"},"InquirySubscriptionResponse":{"properties":{"subscription_id":{"type":"string","title":"Subscription Id"},"inquiries":{"items":{"anyOf":[{"$ref":"#/components/schemas/ExternalDentalInquiry"},{"$ref":"#/components/schemas/ExternalMedicalInquiry"},{"$ref":"#/components/schemas/ExternalMentalHealthInquiry"}]},"type":"array","title":"Inquiries"},"message_hash":{"type":"string","title":"Message Hash","default":""}},"type":"object","required":["subscription_id","inquiries"],"title":"InquirySubscriptionResponse"},"KnowledgeEntryDeletionResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"entry_id":{"type":"string","title":"Entry Id"}},"type":"object","required":["success","entry_id"],"title":"KnowledgeEntryDeletionResponse"},"Maximums":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"individual_deductible":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Individual Deductible"},"individual_deductible_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Individual Deductible Used"},"individual_deductible_resets_each_calendar_year":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Individual Deductible Resets Each Calendar Year"},"individual_out_of_pocket_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Individual Out Of Pocket Maximum"},"individual_out_of_pocket_maximum_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Individual Out Of Pocket Maximum Used"},"family_deductible":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Family Deductible"},"family_deductible_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Family Deductible Used"},"family_out_of_pocket_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Family Out Of Pocket Maximum"},"family_out_of_pocket_maximum_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Family Out Of Pocket Maximum Used"},"coverage_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coverage Limit"},"coverage_limit_remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coverage Limit Remaining"},"orthodontic_deductible":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontic Deductible"},"orthodontics_deductible_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Deductible Used"},"orthodontics_coverage_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Coverage Limit"},"orthodontics_coverage_limit_remaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Coverage Limit Remaining"},"orthodontics_lifetime_maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Lifetime Maximum"},"orthodontics_lifetime_maximum_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Lifetime Maximum Used"},"orthodontics_maximum_benefits_per_case":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Orthodontics Maximum Benefits Per Case"},"periodontic_maximum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Periodontic Maximum"},"periodontic_maximum_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Periodontic Maximum Used"},"implant_maximum":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Implant Maximum"},"implant_maximum_used":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Implant Maximum Used"},"custom_answers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Custom Answers"},"deductible_remaining":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Deductible Remaining","description":"The amount of deductible remaining for the patient. Calculated as the minimum of the individual and family deductible remaining."},"out_of_pocket_maximum_remaining":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Out Of Pocket Maximum Remaining","description":"The amount of out of pocket maximum remaining for the patient. Calculated as the minimum of the individual and family out of pocket maximum remaining."}},"type":"object","title":"Maximums"},"NewCallRequest":{"properties":{"phone_number":{"type":"string","title":"Phone Number"},"insurance_name":{"type":"string","title":"Insurance Name"}},"type":"object","required":["phone_number","insurance_name"],"title":"NewCallRequest"},"NewCallRequestV2":{"properties":{"phone_number":{"type":"string","title":"Phone Number"},"insurance_name":{"type":"string","title":"Insurance Name"},"patient_member_id":{"type":"string","title":"Patient Member Id"},"patient_dob":{"type":"string","title":"Patient Dob"},"patient_group_number":{"type":"string","title":"Patient Group Number"},"npi":{"type":"string","title":"Npi"},"tax_id":{"type":"string","title":"Tax Id"},"agree_to_baa":{"type":"boolean","title":"Agree To Baa"}},"type":"object","required":["phone_number","insurance_name","patient_member_id","patient_dob","patient_group_number","npi","tax_id","agree_to_baa"],"title":"NewCallRequestV2"},"PatientCallCreationResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"call_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Id"},"already_existed":{"type":"boolean","title":"Already Existed","default":false}},"type":"object","required":["success"],"title":"PatientCallCreationResponse"},"PatientCallDeletionResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"call_id":{"type":"string","title":"Call Id"}},"type":"object","required":["success","call_id"],"title":"PatientCallDeletionResponse"},"PlanInformation":{"properties":{"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"plan_type":{"anyOf":[{"$ref":"#/components/schemas/PlanType"},{"type":"null"}]},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Name"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"termination_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termination Date"},"is_calendar_year_plan":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Calendar Year Plan"},"is_provider_in_network":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Provider In Network"},"is_primary_insurance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Primary Insurance"},"is_provider_pcp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Provider Pcp"},"has_other_insurance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Other Insurance"},"is_self_funded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Self Funded"},"has_out_of_state_coverage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Out Of State Coverage"},"referral_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Referral Required"},"referral_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referral Info"},"out_of_network_benefits":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Out Of Network Benefits"},"custom_answers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Custom Answers"}},"type":"object","title":"PlanInformation"},"PlanType":{"type":"string","enum":["HMO","PPO","POS","EPO","OAP","MEDICAID","HMO_POS","OTHER"],"title":"PlanType"},"PracticeSummary":{"properties":{"practice_id":{"type":"string","title":"Practice Id","description":"Practice ID this summary applies to","examples":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"summary":{"type":"string","title":"Summary","description":"Free-text summary describing this practice location","examples":["Main office in downtown; specializes in pediatric care"]}},"type":"object","required":["practice_id","summary"],"title":"PracticeSummary","description":"Practice-specific summary for organization info."},"ProcedureCodeInfo":{"properties":{"procedure_code":{"type":"string","title":"Procedure Code"},"procedure_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Procedure Name"}},"type":"object","required":["procedure_code"],"title":"ProcedureCodeInfo"},"SubscriptionCreationResponse":{"properties":{"success":{"type":"boolean","title":"Success"}},"type":"object","required":["success"],"title":"SubscriptionCreationResponse"},"SubscriptionRequest":{"properties":{"callback_url":{"type":"string","title":"Callback Url"},"update_frequency_min":{"type":"integer","title":"Update Frequency Min","default":5},"webhook_delay_min":{"type":"integer","title":"Webhook Delay Min","default":15}},"type":"object","required":["callback_url"],"title":"SubscriptionRequest"},"Token":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"}},"type":"object","required":["access_token","token_type"],"title":"Token"},"TranscriptVerificationsResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Whether the request was successful"},"count":{"type":"integer","title":"Count","description":"Number of verifications returned"},"verifications":{"items":{"$ref":"#/components/schemas/ExternalTranscriptVerification"},"type":"array","title":"Verifications","description":"List of transcript verification results, sorted by creation time (newest first)"}},"type":"object","required":["success","count","verifications"],"title":"TranscriptVerificationsResponse","description":"Response model for transcript verifications endpoint."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"token"}}},"HTTPBasic":{"type":"http","scheme":"basic"},"LoginManager":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/login?provider=google"}}}}}}