{"openapi":"3.1.0","info":{"title":"Develop Health Public API","description":"Develop Health Public API","version":"1.0"},"paths":{"/benefit-verification":{"post":{"tags":["public-api"],"summary":"Create Benefit Verification Route","operationId":"create_benefit_verification_route_benefit_verification_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreateBenefitVerificationRequest"}],"title":"Data","examples":[{"priority":3,"drugs":[{"name":"Wegovy","dosage":"0.25 mg","quantity":1.0},{"name":"Ozempic","dosage":"2.68 mg","quantity":1.0},{"name":"Mounjaro","dosage":"2.5 mg","quantity":1.0}],"drug_history":{"currently_taking_drugs":[{"name":"Metformin"}],"previously_taken_drugs":[{"name":"Jardiance"},{"name":"Rybelsus"}]},"diagnoses":[{"code":"E66.9"},{"code":"I10"}],"insurance":[{"file_content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAFgwJ/lzvN2QAAAABJRU5ErkJggg=="},{"file_content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAFgwJ/lzvN2QAAAABJRU5ErkJggg=="}],"patient":{"internal_id":"39dca4a2-8788-4fd6-9e31-15c56e454322","first_name":"John","last_name":"Smith","gender":"male","date_of_birth":"1980-01-01","address":{"street":"123 Main St, Apt 1","city":"Los Angeles","state_province":"CA","zip_postal_code":"94001","country":"USA"},"phone":"555-555-5555"},"provider":{"first_name":"Jane","last_name":"Green","address":{"street":"9071 E. Mississippi Ave","city":"Denver","state_province":"CO","zip_postal_code":"80247","country":"USA"},"phone":"1231231234","fax":"None","npi":"0000000000","in_network_payers":[]},"entity":{"legal_name":"Test Entity","tax_id":"111223333"},"use_patient_plan_fund_source_check":false}]}}},"required":true},"responses":{"200":{"description":"Successful creation of a benefit verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBenefitVerificationResponse"},"example":{"status":"success","data":{"id":"bv_sdkfj3f"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/benefit-verification/{id}":{"get":{"tags":["public-api"],"summary":"Get Benefit Verification Route","operationId":"get_benefit_verification_route_benefit_verification__id__get","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successfully returned a benefit verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBenefitVerificationResponse"},"example":{"status":"success","data":{"id":"bv_dj3wiu","object":"benefit_verification","status":"completed","status_description":"The verification was successful","review_status":"not_reviewed","drugs":[{"name":"Wegovy","dosage":"0.25 mg","quantity":1.0,"coverage":"covered","coverage_detail_code":"insurer_reported_value","prior_authorization_required":"yes","copay":"$30 for 28 days supply","copay_options":[{"amount_cents":3000,"supply_duration_days":28}],"determination_details":{"is_on_formulary":true}},{"name":"Ozempic","dosage":"2.68 mg","quantity":1.0,"coverage":"covered","coverage_detail_code":"insurer_reported_value","prior_authorization_required":"yes","copay":"$30 for 28 days supply","copay_options":[{"amount_cents":3000,"supply_duration_days":28}],"determination_details":{"is_on_formulary":true}},{"name":"Mounjaro","dosage":"2.5 mg","quantity":1.0,"coverage":"covered","coverage_detail_code":"insurer_reported_value","prior_authorization_required":"yes","copay":"$30 for 28 days supply","copay_options":[{"amount_cents":3000,"supply_duration_days":28}],"determination_details":{"is_on_formulary":true}}],"drug_history":{"currently_taking_drugs":[{"name":"Metformin"}],"previously_taken_drugs":[{"name":"Jardiance"},{"name":"Rybelsus"}]},"diagnoses":[{"code":"E66.9"},{"code":"I10"}],"patient":{"internal_id":"39dca4a2-8788-4fd6-9e31-15c56e454322","first_name":"John","last_name":"Smith","gender":"male","date_of_birth":"1980-01-01","address":{"street":"123 Main St, Apt 1","city":"Los Angeles","state_province":"CA","zip_postal_code":"94001","country":"USA"},"phone":"555-555-5555"},"provider":{"first_name":"Jane","last_name":"Green","address":{"street":"9071 E. Mississippi Ave","city":"Denver","state_province":"CO","zip_postal_code":"80247","country":"USA"},"phone":"1231231234","fax":"None","npi":"0000000000","in_network_payers":[]},"entity":{"legal_name":"Test Entity","tax_id":"111223333"},"insurance":[{"scanned_content":{"client_name":"Company","group_number":"12345678","member_name":"John Smith","member_number":"12345678","payer_name":"United","plan_name":"Plus Plan","rx_bin":"123456","rx_group":"ADV","rx_pcn":"FAC"},"discrete_content":{},"url":"https://example.com/insurance_doc"},{"scanned_content":{"error":"Unable to extract information from card"},"discrete_content":{},"url":"https://example.com/insurance_doc2"}],"patient_coverage_status":"covered","verification_methods":[{"id":"bva_23j3234","type":"ai_call","transcript":"Call transcript","recording_url":"https://example.com/recording"}],"patient_plan_fund_source":"question_not_asked","patient_coverage_type":"question_not_asked","priority":2}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/benefit-verification/{id}/cancel":{"post":{"tags":["public-api"],"summary":"Cancel Benefit Verification Route","operationId":"cancel_benefit_verification_route_benefit_verification__id__cancel_post","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"503":{"content":{"application/json":{"example":{"status":"error","error":{"title":"Benefit Verification Busy","description":"Benefit Verification with id bv_abc123 is temporarily locked by other processing. Retry the request shortly.","code":"resource_busy"}}}},"description":"Another transaction holds the benefit verification, so the cancellation was not applied. The request is safe to retry."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clinical-qualification":{"post":{"tags":["public-api"],"summary":"Create Clinical Qualification Route","operationId":"create_clinical_qualification_route_clinical_qualification_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreateClinicalQualificationRequest"}],"title":"Data","examples":[{"diagnoses":[{"code":"E66.9"}],"evidence":[{"content":{"bmi_value":32,"date_measured":"2023-11-10"},"date_created":"2023-11-10T10:15:00","title":"BMI Chart"},{"content":{"medication_name":"Metformin","response":"No significant weight loss"},"date_created":"2023-11-10T10:15:00","title":"Previous Medication History"}],"patient":{"address":{"street":"123 Health St.","city":"Wellness","state_province":"CA","zip_postal_code":"12345","country":"USA"},"date_of_birth":"1980-01-01","email":"johndoe@email.com","first_name":"John","last_name":"Doe","gender":"male","internal_id":"123456","phone":"123-456-7890"},"insurance":[{"file_content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAFgwJ/lzvN2QAAAABJRU5ErkJggg=="},{"file_content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAFgwJ/lzvN2QAAAABJRU5ErkJggg=="}],"drugs":[{"days_supply":30,"quantity":2,"directions":"Inject subcutaneously once a week","drug_name":"Wegovy","strength":"0.25 mg/0.5 mL (0.25 mg dose)","dose_form":"injectable","route_of_administration":"subcutaneous"},{"days_supply":28,"quantity":1,"directions":"Inject subcutaneously once a week","drug_name":"Ozempic","strength":"0.5 mg/dose","dose_form":"injectable","route_of_administration":"subcutaneous"},{"days_supply":28,"quantity":4,"directions":"Inject subcutaneously once a week","drug_name":"Zepbound","strength":"1 mg/dose","dose_form":"injectable","route_of_administration":"subcutaneous"}],"provider":{"address":{"street":"456 Care Blvd.","city":"Healtown","state_province":"CA","zip_postal_code":"67890","country":"USA"},"fax":"987-654-3211","first_name":"Alice","internal_id":"provider_12345","last_name":"Smith","npi":"1234567890","phone":"987-654-3210"},"questionnaires":[{"questions":[{"answer":"I usually eat a balanced diet and exercise 3 times a week.","question":"Please describe your current diet and exercise routine."},{"answer":"Yes, I have tried metformin without significant results.","question":"Have you previously tried other weight loss medications?"}],"date_created":"2023-11-01T08:00:00"}],"visit_notes":[{"content":"Patient presents with a BMI of 32, indicating obesity. Recommended to start Wegovy for weight management.","date_created":"2023-11-10T10:00:00"}]}]}}},"required":true},"responses":{"200":{"description":"Successful creation of an clinical qualification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClinicalQualificationResponse"},"example":{"status":"success","data":{"id":"cq_sdkfj3f"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/clinical-qualification/{id}":{"get":{"tags":["public-api"],"summary":"Get Clinical Qualification Submission By Id","operationId":"get_clinical_qualification_submission_by_id_clinical_qualification__id__get","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successfully returned an clinical qualification.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClinicalQualificationResponse"},"example":{"status":"success","data":{"id":"cq_sdkfj3f","object":"clinical_qualification","diagnoses":[{"code":"E66.9"}],"evidence":[{"content":{"bmi_value":32,"date_measured":"2023-11-10"},"date_created":"2023-11-10T10:15:00","title":"BMI Chart"},{"content":{"medication_name":"Metformin","response":"No significant weight loss"},"date_created":"2023-11-10T10:15:00","title":"Previous Medication History"}],"patient":{"address":{"street":"123 Health St.","city":"Wellness","state_province":"CA","zip_postal_code":"12345","country":"USA"},"date_of_birth":"1980-01-01","email":"johndoe@email.com","first_name":"John","last_name":"Doe","gender":"male","internal_id":"123456","phone":"123-456-7890"},"insurance":[{"scanned_content":{"client_name":"Company","group_number":"12345678","member_name":"John Doe","member_number":"12345678","payer_name":"United","plan_name":"Plus Plan","rx_bin":"123456","rx_group":"ADV","rx_pcn":"FAC"},"discrete_content":{},"url":"https://example.com/insurance_doc"},{"scanned_content":{"error":"Unable to extract information from card"},"discrete_content":{},"url":"https://example.com/insurance_doc2"}],"drugs":[{"days_supply":30,"quantity":2,"directions":"Inject subcutaneously once a week","drug_name":"Wegovy","strength":"0.25 mg/0.5 mL (0.25 mg dose)","dose_form":"injectable","route_of_administration":"subcutaneous"},{"days_supply":28,"quantity":1,"directions":"Inject subcutaneously once a week","drug_name":"Ozempic","strength":"0.5 mg/dose","dose_form":"injectable","route_of_administration":"subcutaneous"},{"days_supply":28,"quantity":4,"directions":"Inject subcutaneously once a week","drug_name":"Zepbound","strength":"1 mg/dose","dose_form":"injectable","route_of_administration":"subcutaneous"}],"provider":{"address":{"street":"456 Care Blvd.","city":"Healtown","state_province":"CA","zip_postal_code":"67890","country":"USA"},"fax":"987-654-3211","first_name":"Alice","internal_id":"provider_12345","last_name":"Smith","npi":"1234567890","phone":"987-654-3210"},"questionnaires":[{"questions":[{"answer":"I usually eat a balanced diet and exercise 3 times a week.","question":"Please describe your current diet and exercise routine."},{"answer":"Yes, I have tried metformin without significant results.","question":"Have you previously tried other weight loss medications?"}],"date_created":"2023-11-01T08:00:00"}],"visit_notes":[{"content":"Patient presents with a BMI of 32, indicating obesity. Recommended to start Wegovy for weight management.","date_created":"2023-11-10T10:00:00"}],"results":[{"drug":{"days_supply":30,"quantity":2,"directions":"Inject subcutaneously once a week","drug_name":"Wegovy","strength":"0.25 mg/0.5 mL (0.25 mg dose)","dose_form":"injectable","route_of_administration":"subcutaneous"},"status":"qualified","unqualified_reasons":[]},{"drug":{"days_supply":28,"quantity":4,"directions":"Inject subcutaneously once a week","drug_name":"Zepbound","strength":"1 mg/dose","dose_form":"injectable","route_of_administration":"subcutaneous"},"status":"qualified","unqualified_reasons":[]},{"drug":{"days_supply":28,"quantity":1,"directions":"Inject subcutaneously once a week","drug_name":"Ozempic","strength":"0.5 mg/dose","dose_form":"injectable","route_of_administration":"subcutaneous"},"status":"unqualified","unqualified_reasons":[{"description":"The patient does not have a diagnosis of type 2 diabetes."}]}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/prior-authorization/{id}/cancel":{"post":{"tags":["public-api","public-api"],"summary":"Cancel Prior Auth Submission By Id","description":"Cancel a prior authorization request.\n\nThe request must not already be in a terminal state (`completed`, `failed`,\nor `cancelled`). Requires a `cancellation_reason` payload which is stored\nfor analytics.","operationId":"cancel_prior_auth_submission_by_id_prior_authorization__id__cancel_post","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request Data","allOf":[{"$ref":"#/components/schemas/CancelPriorAuthRequest"}]}}}},"responses":{"200":{"description":"Successfully cancelled a prior authorization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPriorAuthResponse"},"example":{"status":"success"}}}},"400":{"content":{"application/json":{"example":{"detail":"Cannot cancel a prior authorization request with status: COMPLETED"}}},"description":"Cannot cancel a prior authorization in completed, failed, or cancelled state"},"404":{"content":{"application/json":{"example":{"detail":"Prior Authorization Request does not exist."}}},"description":"Prior Authorization Request does not exist"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/prior-authorization/{id}/feedback":{"post":{"tags":["public-api","public-api"],"summary":"Submit Prior Auth Feedback","description":"Submit feedback related to a prior authorization request.\n\nThe feedback is used to improve the product and is surfaced in analytics dashboards.","operationId":"submit_prior_auth_feedback_prior_authorization__id__feedback_post","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request Data","allOf":[{"$ref":"#/components/schemas/PriorAuthFeedbackRequest"}]}}}},"responses":{"201":{"description":"Successfully submitted feedback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriorAuthFeedbackResponse"},"example":{"status":"success"}}}},"404":{"content":{"application/json":{"example":{"detail":"Prior Authorization Request does not exist."}}},"description":"Prior Authorization Request does not exist"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/prior-authorization/{id}/ndp-submission":{"patch":{"tags":["public-api","public-api"],"summary":"Update Ndp Submission By Id","description":"Update the preferred pharmacy NCPDP ID for a prior authorization's NDP\nsubmission. Only allowed while the PA request is active and no transfer\nattempts have been made.","operationId":"update_ndp_submission_by_id_prior_authorization__id__ndp_submission_patch","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Request Data","allOf":[{"$ref":"#/components/schemas/UpdateNDPSubmissionRequest"}]}}}},"responses":{"200":{"description":"Successfully updated preferred pharmacy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNDPSubmissionResponse"},"example":{"status":"success","data":{"preferred_pharmacy_ncpdp_id":"1234567"}}}}},"400":{"content":{"application/json":{"example":{"detail":"Cannot update preferred pharmacy for a prior authorization request with status: COMPLETED"}}},"description":"Cannot update preferred pharmacy for terminal PA requests."},"404":{"content":{"application/json":{"example":{"detail":"Prior Authorization Request does not exist."}}},"description":"Prior Authorization Request does not exist."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/prior-authorization/{id}/prescription-transfer/cancel":{"post":{"tags":["public-api","public-api"],"summary":"Cancel Prescription Transfer By Id","description":"Cancel the prescription transfer for a prior authorization with NDP submission.","operationId":"cancel_prescription_transfer_by_id_prior_authorization__id__prescription_transfer_cancel_post","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successfully cancelled prescription transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPriorAuthPrescriptionTransferResponse"},"example":{"status":"success"}}}},"400":{"content":{"application/json":{"example":{"detail":"Cannot cancel prescription transfer due to completed status"}}},"description":"Cannot cancel prescription transfer in completed state"},"404":{"content":{"application/json":{"example":{"detail":"Prior Authorization Request does not exist."}}},"description":"Prior Authorization Request does not exist"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/prior-authorization":{"post":{"tags":["public-api"],"summary":"Create Prior Auth Route","operationId":"create_prior_auth_route_prior_authorization_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreatePriorAuthRequest"}],"title":"Data","examples":[{"diagnoses":[{"code":"E66.9"}],"evidence":[{"content":{"bmi_value":32,"date_measured":"2023-11-10"},"date_created":"2023-11-10T10:15:00","title":"BMI Chart"},{"content":{"medication_name":"Metformin","response":"No significant weight loss"},"date_created":"2023-11-10T10:15:00","title":"Previous Medication History"}],"patient":{"address":{"street":"123 Health St.","city":"Wellness","state_province":"CA","zip_postal_code":"12345","country":"USA"},"date_of_birth":"1980-01-01","email":"johndoe@email.com","first_name":"John","last_name":"Doe","gender":"male","internal_id":"123456","phone":"123-456-7890"},"insurance":[{"file_content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAFgwJ/lzvN2QAAAABJRU5ErkJggg=="},{"file_content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAFgwJ/lzvN2QAAAABJRU5ErkJggg=="}],"prescription":{"days_supply":30,"quantity":2,"directions":"Inject subcutaneously once a week","drug_name":"Wegovy","strength":"0.25 mg/0.5 mL (0.25 mg dose)","dose_form":"injectable","route_of_administration":"subcutaneous","extra":{"prescribing_information":"Prescribed for weight management in patients with obesity"},"prescription_date":"2024-02-14T05:46:07.764000"},"provider":{"address":{"street":"456 Care Blvd.","city":"Healtown","state_province":"CA","zip_postal_code":"67890","country":"USA"},"fax":"987-654-3211","first_name":"Alice","internal_id":"provider_12345","last_name":"Smith","npi":"1234567890","phone":"987-654-3210"},"pharmacy":{"name":"Walgreens","address":{"street":"789 Pharmacy Ave.","city":"Medtown","state_province":"MD","zip_postal_code":"12345","country":"USA"}},"questionnaires":[{"questions":[{"answer":"I usually eat a balanced diet and exercise 3 times a week.","question":"Please describe your current diet and exercise routine."},{"answer":"Yes, I have tried metformin without significant results.","question":"Have you previously tried other weight loss medications?"}],"date_created":"2023-11-01T08:00:00"}],"visit_notes":[{"content":"Patient presents with a BMI of 32, indicating obesity. Recommended to start Wegovy for weight management.","date_created":"2023-11-10T10:00:00"}],"priority":2}]}}},"required":true},"responses":{"200":{"description":"Successful creation of a prior authorization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePriorAuthResponse"},"example":{"status":"success","data":{"id":"pa_sdkfj3f"}}}}},"400":{"description":"API error during creation of the prior authorization request","content":{"application/json":{"example":{"status":"error","error":{"title":"Unsupported Drug","description":"The drug you submitted is not yet supported for prior authorization.","code":"unsupported_drug"}}}}},"409":{"description":"Conflict: prescription message already linked to existing prior authorization","content":{"application/json":{"example":{"status":"error","error":{"title":"Prescription Already Linked","description":"The prescription_message_id provided is already linked to a prior authorization request that is in progress or has already been completed as approved. The existing PA request must be cancelled before submitting a new request for the same prescription.","code":"prescription_message_already_linked","existing_prior_auth_request_id":"par_example123"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/prior-authorization/{id}":{"get":{"tags":["public-api"],"summary":"Get Prior Auth Submission By Id","operationId":"get_prior_auth_submission_by_id_prior_authorization__id__get","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successfully returned a prior authorization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPriorAuthResponse"},"example":{"status":"success","data":{"id":"pa_sdkfj3f","object":"prior_authorization","url":"https://platform.develophealth.ai/prior-authorizations/pa_sdkfj3f","status":"completed","diagnoses":[{"code":"E66.9"}],"evidence":[{"content":{"bmi_value":32,"date_measured":"2023-11-10"},"date_created":"2023-11-10T10:15:00","title":"BMI Chart"},{"content":{"medication_name":"Metformin","response":"No significant weight loss"},"date_created":"2023-11-10T10:15:00","title":"Previous Medication History"}],"patient":{"address":{"street":"123 Health St.","city":"Wellness","state_province":"CA","zip_postal_code":"12345","country":"USA"},"date_of_birth":"1980-01-01","email":"johndoe@email.com","first_name":"John","last_name":"Doe","gender":"male","internal_id":"123456","phone":"123-456-7890"},"insurance":[{"scanned_content":{"client_name":"Company","group_number":"12345678","member_name":"John Doe","member_number":"12345678","payer_name":"United","plan_name":"Plus Plan","rx_bin":"123456","rx_group":"ADV","rx_pcn":"FAC"},"discrete_content":{},"url":"https://example.com/insurance_doc"},{"scanned_content":{"error":"Unable to extract information from card"},"discrete_content":{},"url":"https://example.com/insurance_doc2"}],"prescription":{"days_supply":30,"quantity":2,"directions":"Inject subcutaneously once a week","drug_name":"Wegovy","strength":"0.25 mg/0.5 mL (0.25 mg dose)","dose_form":"injectable","route_of_administration":"subcutaneous","extra":{"prescribing_information":"Prescribed for weight management in patients with obesity"},"prescription_date":"2024-02-14T05:46:07.764000"},"provider":{"address":{"street":"456 Care Blvd.","city":"Healtown","state_province":"CA","zip_postal_code":"67890","country":"USA"},"fax":"987-654-3211","first_name":"Alice","internal_id":"provider_12345","last_name":"Smith","npi":"1234567890","phone":"987-654-3210"},"pharmacy":{"name":"Walgreens","address":{"street":"789 Pharmacy Ave.","city":"Medtown","state_province":"MD","zip_postal_code":"12345","country":"USA"}},"questionnaires":[{"questions":[{"answer":"I usually eat a balanced diet and exercise 3 times a week.","question":"Please describe your current diet and exercise routine."},{"answer":"Yes, I have tried metformin without significant results.","question":"Have you previously tried other weight loss medications?"}],"date_created":"2023-11-01T08:00:00"}],"visit_notes":[{"content":"Patient presents with a BMI of 32, indicating obesity. Recommended to start Wegovy for weight management.","date_created":"2023-11-10T10:00:00"}],"activity_log":[{"id":"sent_fax__S4382DA","created_at":"2024-02-14T02:01:02","type":"sent_fax","details":{"url":"https://example.com/sent_fax"}},{"id":"rec_fax__SJ34WX","created_at":"2024-02-14T05:46:07","type":"received_fax","details":{"url":"https://example.com/received_fax"}},{"id":"pa_follow_up_call__BF9AJ56","created_at":"2024-02-14T05:50:10","type":"follow_up_call","details":{"notes":"Called Example PBM and ...","recording_url":"https://example.com/follow_up_call_recording","transcript":"Hello, this is Example PBM ..."}}],"submitted_by":{"first_name":"John","last_name":"Doe","email":"johndoe@email.com"},"reviewed_by":{"first_name":"Jane","last_name":"Doe","email":"janedoe@email.com"},"denial_reason_analysis":{"categories":["Preferred Products Not Tried First"],"explanation":"The prior authorization request for Zepbound (tirzepatide) was denied because the patient's health plan requires ...","next_steps_code":"other","next_steps":"Discuss with Provider","next_steps_explanation":"The denial was due to the requirement to try a primary covered drug, Wegovy, before Zepbound can be approved. The client should discuss with the provider ..."},"is_appeal":false,"patient_consent_required":false,"outcome":{"detail":"Step Therapy Criteria Not Met","result":"Denied","detail_code":"step_therapy_criteria_not_met"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/pa-status":{"post":{"tags":["public-api"],"summary":"Create a PA status check","description":"Create an asynchronous PA status check.\n\n`instant_only` never falls back to standard processing. An ineligible or\nfailed instant check becomes a failed operation. `instant_preferred`\nattempts instant processing first and permits standard fallback.\n\nThis contract-only stub currently returns 501 without creating a record.","operationId":"create_pa_status","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaStatusRequest"}}},"required":true},"responses":{"200":{"description":"PA status check created; returns its current processing state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaStatusSuccessResponse"}}}},"501":{"description":"PA status checking is not yet implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseV2"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/pa-status/{id}":{"get":{"tags":["public-api"],"summary":"Get a PA status check","description":"Get the current state of an asynchronous PA status check.\n\nOnly the effective processing method is returned. If an\n`instant_preferred` request falls back, it changes from `instant` to\n`standard`.\n\nThis contract-only stub currently returns 501.","operationId":"get_pa_status","security":[{"FronteggJWTAuthentication":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"PA status check ID.","title":"Id"},"description":"PA status check ID."}],"responses":{"200":{"description":"Current PA status check state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaStatusSuccessResponse"}}}},"404":{"description":"No PA status check exists with the supplied ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseV2"}}}},"501":{"description":"PA status checking is not yet implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseV2"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/status":{"get":{"tags":["public-api"],"summary":"Get Status Route","description":"Handles GET requests at the '/status' endpoint.\n\nThis route function is designed to provide a quick status check of the API.\nWhen called, it returns a JSON response indicating the operational status of the API.\n\nReturns:\n    ApiResponse: An object of ApiResponse schema which includes a 'status' key set to 'success'\n                 and a 'data' key containing a message about the API's operational status.","operationId":"get_status_route_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/provider/authorize":{"post":{"tags":["public-api"],"summary":"Authorize Provider","operationId":"authorize_provider_provider_authorize_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AuthorizeProviderRequest"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful initiation of provider authorization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse"},"example":{"status":"success"}}}},"400":{"description":"Provider authorization already initiated","content":{"application/json":{"example":{"status":"error","error":{"title":"Provider Authorization Already Initiated","description":"Authorization has already been initiated for a provider with this NPI or email","code":"PROVIDER_AUTHORIZATION_ALREADY_INITIATED"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/authorized-providers":{"get":{"tags":["public-api"],"summary":"Get Authorized Providers","description":"Retrieve all authorized providers for the organization.\n\nReturns a list of providers that have been authorized or are pending authorization.\nProviders with signed_at=null are pending authorization (they haven't signed the form yet).\nProviders with signed_at populated have completed the authorization process.\n\nReturns:\n    ApiResponse containing a list of AuthorizedProviderResponse objects","operationId":"get_authorized_providers_authorized_providers_get","responses":{"200":{"description":"Successfully retrieved authorized providers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_list_api.schemas.platform.public_api.provider.AuthorizedProviderResponse__"},"example":{"status":"success","data":[{"npi":"1234567890","first_name":"John","last_name":"Doe","email":"john.doe@example.com","signed_at":"2024-01-15T10:30:00Z"},{"npi":"0987654321","first_name":"Jane","last_name":"Smith","email":"jane.smith@example.com"}]}}}}},"security":[{"FronteggJWTAuthentication":[]}]}},"/provider/lookup":{"post":{"tags":["public-api"],"summary":"Lookup Provider","description":"Look up a provider by NPI or by name+state.\n\nNPI mode: returns ``active``, ``deactivated`` (with name+state search\ncandidates seeded from the deactivated record's name), ``not_found``, or\n``registry_error``. Sandbox organizations may receive an ``active``\nmock identity when the NPI is absent from the registry. Deactivated\nrecords with no name on file return an empty candidate list — the FE\nprompts for manual name+state entry.\n\nName mode: ``last_name`` is required, ``first_name`` and ``state`` are\noptional. Always returns ``search_results`` (the candidate list may be\nempty when no match is found).","operationId":"lookup_provider_provider_lookup_post","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProviderLookupRequest"}],"title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ProviderLookupResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"FronteggJWTAuthentication":[]}]}}},"components":{"schemas":{"ActionEvent":{"properties":{"call_id":{"type":"string","title":"Call Id"},"type":{"type":"string","const":"event_action","title":"Type"},"payload":{"$ref":"#/components/schemas/ActionEventPayload"}},"type":"object","required":["call_id","type","payload"],"title":"ActionEvent"},"ActionEventPayload":{"properties":{"action_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action Type"},"parameters":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Parameters"},"response":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Response"}},"type":"object","required":["action_type","parameters","response"],"title":"ActionEventPayload"},"AddProviderContactRequest":{"properties":{"fax_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fax Number"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"address_street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Street"},"address_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address City"},"address_state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address State Province"},"address_zip_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Zip Postal Code"},"set_as_primary":{"type":"boolean","title":"Set As Primary","description":"When true, atomically promote the new contact to primary and demote any existing primary.","default":false}},"type":"object","title":"AddProviderContactRequest","description":"Body for POST /providers/{provider_uuid}/contacts."},"Address":{"properties":{"street":{"type":"string","minLength":1,"title":"Street","description":"Street address of residence."},"street_line_2":{"type":"string","title":"Street Line 2","description":"Additional street address information."},"city":{"type":"string","minLength":1,"title":"City","description":"City of residence."},"state_province":{"type":"string","minLength":1,"title":"State Province","description":"State or province of residence."},"zip_postal_code":{"type":"string","minLength":1,"title":"Zip Postal Code","description":"ZIP or postal code part of the address."},"country":{"type":"string","title":"Country","description":"Country of residence.","default":"USA"}},"type":"object","required":["street","city","state_province","zip_postal_code"],"title":"Address","description":"Represents a postal address."},"AddressResponse":{"properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Province"},"zip_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Postal Code"}},"type":"object","title":"AddressResponse"},"ApiError":{"properties":{"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"code":{"type":"string","title":"Code"}},"type":"object","required":["title","description","code"],"title":"ApiError"},"ApiErrorResponseV2":{"properties":{"status":{"type":"string","const":"error","title":"Status","default":"error"},"error":{"$ref":"#/components/schemas/ApiErrorV2"},"data":{"type":"null","title":"Data"}},"type":"object","required":["error"],"title":"ApiErrorResponseV2","description":"V2 version of ApiErrorResponse using Pydantic v2."},"ApiErrorV2":{"properties":{"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"code":{"type":"string","title":"Code"}},"type":"object","required":["title","description","code"],"title":"ApiErrorV2","description":"V2 version of ApiError using Pydantic v2."},"ApiResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"title":"Data"}},"type":"object","title":"ApiResponse"},"ApiResponseV2_ProviderContactSchema_":{"properties":{"status":{"type":"string","enum":["success","error"],"title":"Status","default":"success"},"error":{"anyOf":[{"$ref":"#/components/schemas/ApiErrorV2"},{"type":"null"}]},"data":{"anyOf":[{"$ref":"#/components/schemas/ProviderContactSchema"},{"type":"null"}]}},"type":"object","title":"ApiResponseV2[ProviderContactSchema]"},"ApiResponseV2_ProviderContactsResponse_":{"properties":{"status":{"type":"string","enum":["success","error"],"title":"Status","default":"success"},"error":{"anyOf":[{"$ref":"#/components/schemas/ApiErrorV2"},{"type":"null"}]},"data":{"anyOf":[{"$ref":"#/components/schemas/ProviderContactsResponse"},{"type":"null"}]}},"type":"object","title":"ApiResponseV2[ProviderContactsResponse]"},"ApiResponseV2_dict_str__str__":{"properties":{"status":{"type":"string","enum":["success","error"],"title":"Status","default":"success"},"error":{"anyOf":[{"$ref":"#/components/schemas/ApiErrorV2"},{"type":"null"}]},"data":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","title":"ApiResponseV2[dict[str, str]]"},"ApiResponseV2_list_AuthorizedProviderResponse__":{"properties":{"status":{"type":"string","enum":["success","error"],"title":"Status","default":"success"},"error":{"anyOf":[{"$ref":"#/components/schemas/ApiErrorV2"},{"type":"null"}]},"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/api__routers__platform_api__provider__AuthorizedProviderResponse"},"type":"array"},{"type":"null"}],"title":"Data"}},"type":"object","title":"ApiResponseV2[list[AuthorizedProviderResponse]]"},"ApiResponseV2_str_":{"properties":{"status":{"type":"string","enum":["success","error"],"title":"Status","default":"success"},"error":{"anyOf":[{"$ref":"#/components/schemas/ApiErrorV2"},{"type":"null"}]},"data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data"}},"type":"object","title":"ApiResponseV2[str]"},"ApiResponse_NoneType_":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"type":"null","title":"Data"}},"type":"object","title":"ApiResponse[NoneType]"},"ApiResponse_ProviderLookupResponse_":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"$ref":"#/components/schemas/ProviderLookupResponse"}},"type":"object","title":"ApiResponse[ProviderLookupResponse]"},"ApiResponse_list_api.schemas.platform.public_api.provider.AuthorizedProviderResponse__":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"items":{"$ref":"#/components/schemas/api__schemas__platform__public_api__provider__AuthorizedProviderResponse"},"type":"array","title":"Data"}},"type":"object","title":"ApiResponse[list[api.schemas.platform.public_api.provider.AuthorizedProviderResponse]]"},"AppealDetails":{"properties":{"appeal_letter":{"allOf":[{"$ref":"#/components/schemas/AppealLetter"}],"title":"Appeal Letter","description":"Appeal letter file to submit with the appeal."},"is_urgent":{"type":"boolean","title":"Is Urgent","description":"Whether this appeal should be treated as urgent.","default":false}},"type":"object","required":["appeal_letter"],"title":"AppealDetails","description":"Details for submitting an appeal of a previously denied prior authorization."},"AppealLetter":{"properties":{"asset":{"allOf":[{"$ref":"#/components/schemas/Asset"}],"title":"Asset","description":"File asset containing the appeal letter."},"title":{"type":"string","minLength":1,"title":"Title","description":"Title of the appeal letter"},"date_created":{"type":"string","format":"date-time","title":"Date Created","description":"The date and time when the appeal letter was created."}},"type":"object","required":["asset","title","date_created"],"title":"AppealLetter","description":"An appeal letter file to include with the appeal submission."},"Asset":{"properties":{"file_content":{"type":"string","minLength":1,"title":"File Content","description":"The file content, encoded in Base64 format. Currently only PDF files are supported. This field cannot be used if `file_url` is provided."},"file_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"File Url","description":"URL pointing to the file. The file will be downloaded immediately. This field cannot be used if `file_content` is provided."}},"type":"object","title":"Asset"},"AssetResponse":{"properties":{"url":{"type":"string","minLength":1,"title":"Url","description":"The URL where the asset can be accessed."},"file_type":{"allOf":[{"$ref":"#/components/schemas/DocType"}],"description":"MIME type of the file. e.g. `application/pdf`"}},"type":"object","required":["url","file_type"],"title":"AssetResponse"},"AuthorizeProviderRequest":{"properties":{"npi":{"type":"string","title":"Npi","description":"The NPI of the provider."},"first_name":{"type":"string","title":"First Name","description":"The first name of the provider."},"last_name":{"type":"string","title":"Last Name","description":"The last name of the provider."},"email":{"type":"string","format":"email","title":"Email","description":"The email of the provider."},"fax_number":{"type":"string","title":"Fax Number","description":"The provider's fax number."},"phone_number":{"type":"string","title":"Phone Number","description":"The provider's phone number."},"address":{"allOf":[{"$ref":"#/components/schemas/OptionalAddress"}],"title":"Address","description":"The provider's practice address."}},"type":"object","required":["npi","first_name","last_name"],"title":"AuthorizeProviderRequest","description":"Represents a request for authorizing a provider."},"BenefitVerificationDebugConfig":{"properties":{"override_insurance_number":{"type":"string","title":"Override Insurance Number","description":"An optional insurance number to override the default. Useful to have the bot call you instead of an actual insurance company"},"monitor_conference_number":{"type":"string","title":"Monitor Conference Number","description":"An optional conference number for monitoring. Useful for listening into a live call with the insurance company."},"pbm_matching_only":{"type":"boolean","title":"Pbm Matching Only","description":"Set to true to skip calling and only evaluate the PBM match. Useful if you're working on the plan contact matching and don't want to trigger real calls. This currently only works when used from the eval script.","default":false},"override_scheduling":{"allOf":[{"$ref":"#/components/schemas/OverrideSchedulingChoices"}],"description":"Overrides the default scheduling choice. Useful if you're testing out of standard insurance company hours but you want the calling job to be run straight away.","default":"no_override"},"match_using_plan_contacts":{"type":"boolean","title":"Match Using Plan Contacts","description":"If True, match using plan contacts. If False plan contact matching will not be used","default":true},"match_using_mmit_employer":{"type":"boolean","title":"Match Using Mmit Employer","description":"If True, use MMIT Employer method to match a pbm.","default":true},"match_using_mmit_payer":{"type":"boolean","title":"Match Using Mmit Payer","description":"If True, use MMIT Payer OCR method to match a pbm.","default":true},"match_using_card_phone_number":{"type":"boolean","title":"Match Using Card Phone Number","description":"If True, use card phone number method to match a pbm.","default":true},"enqueue_processing":{"type":"boolean","title":"Enqueue Processing","description":"Set to false to disable processing of the benefit verification. It'll still be created and saved in the database, but process_benefit_verification on the worker will not be triggered. Useful if you want to manually run/debug the benefit verification processing.","default":true},"use_callbot":{"type":"boolean","title":"Use Callbot","description":"Set to false to disable the use of our internal call bot. This is not a required field and should not be exposed to the customer.","default":true},"use_no_op_agent":{"type":"boolean","title":"Use No Op Agent","description":"Whether or not to enable to no op agent where the bot will be muted/silent.","default":false},"use_bpo_fallback":{"type":"boolean","title":"Use Bpo Fallback","description":"Whether or not to fall back to our human BPO."}},"type":"object","title":"BenefitVerificationDebugConfig"},"BenefitVerificationMethodInfo":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the verification method."},"type":{"type":"string","title":"Type","description":"The type of the verification method."},"transcript":{"type":"string","title":"Transcript","description":"The call transcript"},"recording_url":{"type":"string","title":"Recording Url","description":"The URL to the call recording"}},"type":"object","required":["id","type"],"title":"BenefitVerificationMethodInfo","description":"Represents the verification method used in a benefit verification response."},"BenefitVerificationStatus":{"type":"string","enum":["pending","failed","completed","cancelled"],"title":"BenefitVerificationStatus","description":"An enumeration."},"Body_conference_event_api_v1_calls_conference_event_post":{"properties":{"FriendlyName":{"type":"string","title":"Friendlyname"},"ConferenceSid":{"type":"string","title":"Conferencesid"},"StatusCallbackEvent":{"type":"string","title":"Statuscallbackevent"}},"type":"object","required":["FriendlyName","ConferenceSid","StatusCallbackEvent"],"title":"Body_conference_event_api_v1_calls_conference_event_post"},"Body_incoming_call_api_v1_calls_incoming_call_post":{"properties":{"From":{"type":"string","title":"From"},"To":{"type":"string","title":"To"}},"type":"object","required":["From","To"],"title":"Body_incoming_call_api_v1_calls_incoming_call_post"},"Body_receiveInboundSmsMfaMessage":{"properties":{"MessageSid":{"type":"string","title":"Messagesid"},"AccountSid":{"type":"string","title":"Accountsid"},"From":{"type":"string","title":"From"},"To":{"type":"string","title":"To"},"Body":{"type":"string","title":"Body"}},"type":"object","required":["MessageSid","AccountSid","From","To","Body"],"title":"Body_receiveInboundSmsMfaMessage"},"Body_recording_event_api_v1_calls_recording_event_post":{"properties":{"ConferenceSid":{"type":"string","title":"Conferencesid"},"RecordingStatus":{"type":"string","title":"Recordingstatus"},"RecordingUrl":{"type":"string","title":"Recordingurl"}},"type":"object","required":["ConferenceSid","RecordingStatus","RecordingUrl"],"title":"Body_recording_event_api_v1_calls_recording_event_post"},"CallConnectedEvent":{"properties":{"call_id":{"type":"string","title":"Call Id"},"type":{"type":"string","const":"event_phone_call_connected","title":"Type"},"payload":{"$ref":"#/components/schemas/CallConnectedEventPayload"}},"type":"object","required":["call_id","type","payload"],"title":"CallConnectedEvent"},"CallConnectedEventPayload":{"properties":{"from_number":{"type":"string","title":"From Number"},"to_number":{"type":"string","title":"To Number"}},"type":"object","required":["from_number","to_number"],"title":"CallConnectedEventPayload"},"CallEndedEvent":{"properties":{"call_id":{"type":"string","title":"Call Id"},"type":{"type":"string","const":"event_phone_call_ended","title":"Type"},"payload":{"$ref":"#/components/schemas/CallEndedEventPayload"}},"type":"object","required":["call_id","type","payload"],"title":"CallEndedEvent"},"CallEndedEventPayload":{"properties":{},"type":"object","title":"CallEndedEventPayload","description":"It's an empty payload object"},"CancelPriorAuthPrescriptionTransferResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"type":"null","title":"Data"}},"type":"object","title":"CancelPriorAuthPrescriptionTransferResponse","description":"Represents the response structure for a POST /prior-authorization/:id/prescription-transfer/cancel request.\n\nThis response is returned when a prior authorization is successfully cancelled."},"CancelPriorAuthRequest":{"properties":{"cancellation_reason":{"type":"string","minLength":1,"title":"Cancellation Reason","description":"Reason for cancellation. This is used for analytics purposes."}},"type":"object","required":["cancellation_reason"],"title":"CancelPriorAuthRequest","description":"Request to cancel a prior authorization."},"CancelPriorAuthResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"type":"null","title":"Data"}},"type":"object","title":"CancelPriorAuthResponse","description":"Represents the response structure for a POST /prior-authorization/:id/cancellation request.\n\nThis response is returned when a prior authorization is successfully cancelled."},"CardDetails":{"properties":{"card_id":{"type":"string","title":"Card Id"},"state":{"type":"string","title":"State"},"created_at":{"type":"string","title":"Created At"},"message":{"type":"string","title":"Message"},"error":{"$ref":"#/components/schemas/Error"},"details":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/DetailsInfo"},{"items":{"$ref":"#/components/schemas/DetailsInfo"},"type":"array"}]},"type":"object","title":"Details"},"images":{"additionalProperties":{"$ref":"#/components/schemas/ImagesInfo"},"type":"object","title":"Images"},"payer_match":{"$ref":"#/components/schemas/PayerMatchDetails"}},"type":"object","title":"CardDetails","description":"Captures the overall JSON document structure of the card details API response."},"ClientErrorCode":{"type":"string","enum":["Patient Not Found","Insurance Card OCR Failure","Insurance Unable to Provide Information","Document Quality Error","Document Info Missing or Incorrect","Unable to Route Call","Unable to Gather Benefits","Internal Error","Patient Consent Required"],"title":"ClientErrorCode","description":"An enumeration."},"ClientInsuranceDocumentErrorDetailCode":{"type":"string","enum":["incorrect_member_id","incorrect_dob","incorrect_address","incorrect_phone_number","missing_member_id","medical_only_member_id","name_mismatch"],"title":"ClientInsuranceDocumentErrorDetailCode","description":"An enumeration."},"ClientOtherErrorDetailCode":{"type":"string","enum":["missing_tax_id","incorrect_tax_id","incorrect_npi","patient_consent_required","patient_declined_consent","kaiser_prescriber_required","expired"],"title":"ClientOtherErrorDetailCode","description":"An enumeration."},"ClinicalQualificationResult":{"properties":{"drug":{"allOf":[{"$ref":"#/components/schemas/Drug"}],"title":"Drug","description":"The drug this clinical qualification is for."},"status":{"allOf":[{"$ref":"#/components/schemas/ClinicalQualificationResultStatus"}],"description":"The status of the clinical qualification for this prescription."},"unqualified_reasons":{"items":{"$ref":"#/components/schemas/UnqualifiedReason"},"type":"array","title":"Unqualified Reasons","description":"If the status is ineligible, the reason(s) why. More structured fields will be added to this model in the future."}},"type":"object","required":["drug","status"],"title":"ClinicalQualificationResult"},"ClinicalQualificationResultStatus":{"type":"string","enum":["pending","qualified","unqualified","unknown"],"title":"ClinicalQualificationResultStatus","description":"The status of a clinical qualification check."},"CodedDrugInfo":{"properties":{"ndc":{"type":"string","pattern":"^(\\d{5}-?\\d{4}-?\\d{2}|\\d{4,5}-\\d{3,4}-\\d{1,2}|\\d{5}-?\\d{4}|\\d{4,5}-\\d{3,4})$","title":"Ndc","description":"The NDC of the medication.","examples":["00169-4505-14","0169-4505-14","00169450514","00169-4505","0169-4505","001694505"]},"quantity":{"type":"integer","title":"Quantity","description":"The quantity of the drug prescribed.","examples":[1]}},"type":"object","required":["ndc","quantity"],"title":"CodedDrugInfo","description":"Like DrugInfo, but more closely aligned with NCPDP standards. Helps reduce\nany confusion on the payer-side."},"CodedPrescription":{"properties":{"ndc":{"type":"string","pattern":"^(\\d{5}-?\\d{4}-?\\d{2}|\\d{4,5}-\\d{3,4}-\\d{1,2}|\\d{5}-?\\d{4}|\\d{4,5}-\\d{3,4})$","title":"Ndc","description":"The NDC of the medication. Both 10 and 11-digit NDCs are supported.","examples":["00169-4505-14","0169-4505-14","00169450514"]},"directions":{"type":"string","minLength":1,"title":"Directions","description":"Instructions on how the medication should be taken.","examples":["Inject 0.25 mg under the skin once weekly","Take 1 tablet by mouth daily"]},"quantity":{"type":"integer","title":"Quantity","description":"The quantity of the medication.","examples":[1]},"quantity_unit_of_measure":{"type":"string","title":"Quantity Unit Of Measure","description":"The unit of measurement for the quantity of the medication (subset code C89510). Either an NCIt code or the name of the term. If not provided, C38046 (Unspecified) will be used.","default":"C38046","examples":["C48504","Kit"]},"days_supply":{"type":"integer","title":"Days Supply","description":"The number of days the prescription will be expected to last.","examples":[28,30,90]},"expected_length_of_therapy":{"type":"string","title":"Expected Length Of Therapy","description":"The expected length of therapy for the prescribed drug. Defaults to 'Until No Longer Needed' if not provided.","examples":["Until No Longer Needed","12 months","6 weeks"]},"extra":{"type":"object","title":"Extra","description":"An optional dictionary containing additional information related to the drug or future prescription.","examples":[{"notes":"Patient prefers brand name","prior_auth_reference":"ABC123"}]},"prescription_date":{"type":"string","format":"date-time","title":"Prescription Date","description":"The date the prescription was issued"}},"type":"object","required":["ndc","directions","quantity","days_supply","prescription_date"],"title":"CodedPrescription","description":"Represents a prescription issued by a healthcare provider. This is an\nalternative to the Prescription model that is more closely aligned with\nNCPDP standards and helps reduce any confusion on the payer-side. Prefer\nthis model over Prescription when NDCs are available."},"CopayOption":{"properties":{"amount_cents":{"type":"integer","title":"Amount Cents","description":"The amount of the copay in cents."},"supply_duration_days":{"type":"integer","title":"Supply Duration Days","description":"The duration of the supply in days. Use null if unknown."}},"type":"object","title":"CopayOption"},"CoverageDetailCode":{"type":"string","enum":["insurer_reported_value","diagnoses_not_covered","quantity_limit_pa_required"],"title":"CoverageDetailCode","description":"An enumeration."},"CreateBenefitVerificationRequest":{"properties":{"priority":{"allOf":[{"$ref":"#/components/schemas/Priority"}],"description":"The priority of the benefit verification request, where 0 is most urgent and 3 is least urgent. This will determine the order in which the request is processed.","default":3,"gte":0,"lte":3},"replaces":{"type":"string","title":"Replaces","description":"If this Benefit Verification is being submitted as a replacement for a canceled one, the ID of the canceled Benefit Verification it replaces."},"drugs":{"anyOf":[{"items":{"$ref":"#/components/schemas/CodedDrugInfo"},"type":"array","maxItems":7,"minItems":1},{"items":{"$ref":"#/components/schemas/DrugInfo"},"type":"array","maxItems":7,"minItems":1}],"title":"Drugs","description":"Array of medications for which to perform the benefit verification. Prefer coded drugs when NDCs are available."},"drug_history":{"allOf":[{"$ref":"#/components/schemas/DrugHistory"}],"title":"Drug History","description":"The patient's current and previously taken medications.","deprecated":true},"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses","description":"Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9'"},"insurance":{"items":{"$ref":"#/components/schemas/api__schemas__platform__public_api__benefit_verification__InsuranceDocument"},"type":"array","title":"Insurance","description":"Insurance information for the patient. We will extract the required information from the insurance card images you provide. Please provide both the front and the back of the card. This is optional if you provide `insurance_content`, but highly recommended to ensure best results."},"insurance_content":{"allOf":[{"$ref":"#/components/schemas/PartialInsuranceInfo"}],"title":"Insurance Content","description":"Insurance information for the patient. Values provided here will be used in combination with those extracted from any insurance cards provided. We recommend providing this information when available to ensure best results. If you provide both `insurance` and `insurance_content`, the values provided here will be used and the values extracted from `insurance` will be used as a fallback."},"patient":{"allOf":[{"$ref":"#/components/schemas/api__schemas__platform__public_api__common__PatientInfo"}],"title":"Patient","description":"Demographic information for the patient"},"provider":{"allOf":[{"$ref":"#/components/schemas/ProviderInfo"}],"title":"Provider","description":"Details of the healthcare provider whose NPI number can be used for the benefit verification."},"entity":{"allOf":[{"$ref":"#/components/schemas/EntityInfo"}],"title":"Entity","description":"A large proportion (20%+) of payers will often ask for information on the legal entity that the provider is associated with. Without this information the benefit verification will fail. Although this is currently optional it will be required in the future. We highly recommend providing this information."},"mock_result":{"allOf":[{"$ref":"#/components/schemas/MockResult"}],"title":"Mock Result","description":"Specifies the simulated outcome for a completed verification. These values will be applied to all drugs in the request. This field is only accepted for sandbox organizations."},"use_patient_plan_fund_source_check":{"type":"boolean","title":"Use Patient Plan Fund Source Check","description":"Whether to check the patient's plan fund source during the benefit verification call.","default":false}},"type":"object","required":["drugs","patient","provider"],"title":"CreateBenefitVerificationRequest","description":"Models a request to create a benefit verification."},"CreateBenefitVerificationResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"$ref":"#/components/schemas/CreateBenefitVerificationResponseData"}},"type":"object","title":"CreateBenefitVerificationResponse","description":"Models the response received upon creating a benefit verification request."},"CreateBenefitVerificationResponseData":{"properties":{"id":{"type":"string","title":"Id","description":"A unique identifier for the benefit verification result."}},"type":"object","required":["id"],"title":"CreateBenefitVerificationResponseData","description":"Represents the data contained in the response for a create benefit verification request."},"CreateClinicalQualificationRequest":{"properties":{"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses","description":"Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9'"},"evidence":{"items":{"$ref":"#/components/schemas/EvidenceItem"},"type":"array","title":"Evidence","description":"A collection of evidence items supporting the authorization request. Any supporting evidence that doesn't belong in the other predefined fields can be added here."},"patient":{"allOf":[{"$ref":"#/components/schemas/Patient"}],"title":"Patient","description":"Demographic information for the patient"},"insurance":{"items":{"$ref":"#/components/schemas/api__schemas__platform__public_api__insurance_document__InsuranceDocument"},"type":"array","title":"Insurance","description":"Array of insurance documents."},"drugs":{"items":{"$ref":"#/components/schemas/Drug"},"type":"array","title":"Drugs","description":"Information regarding the drugs this clinical qualification check should be run for"},"provider":{"allOf":[{"$ref":"#/components/schemas/Provider"}],"title":"Provider","description":"Details of the healthcare provider who created the prescription."},"questionnaires":{"items":{"$ref":"#/components/schemas/Questionnaire"},"type":"array","title":"Questionnaires","description":"list of questionnaires. This is the best place to send structured Q&A format data, such as intake forms, etc."},"visit_notes":{"items":{"$ref":"#/components/schemas/VisitNote"},"type":"array","title":"Visit Notes","description":"list of visit notes."}},"type":"object","required":["diagnoses","patient","insurance","drugs","provider"],"title":"CreateClinicalQualificationRequest","description":"Represents a request for creating a clinical qualification check for a list of medications. This includes detailed\ninformation about the patient, their diagnosis, prescribed medication, evidence supporting the need for treatment,\ninsurance details, and responses to relevant questionnaires."},"CreateClinicalQualificationResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"allOf":[{"$ref":"#/components/schemas/CreateClinicalQualificationResponseData"}],"title":"Data","description":"Data payload of the response, containing details of the created clinical qualification request, or None if the request was unsuccessful."}},"type":"object","title":"CreateClinicalQualificationResponse","description":"Models the response received upon creating a clinical qualification request."},"CreateClinicalQualificationResponseData":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the created clinical qualification request."}},"type":"object","required":["id"],"title":"CreateClinicalQualificationResponseData","description":"Represents the data contained in the response for a create clinical qualification request."},"CreatePaStatusRequest":{"properties":{"processing_method":{"type":"string","enum":["instant_only","instant_preferred"],"title":"Processing Method","description":"Requested processing policy. instant_only fails if instant processing cannot produce a result; instant_preferred permits standard fallback."},"priority":{"type":"integer","maximum":3.0,"minimum":0.0,"title":"Priority","description":"Lower values indicate higher processing priority.","default":2},"patient":{"$ref":"#/components/schemas/PaStatusPatient"},"provider":{"$ref":"#/components/schemas/PaStatusProvider"},"prescription":{"$ref":"#/components/schemas/PaStatusPrescription"},"insurances":{"items":{"$ref":"#/components/schemas/PaStatusInsurance"},"type":"array","minItems":1,"title":"Insurances","description":"Insurance plans to check for the requested NDC."}},"additionalProperties":false,"type":"object","required":["processing_method","patient","provider","prescription","insurances"],"title":"CreatePaStatusRequest"},"CreatePaStatusResponseData":{"properties":{"id":{"type":"string","minLength":1,"title":"Id","description":"Identifier used to poll the PA status GET endpoint."},"object":{"type":"string","const":"pa_status","title":"Object"},"effective_processing_method":{"type":"string","enum":["instant","standard"],"title":"Effective Processing Method","description":"Method currently running, that completed the operation, or that was most recently attempted before failure."},"status":{"type":"string","enum":["pending","completed","failed"],"title":"Status"},"failure_reason":{"anyOf":[{"$ref":"#/components/schemas/PaStatusFailureReason"},{"type":"null"}],"description":"Failure details when status is failed; otherwise null. The failure code corresponds to the effective processing method."}},"additionalProperties":false,"type":"object","required":["id","object","effective_processing_method","status","failure_reason"],"title":"CreatePaStatusResponseData","description":"Response metadata returned after creating a PA status check."},"CreatePaStatusSuccessResponse":{"properties":{"status":{"type":"string","const":"success","title":"Status","default":"success"},"error":{"type":"null","title":"Error"},"data":{"$ref":"#/components/schemas/CreatePaStatusResponseData"}},"type":"object","required":["data"],"title":"CreatePaStatusSuccessResponse","description":"Successful response to POST /pa-status."},"CreatePlatformMessageRequest":{"properties":{"content":{"type":"string","minLength":1,"title":"Content"},"is_resolution":{"type":"boolean","title":"Is Resolution"},"attachment_ids":{"items":{"type":"string"},"type":"array","title":"Attachment Ids"}},"type":"object","required":["content","is_resolution"],"title":"CreatePlatformMessageRequest"},"CreatePriorAuthRequest":{"properties":{"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses","description":"Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9'"},"evidence":{"items":{"$ref":"#/components/schemas/EvidenceItem"},"type":"array","title":"Evidence","description":"A collection of evidence items supporting the authorization request. Any supporting evidence that doesn't belong in the other predefined fields can be added here."},"patient":{"allOf":[{"$ref":"#/components/schemas/Patient"}],"title":"Patient","description":"Demographic information for the patient"},"insurance":{"items":{"$ref":"#/components/schemas/api__schemas__platform__public_api__insurance_document__InsuranceDocument"},"type":"array","title":"Insurance","description":"Insurance information for the patient. We will extract the required information from the insurance card images you provide. Please provide both the front and the back of the card. This is optional if you provide `insurance_content`, but highly recommended to ensure best results."},"insurance_content":{"allOf":[{"$ref":"#/components/schemas/PartialInsuranceInfo"}],"title":"Insurance Content","description":"Insurance information for the patient. Values provided here will be used in combination with those extracted from any insurance cards provided. We recommend providing this information when available to ensure best results. If you provide both `insurance` and `insurance_content`, the values provided here will be used and the values extracted from `insurance` will be used as a fallback."},"prescription":{"anyOf":[{"$ref":"#/components/schemas/CodedPrescription"},{"$ref":"#/components/schemas/Prescription"}],"title":"Prescription","description":"Information regarding the prescription this prior authorization is being created for. Required unless `ndp_submission` is provided with a `prescription_message_id`. Prefer coded prescriptions when NDCs are available."},"provider":{"allOf":[{"$ref":"#/components/schemas/Provider"}],"title":"Provider","description":"Details of the healthcare provider who created the prescription."},"pharmacy":{"allOf":[{"$ref":"#/components/schemas/Pharmacy"}],"title":"Pharmacy","description":"Information about the pharmacy where the prescription will be filled."},"questionnaires":{"items":{"$ref":"#/components/schemas/Questionnaire"},"type":"array","title":"Questionnaires","description":"List of questionnaires. This is the best place to send structured Q&A format data, such as intake forms, etc."},"visit_notes":{"items":{"$ref":"#/components/schemas/VisitNote"},"type":"array","title":"Visit Notes","description":"List of visit notes."},"ndp_submission":{"$ref":"#/components/schemas/PriorAuthRequestNDPSubmission"},"resubmission_info":{"$ref":"#/components/schemas/PriorAuthRequestResubmissionInfo"},"appeal_details":{"allOf":[{"$ref":"#/components/schemas/AppealDetails"}],"title":"Appeal Details","description":"Details for submitting an appeal of a previously denied prior authorization. When provided, the request will be processed as an appeal."},"mock_result":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthMockResultApproved"},{"$ref":"#/components/schemas/PriorAuthMockResultDenied"},{"$ref":"#/components/schemas/PriorAuthMockResultOther"},{"$ref":"#/components/schemas/PriorAuthMockResultNotSubmitted"}],"title":"Mock Result","description":"Specifies the simulated outcome for a completed prior authorization. This field is only accepted for sandbox organizations. Setting this field will instantly complete the prior authorization request and send a webhook with the value of this field. You will not be charged for these requests and you will not be sent the prior auth for manual review."},"priority":{"allOf":[{"$ref":"#/components/schemas/Priority"}],"description":"Specifies the priority of the prior authorization request. This is used to determine the order in which requests are processed. Lower values indicate higher priority.","default":2},"trigger_benefit_verification":{"allOf":[{"$ref":"#/components/schemas/TriggerBenefitVerificationConfig"}],"title":"Trigger Benefit Verification","description":"If provided and enabled, triggers a benefit verification to check drug coverage before the PA proceeds."},"provider_outreach":{"allOf":[{"$ref":"#/components/schemas/ProviderOutreachConfig"}],"title":"Provider Outreach","description":"Configuration for requesting clinical documents from the provider before answering begins."}},"type":"object","required":["patient","provider"],"title":"CreatePriorAuthRequest","description":"Represents a request for creating a prior authorization for a medication. This includes detailed\ninformation about the patient, their diagnosis, prescribed medication, evidence supporting the need for treatment,\ninsurance details, and responses to relevant questionnaires."},"CreatePriorAuthResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"allOf":[{"$ref":"#/components/schemas/CreatePriorAuthResponseError"}],"title":"Error","description":"Error payload of the response, containing details of the error that occurred during the creation of the prior authorization request."},"data":{"allOf":[{"$ref":"#/components/schemas/CreatePriorAuthResponseData"}],"title":"Data","description":"Data payload of the response, containing details of the created prior authorization request, or None if the request was unsuccessful."}},"type":"object","title":"CreatePriorAuthResponse","description":"Models the response received upon creating a prior authorization request."},"CreatePriorAuthResponseData":{"properties":{"id":{"type":"string","minLength":1,"title":"Id","description":"The unique identifier for the created prior authorization request."},"provider_outreach":{"allOf":[{"$ref":"#/components/schemas/ProviderOutreachResponse"}],"title":"Provider Outreach","description":"The initial provider outreach outcome when provider outreach was requested."}},"type":"object","required":["id"],"title":"CreatePriorAuthResponseData","description":"Represents the data contained in the response for a create prior authorization request."},"CreatePriorAuthResponseError":{"properties":{"title":{"type":"string","title":"Title","description":"A brief title summarizing the error."},"description":{"type":"string","title":"Description","description":"A detailed message explaining the error. These messages may be unique to the specific prior authorization request."},"code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthErrorCode"}],"description":"A specific code identifying the error. While we'll aim to ensure that the occurence of these errors is minimal, it's likely they will occur. To prevent delays to patient care, we generally recommend that you implement a strategy of falling back to your existing process for handling a prior authorization if you encounter one of these errors. The Develop Health team will then work with you in parallel to fix the issue. The following codes are currently possible: \n- **unsupported_patient**: This means that the patient you submitted the prior authorization for is not currently supported. We're rapidly increasing our PBM and payer coverage, so we'll be reducing the occurrence of these over time.\n- **unsupported_drug**: The drug you submitted is not yet supported for prior authorization.\n- **daily_prior_auth_request_limit_reached**: The daily limit for prior authorization requests has been reached. There is a temporary limit set on new accounts to ensure that submissions are accurate before we allow unlimited submissions. The Develop Health team will work with you to increase this limit as quickly as possible.\n- **daily_prior_auth_request_new_plan_limit_reached**: The daily limit for prior authorization requests for new plans has been reached. As we increase our payer and plan coverage this limit ensures that submissions are accurate before we allow unlimited submissions.\n- **insurance_card_member_id_ocr_failure**: We were unable to extract the member ID from the insurance card image provided and no discrete values were provided.\n- **insurance_content_invalid_rx_bin**: The Rx BIN provided in the insurance content is invalid. This should be a 6 digit number.\n- **prescription_message_not_found**: The prescription_message_id provided does not correspond to any known prescription.\n- **prescription_message_already_linked**: The prescription_message_id provided is already linked to a prior authorization request that is in progress or has already been completed as approved. The existing PA request must be cancelled before submitting a new request for the same prescription.\n- **provider_not_authorized**: The NPI provided is not authorized to submit requests. To enable prior authorization requests for this provider, please complete the provider authorization process.\n- **evidence_file_download_failed**: The evidence file could not be downloaded from the provided URL.\n- **invalid_qle_resubmission**: Quantity limit exception resubmissions are only allowed when the previous prior authorization was approved or was not required.\n- **previous_pa_request_in_progress**: The previous prior authorization request referenced in resubmission_info is still in progress. It must be completed or cancelled before a new resubmission can be created.\n- **mock_result_not_allowed**: The mock_result field is only supported for sandbox organizations. Production organizations cannot submit mocked prior authorization outcomes; remove mock_result to submit a real request.\n- **invalid_npi**: The provider NPI does not exist in the NPI registry.\n- **invalid_diagnosis_codes**: One or more diagnosis codes are not supported ICD-10-CM codes.\n- **provider_outreach_not_supported**: Provider outreach is available only to pharmacy organizations.\n- **provider_outreach_fax_required**: A provider fax number is required when provider outreach is requested.\n- **provider_outreach_mock_result_conflict**: Mock results cannot be supplied when provider outreach is requested.\n- **other**: An unexpected error occurred during the prior authorization process.","choices":[["unsupported_patient","unsupported_patient"],["unsupported_drug","unsupported_drug"],["daily_prior_auth_request_limit_reached","daily_prior_auth_request_limit_reached"],["daily_prior_auth_request_new_plan_limit_reached","daily_prior_auth_request_new_plan_limit_reached"],["insurance_card_member_id_ocr_failure","insurance_card_member_id_ocr_failure"],["insurance_content_invalid_rx_bin","insurance_content_invalid_rx_bin"],["prescription_message_not_found","prescription_message_not_found"],["prescription_message_already_linked","prescription_message_already_linked"],["provider_not_authorized","provider_not_authorized"],["evidence_file_download_failed","evidence_file_download_failed"],["invalid_qle_resubmission","invalid_qle_resubmission"],["previous_pa_request_in_progress","previous_pa_request_in_progress"],["mock_result_not_allowed","mock_result_not_allowed"],["invalid_npi","invalid_npi"],["invalid_diagnosis_codes","invalid_diagnosis_codes"],["provider_outreach_not_supported","provider_outreach_not_supported"],["provider_outreach_fax_required","provider_outreach_fax_required"],["provider_outreach_mock_result_conflict","provider_outreach_mock_result_conflict"],["other","other"]]},"existing_prior_auth_request_id":{"type":"string","title":"Existing Prior Auth Request Id","description":"Identifier of an existing prior authorization request related to this error."}},"type":"object","required":["title","code"],"title":"CreatePriorAuthResponseError"},"DenialReasonAnalysis":{"properties":{"categories":{"items":{"type":"string"},"type":"array","title":"Categories","description":"Categories describing the denial reason"},"explanation":{"type":"string","title":"Explanation","description":"Explanation of the denial"},"next_steps_code":{"allOf":[{"$ref":"#/components/schemas/DenialReasonNextStepsCode"}],"description":"A machine-readable code for the recommended next step. Possible values are:\n- **resubmit_current**: Resubmit the current prior authorization request as-is.\n- **resubmit_additional_information**: Resubmit the prior authorization request with additional information.\n- **appeal**: Appeal the denial.\n- **consider_alternative_therapy**: Consider an alternative therapy, such as a formulary alternative or step therapy.\n- **other**: Take another action not represented by the other codes."},"next_steps":{"type":"string","title":"Next Steps","description":"Human-readable description of the recommended next steps"},"next_steps_explanation":{"type":"string","title":"Next Steps Explanation","description":"Human-readable explanation of why the next steps are recommended"}},"type":"object","required":["categories","explanation","next_steps_code","next_steps","next_steps_explanation"],"title":"DenialReasonAnalysis","description":"Summary of why a prior authorization was denied."},"DenialReasonNextStepsCode":{"type":"string","enum":["resubmit_current","resubmit_additional_information","appeal","consider_alternative_therapy","other"],"title":"DenialReasonNextStepsCode","description":"Machine-readable action recommended after a prior authorization denial."},"DetailsInfo":{"properties":{"value":{"type":"string","title":"Value"},"scores":{"items":{"type":"string"},"type":"array","title":"Scores"}},"type":"object","required":["value","scores"],"title":"DetailsInfo"},"DevelopHealthFormModel":{"properties":{"slug":{"type":"string","pattern":"^[-a-zA-Z0-9_]+\\Z","title":"Slug"},"form_type":{"$ref":"#/components/schemas/DevelopHealthFormType"},"data":{"type":"object","title":"Data"}},"type":"object","required":["slug","form_type","data"],"title":"DevelopHealthFormModel"},"DevelopHealthFormType":{"type":"string","enum":["standard","additional"],"title":"DevelopHealthFormType","description":"The type of form on the Develop Health platform."},"Diagnosis":{"properties":{"code":{"type":"string","title":"Code","description":"ICD-10 code for the diagnosis. i.e. 'E66.9'"}},"type":"object","required":["code"],"title":"Diagnosis","description":"Represents a medical diagnosis with a code and description."},"DispenseUnit":{"type":"string","enum":["milliliter","liter","gram","milligram","microgram","unit","tablet","capsule","patch","inhaler","applicator","pack","vial","film"],"title":"DispenseUnit","description":"This enum is deprecated and should not be used."},"DocType":{"type":"string","enum":["application/pdf","application/msword","text/plain","application/vnd.ms-excel"],"title":"DocType","description":"An enumeration."},"DoseForm":{"type":"string","enum":["aerosol","bar","bead","breadstick","bulk","capsule","catheter","cement","cigarette","cloth","concentrate","cone","cream","crystal","culture","dentifrice","deposit","device","diaphragm","disc","douche","dressing","drops","elixir","emulsion","enema","extract","film","food","foam","gel","generator","globule","graft","gum","implant","infusion","inhalant","inhalation","inhaler","injectable","injection","insert","irrigant","irrigation","jelly","kit","lens","liner","liniment","lipstick","liquid","lollipop","lotion","lozenge","miscellaneous","mouthwash","mucilage","oil","ointment","packing","paste","pastille","patch","pellet","pill","plaster","poultice","powder","resin","ring","rinse","rod","salve","shampoo","soap","sol","solution","sponge","spray","stick","strip","suppository","suspension","suture","swab","syrup","tablet","tampon","tape","tea","test","tincture","troche","vaginal_suppository","vaginal_tablet","wafer","wash","wax"],"title":"DoseForm","description":"An enumeration."},"Drug":{"properties":{"days_supply":{"type":"integer","title":"Days Supply","description":"The number of days the prescription will be expected to last."},"quantity":{"type":"integer","title":"Quantity","description":"The quantity of the medication."},"directions":{"type":"string","minLength":1,"title":"Directions","description":"Instructions on how the medication should be taken."},"drug_name":{"type":"string","minLength":1,"title":"Drug Name","description":"The name of the medication."},"strength":{"type":"string","minLength":1,"title":"Strength","description":"The strength of the medication."},"dose_form":{"allOf":[{"$ref":"#/components/schemas/DoseForm"}],"description":"The form of the medication."},"route_of_administration":{"allOf":[{"$ref":"#/components/schemas/RouteOfAdministration"}],"description":"The route of administration for the medication."},"extra":{"type":"object","title":"Extra","description":"An optional dictionary containing additional information related to the drug or future prescription."},"expected_length_of_therapy":{"type":"string","title":"Expected Length Of Therapy","description":"The expected length of therapy for the prescribed drug. Defaults to 'Until No Longer Needed' if not provided.","examples":["Until No Longer Needed","12 months","6 weeks"]}},"type":"object","required":["days_supply","quantity","directions","drug_name","strength","dose_form","route_of_administration"],"title":"Drug","description":"Represents a medication prescribed by a healthcare provider. Prefer\nCodedDrug when NDCs are available."},"DrugCoverage":{"type":"string","enum":["covered","not_covered"],"title":"DrugCoverage","description":"An enumeration."},"DrugCoverageDeterminationDetails":{"properties":{"is_on_formulary":{"type":"boolean","title":"Is On Formulary","description":"Whether the drug is on the formulary for the patient's plan.","nullable":true},"is_explicit_plan_exclusion":{"type":"boolean","title":"Is Explicit Plan Exclusion","description":"Whether the drug is explicitly excluded from the patient's plan.","nullable":true},"is_prior_auth_acting_as_exception_request":{"type":"boolean","title":"Is Prior Auth Acting As Exception Request","description":"Whether the prior authorization is acting as an exception request. This is only applicable if the drug is not on the formulary.","nullable":true}},"type":"object","title":"DrugCoverageDeterminationDetails"},"DrugCoverageInfo":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the drug."},"dosage":{"type":"string","title":"Dosage","description":"The prescribed dosage of the drug."},"quantity":{"type":"number","title":"Quantity","description":"The quantity of the drug prescribed."},"ndc":{"type":"string","title":"Ndc","description":"The National Drug Code (NDC) of the drug. Read-only; this field is ignored on input and populated from the resolved drug data.","readOnly":true,"nullable":true},"coverage":{"allOf":[{"$ref":"#/components/schemas/DrugCoverage"}],"description":"This field will start off as null and will be populated if the benefit verification is successfully completed. The drug coverage result","nullable":true},"coverage_detail_code":{"allOf":[{"$ref":"#/components/schemas/CoverageDetailCode"}],"description":"This field will start off as null and will be populated if the benefit verification is successfully completed. The options are:\n- **insurer_reported_value**: This is the exact value that the insurer reported for the drug coverage.\n- **diagnoses_not_covered**: The drug is being reported as not covered due to this patient's specific diagnosis codes.\n- **quantity_limit_pa_required**: The drug is covered but exceeds the plan's dispense quantity limit, so prior authorization is required.","nullable":true},"prior_authorization_required":{"allOf":[{"$ref":"#/components/schemas/DrugPriorAuthorizationRequirement"}],"description":"This field will start off as null and will be populated if the benefit verification is successfully completed. A not_applicable value will be returned if the drug is not covered by the insurance plan.","nullable":true},"copay":{"type":"string","title":"Copay","description":"This field will start off as null and will be populated if the benefit verification is successfully completed and a copay is received.","nullable":true},"copay_options":{"items":{"$ref":"#/components/schemas/CopayOption"},"type":"array","title":"Copay Options","description":"A structured representation of the copay options for the drug.","nullable":true},"determination_details":{"allOf":[{"$ref":"#/components/schemas/DrugCoverageDeterminationDetails"}],"title":"Determination Details","description":"A collection of more granular details surrounding the drug coverage determination.","nullable":false},"has_active_prior_auth":{"type":"boolean","title":"Has Active Prior Auth","description":"Whether there is an active prior authorization for this drug. Only set if operating if explicitly requested by the original API call.","nullable":true}},"type":"object","required":["name","dosage","quantity"],"title":"DrugCoverageInfo","description":"Represents information about a specific drug."},"DrugHistory":{"properties":{"currently_taking_drugs":{"items":{"$ref":"#/components/schemas/DrugHistoryItem"},"type":"array","title":"Currently Taking Drugs","description":"The drugs that the patient is currently taking.","default":[]},"previously_taken_drugs":{"items":{"$ref":"#/components/schemas/DrugHistoryItem"},"type":"array","title":"Previously Taken Drugs","description":"The drugs that the patient has previously taken.","default":[]}},"type":"object","title":"DrugHistory","description":"Represents the history of drugs taken by a patient."},"DrugHistoryItem":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the drug."}},"type":"object","required":["name"],"title":"DrugHistoryItem","description":"Represents information about a currently or previously taken drug."},"DrugInfo":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the drug."},"dosage":{"type":"string","title":"Dosage","description":"The prescribed dosage of the drug."},"quantity":{"type":"number","title":"Quantity","description":"The quantity of the drug prescribed."},"ndc":{"type":"string","title":"Ndc","description":"The National Drug Code (NDC) of the drug. Read-only; this field is ignored on input and populated from the resolved drug data.","readOnly":true,"nullable":true}},"type":"object","required":["name","dosage","quantity"],"title":"DrugInfo","description":"Represents information about a specific drug."},"DrugPriorAuthorizationRequirement":{"type":"string","enum":["yes","no","not_applicable"],"title":"DrugPriorAuthorizationRequirement","description":"An enumeration."},"EligibilityCheckActionCode":{"type":"string","enum":["please_correct_and_resubmit","resubmission_not_allowed"],"title":"EligibilityCheckActionCode","description":"Action code indicating the action suggested by the payer in the error case"},"EligibilityCheckErrorCode":{"type":"string","enum":["provider_not_on_file","patient_birth_date_does_not_match_database","invalid_missing_subscriber_insured_id","subscriber_insured_not_found","duplicate_subscriber_insured_id_number"],"title":"EligibilityCheckErrorCode","description":"Error code indicating the specific error encountered"},"EligibilityCheckPlanType":{"type":"string","enum":["medicare","medicare_advantage","medicaid","tricare","commercial","unclassified"],"title":"EligibilityCheckPlanType","description":"Benefit type of a patient's health plan."},"EligibilityCheckResponseErrorItem":{"properties":{"status":{"type":"string","enum":["error"],"title":"Status","default":"error"},"error_code":{"allOf":[{"$ref":"#/components/schemas/EligibilityCheckErrorCode"}],"description":"The error code indicating the specific error encountered. Possible values are:\n- **provider_not_on_file**: The payer has no record of the provider ID supplied. Provider is not registered with the payer, provider must call payer directly to register their NPI.\n- **patient_birth_date_does_not_match_database**: The DOB supplied doesn’t match the payer’s record for the member ID.\n- **invalid_missing_subscriber_insured_id**: Member ID is empty, wrong length, or fails checksum/cross-file lookup. Or does not meet the payer requirements for subscriber ID. This error is rarely encountered.\n- **subscriber_insured_not_found**: Member could not be located with the ID / name / DOB combination submitted. This error is the most common by far.\n- **duplicate_subscriber_insured_id_number**: The ID supplied matches more than one person in the payer’s system; inquiry is ambiguous. This error is very rarely encountered, usually only around New Year."},"error_message":{"type":"string","maxLength":256,"title":"Error Message","description":"Human-readable description of the error. This always corresponds to the error code."},"action_code":{"allOf":[{"$ref":"#/components/schemas/EligibilityCheckActionCode"}],"description":"The action suggested by the payer in response to the error. Possible values are:\n- **please_correct_and_resubmit**: The transaction failed basic edits (e.g., missing or invalid data). Fix the errors and resubmit. This indicates the data submitted is incorrect.\n- **resubmission_not_allowed**: The payer will not accept this inquiry again in its current form; requires taking action outside of PMS / contacting the payer directly. For example, (49) PCP assignment requires updating, (76) duplicate patient records must be merged."}},"type":"object","required":["error_code","error_message","action_code"],"title":"EligibilityCheckResponseErrorItem"},"EligibilityCheckResponseSuccessItem":{"properties":{"status":{"type":"string","enum":["success"],"title":"Status","default":"success"},"health_plan_name":{"type":"string","title":"Health Plan Name","description":"Health plan name","nullable":true},"plan_type":{"allOf":[{"$ref":"#/components/schemas/EligibilityCheckPlanType"}],"description":"Type of the health plan if determined."},"rx_bin":{"type":"string","pattern":"^\\d{6}$","title":"Rx Bin","description":"Rx BIN","nullable":true},"rx_pcn":{"type":"string","title":"Rx Pcn","description":"Rx PCN","nullable":true},"rx_grp":{"type":"string","title":"Rx Grp","description":"Rx GRP","nullable":true},"effective_start_date":{"type":"string","format":"date","title":"Effective Start Date","description":"Effective start date of coverage"},"effective_end_date":{"type":"string","format":"date","title":"Effective End Date","description":"Effective end date of coverage"}},"type":"object","required":["effective_start_date"],"title":"EligibilityCheckResponseSuccessItem"},"EntityInfo":{"properties":{"legal_name":{"type":"string","title":"Legal Name","description":"The legal name of the entity. This is the name that the provider is associated with."},"tax_id":{"type":"string","title":"Tax Id","description":"The tax identifier of the entity. This is the tax ID that the provider is associated with."}},"type":"object","title":"EntityInfo","description":"Contains information about a healthcare entity."},"Error":{"properties":{"error":{"type":"string","title":"Error"},"message":{"type":"string","title":"Message"}},"type":"object","required":["error","message"],"title":"Error"},"EvidenceItem":{"properties":{"asset":{"allOf":[{"$ref":"#/components/schemas/Asset"}],"title":"Asset","description":"File asset containing the evidence. This is an alternative to the `content` field which must be unused or null if `asset` is provided."},"content":{"anyOf":[{"type":"object"},{"type":"string"}],"title":"Content","description":"Detailed content of the evidence, which varies based on the type of evidence."},"date_created":{"type":"string","format":"date-time","title":"Date Created","description":"The date and time (if available) when the evidence was created. This is important for ensuring we have an accurate timeline of the patient's history."},"document_date":{"type":"string","format":"date","title":"Document Date","description":"Optional explicit clinical/source document date. Only provide this when it comes from a trusted source document/event field, not upload, export, or ingestion time."},"title":{"type":"string","title":"Title","description":"Title of the evidence. This will be shown to users in the platform UI so it's recommended to give it a name that would be meaningful to them, such as 'Intake Form'"}},"type":"object","required":["date_created","title"],"title":"EvidenceItem","description":"Represents an item of evidence, which can include an associated digital asset."},"FailureDetails":{"properties":{"title":{"type":"string","title":"Title","description":"A brief title summarizing the error."},"code":{"allOf":[{"$ref":"#/components/schemas/ClientErrorCode"}],"description":"A specific code identifying the error. This list will likely expand over time to provide more specific error codes. The following codes are currently supported: \n- **Unable to Route Call**: We were unable to determine the correct number to call using the insurance information provided. More information is required.\n- **Document Info Missing or Incorrect**: The insurance documents provided are missing information that is necessary to identify the patient. The information could be outdated or not present in the documentation. For example, the documents might be missing the member ID for the patient, or could have a medical only ID, or could have an out of date address. To fix this error you can try re-uploading documents that contain the information specified in the message for this error.\n- **Document Quality Error**: The insurance documents provided are not valid insurance documents or are low quality (blurry or low resolution) and therefore cannot be processed by our system. To fix this error you can try re-uploading higher quality documents.\n- **Insurance Card OCR Failure**: This error means we were unable to read the necessary information from the insurance card image provided. This could be due to the image being unclear. Please check the images provided and/or provide the information manually if possible. This is generally an issue that would be handled on your side, and may involve reaching out to the patient to get a better image of their insurance card.\n- **Insurance Unable to Provide Information**: The insurance company was unable to provide the information needed to determine the patient's coverage status. This could be due to various reasons such as the insurance representative being unable or unwilling to provide the necessary details, or issues during the call, like refusal to transfer to a supervisor.\n- **Patient Not Found**: The plan contact we called was unable to locate the patient in their system. We weren't able to identify a root cause issue with the documentation provided, but re-uploading additional documents may help.\n- **Unable to Gather Benefits**: We were unable to gather benefits from the insurance company. This could be due to a variety of reasons, such as the insurance company not being able to provide the information, or the information provided not being sufficient to determine the patient's coverage status. To fix this error, you can try providing insurace information manually and/or providing medication history.\n- **Internal Error**: There was an internal error during the benefit verification.\n- **Patient Consent Required**: Benefit verification could not be completed. The payer requires the patient to provide verbal consent during the call."},"detail_code":{"anyOf":[{"$ref":"#/components/schemas/ClientInsuranceDocumentErrorDetailCode"},{"$ref":"#/components/schemas/ClientOtherErrorDetailCode"}],"title":"Detail Code","description":"A more detailed code that can be used to identify the specific issue that caused the error."},"message":{"type":"string","title":"Message","description":"A detailed message explaining the error, such as: 'We were unable to extract the member ID from the insurance card image provided, the image(s) my be unclear.' These messages may be unique to the specific benefit verification request."},"detail_message":{"type":"string","title":"Detail Message","description":"A more detailed message that can be used to identify the specific issue that caused the error."}},"type":"object","required":["title"],"title":"FailureDetails","description":"Represents status details about a failed benefit verification."},"FastItem":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"}},"type":"object","required":["name","id"],"title":"FastItem"},"FastItems":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FastItem"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"FastItems"},"Feedback":{"properties":{"message":{"type":"string","title":"Message"},"category":{"type":"string","title":"Category"},"regarding":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"object","title":"Regarding"},"organization_id":{"type":"string","title":"Organization Id"},"organization_name":{"type":"string","title":"Organization Name"},"user_id":{"type":"string","title":"User Id"},"user_email":{"type":"string","title":"User Email"},"user_name":{"type":"string","title":"User Name"},"sentiment":{"$ref":"#/components/schemas/FeedbackSentiment"},"type":{"$ref":"#/components/schemas/FeedbackType"}},"type":"object","title":"Feedback"},"FeedbackSentiment":{"type":"string","enum":["positive","negative","neutral"],"title":"FeedbackSentiment","description":"An enumeration."},"FeedbackType":{"type":"string","enum":["bug","feature_request","other"],"title":"FeedbackType","description":"An enumeration."},"FileAsset":{"properties":{"file_content":{"type":"string","title":"File Content","description":"The file contents encoded in base64"},"file_type":{"type":"string","title":"File Type","description":"The MIME type of the file"},"file_name":{"type":"string","title":"File Name","description":"The name of the file"}},"type":"object","required":["file_content","file_type"],"title":"FileAsset","description":"Represents a file uploaded via the API.\n\nSecurity: This model validates both the claimed MIME type and filename\nto prevent malicious file uploads (e.g., .php, .exe files)."},"FormSubmissionData":{"properties":{"url":{"type":"string","title":"Url"},"action":{"type":"string","title":"Action"},"checkpoint_id":{"type":"string","title":"Checkpoint Id"},"questions":{"items":{"$ref":"#/components/schemas/FormSubmissionQuestion"},"type":"array","title":"Questions"},"feature_flags":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Feature Flags","default":{}}},"type":"object","required":["url","questions"],"title":"FormSubmissionData"},"FormSubmissionQuestion":{"properties":{"question_id":{"type":"string","title":"Question Id"},"answer_id":{"type":"string","title":"Answer Id"},"client_side_location_info":{"type":"object","title":"Client Side Location Info"},"answer":{"type":"object","title":"Answer"},"explanation_box_added":{"type":"boolean","title":"Explanation Box Added"},"answer_filled_by_extension":{"type":"boolean","title":"Answer Filled By Extension"},"answer_changed_by_user":{"type":"boolean","title":"Answer Changed By User"},"answer_filled_by_extension_details":{"type":"object","title":"Answer Filled By Extension Details"},"disabled":{"type":"boolean","title":"Disabled"}},"type":"object","required":["client_side_location_info","answer","explanation_box_added","answer_filled_by_extension","disabled"],"title":"FormSubmissionQuestion"},"Gender":{"type":"string","enum":["male","female","other","not_specified"],"title":"Gender","description":"An enumeration."},"GetBenefitVerificationResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"$ref":"#/components/schemas/GetBenefitVerificationResponseData"}},"type":"object","title":"GetBenefitVerificationResponse","description":"Represents the response structure for a benefit verification query in a healthcare context.\n\nThis class extends the generic ApiResponse, specifically tailored to handle responses related to\nbenefit verifications. It primarily includes the data attribute, which holds detailed information\nabout the benefit verification process and its results."},"GetBenefitVerificationResponseData":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the benefit verification request."},"object":{"type":"string","enum":["benefit_verification"],"title":"Object","description":"The type of object the response is about, which is 'benefit_verification'.","default":"benefit_verification"},"status":{"allOf":[{"$ref":"#/components/schemas/BenefitVerificationStatus"}],"description":"Benefit Verifications will always start in the pending state. Once the verification is complete, the status will change to completed or failed. If the verification is still in progress, the status will remain pending."},"status_description":{"type":"string","title":"Status Description","description":"Provides additional information about the verification status."},"error":{"allOf":[{"$ref":"#/components/schemas/FailureDetails"}],"title":"Error","description":"Specific error information if the benefit verification failed"},"review_status":{"allOf":[{"$ref":"#/components/schemas/ReviewStatus"}],"description":"The status on if this benefits investigation has been reviewed in the portal. Users of the portal can click the 'Mark as Reviewed' button to mark the benefits investigation as reviewed."},"drugs":{"items":{"$ref":"#/components/schemas/DrugCoverageInfo"},"type":"array","title":"Drugs","description":"List of drug coverage information related to the verification."},"drug_history":{"allOf":[{"$ref":"#/components/schemas/DrugHistory"}],"title":"Drug History","description":"The patient's drug history"},"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses","description":"List of diagnoses for the patient."},"patient":{"allOf":[{"$ref":"#/components/schemas/api__schemas__platform__public_api__common__PatientInfo"}],"title":"Patient","description":"Demographic information for the patient"},"provider":{"allOf":[{"$ref":"#/components/schemas/ProviderInfo"}],"title":"Provider","description":"Details of the healthcare provider whose NPI number can be used for the benefit verification."},"entity":{"allOf":[{"$ref":"#/components/schemas/EntityInfo"}],"title":"Entity","description":"A large proportion (20%+) of payers will often ask for information on the legal entity that the provider is associated with. Without this information the benefit verification will fail. Although this is currently optional it will be required in the future. We highly recommend providing this information."},"insurance":{"items":{"$ref":"#/components/schemas/InsuranceDocumentInfo"},"type":"array","title":"Insurance","description":"Insurance information for the patient."},"pharmacy_benefit_manager_name":{"type":"string","title":"Pharmacy Benefit Manager Name","description":"The name of the pharmacy benefit manager (PBM) responsible for the patient's coverage. E.g. 'OptumRx' or 'Express Scripts'. May be null if the PBM's name is not available."},"patient_coverage_status":{"allOf":[{"$ref":"#/components/schemas/PatientCoverageStatus"}],"description":"This field indicates the insurance coverage status of the patient. The options are:\n- **covered**: Indicates that the patient is covered by the insurance plan.\n- **patient_not_found**: Indicates that the patient could not be found in the insurance database.\n- **coverage_expired**: Implies that the patient's insurance coverage has expired.\n- **coverage_not_started**: Suggests that the patient's insurance coverage is in place but has not started yet.\n- **patient_not_covered_unspecified**: Used when the patient is not covered by the insurance plan, but the specific reason is not specified.\n- **unknown**: We were unable to determine the patient's insurance coverage status."},"verification_methods":{"items":{"$ref":"#/components/schemas/BenefitVerificationMethodInfo"},"type":"array","title":"Verification Methods","description":"List of verification methods used to determine the coverage status of the drug. These will contain evidence from the verification procedure, such as a transcript of the phone conversation between the AI and the insurance provider."},"mock_result":{"allOf":[{"$ref":"#/components/schemas/MockResult"}],"title":"Mock Result","description":"Details of the mock result if one was used for this benefit verification."},"patient_plan_fund_source":{"allOf":[{"$ref":"#/components/schemas/PatientPlanFundSource"}],"description":"The source of the patient's plan funding. The options are:\n- commercial: The patient's plan is commercial insurance.\n- government: The patient's plan is government-funded.\n- question_not_asked: The patient's plan funding source was not asked.\n- unable_to_determine: The patient's plan funding source was asked, but could not be determined.","default":"question_not_asked"},"patient_coverage_type":{"allOf":[{"$ref":"#/components/schemas/PatientCoverageType"}],"description":"The type of coverage the patient has. The options are:\n- medicare\n- medicare_advantage\n- tricare\n- medicaid\n- other\n- question_not_asked\n- unable_to_determine","default":"question_not_asked"},"priority":{"allOf":[{"$ref":"#/components/schemas/Priority"}],"description":"The priority of the benefit verification request, as defined in the creation request."},"replaced_by":{"type":"string","title":"Replaced By","description":"If this Benefit Verification was canceled and subsequently resubmitted, this field stores the ID of the new (replacement) Benefit Verification."},"replaces":{"type":"string","title":"Replaces","description":"If this Benefit Verification was submitted as a replacement for a canceled one, this field stores the ID of the canceled Benefit Verification it replaces."},"triggered_by_pa_id":{"type":"string","title":"Triggered By Pa Id","description":"The ID of the PA request that triggered this benefit verification, if applicable."}},"type":"object","required":["id","status","status_description","review_status","drugs","patient","provider","insurance","patient_coverage_status","verification_methods","priority"],"title":"GetBenefitVerificationResponseData","description":"Represents the data the data contained in the response for a get benefit verification request."},"GetClinicalQualificationResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"allOf":[{"$ref":"#/components/schemas/GetClinicalQualificationResponseData"}],"title":"Data","description":"An instance of GetClinicalQualificationResponseData containing detailed information about the prior auth, or None if no such data is available."}},"type":"object","title":"GetClinicalQualificationResponse","description":"Represents the response structure for a GET /prior-authorization/:id request.\n\nThis class extends the generic ApiResponse, specifically tailored to handle responses related to\nclinical qualifications. It primarily includes the data attribute, which holds detailed information\nabout the benefit verification process and its results."},"GetClinicalQualificationResponseData":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of this clinical qualification"},"object":{"type":"string","enum":["clinical_qualification"],"title":"Object","description":"The type of object. This will always be 'clinical_qualification', from this endpoint, but this can be helpful for differentiating between different types of objects when parsing webhook responses.","default":"clinical_qualification"},"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses","description":"Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9'"},"evidence":{"items":{"$ref":"#/components/schemas/ResponseEvidenceItem"},"type":"array","title":"Evidence","description":"A collection of evidence items supporting the authorization request. Any other supporting evidence that doesn't fit into one of the explicitly declared fields above can be added here."},"patient":{"allOf":[{"$ref":"#/components/schemas/Patient"}],"title":"Patient","description":"Demographic information for the patient"},"insurance":{"items":{"$ref":"#/components/schemas/InsuranceDocumentInfo"},"type":"array","title":"Insurance","description":"Array of insurance documents."},"drugs":{"items":{"$ref":"#/components/schemas/Drug"},"type":"array","title":"Drugs","description":"Information regarding the potential prescriptions this clinical qualification check should be run for"},"provider":{"allOf":[{"$ref":"#/components/schemas/Provider"}],"title":"Provider","description":"Details of the healthcare provider who created the prescription."},"pharmacy":{"allOf":[{"$ref":"#/components/schemas/Pharmacy"}],"title":"Pharmacy","description":"Information about the pharmacy where the prescription will be filled."},"questionnaires":{"items":{"$ref":"#/components/schemas/Questionnaire"},"type":"array","title":"Questionnaires","description":"list of questionnaires. This is the best place to send structured Q&A format data, such as intake forms, etc."},"visit_notes":{"items":{"$ref":"#/components/schemas/VisitNote"},"type":"array","title":"Visit Notes","description":"list of visit notes."},"results":{"items":{"$ref":"#/components/schemas/ClinicalQualificationResult"},"type":"array","title":"Results","description":"The results of the clinical qualification for each of the drugs."}},"type":"object","required":["id","diagnoses","patient","insurance","drugs","provider","results"],"title":"GetClinicalQualificationResponseData"},"GetPaStatusResponseData":{"properties":{"id":{"type":"string","minLength":1,"title":"Id","description":"Identifier used to poll the PA status GET endpoint."},"object":{"type":"string","const":"pa_status","title":"Object"},"effective_processing_method":{"type":"string","enum":["instant","standard"],"title":"Effective Processing Method","description":"Method currently running, that completed the operation, or that was most recently attempted before failure."},"status":{"type":"string","enum":["pending","completed","failed"],"title":"Status"},"failure_reason":{"anyOf":[{"$ref":"#/components/schemas/PaStatusFailureReason"},{"type":"null"}],"description":"Failure details when status is failed; otherwise null. The failure code corresponds to the effective processing method."},"prior_authorizations":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaStatusPriorAuthorization"},"type":"array"},{"type":"null"}],"title":"Prior Authorizations","description":"Null while the operation is pending or failed. When the operation is completed, this is always an array. An empty array means the check completed successfully and no prior authorizations were found for the requested patient, NDC, and insurance information."}},"additionalProperties":false,"type":"object","required":["id","object","effective_processing_method","status","failure_reason","prior_authorizations"],"title":"GetPaStatusResponseData","description":"Response data returned when polling a PA status check."},"GetPaStatusSuccessResponse":{"properties":{"status":{"type":"string","const":"success","title":"Status","default":"success"},"error":{"type":"null","title":"Error"},"data":{"$ref":"#/components/schemas/GetPaStatusResponseData"}},"type":"object","required":["data"],"title":"GetPaStatusSuccessResponse","description":"Successful response to GET /pa-status/{id}."},"GetPriorAuthResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"allOf":[{"$ref":"#/components/schemas/GetPriorAuthResponseData"}],"title":"Data","description":"Contains the data from your prior authorization request, or None if an error occurred."}},"type":"object","title":"GetPriorAuthResponse","description":"Represents the response structure for a GET /prior-authorization/:id request.\n\nThis class extends the generic ApiResponse, specifically tailored to handle responses related to\nprior authorizations. It primarily includes the data attribute, which holds detailed information\nabout the benefit verification process and its results."},"GetPriorAuthResponseData":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of this prior authorization"},"object":{"type":"string","enum":["prior_authorization"],"title":"Object","description":"The type of object. This will always be 'prior_authorization', from this endpoint, but this can be helpful for differentiating between different types of objects when parsing webhook responses.","default":"prior_authorization"},"url":{"type":"string","title":"Url","description":"The URL where the Prior Authorization can be viewed."},"status":{"allOf":[{"$ref":"#/components/schemas/PriorAuthRequestStatus"}],"description":"The current status of the prior auth request."},"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses","description":"Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9'"},"evidence":{"items":{"$ref":"#/components/schemas/ResponseEvidenceItem"},"type":"array","title":"Evidence","description":"A collection of evidence items supporting the authorization request. Any other supporting evidence that doesn't fit into one of the explicitly declared fields above can be added here."},"patient":{"allOf":[{"$ref":"#/components/schemas/Patient"}],"title":"Patient","description":"Demographic information for the patient"},"insurance":{"items":{"$ref":"#/components/schemas/InsuranceDocumentInfo"},"type":"array","title":"Insurance","description":"Array of insurance documents."},"prescription":{"allOf":[{"$ref":"#/components/schemas/Prescription"}],"title":"Prescription","description":"Information regarding the prescription this prior authorization is being created for."},"provider":{"allOf":[{"$ref":"#/components/schemas/Provider"}],"title":"Provider","description":"Details of the healthcare provider who created the prescription."},"pharmacy":{"allOf":[{"$ref":"#/components/schemas/Pharmacy"}],"title":"Pharmacy","description":"Information about the pharmacy where the prescription will be filled."},"questionnaires":{"items":{"$ref":"#/components/schemas/Questionnaire"},"type":"array","title":"Questionnaires","description":"List of questionnaires. This is the best place to send structured Q&A format data, such as intake forms, etc."},"visit_notes":{"items":{"$ref":"#/components/schemas/VisitNote"},"type":"array","title":"Visit Notes","description":"List of visit notes."},"ndp_submission":{"allOf":[{"$ref":"#/components/schemas/PriorAuthRequestNDPSubmission"}],"title":"Ndp Submission","description":"Configuration for processing the prescription associated with this PA request."},"resubmission_info":{"allOf":[{"$ref":"#/components/schemas/PriorAuthRequestResubmissionInfo"}],"title":"Resubmission Info","description":"Information provided when resubmitting a prior authorization request."},"activity_log":{"items":{"oneOf":[{"$ref":"#/components/schemas/PriorAuthActivityLogSentFax"},{"$ref":"#/components/schemas/PriorAuthActivityLogReceivedFax"},{"$ref":"#/components/schemas/PriorAuthActivityLogFollowUpCall"}],"discriminator":{"propertyName":"type","mapping":{"sent_fax":"#/components/schemas/PriorAuthActivityLogSentFax","received_fax":"#/components/schemas/PriorAuthActivityLogReceivedFax","follow_up_call":"#/components/schemas/PriorAuthActivityLogFollowUpCall"}}},"type":"array","title":"Activity Log","description":"A list of activity log items for the prior authorization request.\nNote: additional item types will be added here in future, so please ensure that unknown types are ignored when parsing this array to avoid validation errors when new types are added."},"submitted_by":{"allOf":[{"$ref":"#/components/schemas/User"}],"title":"Submitted By","description":"The user who submitted the prior authorization request."},"reviewed_by":{"allOf":[{"$ref":"#/components/schemas/User"}],"title":"Reviewed By","description":"The user who reviewed the prior authorization request."},"eligibility_check_response":{"items":{"anyOf":[{"$ref":"#/components/schemas/EligibilityCheckResponseSuccessItem"},{"$ref":"#/components/schemas/EligibilityCheckResponseErrorItem"}]},"type":"array","minItems":1,"title":"Eligibility Check Response","description":"Populated after the eligibility check has been made for the PA, if enabled"},"real_time_benefits_check_response":{"allOf":[{"$ref":"#/components/schemas/RealTimeBenefitsCheckResponse"}],"title":"Real Time Benefits Check Response","description":"Populated after the real-time benefits check has been made for the PA, if enabled"},"prescription_transfer":{"allOf":[{"$ref":"#/components/schemas/PrescriptionTransfer"}],"title":"Prescription Transfer","description":"Information about the prescription transfer status and attempts"},"mock_result":{"anyOf":[{"$ref":"#/components/schemas/PriorAuthMockResultApproved"},{"$ref":"#/components/schemas/PriorAuthMockResultDenied"},{"$ref":"#/components/schemas/PriorAuthMockResultOther"},{"$ref":"#/components/schemas/PriorAuthMockResultNotSubmitted"}],"title":"Mock Result","description":"The mock result of the prior authorization request, if one was provided in the initial request"},"out_of_pocket_costs":{"items":{"$ref":"#/components/schemas/CopayOption"},"type":"array","title":"Out Of Pocket Costs","description":"List of copay options with amounts in cents and supply duration in days"},"denial_reason_analysis":{"allOf":[{"$ref":"#/components/schemas/DenialReasonAnalysis"}],"title":"Denial Reason Analysis","description":"Analysis of the denial reason(s). Populated when the prior authorization request has been denied."},"message_thread":{"allOf":[{"$ref":"#/components/schemas/PlatformMessageThread"}],"title":"Message Thread","description":"Message thread for this prior authorization, including whether it is resolved and its messages."},"triggered_benefit_verification_id":{"type":"string","title":"Triggered Benefit Verification Id","description":"The ID of the benefit verification triggered by this PA request, if one was configured."},"is_appeal":{"type":"boolean","title":"Is Appeal","description":"Whether this prior authorization request is an appeal of a previously denied PA.","default":false},"patient_consent_required":{"type":"boolean","title":"Patient Consent Required","description":"Whether the payer currently requires verbal patient consent for this prior authorization.","default":false},"outcome":{"oneOf":[{"$ref":"#/components/schemas/PriorAuthSubmissionApprovalOutcome"},{"$ref":"#/components/schemas/PriorAuthSubmissionDenialOutcome"},{"$ref":"#/components/schemas/PriorAuthSubmissionOtherOutcome"},{"$ref":"#/components/schemas/PriorAuthSubmissionPendingOutcome"},{"$ref":"#/components/schemas/PriorAuthSubmissionNotSubmittedOutcome"}],"title":"Outcome","description":"Details of the outcome of the prior authorization request.","discriminator":{"propertyName":"result","mapping":{"Approved":"#/components/schemas/PriorAuthSubmissionApprovalOutcome","Denied":"#/components/schemas/PriorAuthSubmissionDenialOutcome","Other":"#/components/schemas/PriorAuthSubmissionOtherOutcome","Pending":"#/components/schemas/PriorAuthSubmissionPendingOutcome","Not Submitted":"#/components/schemas/PriorAuthSubmissionNotSubmittedOutcome"}}}},"type":"object","required":["id","url","status","diagnoses","patient","insurance","provider","outcome"],"title":"GetPriorAuthResponseData"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImagesInfo":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ImagesInfo"},"InsuranceCardAssets":{"properties":{"card_front":{"$ref":"#/components/schemas/FileAsset"},"card_back":{"$ref":"#/components/schemas/FileAsset"}},"type":"object","required":["card_front"],"title":"InsuranceCardAssets"},"InsuranceDocumentInfo":{"properties":{"scanned_content":{"allOf":[{"$ref":"#/components/schemas/ScannedContent"}],"title":"Scanned Content","description":"An object containing details that were extracted from the insurance card images provided in the creation request."},"discrete_content":{"allOf":[{"$ref":"#/components/schemas/PartialInsuranceInfo"}],"title":"Discrete Content","description":"An object containing manually-provided insurance details from the creation request."},"url":{"type":"string","title":"Url","description":"If applicable, the Base64 encoded insurance card image you send in the request is stored on our servers. A signed URL to the image is returned here. This URL has a short expiry time, so you should download the image immediately after receiving it if you want to view the asset."}},"type":"object","required":["scanned_content","discrete_content"],"title":"InsuranceDocumentInfo"},"LiveKitCallFailurePayload":{"properties":{"room_name":{"type":"string","title":"Room Name"},"sip_status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sip Status Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"agent_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Version"}},"type":"object","required":["room_name"],"title":"LiveKitCallFailurePayload","description":"Pre-media SIP failure reported by the LiveKit agent worker.\n\nThe agent posts raw failure data (no classification). The backend classifies\nvia api.services.sip_failure_classifier and gates retry via\napi.services.sip_failure_retry.should_retry_for_sip_failure."},"LiveKitTranscriptPayload":{"properties":{"room_name":{"type":"string","title":"Room Name"},"transcript":{"type":"string","title":"Transcript"},"attempt_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attempt Id"},"agent_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Version"}},"type":"object","required":["room_name","transcript"],"title":"LiveKitTranscriptPayload","description":"Transcript data from LiveKit agent after call completes"},"LiveKitUsageError":{"properties":{"error_type":{"type":"string","title":"Error Type"},"error_message":{"type":"string","title":"Error Message"},"recoverable":{"type":"boolean","title":"Recoverable"},"source":{"type":"string","title":"Source"},"model_metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Model Metadata"}},"type":"object","required":["error_type","error_message","recoverable","source"],"title":"LiveKitUsageError","description":"Error event from LiveKit agent session"},"LiveKitUsagePayload":{"properties":{"room_name":{"type":"string","title":"Room Name"},"attempt_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attempt Id"},"agent_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Version"},"llm_total_tokens":{"type":"integer","title":"Llm Total Tokens","default":0},"llm_prompt_tokens":{"type":"integer","title":"Llm Prompt Tokens","default":0},"llm_completion_tokens":{"type":"integer","title":"Llm Completion Tokens","default":0},"llm_prompt_cached_tokens":{"type":"integer","title":"Llm Prompt Cached Tokens","default":0},"llm_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Model"},"tts_characters":{"type":"integer","title":"Tts Characters","default":0},"tts_audio_duration":{"type":"number","title":"Tts Audio Duration","default":0.0},"tts_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tts Model"},"stt_audio_duration":{"type":"number","title":"Stt Audio Duration","default":0.0},"stt_model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stt Model"},"errors":{"items":{"$ref":"#/components/schemas/LiveKitUsageError"},"type":"array","title":"Errors","default":[]}},"type":"object","required":["room_name"],"title":"LiveKitUsagePayload","description":"Usage and error data from LiveKit agent after call completes"},"MockResult":{"properties":{"status":{"$ref":"#/components/schemas/MockResultStatus"},"case":{"allOf":[{"$ref":"#/components/schemas/MockResultCase"}],"description":"The case to simulate for the benefit verification. The options are: \n- **drugs_covered__prior_auth_required__has_copay**: Drug is covered, prior authorization required, and there is a copay.\n- **drugs_covered__prior_auth_required__no_copay**: Drug is covered, prior authorization required, but there is no copay.\n- **drugs_covered__prior_auth_not_required__has_copay**: Drug is covered, no prior authorization required, and there is a copay.\n- **drugs_covered__prior_auth_not_required__no_copay**: Drug is covered, no prior authorization required, and there is no copay.\n- **drugs_not_covered__prior_auth_na__no_copay**: Drug is not covered, prior authorization not applicable (because the drug is not covered), and there is no copay.\n- **patient_consent_required**: Patient consent is required to proceed with the benefit verification.\n- **reverification__existing_pa**: Reverification case where an existing prior authorization is found. Coverage status and PA requirement will be N/A, with has_active_prior_auth set to true.\n- **reverification__no_existing_pa**: Reverification case where no existing prior authorization is found. Drug is covered, prior authorization required, with has_active_prior_auth set to false."}},"type":"object","required":["status","case"],"title":"MockResult"},"MockResultCase":{"type":"string","enum":["drugs_covered__prior_auth_required__has_copay","drugs_covered__prior_auth_required__no_copay","drugs_covered__prior_auth_not_required__has_copay","drugs_covered__prior_auth_not_required__no_copay","drugs_not_covered__prior_auth_na__no_copay","patient_consent_required","reverification__existing_pa","reverification__no_existing_pa"],"title":"MockResultCase","description":"An enumeration."},"MockResultStatus":{"type":"string","enum":["completed","failed"],"title":"MockResultStatus","description":"An enumeration."},"NDC":{"properties":{"labeler_code":{"type":"string","maxLength":5,"minLength":5,"title":"Labeler Code"},"product_code":{"type":"string","maxLength":4,"minLength":4,"title":"Product Code"},"package_code":{"type":"string","maxLength":2,"minLength":2,"title":"Package Code"}},"type":"object","required":["labeler_code","product_code"],"title":"NDC"},"OptionalAddress":{"properties":{"street":{"type":"string","title":"Street","description":"Street address of residence."},"street_line_2":{"type":"string","title":"Street Line 2","description":"Additional street address information."},"city":{"type":"string","title":"City","description":"City of residence."},"state_province":{"type":"string","title":"State Province","description":"State or province of residence."},"zip_postal_code":{"type":"string","title":"Zip Postal Code","description":"ZIP or postal code part of the address."},"country":{"type":"string","title":"Country","description":"Country of residence."}},"type":"object","title":"OptionalAddress","description":"Represents a postal address with optional fields.\nUsed for cases where address information may not be complete at creation time."},"OverrideSchedulingChoices":{"type":"string","enum":["no_override","instant_first_call","instant_first_call_no_retry_delay"],"title":"OverrideSchedulingChoices","description":"An enumeration."},"PaStatusAddress":{"properties":{"street":{"type":"string","minLength":1,"title":"Street"},"street_line_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street Line 2"},"city":{"type":"string","minLength":1,"title":"City"},"state_province":{"type":"string","minLength":1,"title":"State Province"},"zip_postal_code":{"type":"string","minLength":1,"title":"Zip Postal Code"},"country":{"type":"string","title":"Country","default":"USA"}},"additionalProperties":false,"type":"object","required":["street","city","state_province","zip_postal_code"],"title":"PaStatusAddress"},"PaStatusAsset":{"oneOf":[{"properties":{"file_content":{"type":"string","minLength":1}},"required":["file_content"]},{"properties":{"file_url":{"type":"string","minLength":1,"format":"uri"}},"required":["file_url"]}],"properties":{"file_content":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"contentEncoding":"base64","title":"File Content","description":"Base64-encoded file contents."},"file_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"File Url","description":"URL downloaded when the request is accepted."}},"additionalProperties":false,"type":"object","title":"PaStatusAsset","description":"Insurance image supplied by content or URL, but not both."},"PaStatusFailureReason":{"properties":{"code":{"type":"string","enum":["instant_pa_status_ineligible","instant_pa_status_failed","standard_pa_status_failed"],"title":"Code"},"message":{"type":"string","minLength":1,"title":"Message"}},"additionalProperties":false,"type":"object","required":["code","message"],"title":"PaStatusFailureReason"},"PaStatusInsurance":{"anyOf":[{"properties":{"member_id":{"type":"string","minLength":1}},"required":["member_id"]},{"properties":{"member_name":{"type":"string","minLength":1}},"required":["member_name"]},{"properties":{"payer_name":{"type":"string","minLength":1}},"required":["payer_name"]},{"properties":{"plan_name":{"type":"string","minLength":1}},"required":["plan_name"]},{"properties":{"client_name":{"type":"string","minLength":1}},"required":["client_name"]},{"properties":{"group_number":{"type":"string","minLength":1}},"required":["group_number"]},{"properties":{"rx_bin":{"type":"string","minLength":1}},"required":["rx_bin"]},{"properties":{"rx_pcn":{"type":"string","minLength":1}},"required":["rx_pcn"]},{"properties":{"rx_group":{"type":"string","minLength":1}},"required":["rx_group"]},{"properties":{"images":{"type":"array","minItems":1}},"required":["images"]}],"properties":{"member_id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Member Id"},"member_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Member Name"},"payer_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Payer Name"},"plan_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Plan Name"},"client_name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Client Name"},"group_number":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Group Number"},"rx_bin":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Rx Bin"},"rx_pcn":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Rx Pcn"},"rx_group":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Rx Group"},"images":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaStatusAsset"},"type":"array","minItems":1},{"type":"null"}],"title":"Images"}},"additionalProperties":false,"type":"object","title":"PaStatusInsurance","description":"Discrete insurance data and images for one plan."},"PaStatusOptionalAddress":{"properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"street_line_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street Line 2"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Province"},"zip_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Postal Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},"additionalProperties":false,"type":"object","title":"PaStatusOptionalAddress"},"PaStatusPatient":{"properties":{"internal_id":{"type":"string","minLength":1,"title":"Internal Id"},"first_name":{"type":"string","minLength":1,"title":"First Name"},"last_name":{"type":"string","minLength":1,"title":"Last Name"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth"},"gender":{"type":"string","enum":["male","female","other"],"title":"Gender","description":"Unspecified gender is not accepted for PA status checks."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"mrn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mrn"},"address":{"$ref":"#/components/schemas/PaStatusAddress"}},"additionalProperties":false,"type":"object","required":["internal_id","first_name","last_name","date_of_birth","gender","address"],"title":"PaStatusPatient"},"PaStatusPrescription":{"properties":{"ndc":{"type":"string","pattern":"^(?:\\d{5}-?\\d{4}-?\\d{2}|\\d{4,5}-\\d{3,4}-\\d{1,2})$","title":"Ndc","description":"Medication National Drug Code. Segmented package NDCs and unsegmented 11-digit package NDCs are supported.","examples":["00169-4505-14","00169450514"]}},"additionalProperties":false,"type":"object","required":["ndc"],"title":"PaStatusPrescription"},"PaStatusPriorAuthorization":{"properties":{"status":{"type":"string","enum":["approved","denied","in_progress","other"],"title":"Status","description":"Normalized PA status. New, pending, and in-review source statuses map to in_progress. Other source statuses map to other."},"request_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Request Date"},"decision_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Decision Date"},"effective_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Effective Date"},"termination_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Termination Date"},"expiration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Expiration Date"},"decision_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Decision Notes"}},"additionalProperties":false,"type":"object","required":["status"],"title":"PaStatusPriorAuthorization","description":"Prior authorization found for the requested NDC."},"PaStatusProvider":{"properties":{"internal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Id"},"first_name":{"type":"string","minLength":1,"title":"First Name"},"last_name":{"type":"string","minLength":1,"title":"Last Name"},"npi":{"type":"string","minLength":1,"title":"Npi"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"fax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fax"},"address":{"$ref":"#/components/schemas/PaStatusOptionalAddress"}},"additionalProperties":false,"type":"object","required":["first_name","last_name","npi","address"],"title":"PaStatusProvider"},"PartialInsuranceInfo":{"properties":{"client_name":{"type":"string","title":"Client Name","description":"The client/employer name."},"group_number":{"type":"string","title":"Group Number","description":"The group number on the card."},"member_name":{"type":"string","title":"Member Name","description":"The member name on the card."},"member_number":{"type":"string","title":"Member Number","description":"The member number on the card."},"payer_name":{"type":"string","title":"Payer Name","description":"The payer name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card. i.e. 'United Healthcare', 'United', 'United Health' could all appear"},"plan_name":{"type":"string","title":"Plan Name","description":"The plan name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card"},"rx_bin":{"type":"string","title":"Rx Bin","description":"The Rx BIN number on the card."},"rx_group":{"type":"string","title":"Rx Group","description":"The Rx group number on the card."},"rx_pcn":{"type":"string","title":"Rx Pcn","description":"The Rx PCN number on the card."}},"type":"object","title":"PartialInsuranceInfo"},"Patient":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"title":"Address","description":"The patient's postal address"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth","description":"The patient's date of birth"},"email":{"type":"string","format":"email","title":"Email","description":"The patient's email address"},"first_name":{"type":"string","minLength":1,"title":"First Name","description":"The patient's first name"},"last_name":{"type":"string","minLength":1,"title":"Last Name","description":"The patient's last name"},"gender":{"allOf":[{"$ref":"#/components/schemas/Gender"}],"description":"The patient's gender"},"internal_id":{"type":"string","minLength":1,"title":"Internal Id","description":"Your internal ID for this patient. This is used for linking all of the requests for a given patient."},"mrn":{"type":"string","title":"Mrn","description":"Medical record number"},"phone":{"type":"string","title":"Phone","description":"The patient's phone number"}},"type":"object","required":["address","date_of_birth","first_name","last_name","gender","internal_id"],"title":"Patient","description":"Represents patient information."},"PatientCoverageStatus":{"type":"string","enum":["patient_not_found","coverage_expired","coverage_not_started","covered","patient_not_covered_unspecified","human_unable_to_answer","missing_from_transcript","unknown"],"title":"PatientCoverageStatus","description":"An enumeration."},"PatientCoverageType":{"type":"string","enum":["medicare","medicare_advantage","tricare","medicaid","other","question_not_asked","unable_to_determine"],"title":"PatientCoverageType","description":"The type of coverage the patient has."},"PatientPlanFundSource":{"type":"string","enum":["commercial","government","question_not_asked","unable_to_determine"],"title":"PatientPlanFundSource","description":"The source of the patient's plan funding."},"PayerMatchDetails":{"properties":{"cardscan_payer_id":{"type":"string","title":"Cardscan Payer Id"},"cardscan_payer_name":{"type":"string","title":"Cardscan Payer Name"},"score":{"type":"string","title":"Score"}},"type":"object","title":"PayerMatchDetails"},"Pharmacy":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"The name of the pharmacy."},"address":{"$ref":"#/components/schemas/Address"}},"type":"object","required":["name"],"title":"Pharmacy","description":"Represents a pharmacy.\n\nAttributes:\n    name (str): The name of the pharmacy.\n    address (Address): The pharmacy's postal address."},"PlatformMessage":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of this message."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of when the message was sent"},"content":{"type":"string","title":"Content","description":"Message content"},"sent_by_name":{"type":"string","title":"Sent By Name","description":"Display name of the sender of this message."},"direction":{"type":"string","enum":["sent","received"],"title":"Direction","description":"Direction of the message relative to you."},"is_resolution":{"type":"boolean","title":"Is Resolution","description":"Whether this message resolves the thread."},"attachments":{"items":{"$ref":"#/components/schemas/PlatformMessageAttachment"},"type":"array","title":"Attachments","description":"Files attached to this message."}},"type":"object","required":["id","timestamp","content","sent_by_name","direction","is_resolution"],"title":"PlatformMessage","description":"A message within a message thread."},"PlatformMessageAttachment":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of this attachment."},"file_name":{"type":"string","title":"File Name","description":"Original filename."},"url":{"type":"string","title":"Url","description":"Download URL for the attachment."}},"type":"object","required":["id","file_name","url"],"title":"PlatformMessageAttachment"},"PlatformMessageThread":{"properties":{"is_resolved":{"type":"boolean","title":"Is Resolved","description":"Whether this message thread is currently resolved. A thread may be unresolved/reopened if further discussion is needed."},"messages":{"items":{"$ref":"#/components/schemas/PlatformMessage"},"type":"array","title":"Messages","description":"Messages in this thread."}},"type":"object","required":["is_resolved","messages"],"title":"PlatformMessageThread","description":"A thread of messages related to this prior authorization."},"PracticeLocation":{"properties":{"address":{"$ref":"#/components/schemas/OptionalAddress"},"phone":{"type":"string","title":"Phone","description":"The phone number the registry has for this practice location."},"fax":{"type":"string","title":"Fax","description":"The fax number the registry has for this practice location."}},"type":"object","required":["address"],"title":"PracticeLocation","description":"A single practice location: postal address paired with the contact\nmethods (phone/fax) the registry reports for that address.\n\nFax matters for prior authorizations (we fax PAs to the practice), and\nphone is useful for the user picking which location to operate on. Both\nare nullable since CMS does not report contacts for every location."},"Prescription":{"properties":{"days_supply":{"type":"integer","title":"Days Supply","description":"The number of days the prescription will be expected to last."},"quantity":{"type":"integer","title":"Quantity","description":"The quantity of the medication."},"directions":{"type":"string","minLength":1,"title":"Directions","description":"Instructions on how the medication should be taken."},"drug_name":{"type":"string","minLength":1,"title":"Drug Name","description":"The name of the medication."},"strength":{"type":"string","minLength":1,"title":"Strength","description":"The strength of the medication."},"dose_form":{"allOf":[{"$ref":"#/components/schemas/DoseForm"}],"description":"The form of the medication."},"route_of_administration":{"allOf":[{"$ref":"#/components/schemas/RouteOfAdministration"}],"description":"The route of administration for the medication."},"extra":{"type":"object","title":"Extra","description":"An optional dictionary containing additional information related to the drug or future prescription."},"expected_length_of_therapy":{"type":"string","title":"Expected Length Of Therapy","description":"The expected length of therapy for the prescribed drug. Defaults to 'Until No Longer Needed' if not provided.","examples":["Until No Longer Needed","12 months","6 weeks"]},"prescription_date":{"type":"string","format":"date-time","title":"Prescription Date","description":"The date the prescription was issued"}},"type":"object","required":["days_supply","quantity","directions","drug_name","strength","dose_form","route_of_administration","prescription_date"],"title":"Prescription","description":"Represents a prescription issued by a healthcare provider. Prefer\nCodedPrescription when NDCs are available."},"PrescriptionTransfer":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/PrescriptionTransferStatus"}],"description":"Status of the pharmacy transfer"},"confirmed":{"type":"boolean","title":"Confirmed","description":"True if completed and confirmation succeeded","default":false},"error_code":{"allOf":[{"$ref":"#/components/schemas/PrescriptionTransferErrorCode"}],"description":"Error code if transfer failed.\n\nNote: this list of codes may grow over time, so your implementation should handle unrecognized values (probably in the same way as 'other').\n- **pharmacy_does_not_exist**: The specified pharmacy does not exist in our records.\n- **pharmacy_permanently_closed**: The pharmacy has been permanently closed and cannot accept any transfers.\n- **pharmacy_unable_to_accept_transfer**: The pharmacy is unable to accept the prescription transfer.\n- **pharmacy_unable_to_fill_prescription**: The pharmacy cannot fill the prescription due to restrictions or lack of stock.\n- **prescription_transfer_not_received**: The pharmacy did not receive the prescription transfer, possibly after several attempts.\n- **transfer_timed_out**: The prescription transfer timed out before it could be completed.\n- **other**: An unexpected error occurred during the prescription transfer process."},"transfer_attempts":{"items":{"$ref":"#/components/schemas/PrescriptionTransferAttempt"},"type":"array","title":"Transfer Attempts","description":"List of transfer attempts"},"confirmation_attempts":{"items":{"$ref":"#/components/schemas/PrescriptionTransferConfirmationAttempt"},"type":"array","title":"Confirmation Attempts","description":"List of confirmation attempts"}},"type":"object","required":["status"],"title":"PrescriptionTransfer","description":"Information about prescription transfer status and attempts"},"PrescriptionTransferAttempt":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of transfer attempt"},"pharmacy_ncpdp_id":{"type":"string","title":"Pharmacy Ncpdp Id","description":"NCPDP ID for the pharmacy receiving the transfer"}},"type":"object","required":["timestamp"],"title":"PrescriptionTransferAttempt"},"PrescriptionTransferConfirmationAttempt":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of confirmation attempt"},"outcome":{"allOf":[{"$ref":"#/components/schemas/PrescriptionTransferConfirmationAttemptOutcome"}],"description":"Outcome of the transfer confirmation attempt"}},"type":"object","required":["timestamp","outcome"],"title":"PrescriptionTransferConfirmationAttempt"},"PrescriptionTransferConfirmationAttemptOutcome":{"type":"string","enum":["success","failed"],"title":"PrescriptionTransferConfirmationAttemptOutcome","description":"An enumeration."},"PrescriptionTransferErrorCode":{"type":"string","enum":["pharmacy_does_not_exist","pharmacy_permanently_closed","pharmacy_unable_to_accept_transfer","pharmacy_unable_to_fill_prescription","prescription_transfer_not_received","transfer_timed_out","other"],"title":"PrescriptionTransferErrorCode","description":"An enumeration."},"PrescriptionTransferStatus":{"type":"string","enum":["in_progress","cancelled","awaiting_provider_response","completed","error"],"title":"PrescriptionTransferStatus","description":"An enumeration."},"PriorAuthActivityLogFaxDetails":{"properties":{"url":{"type":"string","title":"Url","description":"A signed URL to download the fax file. Note that this URL has a short lifespan and should be used immediately to download the file."}},"type":"object","required":["url"],"title":"PriorAuthActivityLogFaxDetails"},"PriorAuthActivityLogFollowUpCall":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"type":{"type":"string","enum":["follow_up_call"],"title":"Type","default":"follow_up_call"},"details":{"$ref":"#/components/schemas/PriorAuthActivityLogFollowUpCallDetails"}},"type":"object","required":["id","created_at","details"],"title":"PriorAuthActivityLogFollowUpCall"},"PriorAuthActivityLogFollowUpCallDetails":{"properties":{"notes":{"type":"string","title":"Notes","description":"Notes from the follow-up call."},"recording_url":{"type":"string","title":"Recording Url","description":"URL to download the call recording."},"transcript":{"type":"string","title":"Transcript","description":"Transcript of the follow-up call if available."}},"type":"object","title":"PriorAuthActivityLogFollowUpCallDetails"},"PriorAuthActivityLogReceivedFax":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"type":{"type":"string","enum":["received_fax"],"title":"Type","default":"received_fax"},"details":{"$ref":"#/components/schemas/PriorAuthActivityLogFaxDetails"}},"type":"object","required":["id","created_at","details"],"title":"PriorAuthActivityLogReceivedFax"},"PriorAuthActivityLogSentFax":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"type":{"type":"string","enum":["sent_fax"],"title":"Type","default":"sent_fax"},"details":{"$ref":"#/components/schemas/PriorAuthActivityLogFaxDetails"}},"type":"object","required":["id","created_at","details"],"title":"PriorAuthActivityLogSentFax"},"PriorAuthErrorCode":{"type":"string","enum":["unsupported_patient","unsupported_drug","daily_prior_auth_request_limit_reached","daily_prior_auth_request_new_plan_limit_reached","insurance_card_member_id_ocr_failure","insurance_content_invalid_rx_bin","prescription_message_not_found","prescription_message_already_linked","provider_not_authorized","evidence_file_download_failed","invalid_qle_resubmission","previous_pa_request_in_progress","mock_result_not_allowed","invalid_npi","invalid_diagnosis_codes","provider_outreach_not_supported","provider_outreach_fax_required","provider_outreach_mock_result_conflict","other"],"title":"PriorAuthErrorCode","description":"Public version of PriorAuthErrorCode. This is used in the API response."},"PriorAuthFeedbackRequest":{"properties":{"category":{"type":"string","title":"Category","description":"User-defined category for the feedback. Used for grouping in analytics."},"message":{"type":"string","title":"Message","description":"Free-text description of the issue or feedback."}},"type":"object","required":["category","message"],"title":"PriorAuthFeedbackRequest","description":"Payload for submitting feedback related to a prior authorization request."},"PriorAuthFeedbackResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"type":"null","title":"Data"}},"type":"object","title":"PriorAuthFeedbackResponse","description":"Response returned after feedback has been accepted."},"PriorAuthMockResultApproved":{"properties":{"result":{"type":"string","enum":["Approved"],"const":"Approved","title":"Result","description":"The Prior Authorization has been approved.","default":"Approved"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeApprovalDetail"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **prior_auth_not_required**: A prior authorization is not required.\n- **approval**: The prior authorization request has been approved.\n- **existing_approval**: An active prior authorization approval already exists for the patient."},"prescription_transfer_error_code":{"allOf":[{"$ref":"#/components/schemas/PrescriptionTransferErrorCode"}],"description":"This field is only used if the ndp_submission.preferred_pharmacy_ncpdp_id was provided in the request. If provided, a prescription transfer error will be mocked. Otherwise / by default, a successful transfer will be mocked."}},"type":"object","title":"PriorAuthMockResultApproved","description":"Represents a mock result for a prior authorization request."},"PriorAuthMockResultDenied":{"properties":{"result":{"type":"string","enum":["Denied"],"const":"Denied","title":"Result","description":"The Prior Authorization has been denied.","default":"Denied"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeDenialDetail"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **formulary_alternative_preferred**: The formulary alternative is preferred.\n- **medical_necessity_criteria_not_met**: The medical necessity criteria are not met.\n- **plan_exclusion**: The drug is excluded by the plan.\n- **step_therapy_criteria_not_met**: The step therapy criteria are not met.\n- **existing_denial**: An existing denial is on file for this medication and patient. Please follow the appeals process if you wish to adjust this outcome\n- **coverage_limits_exceeded**: The coverage limits have been exceeded for this patient's plan.\n- **prior_weight_loss_program_required**: The patient has not completed the required weight loss program prior to therapy.\n- **unknown**: The prior authorization request has been denied."},"client_code":{"type":"string","title":"Client Code","description":"A client-specific outcome code for the denial. This will be returned in the outcome response."}},"type":"object","title":"PriorAuthMockResultDenied","description":"Represents a mock result for a prior authorization request."},"PriorAuthMockResultNotSubmitted":{"properties":{"result":{"type":"string","enum":["Not Submitted"],"const":"Not Submitted","title":"Result","description":"The prior authorization request will not be submitted. For example, when the eligibility check is enabled and the check returns as error.","default":"Not Submitted"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeNotSubmittedDetail"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **eligibility_check_error**: Indicates eligibility check encountered an error. Error details will be surfaced in the `eligibility_check_response` field. This status will not happen if `ndp_submission.ignore_eligibility_check_error` was set to True for the PA request.\n- **eligibility_check_government_plan**: Indicates that the eligibility check revealed the patient has only government insurance plan(s). The `eligibility_check_response` field will contain the successful eligibility check response. This status will not happen if `ndp_submission.submit_pa_with_eligibility_check_government_plan` was set to True for the PA request.\n- **prescription_message_not_found**: Indicates the provided prescription message ID does not correspond to a prescription. This can happen if the eScript received to the NDP could not be converted into a valid prescription.\n- **more_information_required**: Indicates that additional information is required before this request can be submitted. The request was not submitted and should be resubmitted with the additional details.\n- **formulary_alternative_required**: Indicates that the patient needs to try a formulary alternative before the PA can be approved. The request was not submitted and should instead be submitted for the formulary alternative outlined in the outcome message.\n- **benefit_verification_no_medication_coverage**: Indicates that a triggered benefit verification determined the prescribed medication is not covered by the patient's plan.\n- **benefit_verification_only_alternative_medication_covered**: Indicates that a triggered benefit verification determined the prescribed medication is not covered, but an alternative medication specified in the request is covered.\n- **benefit_verification_pa_not_required**: Indicates that a triggered benefit verification determined the prescribed medication is covered and does not require prior authorization.\n- **pbm_excluded**: Indicates that the eligibility check revealed only an excluded PBM payer and the PA was not submitted. The `eligibility_check_response` field will contain the successful eligibility check response.\n- **payer_not_supported**: Indicates that the eligibility check revealed the patient's health plan is not supported. Currently, Kaiser health plans are not supported. The `eligibility_check_response` field will contain the successful eligibility check response."}},"type":"object","title":"PriorAuthMockResultNotSubmitted","description":"Represents a mock result where the prior authorization was NOT submitted\nbecause the eligibility check either encountered an error or revealed the\npatient has a government plan."},"PriorAuthMockResultOther":{"properties":{"result":{"type":"string","enum":["Other"],"const":"Other","title":"Result","description":"The Prior Authorization has completed without an approval/denial determination.","default":"Other"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeOtherDetailPublic"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **coverage_inactive**: The patient's coverage has expired.\n- **coverage_not_yet_started**: The patient's coverage has not yet started.\n- **no_pharmacy_benefits**: The patient's insurance does not include pharmacy benefits.\n- **payer_unable_to_locate_member**: The payer could not locate the member in their system.\n- **npi_taxonomy_ineligible**: The payer rejected the request because the prescriber's NPI taxonomy, provider type, specialty, or credentials are not eligible to submit this prior authorization.\n- **payer_reported_invalid_patient_info**: The payer located the patient in their system but some submitted patient information does not match.\n- **duplicate_request**: The request is a duplicate. Please cancel the existing request and resubmit if needed.\n- **prior_auth_not_required**: A prior authorization is not required for this medication.\n- **patient_consent_required**: The payer requires verbal consent from the patient before discussing or processing the prior authorization.\n- **more_information_required**: Insufficient information provided to complete the prior authorization.\n- **other**: A problem not listed here was encountered. Check the `outcome.detail` field for more information."},"trigger_message":{"type":"boolean","title":"Trigger Message","description":"If True, a message will be added to the prior authorization after creation. This simulates a follow-up message and will trigger the prior authorization message webhook.","default":false}},"type":"object","title":"PriorAuthMockResultOther","description":"Represents a mock result for a prior authorization request."},"PriorAuthOutcomeApprovalDetail":{"type":"string","enum":["prior_auth_not_required","approval","existing_approval"],"title":"PriorAuthOutcomeApprovalDetail","description":"An enumeration."},"PriorAuthOutcomeDenialDetail":{"type":"string","enum":["formulary_alternative_preferred","medical_necessity_criteria_not_met","plan_exclusion","step_therapy_criteria_not_met","existing_denial","coverage_limits_exceeded","prior_weight_loss_program_required","unknown"],"title":"PriorAuthOutcomeDenialDetail","description":"An enumeration."},"PriorAuthOutcomeNotSubmittedDetail":{"type":"string","enum":["eligibility_check_error","eligibility_check_government_plan","prescription_message_not_found","more_information_required","formulary_alternative_required","benefit_verification_no_medication_coverage","benefit_verification_only_alternative_medication_covered","benefit_verification_pa_not_required","pbm_excluded","payer_not_supported"],"title":"PriorAuthOutcomeNotSubmittedDetail","description":"An enumeration."},"PriorAuthOutcomeOtherDetailPublic":{"type":"string","enum":["coverage_inactive","coverage_not_yet_started","no_pharmacy_benefits","payer_unable_to_locate_member","npi_taxonomy_ineligible","payer_reported_invalid_patient_info","duplicate_request","prior_auth_not_required","patient_consent_required","more_information_required","other"],"title":"PriorAuthOutcomeOtherDetailPublic","description":"Public version of PriorAuthOutcomeOtherDetail. This is used in the API response."},"PriorAuthRequestNDPSubmission":{"properties":{"prescription_message_id":{"type":"string","minLength":1,"title":"Prescription Message Id","description":"The Surescripts message ID for the prescription transfer."},"ignore_eligibility_check_error":{"type":"boolean","title":"Ignore Eligibility Check Error","description":"If set to True, error responses from the eligibility check will not terminate the PA request."},"submit_pa_with_eligibility_check_government_plan":{"type":"boolean","title":"Submit Pa With Eligibility Check Government Plan","description":"If set to True, the PA request will be submitted even if the eligibility check reveals the patient has only government insurance plan(s).","default":false},"preferred_pharmacy_ncpdp_id":{"type":"string","pattern":"^\\d{7}$","title":"Preferred Pharmacy Ncpdp Id","description":"The NCPDP ID of the preferred pharmacy where the prescription will be transferred after the PA request has been approved."},"preferred_pharmacy_details":{"type":"string","title":"Preferred Pharmacy Details","description":"Free-text pharmacy preference information (e.g. 'CVS Pharmacy, 123 Main St, Portland OR 97201'). At least one of preferred_pharmacy_ncpdp_id or preferred_pharmacy_details must be provided."}},"type":"object","required":["prescription_message_id","ignore_eligibility_check_error"],"title":"PriorAuthRequestNDPSubmission","description":"Configuration for processing the prescription associated with this PA request.\n\nThis field should only be provided when a prescription has been sent to Develop\nHealth's non-dispensing pharmacy."},"PriorAuthRequestResubmissionInfo":{"properties":{"previous_prior_auth_request_id":{"type":"string","title":"Previous Prior Auth Request Id","description":"Identifier of the previous prior authorization request."},"note":{"type":"string","title":"Note","description":"Reason for resubmission or additional instructions for this attempt. Required unless `appeal_details` is provided."},"quantity_limit_exception_reason":{"type":"string","title":"Quantity Limit Exception Reason","description":"Explanation for requesting an exception to the plan's quantity limit. Required when resubmitting due to a quantity limit denial."}},"type":"object","title":"PriorAuthRequestResubmissionInfo","description":"Information provided when resubmitting a prior authorization request."},"PriorAuthRequestStatus":{"type":"string","enum":["failed","not_submitted","processing","awaiting_review","awaiting_outcome","validating_outcome","completed","cancelled","awaiting_provider_response"],"title":"PriorAuthRequestStatus","description":"The status of a prior authorization request."},"PriorAuthSubmissionApprovalOutcome":{"properties":{"detail":{"type":"string","maxLength":2048,"title":"Detail","description":"A human-readable note providing additional information about the outcome. This will usually be an automated message corresponding to `detail_code`. In some cases it will contain more specific details about the outcome. For example, \"Patient must enroll in the Omada Health Program.\""},"result":{"type":"string","enum":["Approved"],"const":"Approved","title":"Result","description":"The Prior Authorization has been approved.","default":"Approved"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeApprovalDetail"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **prior_auth_not_required**: A prior authorization is not required.\n- **approval**: The prior authorization request has been approved.\n- **existing_approval**: An active prior authorization approval already exists for the patient."},"authorization_start_date":{"type":"string","format":"date","title":"Authorization Start Date","description":"The date when the authorization became effective. This will typically only be populated for approved outcomes."},"authorization_expiration":{"type":"string","format":"date","title":"Authorization Expiration","description":"The date when the authorization expires. This information is not always available, but it will be included where possible."}},"type":"object","title":"PriorAuthSubmissionApprovalOutcome"},"PriorAuthSubmissionDenialOutcome":{"properties":{"detail":{"type":"string","maxLength":2048,"title":"Detail","description":"A human-readable note providing additional information about the outcome. This will usually be an automated message corresponding to `detail_code`. In some cases it will contain more specific details about the outcome. For example, \"Patient must enroll in the Omada Health Program.\""},"result":{"type":"string","enum":["Denied"],"const":"Denied","title":"Result","description":"The Prior Authorization has been denied.","default":"Denied"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeDenialDetail"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **formulary_alternative_preferred**: The formulary alternative is preferred.\n- **medical_necessity_criteria_not_met**: The medical necessity criteria are not met.\n- **plan_exclusion**: The drug is excluded by the plan.\n- **step_therapy_criteria_not_met**: The step therapy criteria are not met.\n- **existing_denial**: An existing denial is on file for this medication and patient. Please follow the appeals process if you wish to adjust this outcome\n- **coverage_limits_exceeded**: The coverage limits have been exceeded for this patient's plan.\n- **prior_weight_loss_program_required**: The patient has not completed the required weight loss program prior to therapy.\n- **unknown**: The prior authorization request has been denied."},"client_code":{"type":"string","title":"Client Code","description":"A client-specific outcome code for the prior authorization request. This field is only populated for clients with custom client codes configured. To configure your outcome codes, please contact support."}},"type":"object","title":"PriorAuthSubmissionDenialOutcome"},"PriorAuthSubmissionNotSubmittedOutcome":{"properties":{"detail":{"type":"string","maxLength":2048,"title":"Detail","description":"A human-readable note providing additional information about the outcome. This will usually be an automated message corresponding to `detail_code`. In some cases it will contain more specific details about the outcome. For example, \"Patient must enroll in the Omada Health Program.\""},"result":{"type":"string","enum":["Not Submitted"],"const":"Not Submitted","title":"Result","description":"The prior authorization request will not be submitted. For example, when the eligibility check is enabled and the check returns as error.","default":"Not Submitted"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeNotSubmittedDetail"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **eligibility_check_error**: Indicates eligibility check encountered an error. Error details will be surfaced in the `eligibility_check_response` field. This status will not happen if `ndp_submission.ignore_eligibility_check_error` was set to True for the PA request.\n- **eligibility_check_government_plan**: Indicates that the eligibility check revealed the patient has only government insurance plan(s). The `eligibility_check_response` field will contain the successful eligibility check response. This status will not happen if `ndp_submission.submit_pa_with_eligibility_check_government_plan` was set to True for the PA request.\n- **prescription_message_not_found**: Indicates the provided prescription message ID does not correspond to a prescription. This can happen if the eScript received to the NDP could not be converted into a valid prescription.\n- **more_information_required**: Indicates that additional information is required before this request can be submitted. The request was not submitted and should be resubmitted with the additional details.\n- **formulary_alternative_required**: Indicates that the patient needs to try a formulary alternative before the PA can be approved. The request was not submitted and should instead be submitted for the formulary alternative outlined in the outcome message.\n- **benefit_verification_no_medication_coverage**: Indicates that a triggered benefit verification determined the prescribed medication is not covered by the patient's plan.\n- **benefit_verification_only_alternative_medication_covered**: Indicates that a triggered benefit verification determined the prescribed medication is not covered, but an alternative medication specified in the request is covered.\n- **benefit_verification_pa_not_required**: Indicates that a triggered benefit verification determined the prescribed medication is covered and does not require prior authorization.\n- **pbm_excluded**: Indicates that the eligibility check revealed only an excluded PBM payer and the PA was not submitted. The `eligibility_check_response` field will contain the successful eligibility check response.\n- **payer_not_supported**: Indicates that the eligibility check revealed the patient's health plan is not supported. Currently, Kaiser health plans are not supported. The `eligibility_check_response` field will contain the successful eligibility check response."}},"type":"object","title":"PriorAuthSubmissionNotSubmittedOutcome"},"PriorAuthSubmissionOtherOutcome":{"properties":{"detail":{"type":"string","maxLength":2048,"title":"Detail","description":"A human-readable note providing additional information about the outcome. This will usually be an automated message corresponding to `detail_code`. In some cases it will contain more specific details about the outcome. For example, \"Patient must enroll in the Omada Health Program.\""},"result":{"type":"string","enum":["Other"],"const":"Other","title":"Result","description":"The Prior Authorization has completed without an approval/denial determination.","default":"Other"},"detail_code":{"allOf":[{"$ref":"#/components/schemas/PriorAuthOutcomeOtherDetailPublic"}],"description":"A code indicating the reason for the prior auth outcome. The possible values are:\n- **coverage_inactive**: The patient's coverage has expired.\n- **coverage_not_yet_started**: The patient's coverage has not yet started.\n- **no_pharmacy_benefits**: The patient's insurance does not include pharmacy benefits.\n- **payer_unable_to_locate_member**: The payer could not locate the member in their system.\n- **npi_taxonomy_ineligible**: The payer rejected the request because the prescriber's NPI taxonomy, provider type, specialty, or credentials are not eligible to submit this prior authorization.\n- **payer_reported_invalid_patient_info**: The payer located the patient in their system but some submitted patient information does not match.\n- **duplicate_request**: The request is a duplicate. Please cancel the existing request and resubmit if needed.\n- **prior_auth_not_required**: A prior authorization is not required for this medication.\n- **patient_consent_required**: The payer requires verbal consent from the patient before discussing or processing the prior authorization.\n- **more_information_required**: Insufficient information provided to complete the prior authorization.\n- **other**: A problem not listed here was encountered. Check the `outcome.detail` field for more information."}},"type":"object","title":"PriorAuthSubmissionOtherOutcome"},"PriorAuthSubmissionPendingOutcome":{"properties":{"detail":{"type":"null","title":"Detail"},"result":{"type":"string","enum":["Pending"],"const":"Pending","title":"Result","description":"The Prior Authorization has been submitted but does not yet have a determination.","default":"Pending"},"detail_code":{"type":"null","title":"Detail Code"}},"type":"object","required":["detail","detail_code"],"title":"PriorAuthSubmissionPendingOutcome"},"Priority":{"type":"integer","enum":[0,1,2,3],"title":"Priority","description":"Represents a priority level. Lower numbers are higher priority.\n\n- CRITICAL: 0\n- HIGH: 1\n- MEDIUM: 2\n- LOW: 3"},"Provider":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/OptionalAddress"}],"title":"Address","description":"The provider's postal address."},"email":{"type":"string","format":"email","title":"Email","description":"The provider's email address."},"fax":{"type":"string","title":"Fax","description":"The provider's fax number."},"first_name":{"type":"string","minLength":1,"title":"First Name","description":"The provider's first name."},"internal_id":{"type":"string","title":"Internal Id","description":"Your internal ID for this provider. This is used for linking all of the requests for a given provider."},"last_name":{"type":"string","minLength":1,"title":"Last Name","description":"The provider's last name."},"npi":{"type":"string","minLength":1,"title":"Npi","description":"The provider's NPI."},"phone":{"type":"string","title":"Phone","description":"The provider's phone number."}},"type":"object","required":["address","first_name","last_name","npi"],"title":"Provider","description":"Represents a healthcare provider."},"ProviderContactSchema":{"properties":{"id":{"type":"string","title":"Id","description":"Hashid of the contact row."},"is_primary":{"type":"boolean","title":"Is Primary","description":"Whether this contact is the primary contact for the provider."},"fax_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fax Number","description":"The provider's fax number."},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"The provider's phone number."},"address_street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Street","description":"Street address of the provider's practice."},"address_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address City","description":"City of the provider's practice."},"address_state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address State Province","description":"State or province of the provider's practice."},"address_zip_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Zip Postal Code","description":"ZIP or postal code of the provider's practice."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the contact row was created."}},"type":"object","required":["id","is_primary","created_at"],"title":"ProviderContactSchema","description":"A single contact row for an authorized provider."},"ProviderContactsResponse":{"properties":{"contacts":{"items":{"$ref":"#/components/schemas/ProviderContactSchema"},"type":"array","title":"Contacts"}},"type":"object","title":"ProviderContactsResponse","description":"Response shape for GET /providers/{provider_uuid}/contacts."},"ProviderIdentitySchema":{"properties":{"npi":{"type":"string","title":"Npi"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"middle_name":{"type":"string","title":"Middle Name"},"name_prefix":{"type":"string","title":"Name Prefix"},"name_suffix":{"type":"string","title":"Name Suffix"},"credential":{"type":"string","title":"Credential"},"status":{"type":"string","title":"Status","description":"Registry status code: 'A' or 'D'."},"practice_address":{"allOf":[{"$ref":"#/components/schemas/OptionalAddress"}],"title":"Practice Address","description":"The primary practice address, if any."},"addresses":{"items":{"$ref":"#/components/schemas/PracticeLocation"},"type":"array","title":"Addresses","description":"All practice locations the registry has for this provider, in the order CMS reports them. Each location pairs the postal address with the phone/fax recorded for it."}},"type":"object","required":["npi","first_name","last_name","status"],"title":"ProviderIdentitySchema","description":"Identity fields surfaced from a registry record."},"ProviderInfo":{"properties":{"first_name":{"type":"string","minLength":1,"title":"First Name","description":"The first name of the provider."},"last_name":{"type":"string","minLength":1,"title":"Last Name","description":"The last name of the provider."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"title":"Address","description":"The address of the provider."},"phone":{"type":"string","title":"Phone","description":"The contact phone number of the provider."},"fax":{"type":"string","title":"Fax","description":"The contact fax number of the provider."},"npi":{"type":"string","minLength":1,"title":"Npi","description":"The National Provider Identifier (NPI) of the provider."},"in_network_payers":{"items":{"type":"string"},"type":"array","title":"In Network Payers","description":"List of insurance payers that the provider is in-network with. This is optional and no longer seems to have much of an impact on the verification process. You can omit this if it is not readily available information"}},"type":"object","required":["first_name","last_name","address","npi"],"title":"ProviderInfo","description":"Contains information about a healthcare provider."},"ProviderLookupRequest":{"properties":{"npi":{"type":"string","title":"Npi","description":"The NPI to look up. Optional names may be included as sandbox fallback hints."},"first_name":{"type":"string","title":"First Name","description":"First name for name+state search. Optional when last_name is provided."},"last_name":{"type":"string","title":"Last Name","description":"Last name for name+state search. Required for name search."},"state":{"type":"string","title":"State","description":"Two-letter state abbreviation. Optional in name searches."}},"type":"object","title":"ProviderLookupRequest","description":"Body for ``POST /provider/lookup``.\n\nEither ``npi`` or a ``last_name`` must be supplied. NPI lookup branches on\nthe registry's ``status`` value and may return active, deactivated (with\nname+state search candidates), not_found, or registry_error. Optional names\nmay accompany NPI lookup as hints for sandbox mock-NPI fallback. A\nname+state body without NPI always returns search_results."},"ProviderLookupResponse":{"properties":{"status":{"$ref":"#/components/schemas/ProviderLookupStatus"},"individual":{"$ref":"#/components/schemas/ProviderIdentitySchema"},"candidates":{"items":{"$ref":"#/components/schemas/ProviderIdentitySchema"},"type":"array","title":"Candidates"}},"type":"object","required":["status"],"title":"ProviderLookupResponse","description":"Response shape for ``POST /provider/lookup``.\n\nThe fields populated depend on ``status``:\n- ``active``: ``individual`` is set; ``candidates`` is empty.\n- ``deactivated``: ``individual`` is the deactivated identity;\n  ``candidates`` is the active replacements found via name+state search\n  (may be empty when the deactivated record has no name on file).\n- ``not_found`` / ``registry_error``: both fields empty.\n- ``search_results``: ``candidates`` lists active matches; ``individual``\n  is empty."},"ProviderLookupStatus":{"type":"string","enum":["active","deactivated","not_found","registry_error","search_results"],"title":"ProviderLookupStatus","description":"Outcome of a provider lookup or search."},"ProviderOutreachConfig":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether to request clinical documents from the provider before answering begins.","default":false}},"type":"object","title":"ProviderOutreachConfig","description":"Configuration for requesting provider outreach for a prior authorization."},"ProviderOutreachResponse":{"properties":{"status":{"type":"string","enum":["sent","failed"],"title":"Status","description":"The initial provider outreach outcome."}},"type":"object","required":["status"],"title":"ProviderOutreachResponse","description":"Initial outcome of provider outreach for a prior authorization."},"Question":{"properties":{"answer":{"type":"string","minLength":1,"title":"Answer","description":"The answer to the question."},"choices":{"items":{"type":"string"},"type":"array","title":"Choices","description":"Optional list of choices for the question. If provided, the answer must be one of the choices. It's important to include this list of choices for any multiple choice question. This allows our AI to know what a user has effectively said 'no' to by picking another option. I.e. for a question 'Do you have any of the following conditions: Diabetes, Heart Disease, Cancer, None of the above' if the user answers 'None of the above' we can infer that they don't have any of those conditions. Without the choices list we would have no way of knowing that."},"question":{"type":"string","minLength":1,"title":"Question","description":"The question to be answered."}},"type":"object","required":["answer","question"],"title":"Question","description":"Represents a single question, as part of a questionnaire."},"Questionnaire":{"properties":{"questions":{"items":{"$ref":"#/components/schemas/Question"},"type":"array","title":"Questions","description":"A list of questions included in the questionnaire."},"date_created":{"type":"string","format":"date-time","title":"Date Created","description":"The date and time when the questionnaire was answered. This is important for ensuring we have an accurate timeline of the patient's history."}},"type":"object","required":["questions","date_created"],"title":"Questionnaire"},"RealTimeBenefitsCheckAlternative":{"properties":{"product_id":{"type":"string","title":"Product Id","description":"The product ID (NDC or RxNorm) of the alternative drug"},"description":{"type":"string","title":"Description","description":"Drug name and strength of the alternative drug"},"patient_cost":{"type":"string","title":"Patient Cost","description":"Patient cost for the alternative drug"},"prior_auth_required":{"type":"boolean","title":"Prior Auth Required","description":"Whether prior authorization is required for the alternative drug"}},"type":"object","required":["product_id","description","patient_cost"],"title":"RealTimeBenefitsCheckAlternative"},"RealTimeBenefitsCheckResponse":{"properties":{"patient_cost":{"type":"string","title":"Patient Cost","description":"Patient cost for the requested prescription"},"prior_auth_required":{"type":"boolean","title":"Prior Auth Required","description":"Whether a prior authorization is required for the requested prescription"},"alternatives":{"items":{"$ref":"#/components/schemas/RealTimeBenefitsCheckAlternative"},"type":"array","title":"Alternatives","description":"List of alternative drugs"}},"type":"object","required":["patient_cost"],"title":"RealTimeBenefitsCheckResponse"},"ResponseEvidenceItem":{"properties":{"asset":{"allOf":[{"$ref":"#/components/schemas/AssetResponse"}],"title":"Asset","description":"File asset containing the evidence."},"content":{"type":"object","title":"Content","description":"Detailed content of the evidence, which varies based on the type of evidence."},"date_created":{"type":"string","format":"date-time","title":"Date Created","description":"The date and time (if available) when the evidence was created. This is important for ensuring we have an accurate timeline of the patient's history."},"document_date":{"type":"string","format":"date","title":"Document Date","description":"The clinical/source document date to display to reviewers, when known. This excludes ingestion/upload/export timestamps."},"title":{"type":"string","title":"Title","description":"Title of the evidence. This will be shown to users in the platform UI so it's recommended to give it a name that would be meaningful to them, such as 'Intake Form'"}},"type":"object","required":["date_created","title"],"title":"ResponseEvidenceItem","description":"Represents an item of evidence, which can include an associated digital asset."},"ReviewStatus":{"type":"string","enum":["reviewed","not_reviewed"],"title":"ReviewStatus","description":"An enumeration."},"RouteOfAdministration":{"type":"string","enum":["auricular (otic)","otic","buccal","conjunctival","cutaneous","dental","electro-osmosis","endocervical","endosinusial","endotracheal","enteral","epidural","extra-amniotic","extracorporeal","hemodialysis","infiltration","interstitial","intra-abdominal","intra-amniotic","intra-arterial","intra-articular","intrabiliary","intrabronchial","intrabursal","intracameral","intracanalicular","intracardiac","intracartilaginous","intracaudal","intracavernous","intracavitary","intracerebral","intracisternal","intracorneal","intracoronal, dental","intracoronary","intracorporus cavernosum","intracranial","intradermal","intradiscal","intraductal","intraduodenal","intradural","intraepicardial","intraepidermal","intraesophageal","intragastric","intragingival","intrahepatic","intraileal","intralesional","intralingual","intraluminal","intralymphatic","intramammary","intramedullary","intrameningeal","intramuscular","intranodal","intraocular","intraomentum","intraovarian","intrapericardial","intraperitoneal","intrapleural","intraprostatic","intrapulmonary","intraruminal","intrasinal","intraspinal","intrasynovial","intratendinous","intratesticular","intrathecal","intrathoracic","intratubular","intratumor","intratympanic","intrauterine","intravascular","intravenous","intraventricular","intravesical","intravitreal","iontophoresis","irrigation","laryngeal","nasal","nasogastric","not applicable","occlusive dressing technique","ophthalmic","oral","oropharyngeal","parenteral","percutaneous","periarticular","peridural","perineural","periodontal","rectal","respiratory (inhalation)","inhalation","retrobulbar","soft tissue","subarachnoid","subconjunctival","subcutaneous","subgingival","sublingual","submucosal","subretinal","suprachoroidal","topical","transdermal","transendocardial","transmucosal","transplacental","transtracheal","transtympanic","ureteral","urethral","vaginal"],"title":"RouteOfAdministration","description":"See: https://www.fda.gov/industry/structured-product-labeling-resources/route-administration"},"ScannedContent":{"properties":{"client_name":{"type":"string","title":"Client Name","description":"The client/employer name."},"group_number":{"type":"string","title":"Group Number","description":"The group number on the card."},"member_name":{"type":"string","title":"Member Name","description":"The member name on the card."},"member_number":{"type":"string","title":"Member Number","description":"The member number on the card."},"payer_name":{"type":"string","title":"Payer Name","description":"The payer name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card. i.e. 'United Healthcare', 'United', 'United Health' could all appear"},"plan_name":{"type":"string","title":"Plan Name","description":"The plan name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card"},"rx_bin":{"type":"string","title":"Rx Bin","description":"The Rx BIN number on the card."},"rx_group":{"type":"string","title":"Rx Group","description":"The Rx group number on the card."},"rx_pcn":{"type":"string","title":"Rx Pcn","description":"The Rx PCN number on the card."},"error":{"type":"string","title":"Error","description":"Error message if we were unable to extract information from the card."}},"type":"object","title":"ScannedContent"},"TaskType":{"type":"string","enum":["prior_auth_initial_review","send_outbound_fax","prior_auth_other","prior_auth_submission_call","prior_auth_follow_up_call","prior_auth_determination_letter_call","prior_auth_denial_manual_reattempt_call","prior_auth_progress_check","prior_auth_internal_review","review_received_fax","review_unmatched_fax","prior_auth_more_info_review","review_received_fax_more_information","portal_submission","cover_my_meds_submission","cover_my_meds_follow_up","validate_prior_auth_outcome","create_question_set","send_additional_information_fax","prior_auth_platform_message","prior_auth_prescription_transfer_confirmation","pa_answer_annotation","evidence_relevance_labeling","appeal_follow_up_call","appeal_validate_outcome","send_appeal_fax","appeal_confirmation_call","rpa_handoff_review","practice_outreach"],"title":"TaskType","description":"An enumeration."},"TranscriptEvent":{"properties":{"call_id":{"type":"string","title":"Call Id"},"type":{"type":"string","const":"event_transcript","title":"Type"},"payload":{"$ref":"#/components/schemas/TranscriptEventPayload"}},"type":"object","required":["call_id","type","payload"],"title":"TranscriptEvent"},"TranscriptEventPayload":{"properties":{"transcript":{"type":"string","title":"Transcript"}},"type":"object","required":["transcript"],"title":"TranscriptEventPayload"},"TriggerBenefitVerificationConfig":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether to trigger a benefit verification when creating this PA."},"additional_medications":{"items":{"$ref":"#/components/schemas/TriggerBenefitVerificationMedication"},"type":"array","title":"Additional Medications","description":"Additional medications to check coverage for alongside the prescribed medication."}},"type":"object","required":["enabled"],"title":"TriggerBenefitVerificationConfig"},"TriggerBenefitVerificationMedication":{"properties":{"ndc":{"type":"string","title":"Ndc","description":"The NDC of the additional medication to check coverage for."},"quantity":{"type":"integer","title":"Quantity","description":"The quantity of the medication to check coverage for."}},"type":"object","required":["ndc","quantity"],"title":"TriggerBenefitVerificationMedication"},"UICreateBenefitVerificationRequest":{"properties":{"patient":{"$ref":"#/components/schemas/api__schemas__platform__platform_api__common__PatientInfo"},"provider":{"$ref":"#/components/schemas/ProviderInfo"},"drugs":{"items":{"anyOf":[{"$ref":"#/components/schemas/DrugInfo"},{"$ref":"#/components/schemas/CodedDrugInfo"}]},"type":"array","maxItems":7,"minItems":1,"title":"Drugs"},"insurance":{"items":{"$ref":"#/components/schemas/api__schemas__platform__public_api__benefit_verification__InsuranceDocument"},"type":"array","title":"Insurance"},"insurance_content":{"$ref":"#/components/schemas/PartialInsuranceInfo"},"entity":{"$ref":"#/components/schemas/EntityInfo"},"diagnoses":{"items":{"$ref":"#/components/schemas/Diagnosis"},"type":"array","title":"Diagnoses"},"drug_history":{"$ref":"#/components/schemas/DrugHistory"}},"type":"object","required":["patient","provider","drugs"],"title":"UICreateBenefitVerificationRequest"},"UIExtractBenefitVerificationRequest":{"properties":{"files":{"items":{"$ref":"#/components/schemas/FileAsset"},"type":"array","title":"Files"},"text":{"type":"string","title":"Text"}},"type":"object","title":"UIExtractBenefitVerificationRequest"},"UnqualifiedReason":{"properties":{"description":{"type":"string","title":"Description","description":"Reason for ineligibility. This is a free text field that could include any text."}},"type":"object","required":["description"],"title":"UnqualifiedReason","description":"Represents the reason why a drug is not eligible for a clinical qualification check.\n\nMore structured fields will be added to this model in the future."},"UpdateBenefitVerificationReviewStatusRequest":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"title":"Data"},"reviewed":{"type":"boolean","title":"Reviewed"}},"type":"object","required":["reviewed"],"title":"UpdateBenefitVerificationReviewStatusRequest"},"UpdateNDPSubmissionRequest":{"properties":{"preferred_pharmacy_ncpdp_id":{"type":"string","pattern":"^\\d{7}$","title":"Preferred Pharmacy Ncpdp Id","description":"The new NCPDP ID of the preferred pharmacy where the prescription will be transferred after the PA request has been approved."}},"type":"object","title":"UpdateNDPSubmissionRequest","description":"Request to update the NDP submission details of a prior authorization.\nCurrently only supports updating the preferred pharmacy NCPDP ID."},"UpdateNDPSubmissionResponse":{"properties":{"status":{"anyOf":[{"type":"string","enum":["success"]},{"type":"string","enum":["error"]}],"title":"Status","default":"success"},"error":{"$ref":"#/components/schemas/ApiError"},"data":{"allOf":[{"$ref":"#/components/schemas/UpdateNDPSubmissionResponseData"}],"title":"Data","description":"Contains the updated NDP submission data, or None if an error occurred."}},"type":"object","title":"UpdateNDPSubmissionResponse","description":"Represents the response structure for a PATCH /prior-authorization/:id/ndp-submission request."},"UpdateNDPSubmissionResponseData":{"properties":{"preferred_pharmacy_ncpdp_id":{"type":"string","title":"Preferred Pharmacy Ncpdp Id","description":"The updated NCPDP ID of the preferred pharmacy."}},"type":"object","title":"UpdateNDPSubmissionResponseData","description":"Data payload returned after a successful NDP submission update."},"User":{"properties":{"first_name":{"type":"string","title":"First Name","description":"The first name of the user."},"last_name":{"type":"string","title":"Last Name","description":"The last name of the user."},"email":{"type":"string","title":"Email","description":"The email of the user."}},"type":"object","required":["email"],"title":"User"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VisitNote":{"properties":{"title":{"type":"string","minLength":1,"title":"Title","description":"The title of the visit note. This is optional and can be used to give the note a meaningful name, such as 'Initial Consultation'."},"content":{"type":"string","minLength":1,"title":"Content","description":"The content of the visit note."},"date_created":{"type":"string","format":"date-time","title":"Date Created","description":"The date and time (if available) when the visit note was created. This is important for ensuring we have an accurate timeline of the patient's history."}},"type":"object","required":["content","date_created"],"title":"VisitNote","description":"Represents a note made during a patient visit."},"api__routers__platform_api__provider__AuthorizedProviderResponse":{"properties":{"uuid":{"type":"string","title":"Uuid"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"npi":{"type":"string","title":"Npi"},"fax_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fax Number"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"address":{"anyOf":[{"$ref":"#/components/schemas/AddressResponse"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"authorization_signed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Authorization Signed At"},"consent_signed":{"type":"boolean","title":"Consent Signed"}},"type":"object","required":["uuid","first_name","last_name","email","npi","created_at","authorization_signed_at","consent_signed"],"title":"AuthorizedProviderResponse"},"api__schemas__platform__platform_api__common__PatientInfo":{"properties":{"internal_id":{"type":"string","title":"Internal Id"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"gender":{"$ref":"#/components/schemas/Gender"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth"},"address":{"$ref":"#/components/schemas/Address"},"phone":{"type":"string","title":"Phone"},"email":{"type":"string","title":"Email"},"insurance":{"items":{"$ref":"#/components/schemas/InsuranceCardAssets"},"type":"array","title":"Insurance"}},"type":"object","required":["internal_id","first_name","last_name","gender","date_of_birth","address"],"title":"PatientInfo","description":"Contains information about a patient.\n\nAttributes:\n    internal_id (str): Your internal ID for this patient. This is used for linking all of the requests for a given patient. If a patient already exists with this ID their data will be updated to match the contents of this request.\n    first_name (str): The first name of the patient.\n    last_name (str): The last name of the patient.\n    gender (Gender): The gender of the patient.\n    date_of_birth (date): The date of birth of the patient.\n    address (Address): The address of the patient.\n    phone (str, optional): The contact phone number of the patient.\n    email (str, optional): The contact email address of the patient.\n    insurance (List[InsuranceCardAssets]): A list of insurance cards for the patient."},"api__schemas__platform__public_api__benefit_verification__InsuranceDocument":{"properties":{"file_content":{"type":"string","title":"File Content","description":"The content of the insurance document, base64 encoded"}},"type":"object","required":["file_content"],"title":"InsuranceDocument","description":"Represents an insurance document."},"api__schemas__platform__public_api__benefit_verification__InsuranceDocumentParsed":{"properties":{"ocr_content":{"type":"string","title":"Ocr Content"},"scanned_content":{"$ref":"#/components/schemas/CardDetails"}},"type":"object","title":"InsuranceDocumentParsed","description":"Represents a parsed insurance document.\nCurrently for internal purposes only, but will eventually be exposed to the client."},"api__schemas__platform__public_api__common__PatientInfo":{"properties":{"internal_id":{"type":"string","minLength":1,"title":"Internal Id","description":"Your internal ID for this patient. This is used for linking all of the requests for a given patient."},"first_name":{"type":"string","minLength":1,"title":"First Name","description":"The first name of the patient."},"last_name":{"type":"string","minLength":1,"title":"Last Name","description":"The last name of the patient."},"gender":{"allOf":[{"$ref":"#/components/schemas/Gender"}],"description":"The gender of the patient."},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth","description":"The date of birth of the patient."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"title":"Address","description":"The address of the patient."},"phone":{"type":"string","title":"Phone","description":"The contact phone number of the patient."},"email":{"type":"string","title":"Email","description":"The contact email address of the patient."}},"type":"object","required":["internal_id","first_name","last_name","gender","date_of_birth","address"],"title":"PatientInfo","description":"Contains information about a patient."},"api__schemas__platform__public_api__insurance_document__InsuranceDocument":{"properties":{"file_content":{"type":"string","title":"File Content"}},"type":"object","required":["file_content"],"title":"InsuranceDocument","description":"Represents an insurance document.\n\nAttributes:\n    file_content (str): The content of the insurance document,\n                        base64 encoded"},"api__schemas__platform__public_api__insurance_document__InsuranceDocumentParsed":{"properties":{"ocr_content":{"type":"string","title":"Ocr Content"},"scanned_content":{"$ref":"#/components/schemas/CardDetails"}},"type":"object","title":"InsuranceDocumentParsed","description":"Represents a parsed insurance document.\nCurrently for internal purposes only, but will eventually be exposed to the client.\n\nAttributes:\n    file_content (str): The content of the insurance document,\n                        base64 encoded"},"api__schemas__platform__public_api__provider__AuthorizedProviderResponse":{"properties":{"npi":{"type":"string","title":"Npi","description":"The NPI of the provider."},"first_name":{"type":"string","title":"First Name","description":"The first name of the provider."},"last_name":{"type":"string","title":"Last Name","description":"The last name of the provider."},"email":{"type":"string","title":"Email","description":"The email of the provider."},"fax_number":{"type":"string","title":"Fax Number","description":"The provider's fax number."},"phone_number":{"type":"string","title":"Phone Number","description":"The provider's phone number."},"address":{"allOf":[{"$ref":"#/components/schemas/OptionalAddress"}],"title":"Address","description":"The provider's practice address."},"signed_at":{"type":"string","format":"date-time","title":"Signed At","description":"The date and time when the provider signed the authorization form. If null, the authorization is pending."}},"type":"object","required":["npi","first_name","last_name"],"title":"AuthorizedProviderResponse","description":"Represents an authorized provider with their authorization status.\nIf signed_at is null, the authorization is pending."}},"securitySchemes":{"FronteggJWTAuthentication":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token."}}},"servers":[{"url":"https://api.develophealth.ai"}]}