> For the complete documentation index, see [llms.txt](https://docs.mdintegrations.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mdintegrations.com/partner-api-reference/models.md). # Models ## The AddressResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"AddressResource":{"type":"object","properties":{"address":{"type":"string"},"address2":{"type":["string","null"]},"address_id":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["address","address2","address_id","zip_code","city_name","state"],"title":"AddressResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"}}}} ``` ## The App.Http.Requests.Sandbox.PostPatientMessageRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Requests.Sandbox.PostPatientMessageRequest":{"type":"object","properties":{"clinician_id":{"type":"string","format":"uuid","description":"Payload;"},"support_staff_id":{"type":"string","format":"uuid"},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}},"title":"App.Http.Requests.Sandbox.PostPatientMessageRequest"}}}} ``` ## The App.Http.Resources.AddressResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"}}}} ``` ## The App.Http.Resources.Boothwyn.OfferingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.Boothwyn.OfferingResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"},"sku":{"type":"string"}},"required":["name","sku"],"title":"App.Http.Resources.Boothwyn.OfferingResource"}}}} ``` ## The App.Http.Resources.ClinicianResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The App.Http.Resources.CountryResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"}}}} ``` ## The App.Http.Resources.Dosespot.MedicationResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.Dosespot.MedicationResource":{"anyOf":[{"type":"object","properties":{"dispensable_drug_id":{"type":"string","description":"Attributes;"},"routed_dose_form_drug_id":{"type":"string"},"ndc":{"type":"string"},"rx_cui":{"type":"string"},"name_with_route_dose_form":{"type":"string"},"strength":{"type":"string"},"is_obsolete":{"type":"string"},"name":{"type":"string","description":"keep compatibility;"}},"required":["dispensable_drug_id","routed_dose_form_drug_id","ndc","rx_cui","name_with_route_dose_form","strength","is_obsolete","name"]},{"type":"object","properties":{"dispensable_drug_id":{"type":"string","description":"Attributes;"},"generic_drug_name":{"type":"string"},"rx_cui":{"type":"string"},"drug_name":{"type":"string"},"state_schedules":{"type":"array","items":{"$ref":"#/components/schemas/MedicationStateScheduleResource"}},"ndc":{"type":"string","description":"Non conditionally - its always returned from DoseSpot;"},"display_name":{"type":"string"},"route":{"type":"string"},"dose_form":{"type":"string"},"strength":{"type":"string"},"dispense_unit_id":{"type":"string"},"brand":{"type":"string"},"otc":{"type":"string"},"drug_classification":{"type":"string"},"schedule":{"type":"string"},"is_obsolete":{"type":"string"}},"required":["dispensable_drug_id","generic_drug_name","rx_cui","drug_name","state_schedules","ndc","display_name","route","dose_form","strength","dispense_unit_id","brand","otc","drug_classification","schedule","is_obsolete"]}],"title":"App.Http.Resources.Dosespot.MedicationResource"},"MedicationStateScheduleResource":{"type":"object","properties":{"state_name":{"type":"string","description":"Attributes;"},"schedule":{"type":"string"}},"required":["state_name","schedule"],"title":"MedicationStateScheduleResource"}}}} ``` ## The App.Http.Resources.Dosespot.SupplyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.Dosespot.SupplyResource":{"type":"object","properties":{"supply_id":{"type":"string","description":"Attributes;"},"ndc":{"type":"string"},"upc":{"type":["string","null"]},"name":{"type":"string"},"otc":{"type":["string","null"]},"is_obsolete":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"dosespot_supply_id":{"type":"string","description":"keep conpability;"}},"required":["supply_id","ndc","upc","name","otc","is_obsolete","dosespot_supply_id"],"title":"App.Http.Resources.Dosespot.SupplyResource"}}}} ``` ## The App.Http.Resources.FileResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"}}}} ``` ## The App.Http.Resources.Partner.OfferingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.Partner.OfferingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"product_type":{"type":"string"},"product_id":{"type":"string"},"partner_id":{"type":["string","null"]},"specialty_id":{"type":["string","null"]},"active":{"type":"string"},"title":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"is_important":{"type":"string"},"clinical_note":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"order":{"type":["integer","null"]},"metadata":{"type":["string","null"]},"replicated_from_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"product":{"type":"string","description":"Relationships;"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}},"faqs":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/FaqResource"}},"states":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"diseases":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/DiseaseResource"}},"clinicians":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"thank_you_files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}}},"required":["id","product_type","product_id","partner_id","specialty_id","active","title","is_additional_approval_needed","is_important","clinical_note","thank_you_note","order","metadata","replicated_from_id","created_at","updated_at","deleted_at","product"],"title":"App.Http.Resources.Partner.OfferingResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"FaqResource":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"questions":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/FaqQuestionResource"}},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}]},"files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","key","title","description","questions","created_at","updated_at","deleted_at"],"title":"FaqResource"},"FaqQuestionResource":{"type":"object","properties":{"question":{},"answer":{}},"required":["question","answer"],"title":"FaqQuestionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The App.Http.Resources.PartnerResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The App.Http.Resources.PatientResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.PatientResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":"string"},"ssn":{"type":["string","null"]},"active":{"type":"string"},"prefix":{"type":["string","null"]},"weight":{"type":"string"},"height":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"address_id":{"type":"string"},"driver_license_id":{"type":["string","null"]},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"pregnancy":{"type":"string"},"partner_id":{"type":"string"},"environment_id":{"type":"string"},"clinician_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"intro_video_file_id":{"type":["string","null"]},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]},"patient_id":{"type":"string","description":"Appended Attributes;"},"full_name":{"type":"string"},"abbreviated_name":{"type":"string"},"is_live":{"type":"string"},"intro_video_id":{"type":"string"},"exam_id":{"type":"string"},"dosespot":{"type":"string"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"shopify_customer_id":{"type":"string"},"address":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"clinician":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"},"driver_license":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"environment":{"description":"When loaded;","$ref":"#/components/schemas/EnvironmentResource"},"intro_video":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","first_name","middle_name","last_name","email","ssn","active","prefix","weight","height","blood_pressure","body_temperature","oxygen_saturation","special_necessities","date_of_birth","gender","gender_label","phone_number","phone_type","address_id","driver_license_id","allergies","current_medications","medical_conditions","pregnancy","partner_id","environment_id","clinician_id","metadata","intro_video_file_id","recent_encounter_id","important_offering_case_id","created_at","updated_at","deleted_at","is_sms_enabled","is_email_enabled","original_patient_id","status","patient_id","full_name","abbreviated_name","is_live","intro_video_id","exam_id","dosespot","metafields","shopify_customer_id"],"title":"App.Http.Resources.PatientResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The App.Http.Resources.PermissionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"}}}} ``` ## The App.Http.Resources.RoleResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"}}}} ``` ## The App.Http.Resources.StateResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"}}}} ``` ## The App.Http.Resources.TagResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The App.Http.Resources.V1.DiseaseResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.V1.DiseaseResource":{"type":"object","properties":{"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"is_primary":{"type":"string"}},"required":["disease_id","icd","description"],"title":"App.Http.Resources.V1.DiseaseResource"}}}} ``` ## The App.Http.Resources.V1.PaymentAccountResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"App.Http.Resources.V1.PaymentAccountResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"public_key":{"type":"string"},"is_chargeable":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","public_key","is_chargeable","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.V1.PaymentAccountResource"}}}} ``` ## The AttachTagToCaseRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"AttachTagToCaseRequest":{"type":"object","properties":{"notes":{"type":["string","null"]}},"title":"AttachTagToCaseRequest"}}}} ``` ## The CancelCaseOfferingRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CancelCaseOfferingRequest":{"type":"object","properties":{"reason":{"type":["string","null"]}},"title":"CancelCaseOfferingRequest"}}}} ``` ## The CancelCasePrescriptionRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CancelCasePrescriptionRequest":{"type":"object","properties":{"reason":{"type":["string","null"]}},"title":"CancelCasePrescriptionRequest"}}}} ``` ## The CaseByStatusResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseByStatusResource":{"type":"object","properties":{"case_id":{"type":"string","description":"Attributes;"},"external_id":{"type":"string"},"metadata":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"prioritized_at":{"type":"string"},"programs":{"type":"string"},"tier":{"type":"string"},"prioritized_reason":{"type":"string"},"prioritized":{"type":"string"},"partner_id":{"type":"string"},"reference_case_id":{"type":"string"},"patient_exam_id":{"type":"string"},"service_pdf_exported":{"type":"string"},"case_type":{"type":"string"},"is_chargeable":{"type":"string"},"is_upsell_generated":{"type":"string"},"charged_by":{"type":"string"},"is_sync":{"type":"string"},"is_video_consult_required":{"type":"string"},"case_status":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["name","reason","updated_at","created_at"]},"created_at":{"type":"string"},"patient":{"type":"object","properties":{"patient_id":{"type":"string"},"date_of_birth":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"external_id":{"type":"string"},"metadata":{"type":"string"},"gender":{"type":"string"},"gender_label":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"pregnancy":{"type":"string"},"address":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"address_id":{"type":"string"},"address":{"type":"string"},"address2":{"type":"string"},"city_name":{"type":"string"},"zip_code":{"type":"string"},"state":{"type":"object","properties":{"state_id":{"type":"string"},"abbreviation":{"type":"string"},"name":{"type":"string"},"is_sync":{"type":"string"},"country":{"type":"object","properties":{"state_id":{"type":"string"},"abbreviation":{"type":"string"}},"required":["state_id","abbreviation"]}},"required":["state_id","abbreviation","name","is_sync","country"]}},"required":["address_id","address","address2","city_name","zip_code","state"]}]}},"required":["patient_id","date_of_birth","first_name","last_name","external_id","metadata","gender","gender_label","email","phone_number","pregnancy","address"]},"case_assignment":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"created_at":{"type":"string"},"reason":{"type":"string"},"clinician_id":{"type":"string"},"clinician":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"clinician_id":{"type":"string"},"clinician_specialty":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"},"is_online":{"type":"string"},"photo":{"type":["object","null"],"properties":{"url_thumbnail":{"type":"string"}},"required":["url_thumbnail"]}},"required":["clinician_id","clinician_specialty","first_name","last_name","full_name","is_online","photo"]}]}},"required":["created_at","reason","clinician_id","clinician"]}]},"case_prescriptions":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},"case_offerings":{"type":"array","items":{"type":"object","properties":{"case_offering_id":{"type":"string"},"case_prescription_id":{"type":"string"},"is_important":{"type":"string"},"order":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"}},"required":["case_offering_id","case_prescription_id","is_important","order","name","title"]}},"case_services":{"type":"string"},"diseases":{"type":"string"},"tags":{"type":"string"},"orders":{"type":"string"}},"required":["case_id","external_id","metadata","is_additional_approval_needed","prioritized_at","programs","tier","prioritized_reason","prioritized","partner_id","reference_case_id","patient_exam_id","service_pdf_exported","case_type","is_chargeable","is_upsell_generated","charged_by","is_sync","case_status","created_at","patient","case_assignment","case_prescriptions","case_offerings","case_services","diseases","tags","orders"],"title":"CaseByStatusResource"}}}} ``` ## The CaseModelResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseModelResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_blocked_by_partner_state":{"type":"string"},"patient_id":{"type":"string"},"partner_id":{"type":"string"},"reference_case_id":{"type":["string","null"]},"is_sync":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"case_type":{"type":"string"},"case_assignment_id":{"type":["string","null"]},"case_status_id":{"type":["string","null"]},"prioritized_at":{"type":["string","null"],"format":"date-time"},"locked_at":{"type":["string","null"],"format":"date-time"},"is_locked":{"type":"string"},"prioritized_reason":{"type":["string","null"]},"service_pdf_exported":{"type":"string"},"is_chargeable":{"type":"string"},"charged_by":{"type":["string","null"]},"partner_amount_charged":{"type":["number","null"]},"partner_offering_amount_charged":{"type":["number","null"]},"metadata":{"type":["string","null"]},"patient_exam_id":{"type":["string","null"]},"programs":{"type":["array","null"],"items":{}},"tier":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"prioritized":{"type":"string","description":"Appended Attributes;"},"patient":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.PatientResource"},"partner":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.PartnerResource"},"case_assignment":{"description":"When loaded;","$ref":"#/components/schemas/EncounterAssignmentResource"},"case_status":{"description":"When loaded;","$ref":"#/components/schemas/EncounterStatusResource"},"case_prescriptions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterPrescriptionResource"}},"case_notes":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterNoteResource"}},"case_services":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterServiceResource"}},"case_questions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterQuestionResource"}},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_blocked_by_partner_state","patient_id","partner_id","reference_case_id","is_sync","is_additional_approval_needed","case_type","case_assignment_id","case_status_id","prioritized_at","locked_at","is_locked","prioritized_reason","service_pdf_exported","is_chargeable","charged_by","partner_amount_charged","partner_offering_amount_charged","metadata","patient_exam_id","programs","tier","created_at","updated_at","deleted_at","prioritized"],"title":"CaseModelResource"},"App.Http.Resources.PatientResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":"string"},"ssn":{"type":["string","null"]},"active":{"type":"string"},"prefix":{"type":["string","null"]},"weight":{"type":"string"},"height":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"address_id":{"type":"string"},"driver_license_id":{"type":["string","null"]},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"pregnancy":{"type":"string"},"partner_id":{"type":"string"},"environment_id":{"type":"string"},"clinician_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"intro_video_file_id":{"type":["string","null"]},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]},"patient_id":{"type":"string","description":"Appended Attributes;"},"full_name":{"type":"string"},"abbreviated_name":{"type":"string"},"is_live":{"type":"string"},"intro_video_id":{"type":"string"},"exam_id":{"type":"string"},"dosespot":{"type":"string"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"shopify_customer_id":{"type":"string"},"address":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"clinician":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"},"driver_license":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"environment":{"description":"When loaded;","$ref":"#/components/schemas/EnvironmentResource"},"intro_video":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","first_name","middle_name","last_name","email","ssn","active","prefix","weight","height","blood_pressure","body_temperature","oxygen_saturation","special_necessities","date_of_birth","gender","gender_label","phone_number","phone_type","address_id","driver_license_id","allergies","current_medications","medical_conditions","pregnancy","partner_id","environment_id","clinician_id","metadata","intro_video_file_id","recent_encounter_id","important_offering_case_id","created_at","updated_at","deleted_at","is_sms_enabled","is_email_enabled","original_patient_id","status","patient_id","full_name","abbreviated_name","is_live","intro_video_id","exam_id","dosespot","metafields","shopify_customer_id"],"title":"App.Http.Resources.PatientResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"},"EncounterAssignmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"reason":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","case_id","clinician_id","reason","created_at","updated_at"],"title":"EncounterAssignmentResource"},"EncounterStatusResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","reason","updated_at","created_at"],"title":"EncounterStatusResource"},"EncounterPrescriptionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"name":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"dosespot_prescription_id":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"pharmacy_notes":{"type":"string"},"no_substitutions":{"type":"string"},"dosespot_display_name":{"type":"string"},"medication":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","title","name","refills","quantity","days_supply","directions","dispense_unit_id","is_additional_approval_needed","pharmacy_id","thank_you_note","clinical_note","dosespot_prescription_id","status","status_details","pharmacy_notes","no_substitutions","dosespot_display_name","medication","offerable_type","offerable_id","updated_at","created_at"],"title":"EncounterPrescriptionResource"},"EncounterNoteResource":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","text","case_id","clinician_id","created_at","updated_at"],"title":"EncounterNoteResource"},"EncounterServiceResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_notes":{"type":"string"},"pharmacy_fax_number":{"type":"string"},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"order":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"}},"required":["id","title","service_type","description","additional_note","thank_you_note","clinical_notes","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","order","offerable_type","offerable_id"],"title":"EncounterServiceResource"},"EncounterQuestionResource":{"type":"object","properties":{"id":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"displayed_options":{"type":"string"},"metadata":{"type":"string"}},"required":["id","question","answer","type","important","is_critical","display_in_pdf","description","label","displayed_options","metadata"],"title":"EncounterQuestionResource"}}}} ``` ## The CaseNoteResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseNoteResource":{"type":"object","properties":{"case_note_id":{"type":"string"},"text":{"type":"string"},"type":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/CaseNoteType"}]},"case_id":{"type":"string"},"model_id":{"type":["string","null"]},"model_type":{"type":["string","null"]},"model":{"$ref":"#/components/schemas/ClinicianResource"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"clinician":{"anyOf":[{"description":"keeping compatibility with previous versions;","$ref":"#/components/schemas/ClinicianResource"},{"type":"null"}]}},"required":["case_note_id","text","type","case_id","model_id","model_type","model","created_at","updated_at","clinician"],"title":"CaseNoteResource"},"CaseNoteType":{"type":"string","enum":["clinical_note","communication","phone_video_memo","prescription_approval"],"title":"CaseNoteType"},"ClinicianResource":{"type":"object","properties":{"clinician_id":{"type":"string"},"is_online":{"type":"string"},"specialty":{"type":["string","null"]},"full_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"date_of_birth":{"type":["string","null"]},"phone_number":{"type":"string","const":"(629) 777-5752"},"phone_type":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"active":{"type":"string"},"managed_by_partner":{"type":"string"},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"photo":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"signature":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"npdb":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"w9form_file":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"address":{"$ref":"#/components/schemas/AddressResource"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/PartnerResource"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleResource"}},"dosespot":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionResource"}},"bio_details":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"out_of_office_message":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file":{"$ref":"#/components/schemas/FileResource"},"thank_you_video_file":{"$ref":"#/components/schemas/FileResource"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"epcs_requested":{"anyOf":[{"type":"string"},{"type":"null"},{"type":"boolean"}]},"epcs_status":{"type":["string","null"]}},"required":["clinician_id","is_online","specialty","full_name","first_name","last_name","suffix","email","date_of_birth","phone_number","phone_type","fax_number","profile_url","active","managed_by_partner","case_assignment_availability","is_video_call_available","is_message_availability","photo","bio_details","is_out_of_office","out_of_office_at","out_of_office_return_at","out_of_office_message","automatic_sync_message","automatic_sync_video_file","thank_you_video_file","metafields","epcs_requested","epcs_status"],"title":"ClinicianResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"AddressResource":{"type":"object","properties":{"address":{"type":"string"},"address2":{"type":["string","null"]},"address_id":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["address","address2","address_id","zip_code","city_name","state"],"title":"AddressResource"},"PartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"support_message_capability":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"provides_medications":{"type":"string"},"partner_notes":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"customer_support_email":{"type":["string","null"]},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"can_unlock_phi":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"reassignment_interval":{"type":"integer"},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"business_model":{"type":"string"},"customization":{"type":"string"},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"parent_partner_id":{"type":["string","null"]},"integration_type":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"image":{"type":["object","null"],"description":"It's called \"logo\" in other resource;","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"metadata":{"type":["array","null"],"items":{}}},"required":["file_id","path","name","mime_type","url","url_thumbnail","created_at","metadata"]}},"required":["partner_id","notification_priority","notification_schedule","is_patient_identity_verified","name","customer_support_email","operation_country","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_ai_auto_summary_enabled","is_sending_tracking_number_enabled","enable_icd_bmi","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","customization","vouched_integration_type","parent_partner_id","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","image"],"title":"PartnerResource"},"RoleResource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"RoleResource"},"PermissionResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"}},"required":["name"],"title":"PermissionResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The CaseNoteType object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseNoteType":{"type":"string","enum":["clinical_note","communication","phone_video_memo","prescription_approval"],"title":"CaseNoteType"}}}} ``` ## The CaseOfferingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseOfferingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_offering_id":{"type":"string"},"title":{"type":"string"},"name":{"type":"string"},"directions":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"has_recommendations":{"type":"string"},"recommendation_message":{"type":["string","null"],"description":"virtual attribute from CasePrescription model"},"store_url":{"type":["string","null"],"description":"virtual attribute from Offering model"},"product_name":{"type":["string","null"],"description":"virtual attribute from Offering model"},"image_file_id":{"type":["string","null"],"description":"virtual attribute from Offering model"},"order":{"type":"string","description":"virtual attribute from Offering model"},"upcharged":{"type":"string"},"offering_cost":{"type":"string"},"clinician_extra_fee":{"type":"string"},"is_important":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"order_status":{"type":"string"},"order_date":{"type":"string"},"order_details":{"type":"string"},"order_updated":{"type":"string"},"programs":{"type":"string"},"external_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"submitted_at":{"type":"string"},"product":{"type":"string"},"product_id":{"type":["string","null"]},"product_type":{"type":["string","null"]},"diseases":{"type":"array","items":{"$ref":"#/components/schemas/DiseaseResource"}}},"required":["id","case_offering_id","title","name","directions","is_additional_approval_needed","thank_you_note","clinical_note","status","status_details","has_recommendations","recommendation_message","store_url","product_name","image_file_id","order","upcharged","offering_cost","clinician_extra_fee","is_important","offerable_type","offerable_id","order_status","order_date","order_details","order_updated","programs","external_id","created_at","updated_at","deleted_at","submitted_at","product","product_id","product_type","diseases"],"title":"CaseOfferingResource"},"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"}}}} ``` ## The CaseOrderResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseOrderResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"external_id":{"type":"string"},"pharmacy_id":{"type":"string"},"prescriptions_id":{"type":"array","items":{}},"status":{"type":"string"},"details":{"type":["string","null"]},"status_details":{"type":["string","null"],"description":"retrocompatibility"},"status_metadata":{"type":["string","null"]},"number":{"type":["string","null"]},"date":{"type":["string","null"]},"tracking_number":{"type":["string","null"]},"tracking_url":{"type":["string","null"]},"tracking_metadata":{"type":["string","null"]},"tracked_at":{"type":["string","null"]},"sequence_number":{"type":["integer","null"]},"sequence_total":{"type":["integer","null"]},"sequence_order_id":{"type":["string","null"]},"acknowledged_at":{"type":["string","null"]},"acknowledged_id":{"type":["string","null"]},"acknowledged_metadata":{"type":["string","null"]},"payment_date":{"type":["string","null"]},"payment_status":{"type":["string","null"]},"pharmacy_name":{"type":["string","null"],"description":"appends;"},"case":{"$ref":"#/components/schemas/CaseByStatusResource"},"offerings":{"type":"array","items":{"$ref":"#/components/schemas/CaseOfferingResource"}},"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"external_id":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"number":{"type":"string"},"sequence_number":{"type":"string"},"sequence_total":{"type":"string"},"sequence_order_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"date":{"type":"string"}},"required":["id","external_id","status","status_details","number","sequence_number","sequence_total","sequence_order_id","created_at","updated_at","date"]}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","case_id","external_id","pharmacy_id","prescriptions_id","status","details","status_details","status_metadata","number","date","tracking_number","tracking_url","tracking_metadata","tracked_at","sequence_number","sequence_total","sequence_order_id","acknowledged_at","acknowledged_id","acknowledged_metadata","payment_date","payment_status","pharmacy_name","case","created_at","updated_at","deleted_at"],"title":"CaseOrderResource"},"CaseByStatusResource":{"type":"object","properties":{"case_id":{"type":"string","description":"Attributes;"},"external_id":{"type":"string"},"metadata":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"prioritized_at":{"type":"string"},"programs":{"type":"string"},"tier":{"type":"string"},"prioritized_reason":{"type":"string"},"prioritized":{"type":"string"},"partner_id":{"type":"string"},"reference_case_id":{"type":"string"},"patient_exam_id":{"type":"string"},"service_pdf_exported":{"type":"string"},"case_type":{"type":"string"},"is_chargeable":{"type":"string"},"is_upsell_generated":{"type":"string"},"charged_by":{"type":"string"},"is_sync":{"type":"string"},"is_video_consult_required":{"type":"string"},"case_status":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["name","reason","updated_at","created_at"]},"created_at":{"type":"string"},"patient":{"type":"object","properties":{"patient_id":{"type":"string"},"date_of_birth":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"external_id":{"type":"string"},"metadata":{"type":"string"},"gender":{"type":"string"},"gender_label":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"pregnancy":{"type":"string"},"address":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"address_id":{"type":"string"},"address":{"type":"string"},"address2":{"type":"string"},"city_name":{"type":"string"},"zip_code":{"type":"string"},"state":{"type":"object","properties":{"state_id":{"type":"string"},"abbreviation":{"type":"string"},"name":{"type":"string"},"is_sync":{"type":"string"},"country":{"type":"object","properties":{"state_id":{"type":"string"},"abbreviation":{"type":"string"}},"required":["state_id","abbreviation"]}},"required":["state_id","abbreviation","name","is_sync","country"]}},"required":["address_id","address","address2","city_name","zip_code","state"]}]}},"required":["patient_id","date_of_birth","first_name","last_name","external_id","metadata","gender","gender_label","email","phone_number","pregnancy","address"]},"case_assignment":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"created_at":{"type":"string"},"reason":{"type":"string"},"clinician_id":{"type":"string"},"clinician":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"clinician_id":{"type":"string"},"clinician_specialty":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"},"is_online":{"type":"string"},"photo":{"type":["object","null"],"properties":{"url_thumbnail":{"type":"string"}},"required":["url_thumbnail"]}},"required":["clinician_id","clinician_specialty","first_name","last_name","full_name","is_online","photo"]}]}},"required":["created_at","reason","clinician_id","clinician"]}]},"case_prescriptions":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},"case_offerings":{"type":"array","items":{"type":"object","properties":{"case_offering_id":{"type":"string"},"case_prescription_id":{"type":"string"},"is_important":{"type":"string"},"order":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"}},"required":["case_offering_id","case_prescription_id","is_important","order","name","title"]}},"case_services":{"type":"string"},"diseases":{"type":"string"},"tags":{"type":"string"},"orders":{"type":"string"}},"required":["case_id","external_id","metadata","is_additional_approval_needed","prioritized_at","programs","tier","prioritized_reason","prioritized","partner_id","reference_case_id","patient_exam_id","service_pdf_exported","case_type","is_chargeable","is_upsell_generated","charged_by","is_sync","case_status","created_at","patient","case_assignment","case_prescriptions","case_offerings","case_services","diseases","tags","orders"],"title":"CaseByStatusResource"},"CaseOfferingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_offering_id":{"type":"string"},"title":{"type":"string"},"name":{"type":"string"},"directions":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"has_recommendations":{"type":"string"},"recommendation_message":{"type":["string","null"],"description":"virtual attribute from CasePrescription model"},"store_url":{"type":["string","null"],"description":"virtual attribute from Offering model"},"product_name":{"type":["string","null"],"description":"virtual attribute from Offering model"},"image_file_id":{"type":["string","null"],"description":"virtual attribute from Offering model"},"order":{"type":"string","description":"virtual attribute from Offering model"},"upcharged":{"type":"string"},"offering_cost":{"type":"string"},"clinician_extra_fee":{"type":"string"},"is_important":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"order_status":{"type":"string"},"order_date":{"type":"string"},"order_details":{"type":"string"},"order_updated":{"type":"string"},"programs":{"type":"string"},"external_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"submitted_at":{"type":"string"},"product":{"type":"string"},"product_id":{"type":["string","null"]},"product_type":{"type":["string","null"]},"diseases":{"type":"array","items":{"$ref":"#/components/schemas/DiseaseResource"}}},"required":["id","case_offering_id","title","name","directions","is_additional_approval_needed","thank_you_note","clinical_note","status","status_details","has_recommendations","recommendation_message","store_url","product_name","image_file_id","order","upcharged","offering_cost","clinician_extra_fee","is_important","offerable_type","offerable_id","order_status","order_date","order_details","order_updated","programs","external_id","created_at","updated_at","deleted_at","submitted_at","product","product_id","product_type","diseases"],"title":"CaseOfferingResource"},"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"}}}} ``` ## The CasePrescriptionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CasePrescriptionResource":{"type":"object","properties":{"id":{"type":"string"},"case_prescription_id":{"type":"string"},"order":{"type":["integer","null"]},"title":{"type":["string","null"]},"name":{"type":["string","null"]},"is_important":{"type":["string","null"]},"refills":{"type":["integer","null"]},"quantity":{"type":["string","null"]},"days_supply":{"type":["string","null"]},"directions":{"type":["string","null"]},"dispense_unit_id":{"type":["string","null"]},"is_additional_approval_needed":{"type":"string"},"dispense_unit_name":{"type":["string","null"]},"pharmacy_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}]},"pharmacy_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"thank_you_note":{"type":["string","null"]},"thank_you_files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"clinical_note":{"type":["string","null"]},"dosespot_prescription_id":{"type":["integer","null"]},"status":{"type":"string"},"effective_date":{"type":["string","null"]},"status_details":{"type":["string","null"]},"upcharged":{"type":["string","null"]},"clinician_extra_fee":{"type":["string","null"]},"pharmacy_notes":{"type":["string","null"]},"no_substitutions":{"type":"boolean"},"dosespot_display_name":{"type":"string"},"offering_cost":{"type":["string","null"]},"is_insurance_check_needed":{"type":["string","null"]},"dosespot_prescription_benefits":{"type":"string"},"dosespot_prior_auth_id":{"type":"string"},"dosespot_prior_auth_status":{"type":"string"},"dosespot_prior_auth_status_details":{"type":"string"},"dosespot_prior_auth_status_at":{"type":"string"},"dosespot_prior_auth_details":{"type":"string"},"medication":{"type":["string","null"]},"partner_compound":{"type":["array","null"],"items":{}},"partner_supply":{"type":["object","null"],"properties":{"ndc":{"type":["string","null"]},"name":{"type":["string","null"]},"active":{"type":["string","null"]},"refills":{"type":["string","null"]},"metadata":{"type":["string","null"]},"quantity":{"type":["string","null"]},"directions":{"type":["string","null"]},"days_supply":{"type":["string","null"]},"pharmacy_id":{"type":["string","null"]},"clinical_note":{"type":["string","null"]},"dispense_unit":{"type":["string","null"]},"pharmacy_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"pharmacy_notes":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"dispense_unit_id":{"type":["string","null"]},"partner_supply_id":{"type":["string","null"]},"dosespot_supply_id":{"type":["string","null"]}},"required":["ndc","name","active","refills","metadata","quantity","directions","days_supply","pharmacy_id","clinical_note","dispense_unit","pharmacy_name","pharmacy_notes","thank_you_note","dispense_unit_id","partner_supply_id","dosespot_supply_id"]},"offering":{"type":["object","null"],"properties":{"offering_id":{"type":["string","null"]},"name":{"type":["string","null"]},"title":{"type":["string","null"]}},"required":["offering_id","name","title"]},"offerable_type":{"type":["string","null"]},"offerable_id":{"type":["string","null"]},"diseases":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.V1.DiseaseResource"}}},"required":["id","case_prescription_id","order","title","name","is_important","refills","quantity","days_supply","directions","dispense_unit_id","is_additional_approval_needed","dispense_unit_name","pharmacy_id","pharmacy_name","thank_you_note","thank_you_files","clinical_note","dosespot_prescription_id","status","effective_date","status_details","upcharged","clinician_extra_fee","pharmacy_notes","no_substitutions","dosespot_display_name","offering_cost","is_insurance_check_needed","dosespot_prescription_benefits","dosespot_prior_auth_id","dosespot_prior_auth_status","dosespot_prior_auth_status_details","dosespot_prior_auth_status_at","dosespot_prior_auth_details","medication","partner_compound","partner_supply","offering","offerable_type","offerable_id","diseases"],"title":"CasePrescriptionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.V1.DiseaseResource":{"type":"object","properties":{"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"is_primary":{"type":"string"}},"required":["disease_id","icd","description"],"title":"App.Http.Resources.V1.DiseaseResource"}}}} ``` ## The CaseQuestionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseQuestionResource":{"type":"object","properties":{"case_question_id":{"type":"string"},"question":{"type":"string"},"answer":{"type":["string","null"]},"type":{"type":"string"},"important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"description":{"type":["string","null"]},"label":{"type":["string","null"]},"displayed_options":{"type":["array","null"],"items":{}},"metadata":{"type":["string","null"]}},"required":["case_question_id","question","answer","type","important","is_critical","display_in_pdf","description","label","displayed_options","metadata"],"title":"CaseQuestionResource"}}}} ``` ## The CaseServiceResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseServiceResource":{"type":"object","properties":{"case_service_id":{"type":"string"},"title":{"type":["string","null"]},"service_type":{"type":["string","null"]},"description":{"type":["string","null"]},"additional_note":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"clinical_notes":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":["string","null"]},"send_pdf_file_automatically":{"type":["string","null"]},"order":{"type":["integer","null"]},"partner_service":{"type":"object","properties":{"partner_service_id":{"type":["string","null"]},"title":{"type":["string","null"]},"description":{"type":["string","null"]},"service_type":{"type":["string","null"]},"metadata":{"type":["string","null"]}},"required":["partner_service_id","title","description","service_type","metadata"]},"upcharged":{"type":["string","null"]},"offering_cost":{"type":["string","null"]},"clinician_extra_fee":{"type":["string","null"]},"is_important":{"type":["string","null"]},"offerable_type":{"type":["string","null"]},"offerable_id":{"type":["string","null"]},"offering":{"type":["array","null"],"items":{}}},"required":["case_service_id","title","service_type","description","additional_note","thank_you_note","clinical_notes","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","order","partner_service","upcharged","offering_cost","clinician_extra_fee","is_important","offerable_type","offerable_id","offering"],"title":"CaseServiceResource"}}}} ``` ## The CaseStatusResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseStatusResource":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":["string","null"]},"hold_status":{"type":"string"},"user_id":{"type":["string","null"]},"user_type":{"type":["string","null"]},"user":{"anyOf":[{"$ref":"#/components/schemas/CaseStatusUserResource"},{"type":"null"}]},"updated_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"}},"required":["name","reason","hold_status","user_id","user_type","updated_at","created_at"],"title":"CaseStatusResource"},"CaseStatusUserResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"full_name":{"type":["string","null"]}},"required":["id","type","full_name"],"title":"CaseStatusUserResource"}}}} ``` ## The CaseStatusUserResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CaseStatusUserResource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"full_name":{"type":["string","null"]}},"required":["id","type","full_name"],"title":"CaseStatusUserResource"}}}} ``` ## The ClinicianResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"ClinicianResource":{"type":"object","properties":{"clinician_id":{"type":"string"},"is_online":{"type":"string"},"specialty":{"type":["string","null"]},"full_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"date_of_birth":{"type":["string","null"]},"phone_number":{"type":"string","const":"(629) 777-5752"},"phone_type":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"active":{"type":"string"},"managed_by_partner":{"type":"string"},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"photo":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"signature":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"npdb":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"w9form_file":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"address":{"$ref":"#/components/schemas/AddressResource"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/PartnerResource"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleResource"}},"dosespot":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionResource"}},"bio_details":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"out_of_office_message":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file":{"$ref":"#/components/schemas/FileResource"},"thank_you_video_file":{"$ref":"#/components/schemas/FileResource"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"epcs_requested":{"anyOf":[{"type":"string"},{"type":"null"},{"type":"boolean"}]},"epcs_status":{"type":["string","null"]}},"required":["clinician_id","is_online","specialty","full_name","first_name","last_name","suffix","email","date_of_birth","phone_number","phone_type","fax_number","profile_url","active","managed_by_partner","case_assignment_availability","is_video_call_available","is_message_availability","photo","bio_details","is_out_of_office","out_of_office_at","out_of_office_return_at","out_of_office_message","automatic_sync_message","automatic_sync_video_file","thank_you_video_file","metafields","epcs_requested","epcs_status"],"title":"ClinicianResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"AddressResource":{"type":"object","properties":{"address":{"type":"string"},"address2":{"type":["string","null"]},"address_id":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["address","address2","address_id","zip_code","city_name","state"],"title":"AddressResource"},"PartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"support_message_capability":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"provides_medications":{"type":"string"},"partner_notes":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"customer_support_email":{"type":["string","null"]},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"can_unlock_phi":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"reassignment_interval":{"type":"integer"},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"business_model":{"type":"string"},"customization":{"type":"string"},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"parent_partner_id":{"type":["string","null"]},"integration_type":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"image":{"type":["object","null"],"description":"It's called \"logo\" in other resource;","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"metadata":{"type":["array","null"],"items":{}}},"required":["file_id","path","name","mime_type","url","url_thumbnail","created_at","metadata"]}},"required":["partner_id","notification_priority","notification_schedule","is_patient_identity_verified","name","customer_support_email","operation_country","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_ai_auto_summary_enabled","is_sending_tracking_number_enabled","enable_icd_bmi","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","customization","vouched_integration_type","parent_partner_id","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","image"],"title":"PartnerResource"},"RoleResource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"RoleResource"},"PermissionResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"}},"required":["name"],"title":"PermissionResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The CompoundResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CompoundResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"specialty_id":{"type":"string"},"clinician_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"name":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"effective_date":{"type":"string"},"dispense_unit":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"is_controlled_substance":{"type":"string"},"schedule":{"type":"string"},"pharmacy_id":{"type":"string"},"pharmacy_name":{"type":"string"},"force_pharmacy":{"type":"string"},"is_important":{"type":"string"},"clinical_note":{"type":"string"},"pharmacy_notes":{"type":"string"},"thank_you_note":{"type":"string"},"order":{"type":"string"},"metadata":{"type":"string"},"allow_substitutions":{"type":"string"},"upcharge":{"type":"string"},"offering_cost":{"type":"string"},"clinician_extra_fee":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"review":{"type":"object","description":"Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape."},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","partner_id","specialty_id","clinician_id","active","title","name","refills","quantity","days_supply","directions","effective_date","dispense_unit","dispense_unit_id","is_additional_approval_needed","is_controlled_substance","schedule","pharmacy_id","pharmacy_name","force_pharmacy","is_important","clinical_note","pharmacy_notes","thank_you_note","order","metadata","allow_substitutions","upcharge","offering_cost","clinician_extra_fee","replicated_from_id","created_at","updated_at","deleted_at"],"title":"CompoundResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The CountryResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"}}}} ``` ## The CustomDomainResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"CustomDomainResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes"},"custom_domain":{"type":"string"}},"required":["id","custom_domain"],"title":"CustomDomainResource"}}}} ``` ## The DiseaseResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"}}}} ``` ## The DispenseUnitResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"DispenseUnitResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"dispense_unit_id":{"type":"string"},"dosespot_dispense_unit_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"},"singular":{"type":"string"},"plural":{"type":"string"},"singular_or_plural":{"type":"string"},"potency_unit_code":{"type":"string"},"active":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["id","dispense_unit_id","dosespot_dispense_unit_id","name","abbreviation","singular","plural","singular_or_plural","potency_unit_code","active","created_at","updated_at","deleted_at"],"title":"DispenseUnitResource"}}}} ``` ## The DriverLicenseResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"DriverLicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"DriverLicenseResource"}}}} ``` ## The EncounterAssignmentResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterAssignmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"reason":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","case_id","clinician_id","reason","created_at","updated_at"],"title":"EncounterAssignmentResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The EncounterNoteResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterNoteResource":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","text","case_id","clinician_id","created_at","updated_at"],"title":"EncounterNoteResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The EncounterPrescriptionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterPrescriptionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"name":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"dosespot_prescription_id":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"pharmacy_notes":{"type":"string"},"no_substitutions":{"type":"string"},"dosespot_display_name":{"type":"string"},"medication":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","title","name","refills","quantity","days_supply","directions","dispense_unit_id","is_additional_approval_needed","pharmacy_id","thank_you_note","clinical_note","dosespot_prescription_id","status","status_details","pharmacy_notes","no_substitutions","dosespot_display_name","medication","offerable_type","offerable_id","updated_at","created_at"],"title":"EncounterPrescriptionResource"}}}} ``` ## The EncounterQuestionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterQuestionResource":{"type":"object","properties":{"id":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"displayed_options":{"type":"string"},"metadata":{"type":"string"}},"required":["id","question","answer","type","important","is_critical","display_in_pdf","description","label","displayed_options","metadata"],"title":"EncounterQuestionResource"}}}} ``` ## The EncounterResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_blocked_by_partner_state":{"type":"string"},"patient_id":{"type":"string"},"partner_id":{"type":"string"},"reference_case_id":{"type":"string"},"is_sync":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"case_type":{"type":"string"},"case_assignment_id":{"type":"string"},"case_status_id":{"type":"string"},"prioritized_at":{"type":"string"},"locked_at":{"type":"string"},"is_locked":{"type":"string"},"prioritized_reason":{"type":"string"},"service_pdf_exported":{"type":"string"},"is_chargeable":{"type":"string"},"charged_by":{"type":"string"},"partner_amount_charged":{"type":"string"},"partner_offering_amount_charged":{"type":"string"},"metadata":{"type":"string"},"patient_exam_id":{"type":"string"},"programs":{"type":"string"},"tier":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"prioritized":{"type":"string","description":"Appended Attributes;"},"patient":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.PatientResource"},"partner":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.PartnerResource"},"case_assignment":{"description":"When loaded;","$ref":"#/components/schemas/EncounterAssignmentResource"},"case_status":{"description":"When loaded;","$ref":"#/components/schemas/EncounterStatusResource"},"case_prescriptions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterPrescriptionResource"}},"case_notes":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterNoteResource"}},"case_services":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterServiceResource"}},"case_questions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterQuestionResource"}},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_blocked_by_partner_state","patient_id","partner_id","reference_case_id","is_sync","is_additional_approval_needed","case_type","case_assignment_id","case_status_id","prioritized_at","locked_at","is_locked","prioritized_reason","service_pdf_exported","is_chargeable","charged_by","partner_amount_charged","partner_offering_amount_charged","metadata","patient_exam_id","programs","tier","created_at","updated_at","deleted_at","prioritized"],"title":"EncounterResource"},"App.Http.Resources.PatientResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":"string"},"ssn":{"type":["string","null"]},"active":{"type":"string"},"prefix":{"type":["string","null"]},"weight":{"type":"string"},"height":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"address_id":{"type":"string"},"driver_license_id":{"type":["string","null"]},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"pregnancy":{"type":"string"},"partner_id":{"type":"string"},"environment_id":{"type":"string"},"clinician_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"intro_video_file_id":{"type":["string","null"]},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]},"patient_id":{"type":"string","description":"Appended Attributes;"},"full_name":{"type":"string"},"abbreviated_name":{"type":"string"},"is_live":{"type":"string"},"intro_video_id":{"type":"string"},"exam_id":{"type":"string"},"dosespot":{"type":"string"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"shopify_customer_id":{"type":"string"},"address":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"clinician":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"},"driver_license":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"environment":{"description":"When loaded;","$ref":"#/components/schemas/EnvironmentResource"},"intro_video":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","first_name","middle_name","last_name","email","ssn","active","prefix","weight","height","blood_pressure","body_temperature","oxygen_saturation","special_necessities","date_of_birth","gender","gender_label","phone_number","phone_type","address_id","driver_license_id","allergies","current_medications","medical_conditions","pregnancy","partner_id","environment_id","clinician_id","metadata","intro_video_file_id","recent_encounter_id","important_offering_case_id","created_at","updated_at","deleted_at","is_sms_enabled","is_email_enabled","original_patient_id","status","patient_id","full_name","abbreviated_name","is_live","intro_video_id","exam_id","dosespot","metafields","shopify_customer_id"],"title":"App.Http.Resources.PatientResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"},"EncounterAssignmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"reason":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","case_id","clinician_id","reason","created_at","updated_at"],"title":"EncounterAssignmentResource"},"EncounterStatusResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","reason","updated_at","created_at"],"title":"EncounterStatusResource"},"EncounterPrescriptionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"name":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"dosespot_prescription_id":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"pharmacy_notes":{"type":"string"},"no_substitutions":{"type":"string"},"dosespot_display_name":{"type":"string"},"medication":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","title","name","refills","quantity","days_supply","directions","dispense_unit_id","is_additional_approval_needed","pharmacy_id","thank_you_note","clinical_note","dosespot_prescription_id","status","status_details","pharmacy_notes","no_substitutions","dosespot_display_name","medication","offerable_type","offerable_id","updated_at","created_at"],"title":"EncounterPrescriptionResource"},"EncounterNoteResource":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","text","case_id","clinician_id","created_at","updated_at"],"title":"EncounterNoteResource"},"EncounterServiceResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_notes":{"type":"string"},"pharmacy_fax_number":{"type":"string"},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"order":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"}},"required":["id","title","service_type","description","additional_note","thank_you_note","clinical_notes","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","order","offerable_type","offerable_id"],"title":"EncounterServiceResource"},"EncounterQuestionResource":{"type":"object","properties":{"id":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"displayed_options":{"type":"string"},"metadata":{"type":"string"}},"required":["id","question","answer","type","important","is_critical","display_in_pdf","description","label","displayed_options","metadata"],"title":"EncounterQuestionResource"}}}} ``` ## The EncounterServiceResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterServiceResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_notes":{"type":"string"},"pharmacy_fax_number":{"type":"string"},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"order":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"}},"required":["id","title","service_type","description","additional_note","thank_you_note","clinical_notes","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","order","offerable_type","offerable_id"],"title":"EncounterServiceResource"}}}} ``` ## The EncounterStatusResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EncounterStatusResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","reason","updated_at","created_at"],"title":"EncounterStatusResource"}}}} ``` ## The EnvironmentResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"}}}} ``` ## The EventResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"EventResource":{"type":"object","properties":{"event_id":{"type":"string"},"date_time":{"type":"string"},"model":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"by":{"type":"string"},"by_model":{"type":"string"}},"required":["event_id","date_time","model","title","type","by","by_model"],"title":"EventResource"}}}} ``` ## The FaqQuestionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"FaqQuestionResource":{"type":"object","properties":{"question":{},"answer":{}},"required":["question","answer"],"title":"FaqQuestionResource"}}}} ``` ## The FaqResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"FaqResource":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"questions":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/FaqQuestionResource"}},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}]},"files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","key","title","description","questions","created_at","updated_at","deleted_at"],"title":"FaqResource"},"FaqQuestionResource":{"type":"object","properties":{"question":{},"answer":{}},"required":["question","answer"],"title":"FaqQuestionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"}}}} ``` ## The FileResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"}}}} ``` ## The GetCaseCountByStatusRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"GetCaseCountByStatusRequest":{"type":"object","properties":{"is_assigned_to_me":{"type":["boolean","null"]},"case_type":{"type":["string","null"]},"is_sync":{"type":["boolean","null"]},"is_live":{"type":["boolean","null"]},"is_sandbox":{"type":["boolean","null"]},"partners":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"clinicians":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"tags":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"states":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}}},"title":"GetCaseCountByStatusRequest"}}}} ``` ## The GetCasesByStatusRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"GetCasesByStatusRequest":{"type":"object","properties":{"is_assigned_to_me":{"type":["boolean","null"]},"sort":{"type":["string","null"],"enum":["asc","desc","ASC","DESC"]},"case_type":{"type":["string","null"]},"external_id":{"type":["string","null"],"maxLength":255},"is_sync":{"type":["boolean","null"]},"is_live":{"type":["boolean","null"]},"is_sandbox":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"partners":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"clinicians":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"states":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"tags":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"tiers":{"type":["array","null"],"items":{"type":"integer","minimum":1,"maximum":5}}},"title":"GetCasesByStatusRequest"}}}} ``` ## The GetOrdersRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"GetOrdersRequest":{"type":"object","properties":{"case_type":{"type":["string","null"]},"pharmacy_id":{"type":["string","null"],"format":"uuid"},"group":{"type":["string","null"],"enum":["status"]},"sort":{"type":["string","null"],"description":"Order by status grouping;","enum":["date"]},"order":{"type":["string","null"],"enum":["asc","desc"]},"is_live":{"type":["boolean","null"]},"is_sandbox":{"type":["boolean","null"]},"search_field":{"type":["string","null"],"maxLength":255},"page":{"type":"integer"},"per_page":{"type":"integer","minimum":1,"maximum":1000},"partners":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"order_status":{"type":["array","null"],"items":{"type":["string","null"]}},"states":{"type":["array","null"],"items":{"type":["string","null"],"format":"uuid"}},"date_range":{"type":"object","properties":[{"type":["string","null"],"format":"date-time"},{"type":["string","null"],"format":"date-time"}]}},"title":"GetOrdersRequest"}}}} ``` ## The HistoricalCaseTagResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"HistoricalCaseTagResource":{"type":"object","properties":{"event":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"tag_id":{"type":"string"},"reason":{"type":["string","null"]},"user_id":{"type":["string","null"]},"user_type":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"tag":{"description":"Loaded Attributes;","$ref":"#/components/schemas/App.Http.Resources.TagResource"}},"required":["event","case_id","tag_id","reason","user_id","user_type","created_at","updated_at","deleted_at"],"title":"HistoricalCaseTagResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The HistoricalRecordResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"HistoricalRecordResource":{"type":"object","properties":{"type":{"type":"string"},"old":{"type":["array","null"],"items":{}},"new":{"type":"array","items":{}},"created_at":{"type":["string","null"],"format":"date-time"}},"required":["type","old","new","created_at"],"title":"HistoricalRecordResource"}}}} ``` ## The InternalSupportStaffResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"InternalSupportStaffResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"photo_id":{"type":["string","null"]},"active":{"type":"string"},"timezone_id":{"type":["string","null"]},"personal_phone_number":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"can_unlock_phi":{"type":"string"},"permissions":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"pivot":{"type":"object","description":"When loaded;\nPivot Attributes (Partner);","properties":{"clinician_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"can_unlock_phi":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["clinician_id","partner_id","can_unlock_phi","created_at","updated_at","deleted_at"]}},"required":["id","first_name","last_name","email","photo_id","active","timezone_id","personal_phone_number","created_at","updated_at","deleted_at","full_name","is_online","can_unlock_phi","photo"],"title":"InternalSupportStaffResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"}}}} ``` ## The LabResultResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"LabResultResource":{"type":"object","properties":{"file_id":{"type":"string","description":"Attributes;"},"test_name":{"type":"string"},"result":{"type":["string","null"]},"units":{"type":["string","null"]},"reference":{"type":"string"},"status":{"type":"string"},"notes":{"type":["string","null"]},"metadata":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["file_id","test_name","result","units","reference","status","notes","metadata","created_at","updated_at","deleted_at"],"title":"LabResultResource"}}}} ``` ## The LicenseResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"}}}} ``` ## The MatchedPatientResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MatchedPatientResource":{"type":"object","properties":{"patient_id":{"type":"string"},"partner_id":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":["string","null"]},"email":{"type":["string","null"]},"date_of_birth":{"type":"string"},"created_at":{"type":"string"},"status":{"type":"string"}},"required":["patient_id","partner_id","first_name","middle_name","last_name","email","date_of_birth","created_at","status"],"title":"MatchedPatientResource"}}}} ``` ## The MedicalAssistantResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MedicalAssistantResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"photo_id":{"type":["string","null"]},"active":{"type":"string"},"timezone_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"photo":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}}},"required":["id","first_name","last_name","email","photo_id","active","timezone_id","created_at","updated_at","deleted_at","full_name","is_online","photo"],"title":"MedicalAssistantResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"}}}} ``` ## The MedicationResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MedicationResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"dispensable_drug_id":{"type":"string"},"partner_id":{"type":"string"},"specialty_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"name":{"type":"string"},"strength":{"type":"string"},"ndc":{"type":"string"},"effective_date":{"type":"string"},"dispense_unit":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"pharmacy_name":{"type":"string"},"force_pharmacy":{"type":"string"},"is_important":{"type":"string"},"dosespot_rxcui":{"type":"string"},"dosespot_synced_at":{"type":"string"},"is_obsolete":{"type":"string"},"is_insurance_check_needed":{"type":"string"},"clinical_note":{"type":"string"},"pharmacy_notes":{"type":"string"},"thank_you_note":{"type":"string"},"order":{"type":"string"},"metadata":{"type":"string"},"allow_substitutions":{"type":"string"},"upcharge":{"type":"string"},"offering_cost":{"type":"string"},"clinician_extra_fee":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"review":{"type":"object","description":"Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape."},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","dispensable_drug_id","partner_id","specialty_id","active","title","refills","quantity","days_supply","directions","name","strength","ndc","effective_date","dispense_unit","dispense_unit_id","is_additional_approval_needed","pharmacy_id","pharmacy_name","force_pharmacy","is_important","dosespot_rxcui","dosespot_synced_at","is_obsolete","is_insurance_check_needed","clinical_note","pharmacy_notes","thank_you_note","order","metadata","allow_substitutions","upcharge","offering_cost","clinician_extra_fee","replicated_from_id","created_at","updated_at","deleted_at"],"title":"MedicationResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The MedicationStateScheduleResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MedicationStateScheduleResource":{"type":"object","properties":{"state_name":{"type":"string","description":"Attributes;"},"schedule":{"type":"string"}},"required":["state_name","schedule"],"title":"MedicationStateScheduleResource"}}}} ``` ## The MessageReadingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MessageReadingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"message_id":{"type":"string"},"user_type":{"type":"string"},"user_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"user":{"type":"string","description":"Relationships;"}},"required":["id","message_id","user_type","user_id","created_at","updated_at","deleted_at"],"title":"MessageReadingResource"}}}} ``` ## The MessageResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MessageResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"patient_id":{"type":"string"},"channel":{"type":"string"},"text":{"type":["string","null"]},"text_length":{"type":["integer","null"]},"user_type":{"anyOf":[{"type":"string"},{"type":"null"},{"type":"string","enum":["system"]}]},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"]},"reference_message_id":{"type":["string","null"]},"replied_at":{"type":["string","null"],"format":"date-time"},"reply_message_id":{"type":["string","null"]},"dismissed_at":{"type":["string","null"],"format":"date-time"},"dismissed_by_user_type":{"type":["string","null"]},"dismissed_by_user_id":{"type":["string","null"]},"dismissed_by_user_name":{"type":["string","null"]},"on_behalf_user_type":{"type":["string","null"]},"on_behalf_user_id":{"type":["string","null"]},"on_behalf_user_name":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{}},"ai_mood":{"type":["string","null"]},"ai_category":{"type":["string","null"]},"emailed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"read_message_info":{"type":"string","description":"Appended Attributes;"},"partner_id":{"type":"string"},"recent_encounter_id":{"type":"string"},"reference_message":{"description":"Relationships; Circular reference to MessageResource flattened to avoid an unbounded self-referential schema; see components.schemas.MessageResource for the full shape.","type":"object"},"user":{"type":"string","description":"When loaded;"},"dismissed_by_user":{"type":"string","description":"When loaded, dynamicaly resolves the propper user's resource (with the user's resource class);"},"files":{"type":"array","description":"When loaded, dynamicaly resolves the propper dismissed by user's resource (with the user's resource class);","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"patient":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.PatientResource"},"readings":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/MessageReadingResource"}},"partner":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PartnerResource"}},"on_behalf_user":{"type":"string","description":"When loaded;"}},"required":["id","patient_id","channel","text","text_length","user_type","user_id","user_name","reference_message_id","replied_at","reply_message_id","dismissed_at","dismissed_by_user_type","dismissed_by_user_id","dismissed_by_user_name","on_behalf_user_type","on_behalf_user_id","on_behalf_user_name","metadata","ai_mood","ai_category","emailed_at","created_at","updated_at","deleted_at","read_message_info","partner_id","recent_encounter_id"],"title":"MessageResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.PatientResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":"string"},"ssn":{"type":["string","null"]},"active":{"type":"string"},"prefix":{"type":["string","null"]},"weight":{"type":"string"},"height":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"address_id":{"type":"string"},"driver_license_id":{"type":["string","null"]},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"pregnancy":{"type":"string"},"partner_id":{"type":"string"},"environment_id":{"type":"string"},"clinician_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"intro_video_file_id":{"type":["string","null"]},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]},"patient_id":{"type":"string","description":"Appended Attributes;"},"full_name":{"type":"string"},"abbreviated_name":{"type":"string"},"is_live":{"type":"string"},"intro_video_id":{"type":"string"},"exam_id":{"type":"string"},"dosespot":{"type":"string"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"shopify_customer_id":{"type":"string"},"address":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"clinician":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"},"driver_license":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"environment":{"description":"When loaded;","$ref":"#/components/schemas/EnvironmentResource"},"intro_video":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","first_name","middle_name","last_name","email","ssn","active","prefix","weight","height","blood_pressure","body_temperature","oxygen_saturation","special_necessities","date_of_birth","gender","gender_label","phone_number","phone_type","address_id","driver_license_id","allergies","current_medications","medical_conditions","pregnancy","partner_id","environment_id","clinician_id","metadata","intro_video_file_id","recent_encounter_id","important_offering_case_id","created_at","updated_at","deleted_at","is_sms_enabled","is_email_enabled","original_patient_id","status","patient_id","full_name","abbreviated_name","is_live","intro_video_id","exam_id","dosespot","metafields","shopify_customer_id"],"title":"App.Http.Resources.PatientResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"MessageReadingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"message_id":{"type":"string"},"user_type":{"type":"string"},"user_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"user":{"type":"string","description":"Relationships;"}},"required":["id","message_id","user_type","user_id","created_at","updated_at","deleted_at"],"title":"MessageReadingResource"},"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"}}}} ``` ## The MetafieldResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The ModelSpecialty object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"ModelSpecialty":{"type":"object","properties":{"model_type":{"type":"string"},"model_id":{"type":"string"},"specialty_id":{"type":"string"},"is_auto_replicate":{"type":"string"},"priority":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"]}},"required":["model_type","model_id","specialty_id","is_auto_replicate","priority","created_at","updated_at","deleted_at"],"title":"ModelSpecialty"}}}} ``` ## The ModelSpecialtyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"ModelSpecialtyResource":{"type":"object","properties":{"model_type":{"type":"string","description":"Attributes;"},"model_id":{"type":"string"},"specialty_id":{"type":"string"},"priority":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"]},"model":{"description":"Append;","$ref":"#/components/schemas/ModelSpecialty"}},"required":["model_type","model_id","specialty_id","priority","created_at","updated_at","deleted_at","model"],"title":"ModelSpecialtyResource"},"ModelSpecialty":{"type":"object","properties":{"model_type":{"type":"string"},"model_id":{"type":"string"},"specialty_id":{"type":"string"},"is_auto_replicate":{"type":"string"},"priority":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"]}},"required":["model_type","model_id","specialty_id","is_auto_replicate","priority","created_at","updated_at","deleted_at"],"title":"ModelSpecialty"}}}} ``` ## The NotificationResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"NotificationResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":["string","null"]},"event":{"type":"string"},"title":{"type":["string","null"]},"preview":{"type":"string"},"source_model_type":{"type":["string","null"]},"source_model_id":{"type":["string","null"]},"notifier_model_type":{"type":["string","null"]},"notifier_model_id":{"type":["string","null"]},"notified_model_type":{"type":["string","null"]},"notified_model_id":{"type":["string","null"]},"suggested_notified_model_type":{"type":["string","null"]},"suggested_notified_model_id":{"type":["string","null"]},"dismissed_at":{"type":["string","null"]},"dismissed_by_model_type":{"type":["string","null"]},"dismissed_by_model_id":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"notify_at":{"type":["string","null"]},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"source":{"type":["string","null"],"description":"Relationships;"},"notifier":{"type":"string","description":"When loaded;"},"notified":{"type":["string","null"],"description":"When loaded;"},"suggested_notified":{"type":["string","null"],"description":"When loaded;"}},"required":["id","partner_id","event","title","preview","source_model_type","source_model_id","notifier_model_type","notifier_model_id","notified_model_type","notified_model_id","suggested_notified_model_type","suggested_notified_model_id","dismissed_at","dismissed_by_model_type","dismissed_by_model_id","expires_at","notify_at","metadata","created_at","updated_at","deleted_at"],"title":"NotificationResource"}}}} ``` ## The OfferingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"OfferingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"product_type":{"type":"string"},"product_id":{"type":"string"},"partner_id":{"type":["string","null"]},"specialty_id":{"type":["string","null"]},"image_file_id":{"type":["string","null"]},"active":{"type":"string"},"title":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"is_important":{"type":"string"},"clinical_note":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"order":{"type":["integer","null"]},"metadata":{"type":["string","null"]},"store_url":{"type":["string","null"]},"product_name":{"type":["string","null"]},"recommendation_message":{"type":["string","null"]},"upcharge":{"type":["string","null"]},"offering_cost":{"type":["string","null"]},"clinician_extra_fee":{"type":["string","null"]},"replicated_from_id":{"type":["string","null"]},"programs":{"type":["array","null"],"items":{}},"tier":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"product":{"type":["string","null"],"description":"Relationships;"},"review":{"type":"object","description":"Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape."},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}},"faqs":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/FaqResource"}},"taxonomies":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/TaxonomyResource"}},"states":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"diseases":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/DiseaseResource"}},"partner":{"description":"When loaded; Circular reference to App.Http.Resources.PartnerResource flattened to avoid an unbounded self-referential schema; see components.schemas.App.Http.Resources.PartnerResource for the full shape.","type":"object"},"clinicians":{"type":"array","items":{"type":"object","description":"Circular reference to App.Http.Resources.ClinicianResource flattened to avoid an unbounded self-referential schema; see components.schemas.App.Http.Resources.ClinicianResource for the full shape."}},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"image_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"pivot":{"type":"object","description":"Pivot Attributes;","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"offering_pivot":{"type":"object","description":"Pivot Attributes;","properties":{"offering_id":{"type":"string"},"related_offering_id":{"type":"string"},"recommendation_message":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","related_offering_id","recommendation_message","type","created_at","updated_at"]},"taxonomy_pivot":{"type":"object","properties":{"taxonomy_id":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"},"applied_fields":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["taxonomy_id","model_type","model_id","applied_fields","created_at","updated_at","deleted_at"]}},"required":["id","product_type","product_id","partner_id","specialty_id","image_file_id","active","title","is_additional_approval_needed","is_important","clinical_note","thank_you_note","order","metadata","store_url","product_name","recommendation_message","upcharge","offering_cost","clinician_extra_fee","replicated_from_id","programs","tier","created_at","updated_at","deleted_at","product"],"title":"OfferingResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"FaqResource":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"questions":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/FaqQuestionResource"}},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}]},"files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","key","title","description","questions","created_at","updated_at","deleted_at"],"title":"FaqResource"},"FaqQuestionResource":{"type":"object","properties":{"question":{},"answer":{}},"required":["question","answer"],"title":"FaqQuestionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"TaxonomyResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"parent_taxonomy_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"fields":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":[null,"value"]},{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/DiseaseResource"}}},"required":[null,"value"]},{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.StateResource"}}},"required":[null,"value"]},{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/FaqResource"}}},"required":[null,"value"]},{}]}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot;","properties":{"taxonomy_id":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"},"applied_fields":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["taxonomy_id","model_type","model_id","applied_fields","created_at","updated_at","deleted_at"]},"taxonomies":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to TaxonomyResource flattened to avoid an unbounded self-referential schema; see components.schemas.TaxonomyResource for the full shape."}},"taxonomy_children":{"type":"array","items":{"type":"object","description":"Circular reference to TaxonomyResource flattened to avoid an unbounded self-referential schema; see components.schemas.TaxonomyResource for the full shape."}}},"required":["id","parent_taxonomy_id","type","name","description","color","fields","created_at","updated_at","deleted_at"],"title":"TaxonomyResource"},"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"}}}} ``` ## The PartnerCompoundResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerCompoundResource":{"type":"object","properties":{"title":{"type":["string","null"]},"name":{"type":"string"},"partner_compound_id":{"type":"string"},"allow_substitutions":{"type":"string"},"refills":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"dispense_unit":{"type":"string"},"pharmacy_id":{"type":"string"},"pharmacy_name":{"type":"string"},"days_supply":{"type":"string"},"pharmacy_notes":{"type":"string"},"order":{"type":"string"},"metadata":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"clinical_note":{"type":["string","null"]},"directions":{"type":"string"},"quantity":{"type":"string"},"active":{"type":"string"},"effective_date":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"is_controlled_substance":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"schedule":{"anyOf":[{"type":"string"},{"type":"integer","enum":[0]}]}},"required":["title","name","partner_compound_id","allow_substitutions","refills","dispense_unit_id","is_additional_approval_needed","dispense_unit","pharmacy_id","pharmacy_name","days_supply","pharmacy_notes","order","metadata","thank_you_note","clinical_note","directions","quantity","active","effective_date","created_at","updated_at","is_controlled_substance","schedule"],"title":"PartnerCompoundResource"}}}} ``` ## The PartnerNotificationResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerNotificationResource":{"type":"object","properties":{"id":{"type":"string"},"notes":{"type":"string"},"notify":{"type":"boolean"},"needs_ack":{"type":"boolean"},"partner_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"partner":{"$ref":"#/components/schemas/App.Http.Resources.PartnerResource"}},"required":["id","notes","notify","needs_ack","partner_id","created_at"],"title":"PartnerNotificationResource"},"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The PartnerPharmacyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerPharmacyResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"pharmacy_id":{"type":"integer"},"pharmacy_name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","partner_id","pharmacy_id","pharmacy_name","created_at","updated_at","deleted_at"],"title":"PartnerPharmacyResource"}}}} ``` ## The PartnerQuestionnaireQuestionOptionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerQuestionnaireQuestionOptionResource":{"type":"object","properties":{"partner_questionnaire_question_option_id":{"type":"string"},"title":{"type":"string"},"value":{"type":["string","null"]},"option":{"type":"string"},"is_important":{"type":"string"},"is_critical":{"type":"string"},"is_show_additional_field":{"type":"string"},"order":{"type":"integer"},"icon_type":{"type":["string","null"]},"icon":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"string"},{"type":"null"}]}},"required":["partner_questionnaire_question_option_id","title","value","option","is_important","is_critical","is_show_additional_field","order","icon_type","icon"],"title":"PartnerQuestionnaireQuestionOptionResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"}}}} ``` ## The PartnerQuestionnaireQuestionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerQuestionnaireQuestionResource":{"type":"object","properties":{"partner_questionnaire_question_id":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"label":{"type":["string","null"]},"placeholder":{"type":["string","null"]},"is_important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"is_optional":{"type":"string"},"is_visible":{"type":"string"},"has_next_button":{"type":"string"},"has_back_button":{"type":"string"},"mapped_to_field":{"type":["string","null"]},"order":{"type":"integer"},"type":{"type":"string"},"file_type":{"type":["string","null"]},"default_value":{"type":["string","null"]},"feed_ads":{"type":"string"},"rule_type":{"type":"string"},"hold_status":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionOptionResource"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/FileResource"}},"rules":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionRuleResource"}}},"required":["partner_questionnaire_question_id","title","description","label","placeholder","is_important","is_critical","display_in_pdf","is_optional","is_visible","has_next_button","has_back_button","mapped_to_field","order","type","file_type","default_value","feed_ads","rule_type","hold_status","is_additional_approval_needed","options","rules"],"title":"PartnerQuestionnaireQuestionResource"},"PartnerQuestionnaireQuestionOptionResource":{"type":"object","properties":{"partner_questionnaire_question_option_id":{"type":"string"},"title":{"type":"string"},"value":{"type":["string","null"]},"option":{"type":"string"},"is_important":{"type":"string"},"is_critical":{"type":"string"},"is_show_additional_field":{"type":"string"},"order":{"type":"integer"},"icon_type":{"type":["string","null"]},"icon":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"string"},{"type":"null"}]}},"required":["partner_questionnaire_question_option_id","title","value","option","is_important","is_critical","is_show_additional_field","order","icon_type","icon"],"title":"PartnerQuestionnaireQuestionOptionResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"PartnerQuestionnaireQuestionRuleResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionRuleRequirementResource"}}},"required":["id","title","type","requirements"],"title":"PartnerQuestionnaireQuestionRuleResource"},"PartnerQuestionnaireQuestionRuleRequirementResource":{"type":"object","properties":{"based_on":{"type":["string","null"]},"required_question_id":{"type":["string","null"]},"required_question_title":{"type":["string","null"]},"conditional_answer":{"type":["string","null"]},"required_answer":{"type":"string"}},"required":["based_on","required_question_id","required_question_title","conditional_answer","required_answer"],"title":"PartnerQuestionnaireQuestionRuleRequirementResource"}}}} ``` ## The PartnerQuestionnaireQuestionRuleRequirementResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerQuestionnaireQuestionRuleRequirementResource":{"type":"object","properties":{"based_on":{"type":["string","null"]},"required_question_id":{"type":["string","null"]},"required_question_title":{"type":["string","null"]},"conditional_answer":{"type":["string","null"]},"required_answer":{"type":"string"}},"required":["based_on","required_question_id","required_question_title","conditional_answer","required_answer"],"title":"PartnerQuestionnaireQuestionRuleRequirementResource"}}}} ``` ## The PartnerQuestionnaireQuestionRuleResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerQuestionnaireQuestionRuleResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionRuleRequirementResource"}}},"required":["id","title","type","requirements"],"title":"PartnerQuestionnaireQuestionRuleResource"},"PartnerQuestionnaireQuestionRuleRequirementResource":{"type":"object","properties":{"based_on":{"type":["string","null"]},"required_question_id":{"type":["string","null"]},"required_question_title":{"type":["string","null"]},"conditional_answer":{"type":["string","null"]},"required_answer":{"type":"string"}},"required":["based_on","required_question_id","required_question_title","conditional_answer","required_answer"],"title":"PartnerQuestionnaireQuestionRuleRequirementResource"}}}} ``` ## The PartnerQuestionnaireResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerQuestionnaireResource":{"type":"object","properties":{"partner_questionnaire_id":{"type":"string"},"active":{"type":"string"},"name":{"type":"string"},"intro_title":{"type":["string","null"]},"intro_description":{"type":["string","null"]},"redirect_url":{"type":["string","null"]},"redirect_title":{"type":["string","null"]},"has_pharmacy":{"type":"string"},"terms_of_service":{"type":["string","null"]},"metadata":{"type":["string","null"]},"is_weight_asked":{"type":"string"},"is_height_asked":{"type":"string"},"is_body_temperature_asked":{"type":"string"},"is_oxygen_saturation_asked":{"type":"string"},"ask_blood_pressure":{"type":"string"},"is_condensed_question":{"type":"string"},"is_show_welcome":{"type":"string"},"is_show_user":{"type":"string"},"is_show_thanks":{"type":"string"},"questions_lang":{"type":["array","null"],"description":"Custom fields label;","items":{}},"payment_type":{"type":"string"},"payment_account_id":{"type":["string","null"]},"payment_account":{"anyOf":[{"$ref":"#/components/schemas/App.Http.Resources.V1.PaymentAccountResource"},{"type":"object","properties":{"id":{"type":"null"},"partner_id":{"type":"null"},"is_chargeable":{"type":"boolean"},"name":{"type":"string","const":"MDI Default"},"public_key":{"type":"string"},"created_at":{"type":"null"},"updated_at":{"type":"null"},"deleted_at":{"type":"null"}},"required":["id","partner_id","is_chargeable","name","public_key","created_at","updated_at","deleted_at"]}]},"questions":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionResource"}},"offerings":{"type":"array","items":{"type":["object","null"]}}},"required":["partner_questionnaire_id","active","name","intro_title","intro_description","redirect_url","redirect_title","has_pharmacy","terms_of_service","metadata","is_weight_asked","is_height_asked","is_body_temperature_asked","is_oxygen_saturation_asked","ask_blood_pressure","is_condensed_question","is_show_welcome","is_show_user","is_show_thanks","questions_lang","payment_type","payment_account_id","offerings"],"title":"PartnerQuestionnaireResource"},"App.Http.Resources.V1.PaymentAccountResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"public_key":{"type":"string"},"is_chargeable":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","public_key","is_chargeable","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.V1.PaymentAccountResource"},"PartnerQuestionnaireQuestionResource":{"type":"object","properties":{"partner_questionnaire_question_id":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"label":{"type":["string","null"]},"placeholder":{"type":["string","null"]},"is_important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"is_optional":{"type":"string"},"is_visible":{"type":"string"},"has_next_button":{"type":"string"},"has_back_button":{"type":"string"},"mapped_to_field":{"type":["string","null"]},"order":{"type":"integer"},"type":{"type":"string"},"file_type":{"type":["string","null"]},"default_value":{"type":["string","null"]},"feed_ads":{"type":"string"},"rule_type":{"type":"string"},"hold_status":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionOptionResource"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/FileResource"}},"rules":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionRuleResource"}}},"required":["partner_questionnaire_question_id","title","description","label","placeholder","is_important","is_critical","display_in_pdf","is_optional","is_visible","has_next_button","has_back_button","mapped_to_field","order","type","file_type","default_value","feed_ads","rule_type","hold_status","is_additional_approval_needed","options","rules"],"title":"PartnerQuestionnaireQuestionResource"},"PartnerQuestionnaireQuestionOptionResource":{"type":"object","properties":{"partner_questionnaire_question_option_id":{"type":"string"},"title":{"type":"string"},"value":{"type":["string","null"]},"option":{"type":"string"},"is_important":{"type":"string"},"is_critical":{"type":"string"},"is_show_additional_field":{"type":"string"},"order":{"type":"integer"},"icon_type":{"type":["string","null"]},"icon":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"string"},{"type":"null"}]}},"required":["partner_questionnaire_question_option_id","title","value","option","is_important","is_critical","is_show_additional_field","order","icon_type","icon"],"title":"PartnerQuestionnaireQuestionOptionResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"PartnerQuestionnaireQuestionRuleResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionRuleRequirementResource"}}},"required":["id","title","type","requirements"],"title":"PartnerQuestionnaireQuestionRuleResource"},"PartnerQuestionnaireQuestionRuleRequirementResource":{"type":"object","properties":{"based_on":{"type":["string","null"]},"required_question_id":{"type":["string","null"]},"required_question_title":{"type":["string","null"]},"conditional_answer":{"type":["string","null"]},"required_answer":{"type":"string"}},"required":["based_on","required_question_id","required_question_title","conditional_answer","required_answer"],"title":"PartnerQuestionnaireQuestionRuleRequirementResource"}}}} ``` ## The PartnerResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"support_message_capability":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"provides_medications":{"type":"string"},"partner_notes":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"customer_support_email":{"type":["string","null"]},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"can_unlock_phi":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"reassignment_interval":{"type":"integer"},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"business_model":{"type":"string"},"customization":{"type":"string"},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"parent_partner_id":{"type":["string","null"]},"integration_type":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"image":{"type":["object","null"],"description":"It's called \"logo\" in other resource;","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"metadata":{"type":["array","null"],"items":{}}},"required":["file_id","path","name","mime_type","url","url_thumbnail","created_at","metadata"]}},"required":["partner_id","notification_priority","notification_schedule","is_patient_identity_verified","name","customer_support_email","operation_country","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_ai_auto_summary_enabled","is_sending_tracking_number_enabled","enable_icd_bmi","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","customization","vouched_integration_type","parent_partner_id","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","image"],"title":"PartnerResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"}}}} ``` ## The PartnerServiceResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerServiceResource":{"type":"object","properties":{"partner_service_id":{"type":"string"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":"string"},"thank_you_note":{"type":["string","null"]},"clinical_notes":{"type":["string","null"]},"pharmacy_fax_number":{"type":"string"},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"order":{"type":["integer","null"]},"metadata":{"type":"string"}},"required":["partner_service_id","title","service_type","description","additional_note","thank_you_note","clinical_notes","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","is_additional_approval_needed","order","metadata"],"title":"PartnerServiceResource"}}}} ``` ## The PartnerSupplyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PartnerSupplyResource":{"type":"object","properties":{"partner_supply_id":{"type":"string"},"dosespot_supply_id":{"type":"string"},"title":{"type":["string","null"]},"name":{"type":"string"},"ndc":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"pharmacy_name":{"type":"string"},"pharmacy_id":{"type":"string"},"dispense_unit":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_notes":{"type":"string"},"clinical_note":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"order":{"type":["integer","null"]},"metadata":{"type":"string"},"active":{"type":"string"},"effective_date":{"type":"string"}},"required":["partner_supply_id","dosespot_supply_id","title","name","ndc","refills","quantity","days_supply","directions","pharmacy_name","pharmacy_id","dispense_unit","dispense_unit_id","is_additional_approval_needed","pharmacy_notes","clinical_note","thank_you_note","order","metadata","active","effective_date"],"title":"PartnerSupplyResource"}}}} ``` ## The PatchCaseFilesRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchCaseFilesRequest":{"type":"object","properties":{"case_files":{"type":"array","items":{"type":"string","format":"uuid"}}},"title":"PatchCaseFilesRequest"}}}} ``` ## The PatchCaseOfferingRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchCaseOfferingRequest":{"type":"object","title":"PatchCaseOfferingRequest"}}}} ``` ## The PatchCaseOrderRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchCaseOrderRequest":{"type":"object","properties":{"date":{"type":["string","null"],"format":"date-time"},"payment_status":{"type":["string","null"]},"payment_date":{"type":["string","null"],"format":"date-time"}},"title":"PatchCaseOrderRequest"}}}} ``` ## The PatchCasePrescriptionRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchCasePrescriptionRequest":{"type":"object","properties":{"refills":{"type":["integer","null"],"maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":["number","null"],"minimum":0,"maximum":9999999999},"directions":{"type":["string","null"],"maxLength":1000},"dispense_unit_id":{"type":["integer","null"]},"pharmacy_id":{"type":"integer"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]},"effective_date":{"type":["string","null"],"format":"date"},"title":{"type":["string","null"],"maxLength":255},"order":{"type":["integer","null"],"minimum":1}},"title":"PatchCasePrescriptionRequest"}}}} ``` ## The PatchCasePrescriptionsRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchCasePrescriptionsRequest":{"type":"array","items":{"type":"object","properties":{"refills":{"type":"integer","maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":"number","minimum":0,"maximum":9999999999},"directions":{"type":"string","maxLength":1000},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":["integer","null"]},"dosespot_medication_id":{"type":"integer"},"partner_medication_id":{"type":"string","format":"uuid"},"partner_compound_id":{"type":"string","format":"uuid"},"offering_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"},"dosespot_supply_ndc":{"type":"string"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]},"effective_date":{"type":["string","null"],"format":"date"},"order":{"type":["integer","null"],"minimum":1}}},"title":"PatchCasePrescriptionsRequest"}}}} ``` ## The PatchHoldCaseStatusFlagRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchHoldCaseStatusFlagRequest":{"type":"object","properties":{"hold_status":{"type":"boolean"}},"required":["hold_status"],"title":"PatchHoldCaseStatusFlagRequest"}}}} ``` ## The PatchPatientRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchPatientRequest":{"type":"object","properties":{"prefix":{"type":["string","null"],"maxLength":10},"first_name":{"type":"string","maxLength":35},"middle_name":{"type":["string","null"],"maxLength":35},"last_name":{"type":"string","maxLength":35},"email":{"type":"string","format":"email","maxLength":80},"active":{"type":"boolean"},"status":{"type":"string"},"driver_license_id":{"type":["string","null"],"format":"uuid"},"gender":{"type":["integer","null"]},"external_id":{"type":["string","null"],"maxLength":255},"metadata":{"type":["string","null"],"maxLength":255},"phone_number":{"type":["string","null"],"maxLength":255},"phone_type":{"type":"integer","enum":["2","4"]},"weight":{"type":["number","null"],"minimum":0,"maximum":999},"height":{"type":["number","null"],"minimum":0,"maximum":300},"blood_pressure":{"type":["string","null"],"maxLength":255},"body_temperature":{"type":["number","null"],"minimum":0,"maximum":100},"oxygen_saturation":{"type":["integer","null"],"minimum":0,"maximum":100},"special_necessities":{"type":["string","null"]},"current_medications":{"type":["string","null"]},"medical_conditions":{"type":["string","null"]},"allergies":{"type":["string","null"]},"pregnancy":{"type":["boolean","null"]},"ssn":{"type":["string","null"],"maxLength":11},"intro_video_id":{"type":["string","null"],"format":"uuid"},"is_email_enabled":{"type":["boolean","null"]},"is_sms_enabled":{"type":["boolean","null"]},"address":{"type":"object","properties":{"address":{"type":"string","maxLength":35},"address2":{"type":["string","null"],"maxLength":35},"zip_code":{"type":"string"},"city_id":{"type":"string","description":"TODO: remove this once city_id support is dropped."},"city_name":{"type":"string","maxLength":35},"state_name":{"type":"string"}}},"metafields":{"type":["array","null"],"items":{"type":"object","properties":{"scope":{"type":"string","maxLength":255},"key":{"type":"string","maxLength":255},"value":{"type":["string","null"],"maxLength":255},"type":{"type":["string","null"],"enum":["string","number","boolean"],"maxLength":255},"title":{"type":["string","null"],"maxLength":255}},"required":["key","value"]}}},"title":"PatchPatientRequest"}}}} ``` ## The PatchTagNoteRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatchTagNoteRequest":{"type":"object","properties":{"notes":{"type":"string","maxLength":255}},"required":["notes"],"title":"PatchTagNoteRequest"}}}} ``` ## The PatientAppPartnerResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientAppPartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"name":{"type":"string"},"customer_support_email":{"type":"string"},"business_model":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"image":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"customization":{"type":"string"},"vouched_integration_type":{"type":"string"},"is_patient_identity_verified":{"type":"string"},"custom_theme":{"type":"string"},"custom_style":{"type":"string"},"integration_type":{"type":"string"},"patient_portal_config_page":{"type":"string"},"custom_domains":{"type":"array","items":{"$ref":"#/components/schemas/CustomDomainResource"}}},"required":["partner_id","name","customer_support_email","business_model","enable_av_flow","is_auto_dl_flow","is_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","operation_country","image","customization","vouched_integration_type","is_patient_identity_verified","custom_theme","custom_style","integration_type","patient_portal_config_page","custom_domains"],"title":"PatientAppPartnerResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"CustomDomainResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes"},"custom_domain":{"type":"string"}},"required":["id","custom_domain"],"title":"CustomDomainResource"}}}} ``` ## The PatientCaseResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientCaseResource":{"type":"object","properties":{"prioritized_at":{"type":"string"},"prioritized_reason":{"type":"string"},"created_at":{"type":"string"},"is_sync":{"type":"string"},"case_type":{"type":"string"},"external_id":{"type":"string"},"metadata":{"type":"string"},"is_chargeable":{"type":"string"},"service_pdf_exported":{"type":"string"},"reference_case_id":{"type":"string"},"patient_exam_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"locked_at":{"type":"string"},"charged_by":{"type":"string"},"case_id":{"type":"string"},"prioritized":{"type":"string"},"is_locked":{"type":"string"},"is_blocked_by_partner_state":{"type":"string"},"programs":{"type":"string"},"tier":{"type":"string"},"soap_notes":{"type":"string"},"questionnaire_summary":{"type":"string"},"case_status":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["name","reason","created_at","updated_at"]},"case_assignment":{"type":"object","properties":{"case_assignment_id":{"type":"string"},"reason":{"type":"string"},"created_at":{"type":"string"},"clinician":{"type":"object","properties":{"clinician_id":{"type":"string"},"is_online":{"type":"string"},"is_out_of_office":{"type":"string"},"case_assignment_availability":{"type":"string"},"is_message_availability":{"type":"string"},"managed_by_partner":{"type":"string"},"specialty":{"type":"string"},"full_name":{"type":"string"},"first_name":{"type":"string"},"suffix":{"type":"string"},"last_name":{"type":"string"},"bio_details":{"type":"string"},"profile_url":{"type":"string"},"licenses":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}]},"photo":{"type":["object","null"],"properties":{"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"file_id":{"type":"string"}},"required":["path","name","mime_type","url","url_thumbnail","file_id"]}},"required":["clinician_id","is_online","is_out_of_office","case_assignment_availability","is_message_availability","managed_by_partner","specialty","full_name","first_name","suffix","last_name","bio_details","profile_url","licenses","photo"]}},"required":["case_assignment_id","reason","created_at","clinician"]},"case_notes":{"type":"string"},"case_questions":{"type":"string"},"case_files":{"type":"string"},"diseases":{"type":"string"},"tags":{"type":"string"},"patient":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"string"},"phone_number":{"type":"string"},"phone_type":{"type":"string"},"active":{"type":"string"},"pregnancy":{"type":"string"},"external_id":{"type":"string"},"metadata":{"type":"string"},"prefix":{"type":"string"},"ssn":{"type":"string"},"clinician_id":{"type":"string"},"recent_encounter_id":{"type":"string"},"important_offering_case_id":{"type":"string"},"middle_name":{"type":"string"},"patient_id":{"type":"string"},"gender_label":{"type":"string"},"is_live":{"type":"string"},"intro_video":{"type":"string"},"height":{"type":"string"},"weight":{"type":"string"},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"dosespot":{"type":"string"},"address":{"type":"object","properties":{"address":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":"string"},"address2":{"type":"string"},"address_id":{"type":"string"},"state":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"is_sync":{"type":"string"},"is_av_flow":{"type":"string"},"state_id":{"type":"string"}},"required":["name","abbreviation","is_sync","is_av_flow","state_id"]}},"required":["address","zip_code","city_name","address2","address_id","state"]}},"required":["first_name","last_name","email","date_of_birth","gender","phone_number","phone_type","active","pregnancy","external_id","metadata","prefix","ssn","clinician_id","recent_encounter_id","important_offering_case_id","middle_name","patient_id","gender_label","is_live","intro_video","height","weight","allergies","current_medications","medical_conditions","dosespot","address"]},"partner":{"type":"object","properties":{"name":{"type":"string"},"operations_support_email":{"type":"string"},"support_message_capability":{"type":"string"},"patient_message_capability":{"type":"string"},"partner_notes":{"type":"string"},"customer_support_email":{"type":"string"},"thank_you_note_header":{"type":"string"},"thank_you_note_footer":{"type":"string"},"vouched_integration_type":{"type":"string"},"business_model":{"type":"string"},"enable_av_flow":{"type":"string"},"slack_channel_id":{"type":"string"},"enable_icd_bmi":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"escalation_support_email":{"type":"string"},"review_notes":{"type":"string"},"is_patient_identity_verified":{"type":"string"},"notification_priority":{"type":"string"},"notification_schedule":{"type":"string"},"reassignment_interval":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"partner_id":{"type":"string"},"can_unlock_phi":{"type":"string"},"customization":{"type":"object","properties":{"primary_color":{"type":["string","null"]},"secondary_color":{"type":["string","null"]},"background_color":{"type":["string","null"]}},"required":["primary_color","secondary_color","background_color"]}},"required":["name","operations_support_email","support_message_capability","patient_message_capability","partner_notes","customer_support_email","thank_you_note_header","thank_you_note_footer","vouched_integration_type","business_model","enable_av_flow","slack_channel_id","enable_icd_bmi","is_auto_dl_flow","escalation_support_email","review_notes","is_patient_identity_verified","notification_priority","notification_schedule","reassignment_interval","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","partner_id","can_unlock_phi","customization"]},"case_prescriptions":{"type":"array","items":{}},"case_services":{"type":"array","items":{}},"case_offerings":{"type":"array","items":{}},"orders":{"type":"string"}},"required":["prioritized_at","prioritized_reason","created_at","is_sync","case_type","external_id","metadata","is_chargeable","service_pdf_exported","reference_case_id","patient_exam_id","is_additional_approval_needed","locked_at","charged_by","case_id","prioritized","is_locked","is_blocked_by_partner_state","programs","tier","soap_notes","questionnaire_summary"],"title":"PatientCaseResource"}}}} ``` ## The PatientDataExportJobResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientDataExportJobResource":{"anyOf":[{"type":"object","properties":{"job_id":{"type":"string"},"status":{"type":"string"}},"required":["job_id","status"]},{"type":"object","properties":{"job_id":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"}},"required":["job_id","status","message"]},{"type":"object","properties":{"job_id":{"type":"string"},"status":{"type":"string","const":"completed"},"url":{"type":"string"},"passcode":{"type":"string"},"expires_at":{"type":"string"}},"required":["job_id","status","url","passcode","expires_at"]},{"type":"object","properties":{"job_id":{"type":"string"},"status":{"type":"string","const":"processing"}},"required":["job_id","status"]}],"title":"PatientDataExportJobResource"}}}} ``` ## The PatientEligibilityResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientEligibilityResource":{"type":"object","properties":{"patient_eligibility_id":{"type":["string","null"],"description":"Attributes;"},"payer_name":{"type":["string","null"]},"pharmacy_eligibilities":{"type":["string","null"]},"plan_name":{"type":["string","null"]},"coverage_id":{"type":["string","null"]},"payer_id":{"type":["string","null"]},"bin":{"type":["string","null"]},"pcn":{"type":["string","null"]},"formulary_id":{"type":["string","null"]},"alternatives_id":{"type":["string","null"]},"copay_id":{"type":["string","null"]},"demographic_changes":{"type":["string","null"]},"demographics":{"type":["string","null"]},"error_message":{"type":["string","null"]},"info_message":{"type":["string","null"]},"member_id":{"type":["string","null"]}},"required":["patient_eligibility_id","payer_name","pharmacy_eligibilities","plan_name","coverage_id","payer_id","bin","pcn","formulary_id","alternatives_id","copay_id","demographic_changes","demographics","error_message","info_message","member_id"],"title":"PatientEligibilityResource"}}}} ``` ## The PatientExamResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientExamResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"patient_id":{"type":"string"},"height":{"type":["string","null"]},"weight":{"type":["string","null"]},"blood_pressure":{"type":["string","null"]},"body_temperature":{"type":["string","null"]},"oxygen_saturation":{"type":["integer","null"]},"special_necessities":{"type":["string","null"]},"medications":{"type":["string","null"]},"medical_conditions":{"type":["string","null"]},"allergies":{"type":["string","null"]},"user_type":{"type":["string","null"]},"user_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"user":{"type":"string","description":"Appended;"}},"required":["id","patient_id","height","weight","blood_pressure","body_temperature","oxygen_saturation","special_necessities","medications","medical_conditions","allergies","user_type","user_id","created_at","updated_at","deleted_at"],"title":"PatientExamResource"}}}} ``` ## The PatientMedicationHistoryResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientMedicationHistoryResource":{"type":"object","properties":{"patient_medication_history_id":{"type":["string","null"],"description":"Attributes;"},"pharmacy_notes":{"type":["string","null"]},"no_substitutions":{"type":["string","null"]},"effective_date":{"type":["string","null"]},"last_fill_date":{"type":["string","null"]},"payer":{"type":["string","null"]},"days_supply":{"type":["string","null"]},"directions":{"type":["string","null"]},"dispense_unit_description":{"type":["string","null"]},"dispense_unit_id":{"type":["string","null"]},"quantity":{"type":["string","null"]},"refills":{"type":["string","null"]},"written_date":{"type":["string","null"]},"diagnosis_code":{"type":["string","null"]},"diagnosis_qualifier":{"type":["string","null"]},"dose_form":{"type":["string","null"]},"route":{"type":["string","null"]},"strength":{"type":["string","null"]},"generic_drug_name":{"type":["string","null"]},"dispensable_drug_id":{"type":["string","null"]},"brand":{"type":["string","null"]},"rx_cui":{"type":["string","null"]},"otc":{"type":["string","null"]},"ndc":{"type":["string","null"]},"schedule":{"type":["string","null"]},"display_name":{"type":["string","null"]},"drug_classification":{"type":["string","null"]},"expiration_date":{"type":["string","null"]}},"required":["patient_medication_history_id","pharmacy_notes","no_substitutions","effective_date","last_fill_date","payer","days_supply","directions","dispense_unit_description","dispense_unit_id","quantity","refills","written_date","diagnosis_code","diagnosis_qualifier","dose_form","route","strength","generic_drug_name","dispensable_drug_id","brand","rx_cui","otc","ndc","schedule","display_name","drug_classification","expiration_date"],"title":"PatientMedicationHistoryResource"}}}} ``` ## The PatientOrderBillingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientOrderBillingResource":{"type":"object","properties":{"card_id":{},"issuer":{},"type":{},"expire_date":{"anyOf":[{"type":"array","items":{}},{"type":"string"},{"type":"null"}]}},"required":["card_id","issuer","type","expire_date"],"title":"PatientOrderBillingResource"}}}} ``` ## The PatientOrderProductResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientOrderProductResource":{"type":"object","properties":{"name":{},"description":{},"image_url":{},"unit_price":{},"amount":{},"total_amount":{"type":"number"},"offering_id":{},"file_id":{}},"required":["name","description","image_url","unit_price","amount","total_amount","offering_id","file_id"],"title":"PatientOrderProductResource"}}}} ``` ## The PatientOrderResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientOrderResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"order_number":{"type":"string"},"status":{"type":"string"},"payment_status":{"type":"string"},"total_amount":{"type":"number"},"consultation_price":{"type":"number"},"billing":{"anyOf":[{"$ref":"#/components/schemas/PatientOrderBillingResource"},{"type":"null"}]},"tracking":{"anyOf":[{"$ref":"#/components/schemas/PatientOrderTrackingResource"},{"type":"null"}]},"products":{"type":"array","items":{"$ref":"#/components/schemas/PatientOrderProductResource"}},"patient_id":{"type":["string","null"]},"partner_id":{"type":["string","null"]},"case_id":{"type":["string","null"]},"case_order_id":{"type":["string","null"]},"patient_subscription_id":{"type":["string","null"]},"order_created_at":{"type":"string"},"cancelled_at":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"patient":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.PatientResource"},"partner":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.PartnerResource"},"case":{"description":"When loaded;","$ref":"#/components/schemas/CaseModelResource"},"case_order":{"description":"When loaded;","$ref":"#/components/schemas/CaseOrderResource"},"patient_subscription":{"description":"When loaded; Circular reference to PatientSubscriptionResource flattened to avoid an unbounded self-referential schema; see components.schemas.PatientSubscriptionResource for the full shape.","type":"object"}},"required":["id","order_number","status","payment_status","total_amount","consultation_price","billing","tracking","products","patient_id","partner_id","case_id","case_order_id","patient_subscription_id","order_created_at","cancelled_at","created_at","updated_at","deleted_at"],"title":"PatientOrderResource"},"PatientOrderBillingResource":{"type":"object","properties":{"card_id":{},"issuer":{},"type":{},"expire_date":{"anyOf":[{"type":"array","items":{}},{"type":"string"},{"type":"null"}]}},"required":["card_id","issuer","type","expire_date"],"title":"PatientOrderBillingResource"},"PatientOrderTrackingResource":{"type":"object","properties":{"number":{},"company":{},"link":{},"shipping_price":{}},"required":["number","company","link","shipping_price"],"title":"PatientOrderTrackingResource"},"PatientOrderProductResource":{"type":"object","properties":{"name":{},"description":{},"image_url":{},"unit_price":{},"amount":{},"total_amount":{"type":"number"},"offering_id":{},"file_id":{}},"required":["name","description","image_url","unit_price","amount","total_amount","offering_id","file_id"],"title":"PatientOrderProductResource"},"App.Http.Resources.PatientResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":"string"},"ssn":{"type":["string","null"]},"active":{"type":"string"},"prefix":{"type":["string","null"]},"weight":{"type":"string"},"height":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"address_id":{"type":"string"},"driver_license_id":{"type":["string","null"]},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"pregnancy":{"type":"string"},"partner_id":{"type":"string"},"environment_id":{"type":"string"},"clinician_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"intro_video_file_id":{"type":["string","null"]},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]},"patient_id":{"type":"string","description":"Appended Attributes;"},"full_name":{"type":"string"},"abbreviated_name":{"type":"string"},"is_live":{"type":"string"},"intro_video_id":{"type":"string"},"exam_id":{"type":"string"},"dosespot":{"type":"string"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"shopify_customer_id":{"type":"string"},"address":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"clinician":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"},"driver_license":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"environment":{"description":"When loaded;","$ref":"#/components/schemas/EnvironmentResource"},"intro_video":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","first_name","middle_name","last_name","email","ssn","active","prefix","weight","height","blood_pressure","body_temperature","oxygen_saturation","special_necessities","date_of_birth","gender","gender_label","phone_number","phone_type","address_id","driver_license_id","allergies","current_medications","medical_conditions","pregnancy","partner_id","environment_id","clinician_id","metadata","intro_video_file_id","recent_encounter_id","important_offering_case_id","created_at","updated_at","deleted_at","is_sms_enabled","is_email_enabled","original_patient_id","status","patient_id","full_name","abbreviated_name","is_live","intro_video_id","exam_id","dosespot","metafields","shopify_customer_id"],"title":"App.Http.Resources.PatientResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"},"CaseModelResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_blocked_by_partner_state":{"type":"string"},"patient_id":{"type":"string"},"partner_id":{"type":"string"},"reference_case_id":{"type":["string","null"]},"is_sync":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"case_type":{"type":"string"},"case_assignment_id":{"type":["string","null"]},"case_status_id":{"type":["string","null"]},"prioritized_at":{"type":["string","null"],"format":"date-time"},"locked_at":{"type":["string","null"],"format":"date-time"},"is_locked":{"type":"string"},"prioritized_reason":{"type":["string","null"]},"service_pdf_exported":{"type":"string"},"is_chargeable":{"type":"string"},"charged_by":{"type":["string","null"]},"partner_amount_charged":{"type":["number","null"]},"partner_offering_amount_charged":{"type":["number","null"]},"metadata":{"type":["string","null"]},"patient_exam_id":{"type":["string","null"]},"programs":{"type":["array","null"],"items":{}},"tier":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"prioritized":{"type":"string","description":"Appended Attributes;"},"patient":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.PatientResource"},"partner":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.PartnerResource"},"case_assignment":{"description":"When loaded;","$ref":"#/components/schemas/EncounterAssignmentResource"},"case_status":{"description":"When loaded;","$ref":"#/components/schemas/EncounterStatusResource"},"case_prescriptions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterPrescriptionResource"}},"case_notes":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterNoteResource"}},"case_services":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterServiceResource"}},"case_questions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/EncounterQuestionResource"}},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_blocked_by_partner_state","patient_id","partner_id","reference_case_id","is_sync","is_additional_approval_needed","case_type","case_assignment_id","case_status_id","prioritized_at","locked_at","is_locked","prioritized_reason","service_pdf_exported","is_chargeable","charged_by","partner_amount_charged","partner_offering_amount_charged","metadata","patient_exam_id","programs","tier","created_at","updated_at","deleted_at","prioritized"],"title":"CaseModelResource"},"EncounterAssignmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"reason":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","case_id","clinician_id","reason","created_at","updated_at"],"title":"EncounterAssignmentResource"},"EncounterStatusResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","reason","updated_at","created_at"],"title":"EncounterStatusResource"},"EncounterPrescriptionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"name":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"dosespot_prescription_id":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"pharmacy_notes":{"type":"string"},"no_substitutions":{"type":"string"},"dosespot_display_name":{"type":"string"},"medication":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["id","title","name","refills","quantity","days_supply","directions","dispense_unit_id","is_additional_approval_needed","pharmacy_id","thank_you_note","clinical_note","dosespot_prescription_id","status","status_details","pharmacy_notes","no_substitutions","dosespot_display_name","medication","offerable_type","offerable_id","updated_at","created_at"],"title":"EncounterPrescriptionResource"},"EncounterNoteResource":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"case_id":{"type":"string"},"clinician_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"clinician":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"}},"required":["id","text","case_id","clinician_id","created_at","updated_at"],"title":"EncounterNoteResource"},"EncounterServiceResource":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_notes":{"type":"string"},"pharmacy_fax_number":{"type":"string"},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"order":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"}},"required":["id","title","service_type","description","additional_note","thank_you_note","clinical_notes","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","order","offerable_type","offerable_id"],"title":"EncounterServiceResource"},"EncounterQuestionResource":{"type":"object","properties":{"id":{"type":"string"},"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":"string"},"is_critical":{"type":"string"},"display_in_pdf":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"displayed_options":{"type":"string"},"metadata":{"type":"string"}},"required":["id","question","answer","type","important","is_critical","display_in_pdf","description","label","displayed_options","metadata"],"title":"EncounterQuestionResource"},"CaseOrderResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_id":{"type":"string"},"external_id":{"type":"string"},"pharmacy_id":{"type":"string"},"prescriptions_id":{"type":"array","items":{}},"status":{"type":"string"},"details":{"type":["string","null"]},"status_details":{"type":["string","null"],"description":"retrocompatibility"},"status_metadata":{"type":["string","null"]},"number":{"type":["string","null"]},"date":{"type":["string","null"]},"tracking_number":{"type":["string","null"]},"tracking_url":{"type":["string","null"]},"tracking_metadata":{"type":["string","null"]},"tracked_at":{"type":["string","null"]},"sequence_number":{"type":["integer","null"]},"sequence_total":{"type":["integer","null"]},"sequence_order_id":{"type":["string","null"]},"acknowledged_at":{"type":["string","null"]},"acknowledged_id":{"type":["string","null"]},"acknowledged_metadata":{"type":["string","null"]},"payment_date":{"type":["string","null"]},"payment_status":{"type":["string","null"]},"pharmacy_name":{"type":["string","null"],"description":"appends;"},"case":{"$ref":"#/components/schemas/CaseByStatusResource"},"offerings":{"type":"array","items":{"$ref":"#/components/schemas/CaseOfferingResource"}},"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"external_id":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"number":{"type":"string"},"sequence_number":{"type":"string"},"sequence_total":{"type":"string"},"sequence_order_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"date":{"type":"string"}},"required":["id","external_id","status","status_details","number","sequence_number","sequence_total","sequence_order_id","created_at","updated_at","date"]}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","case_id","external_id","pharmacy_id","prescriptions_id","status","details","status_details","status_metadata","number","date","tracking_number","tracking_url","tracking_metadata","tracked_at","sequence_number","sequence_total","sequence_order_id","acknowledged_at","acknowledged_id","acknowledged_metadata","payment_date","payment_status","pharmacy_name","case","created_at","updated_at","deleted_at"],"title":"CaseOrderResource"},"CaseByStatusResource":{"type":"object","properties":{"case_id":{"type":"string","description":"Attributes;"},"external_id":{"type":"string"},"metadata":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"prioritized_at":{"type":"string"},"programs":{"type":"string"},"tier":{"type":"string"},"prioritized_reason":{"type":"string"},"prioritized":{"type":"string"},"partner_id":{"type":"string"},"reference_case_id":{"type":"string"},"patient_exam_id":{"type":"string"},"service_pdf_exported":{"type":"string"},"case_type":{"type":"string"},"is_chargeable":{"type":"string"},"is_upsell_generated":{"type":"string"},"charged_by":{"type":"string"},"is_sync":{"type":"string"},"is_video_consult_required":{"type":"string"},"case_status":{"type":"object","properties":{"name":{"type":"string"},"reason":{"type":"string"},"updated_at":{"type":"string"},"created_at":{"type":"string"}},"required":["name","reason","updated_at","created_at"]},"created_at":{"type":"string"},"patient":{"type":"object","properties":{"patient_id":{"type":"string"},"date_of_birth":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"external_id":{"type":"string"},"metadata":{"type":"string"},"gender":{"type":"string"},"gender_label":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"pregnancy":{"type":"string"},"address":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"address_id":{"type":"string"},"address":{"type":"string"},"address2":{"type":"string"},"city_name":{"type":"string"},"zip_code":{"type":"string"},"state":{"type":"object","properties":{"state_id":{"type":"string"},"abbreviation":{"type":"string"},"name":{"type":"string"},"is_sync":{"type":"string"},"country":{"type":"object","properties":{"state_id":{"type":"string"},"abbreviation":{"type":"string"}},"required":["state_id","abbreviation"]}},"required":["state_id","abbreviation","name","is_sync","country"]}},"required":["address_id","address","address2","city_name","zip_code","state"]}]}},"required":["patient_id","date_of_birth","first_name","last_name","external_id","metadata","gender","gender_label","email","phone_number","pregnancy","address"]},"case_assignment":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"created_at":{"type":"string"},"reason":{"type":"string"},"clinician_id":{"type":"string"},"clinician":{"anyOf":[{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},{"type":"object","properties":{"clinician_id":{"type":"string"},"clinician_specialty":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"full_name":{"type":"string"},"is_online":{"type":"string"},"photo":{"type":["object","null"],"properties":{"url_thumbnail":{"type":"string"}},"required":["url_thumbnail"]}},"required":["clinician_id","clinician_specialty","first_name","last_name","full_name","is_online","photo"]}]}},"required":["created_at","reason","clinician_id","clinician"]}]},"case_prescriptions":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},"case_offerings":{"type":"array","items":{"type":"object","properties":{"case_offering_id":{"type":"string"},"case_prescription_id":{"type":"string"},"is_important":{"type":"string"},"order":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"}},"required":["case_offering_id","case_prescription_id","is_important","order","name","title"]}},"case_services":{"type":"string"},"diseases":{"type":"string"},"tags":{"type":"string"},"orders":{"type":"string"}},"required":["case_id","external_id","metadata","is_additional_approval_needed","prioritized_at","programs","tier","prioritized_reason","prioritized","partner_id","reference_case_id","patient_exam_id","service_pdf_exported","case_type","is_chargeable","is_upsell_generated","charged_by","is_sync","case_status","created_at","patient","case_assignment","case_prescriptions","case_offerings","case_services","diseases","tags","orders"],"title":"CaseByStatusResource"},"CaseOfferingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"case_offering_id":{"type":"string"},"title":{"type":"string"},"name":{"type":"string"},"directions":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"},"status":{"type":"string"},"status_details":{"type":"string"},"has_recommendations":{"type":"string"},"recommendation_message":{"type":["string","null"],"description":"virtual attribute from CasePrescription model"},"store_url":{"type":["string","null"],"description":"virtual attribute from Offering model"},"product_name":{"type":["string","null"],"description":"virtual attribute from Offering model"},"image_file_id":{"type":["string","null"],"description":"virtual attribute from Offering model"},"order":{"type":"string","description":"virtual attribute from Offering model"},"upcharged":{"type":"string"},"offering_cost":{"type":"string"},"clinician_extra_fee":{"type":"string"},"is_important":{"type":"string"},"offerable_type":{"type":"string"},"offerable_id":{"type":"string"},"order_status":{"type":"string"},"order_date":{"type":"string"},"order_details":{"type":"string"},"order_updated":{"type":"string"},"programs":{"type":"string"},"external_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"submitted_at":{"type":"string"},"product":{"type":"string"},"product_id":{"type":["string","null"]},"product_type":{"type":["string","null"]},"diseases":{"type":"array","items":{"$ref":"#/components/schemas/DiseaseResource"}}},"required":["id","case_offering_id","title","name","directions","is_additional_approval_needed","thank_you_note","clinical_note","status","status_details","has_recommendations","recommendation_message","store_url","product_name","image_file_id","order","upcharged","offering_cost","clinician_extra_fee","is_important","offerable_type","offerable_id","order_status","order_date","order_details","order_updated","programs","external_id","created_at","updated_at","deleted_at","submitted_at","product","product_id","product_type","diseases"],"title":"CaseOfferingResource"},"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"}}}} ``` ## The PatientOrderTrackingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientOrderTrackingResource":{"type":"object","properties":{"number":{},"company":{},"link":{},"shipping_price":{}},"required":["number","company","link","shipping_price"],"title":"PatientOrderTrackingResource"}}}} ``` ## The PatientPreferredPharmacyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientPreferredPharmacyResource":{"type":"object","properties":{"patient_id":{"type":"string"},"pharmacy_id":{"type":"integer"},"name":{"type":"string"},"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip_code":{"type":["string","null"]},"primary_phone":{"type":["string","null"]},"primary_phone_type":{"type":["string","null"]},"primary_fax":{"type":["string","null"]},"enabled":{"type":"string"},"id":{"type":"integer","description":"keeping compatibility"},"phone_additional_1":{"type":"null"},"phone_additional_type_1":{"type":"integer"},"phone_additional_2":{"type":"null"},"phone_additional_type_2":{"type":"integer"},"phone_additional_3":{"type":"null"},"phone_additional_type_3":{"type":"integer"},"pharmacy_specialties":{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false},"service_level":{"type":"null"},"latitude":{"type":"null"},"longitude":{"type":"null"}},"required":["patient_id","pharmacy_id","name","address1","address2","city","state","zip_code","primary_phone","primary_phone_type","primary_fax","enabled","id","phone_additional_1","phone_additional_type_1","phone_additional_2","phone_additional_type_2","phone_additional_3","phone_additional_type_3","pharmacy_specialties","service_level","latitude","longitude"],"title":"PatientPreferredPharmacyResource"}}}} ``` ## The PatientResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientResource":{"type":"object","properties":{"patient_id":{"type":"string"},"partner_id":{"type":"string"},"prefix":{"type":["string","null"]},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"external_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"email":{"type":"string"},"weight":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"height":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"active":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"allergies":{"type":"string"},"pregnancy":{"type":"string"},"ssn":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"is_live":{"type":"string"},"exam_id":{"type":"string"},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"clinician_id":{"type":["string","null"]},"dosespot":{"type":"string"},"clinician":{"$ref":"#/components/schemas/ClinicianResource"},"partner":{"$ref":"#/components/schemas/PartnerResource"},"driver_license":{"$ref":"#/components/schemas/DriverLicenseResource"},"address":{"$ref":"#/components/schemas/AddressResource"},"auth_link":{"type":"string"},"intro_video":{"$ref":"#/components/schemas/FileResource"},"patient_auth":{"anyOf":[{"type":"object","properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"},"expires_in":{"type":"string"},"token_type":{"type":"string"}},"required":["access_token","refresh_token","expires_in","token_type"]},{"type":"object","properties":{"access_token":{"type":"null"},"refresh_token":{"type":"null"},"expires_in":{"type":"null"},"token_type":{"type":"null"}},"required":["access_token","refresh_token","expires_in","token_type"]}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"shopify_customer_id":{"type":"string"},"woocommerce_customer_id":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]}},"required":["patient_id","partner_id","prefix","first_name","middle_name","last_name","external_id","metadata","email","weight","blood_pressure","body_temperature","oxygen_saturation","special_necessities","height","date_of_birth","gender","gender_label","active","phone_number","phone_type","current_medications","medical_conditions","allergies","pregnancy","ssn","created_at","is_live","exam_id","recent_encounter_id","important_offering_case_id","clinician_id","dosespot","partner","driver_license","address","intro_video","tags","metafields","is_sms_enabled","is_email_enabled","shopify_customer_id","woocommerce_customer_id","original_patient_id","status"],"title":"PatientResource"},"ClinicianResource":{"type":"object","properties":{"clinician_id":{"type":"string"},"is_online":{"type":"string"},"specialty":{"type":["string","null"]},"full_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"date_of_birth":{"type":["string","null"]},"phone_number":{"type":"string","const":"(629) 777-5752"},"phone_type":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"active":{"type":"string"},"managed_by_partner":{"type":"string"},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"photo":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"signature":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"npdb":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"w9form_file":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"address":{"$ref":"#/components/schemas/AddressResource"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/PartnerResource"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleResource"}},"dosespot":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionResource"}},"bio_details":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"out_of_office_message":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file":{"$ref":"#/components/schemas/FileResource"},"thank_you_video_file":{"$ref":"#/components/schemas/FileResource"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"epcs_requested":{"anyOf":[{"type":"string"},{"type":"null"},{"type":"boolean"}]},"epcs_status":{"type":["string","null"]}},"required":["clinician_id","is_online","specialty","full_name","first_name","last_name","suffix","email","date_of_birth","phone_number","phone_type","fax_number","profile_url","active","managed_by_partner","case_assignment_availability","is_video_call_available","is_message_availability","photo","bio_details","is_out_of_office","out_of_office_at","out_of_office_return_at","out_of_office_message","automatic_sync_message","automatic_sync_video_file","thank_you_video_file","metafields","epcs_requested","epcs_status"],"title":"ClinicianResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"AddressResource":{"type":"object","properties":{"address":{"type":"string"},"address2":{"type":["string","null"]},"address_id":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["address","address2","address_id","zip_code","city_name","state"],"title":"AddressResource"},"PartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"support_message_capability":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"provides_medications":{"type":"string"},"partner_notes":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"customer_support_email":{"type":["string","null"]},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"can_unlock_phi":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"reassignment_interval":{"type":"integer"},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"business_model":{"type":"string"},"customization":{"type":"string"},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"parent_partner_id":{"type":["string","null"]},"integration_type":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"image":{"type":["object","null"],"description":"It's called \"logo\" in other resource;","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"metadata":{"type":["array","null"],"items":{}}},"required":["file_id","path","name","mime_type","url","url_thumbnail","created_at","metadata"]}},"required":["partner_id","notification_priority","notification_schedule","is_patient_identity_verified","name","customer_support_email","operation_country","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_ai_auto_summary_enabled","is_sending_tracking_number_enabled","enable_icd_bmi","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","customization","vouched_integration_type","parent_partner_id","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","image"],"title":"PartnerResource"},"RoleResource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"RoleResource"},"PermissionResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"}},"required":["name"],"title":"PermissionResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"DriverLicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"DriverLicenseResource"}}}} ``` ## The PatientSubscriptionBillingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientSubscriptionBillingResource":{"type":"object","properties":{"card_id":{},"issuer":{},"type":{},"expire_date":{"anyOf":[{"type":"array","items":{}},{"type":"string"},{"type":"null"}]}},"required":["card_id","issuer","type","expire_date"],"title":"PatientSubscriptionBillingResource"}}}} ``` ## The PatientSubscriptionMetadataResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientSubscriptionMetadataResource":{"type":"object","properties":{"key":{},"value":{}},"required":["key","value"],"title":"PatientSubscriptionMetadataResource"}}}} ``` ## The PatientSubscriptionProductResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientSubscriptionProductResource":{"type":"object","properties":{"name":{},"image_url":{},"description":{},"offering_id":{}},"required":["name","image_url","description","offering_id"],"title":"PatientSubscriptionProductResource"}}}} ``` ## The PatientSubscriptionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PatientSubscriptionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"description":{"type":["string","null"]},"status":{"type":"string"},"renew_period":{"type":["integer","null"]},"encounter_period":{"type":["integer","null"]},"price":{"type":"number"},"category":{"type":["string","null"]},"billing":{"anyOf":[{"$ref":"#/components/schemas/PatientSubscriptionBillingResource"},{"type":"null"}]},"products":{"type":"array","items":{"$ref":"#/components/schemas/PatientSubscriptionProductResource"}},"metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PatientSubscriptionMetadataResource"}},"patient_id":{"type":["string","null"]},"partner_id":{"type":["string","null"]},"subscription_created_at":{"type":"string"},"cancelled_at":{"type":["string","null"]},"expires_at":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"patient":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.PatientResource"},"partner":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.PartnerResource"},"orders":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PatientOrderResource flattened to avoid an unbounded self-referential schema; see components.schemas.PatientOrderResource for the full shape."}}},"required":["id","title","description","status","renew_period","encounter_period","price","category","billing","products","metadata","patient_id","partner_id","subscription_created_at","cancelled_at","expires_at","created_at","updated_at","deleted_at"],"title":"PatientSubscriptionResource"},"PatientSubscriptionBillingResource":{"type":"object","properties":{"card_id":{},"issuer":{},"type":{},"expire_date":{"anyOf":[{"type":"array","items":{}},{"type":"string"},{"type":"null"}]}},"required":["card_id","issuer","type","expire_date"],"title":"PatientSubscriptionBillingResource"},"PatientSubscriptionProductResource":{"type":"object","properties":{"name":{},"image_url":{},"description":{},"offering_id":{}},"required":["name","image_url","description","offering_id"],"title":"PatientSubscriptionProductResource"},"PatientSubscriptionMetadataResource":{"type":"object","properties":{"key":{},"value":{}},"required":["key","value"],"title":"PatientSubscriptionMetadataResource"},"App.Http.Resources.PatientResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":"string"},"ssn":{"type":["string","null"]},"active":{"type":"string"},"prefix":{"type":["string","null"]},"weight":{"type":"string"},"height":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"address_id":{"type":"string"},"driver_license_id":{"type":["string","null"]},"allergies":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"pregnancy":{"type":"string"},"partner_id":{"type":"string"},"environment_id":{"type":"string"},"clinician_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"intro_video_file_id":{"type":["string","null"]},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]},"patient_id":{"type":"string","description":"Appended Attributes;"},"full_name":{"type":"string"},"abbreviated_name":{"type":"string"},"is_live":{"type":"string"},"intro_video_id":{"type":"string"},"exam_id":{"type":"string"},"dosespot":{"type":"string"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"shopify_customer_id":{"type":"string"},"address":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"clinician":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.ClinicianResource"},"driver_license":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"environment":{"description":"When loaded;","$ref":"#/components/schemas/EnvironmentResource"},"intro_video":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","first_name","middle_name","last_name","email","ssn","active","prefix","weight","height","blood_pressure","body_temperature","oxygen_saturation","special_necessities","date_of_birth","gender","gender_label","phone_number","phone_type","address_id","driver_license_id","allergies","current_medications","medical_conditions","pregnancy","partner_id","environment_id","clinician_id","metadata","intro_video_file_id","recent_encounter_id","important_offering_case_id","created_at","updated_at","deleted_at","is_sms_enabled","is_email_enabled","original_patient_id","status","patient_id","full_name","abbreviated_name","is_live","intro_video_id","exam_id","dosespot","metafields","shopify_customer_id"],"title":"App.Http.Resources.PatientResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"App.Http.Resources.AddressResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"address":{"type":"string"},"address2":{"type":["string","null"]},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state_id":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.StateResource"}},"required":["id","address","address2","zip_code","city_name","state_id","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.AddressResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"App.Http.Resources.ClinicianResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":["string","null"]},"photo_id":{"type":["string","null"]},"url_thumbnail":{"type":["string","null"]},"active":{"type":"string"},"bio_details":{"type":["string","null"]},"date_of_birth":{"type":["string","null"]},"address_id":{"type":["string","null"]},"specialty":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"signature_id":{"type":["string","null"]},"npdb_id":{"type":["string","null"]},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"timezone_id":{"type":["string","null"]},"passcode_id":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_message":{"type":["string","null"]},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file_id":{"type":["string","null"]},"thank_you_video_file_id":{"type":["string","null"]},"w9form_file_id":{"type":["string","null"]},"managed_by_partner":{"type":"string"},"epcs_requested":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"priority":{"type":"string"},"dosespot":{"type":"string"},"mfa_status":{"type":"string"},"licenses":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"address":{"description":"TODO improve this resource later moving it to microservice structure;","$ref":"#/components/schemas/App.Http.Resources.AddressResource"},"permissions":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"signature":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"npdb":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"automatic_sync_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"thank_you_video_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"w9form_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"offerings":{"type":"array","items":{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"pivot":{"type":"object","description":"Pivot Attributes (Offering);","properties":{"offering_id":{"type":"string"},"clinician_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["offering_id","clinician_id","type","created_at","updated_at"]},"clinician_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","first_name","last_name","suffix","email","phone_number","phone_type","photo_id","url_thumbnail","active","bio_details","date_of_birth","address_id","specialty","fax_number","profile_url","signature_id","npdb_id","case_assignment_availability","is_video_call_available","is_message_availability","timezone_id","passcode_id","is_out_of_office","out_of_office_message","out_of_office_at","out_of_office_return_at","automatic_sync_message","automatic_sync_video_file_id","thank_you_video_file_id","w9form_file_id","managed_by_partner","epcs_requested","created_at","updated_at","deleted_at","full_name","is_online","priority","mfa_status","metafields","clinician_id"],"title":"App.Http.Resources.ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"App.Http.Resources.PartnerResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"active":{"type":"string"},"logo_file_id":{"type":["string","null"]},"operation_country_id":{"type":"string"},"about":{"type":["string","null"]},"address_id":{"type":["string","null"]},"website_url":{"type":["string","null"]},"status":{"type":["string","null"]},"is_expedited":{"type":"string"},"customer_support_email":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"support_message_capability":{"type":["string","null"]},"support_hours":{"type":["string","null"]},"support_location":{"type":["string","null"]},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"business_model":{"type":"string"},"use_intake_form":{"type":"string"},"is_voucher_reminder":{"type":"string"},"reassignment_interval":{"type":"integer"},"invoice_due_days":{"type":"integer"},"invoice_minimum_charge":{"type":["string","null"]},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"use_messaging":{"type":"string"},"messaging_app_primary_color":{"type":["string","null"]},"messaging_app_secondary_color":{"type":["string","null"]},"messaging_app_background_color":{"type":["string","null"]},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"partner_notes":{"type":["string","null"]},"parent_partner_id":{"type":["string","null"]},"parent_partner":{"type":["string","null"]},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"charge_sync_new_case":{"type":"string"},"charge_async_new_case":{"type":"string"},"charge_sync_follow_up_case":{"type":"string"},"charge_async_follow_up_case":{"type":"string"},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"accepted_at":{"type":"string","format":"date-time"},"slack_channel_id":{"type":["string","null"]},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"shopify_id":{"type":"string"},"shopify_url":{"type":"string","description":"Keep for front-end compatibility"},"is_shopify_active":{"type":"boolean","description":"Keep for front-end compatibility"},"custom_theme":{"type":["string","null"],"description":"Keep for front-end compatibility"},"custom_style":{"type":["string","null"]},"review_notes":{"type":["string","null"]},"contract_file_id":{"type":["string","null"]},"insurance_file_id":{"type":["string","null"]},"is_receiving_patient_transfers":{"type":"string"},"is_sending_patient_transfers":{"type":"string"},"is_patient_workflow_notification_enabled":{"type":"string"},"is_workflow_email_sms_enabled":{"type":"string"},"integration_type":{"type":["string","null"]},"recommendation_pageview_charge_amount":{"type":["string","null"]},"recommendation_encounter_charge_amount":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamps;"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"integrations":{"type":"object","description":"external integrations","properties":{"woocommerce":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_name":{"type":"string"},"store_url":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_name","store_url","intake_flow"]},"boothwyn":{"type":["object","null"],"properties":{"api_key":{"type":"string"}},"required":["api_key"]},"shopify":{"type":["object","null"],"properties":{"id":{"type":"string"},"store_url":{"type":"string"},"environment":{"type":"string"},"intake_flow":{"type":"string"}},"required":["id","store_url","environment","intake_flow"]}},"required":["woocommerce","boothwyn","shopify"]},"is_support_auto_archive_email_enabled":{"type":"string"},"ai":{"type":"object","properties":{"tone":{"type":"string"}},"required":["tone"]},"partner_id":{"type":"string","description":"Appended Attributes;"},"parent_partner_name":{"type":["string","null"]},"contract_file":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},"insurance_file":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"logo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"specialties":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SpecialtyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SpecialtyResource for the full shape."}},"pricing_tiers":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to PricingTierResource flattened to avoid an unbounded self-referential schema; see components.schemas.PricingTierResource for the full shape."}},"pivot":{"type":"object","description":"Pivot Attributes (Panel User);","properties":{"partner_id":{"type":"string","description":"When loaded;"},"panel_user_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["partner_id","panel_user_id","created_at","updated_at","deleted_at"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","is_patient_identity_verified","name","active","logo_file_id","operation_country_id","about","address_id","website_url","status","is_expedited","customer_support_email","operations_support_email","escalation_support_email","patient_message_capability","support_message_capability","support_hours","support_location","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","is_ai_auto_summary_enabled","enable_icd_bmi","business_model","use_intake_form","is_voucher_reminder","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","use_messaging","messaging_app_primary_color","messaging_app_secondary_color","messaging_app_background_color","notification_priority","notification_schedule","partner_notes","parent_partner_id","parent_partner","thank_you_note_header","thank_you_note_footer","charge_sync_new_case","charge_async_new_case","charge_sync_follow_up_case","charge_async_follow_up_case","vouched_integration_type","vouched_integration_charge","text_message_integration_type","text_message_integration_charge","accepted_at","contract_file_id","insurance_file_id","is_receiving_patient_transfers","is_sending_patient_transfers","is_patient_workflow_notification_enabled","is_workflow_email_sms_enabled","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","created_at","updated_at","deleted_at","integrations","is_support_auto_archive_email_enabled","ai","partner_id","parent_partner_name"],"title":"App.Http.Resources.PartnerResource"}}}} ``` ## The PaymentAccountResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PaymentAccountResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"name":{"type":"string"},"public_key":{"type":"string"},"is_chargeable":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","partner_id","name","public_key","is_chargeable","created_at","updated_at","deleted_at"],"title":"PaymentAccountResource"}}}} ``` ## The PaymentResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PaymentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"status":{"type":"string"},"total":{"type":"number"},"partner_id":{"type":"string"},"patient_id":{"type":["string","null"]},"partner_questionnaire_id":{"type":["string","null"]},"partner_voucher_id":{"type":["string","null"]},"response":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","status","total","partner_id","patient_id","partner_questionnaire_id","partner_voucher_id","response","created_at","updated_at","deleted_at"],"title":"PaymentResource"}}}} ``` ## The PermissionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PermissionResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"}},"required":["name"],"title":"PermissionResource"}}}} ``` ## The PharmacyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PharmacyResource":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Attributes;"},"name":{"type":["string","null"]},"store_name":{"type":["string","null"]},"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip_code":{"type":["string","null"]},"primary_phone":{"type":["string","null"]},"primary_phone_type":{"type":["string","null"]},"primary_fax":{"type":["string","null"]},"phone_additional_1":{"type":["string","null"]},"phone_additional_type_1":{"type":["string","null"]},"phone_additional_2":{"type":["string","null"]},"phone_additional_type_2":{"type":["string","null"]},"phone_additional_3":{"type":["string","null"]},"phone_additional_type_3":{"type":["string","null"]},"pharmacy_specialties":{"type":["string","null"]},"service_level":{"type":["string","null"]},"latitude":{"type":["string","null"]},"longitude":{"type":["string","null"]}},"required":["id","name","store_name","address1","address2","city","state","zip_code","primary_phone","primary_phone_type","primary_fax","phone_additional_1","phone_additional_type_1","phone_additional_2","phone_additional_type_2","phone_additional_3","phone_additional_type_3","pharmacy_specialties","service_level","latitude","longitude"],"title":"PharmacyResource"}}}} ``` ## The PinnedEncounterResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PinnedEncounterResource":{"type":"object","properties":{"pinned_by":{"$ref":"#/components/schemas/ClinicianResource"},"pinned_to":{"$ref":"#/components/schemas/ClinicianResource"},"pinned_at":{"type":"string"},"reason":{"type":"string"}},"required":["pinned_by","pinned_to","pinned_at","reason"],"title":"PinnedEncounterResource"},"ClinicianResource":{"type":"object","properties":{"clinician_id":{"type":"string"},"is_online":{"type":"string"},"specialty":{"type":["string","null"]},"full_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"date_of_birth":{"type":["string","null"]},"phone_number":{"type":"string","const":"(629) 777-5752"},"phone_type":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"active":{"type":"string"},"managed_by_partner":{"type":"string"},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"photo":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"signature":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"npdb":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"w9form_file":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"address":{"$ref":"#/components/schemas/AddressResource"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/PartnerResource"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleResource"}},"dosespot":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionResource"}},"bio_details":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"out_of_office_message":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file":{"$ref":"#/components/schemas/FileResource"},"thank_you_video_file":{"$ref":"#/components/schemas/FileResource"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"epcs_requested":{"anyOf":[{"type":"string"},{"type":"null"},{"type":"boolean"}]},"epcs_status":{"type":["string","null"]}},"required":["clinician_id","is_online","specialty","full_name","first_name","last_name","suffix","email","date_of_birth","phone_number","phone_type","fax_number","profile_url","active","managed_by_partner","case_assignment_availability","is_video_call_available","is_message_availability","photo","bio_details","is_out_of_office","out_of_office_at","out_of_office_return_at","out_of_office_message","automatic_sync_message","automatic_sync_video_file","thank_you_video_file","metafields","epcs_requested","epcs_status"],"title":"ClinicianResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"AddressResource":{"type":"object","properties":{"address":{"type":"string"},"address2":{"type":["string","null"]},"address_id":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["address","address2","address_id","zip_code","city_name","state"],"title":"AddressResource"},"PartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"support_message_capability":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"provides_medications":{"type":"string"},"partner_notes":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"customer_support_email":{"type":["string","null"]},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"can_unlock_phi":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"reassignment_interval":{"type":"integer"},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"business_model":{"type":"string"},"customization":{"type":"string"},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"parent_partner_id":{"type":["string","null"]},"integration_type":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"image":{"type":["object","null"],"description":"It's called \"logo\" in other resource;","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"metadata":{"type":["array","null"],"items":{}}},"required":["file_id","path","name","mime_type","url","url_thumbnail","created_at","metadata"]}},"required":["partner_id","notification_priority","notification_schedule","is_patient_identity_verified","name","customer_support_email","operation_country","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_ai_auto_summary_enabled","is_sending_tracking_number_enabled","enable_icd_bmi","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","customization","vouched_integration_type","parent_partner_id","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","image"],"title":"PartnerResource"},"RoleResource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"RoleResource"},"PermissionResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"}},"required":["name"],"title":"PermissionResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"}}}} ``` ## The PostCaseDiseaseRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseDiseaseRequest":{"type":"object","properties":{"disease_id":{"type":"string","format":"uuid"}},"required":["disease_id"],"title":"PostCaseDiseaseRequest"}}}} ``` ## The PostCaseEventRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseEventRequest":{"type":"object","properties":{"event":{"type":"string","enum":["custom"]},"old":{"type":["string","null"]},"new":{"type":["string","null"]}},"required":["event"],"title":"PostCaseEventRequest"}}}} ``` ## The PostCasePrescriptionRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCasePrescriptionRequest":{"type":"object","properties":{"refills":{"type":"integer","maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":"number","minimum":0,"maximum":9999999999},"directions":{"type":"string","maxLength":1000},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":["integer","null"]},"dosespot_medication_id":{"type":"integer"},"partner_medication_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"},"partner_compound_id":{"type":"string","format":"uuid"},"offering_id":{"type":"string","format":"uuid"},"dosespot_supply_ndc":{"type":"string"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]},"order":{"type":["integer","null"],"minimum":1}},"title":"PostCasePrescriptionRequest"}}}} ``` ## The PostCaseQuestionRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseQuestionRequest":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":"boolean"},"is_critical":{"type":"boolean"},"display_in_pdf":{"type":"boolean"},"description":{"type":["string","null"]},"label":{"type":["string","null"],"maxLength":50},"displayed_options":{"type":["array","null"],"items":{"type":"string"}},"metadata":{"type":["string","null"]}},"required":["question","answer","type"],"title":"PostCaseQuestionRequest"}}}} ``` ## The PostCaseRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseRequest":{"type":"object","properties":{"case_id":{"type":["string","null"],"format":"uuid"},"reference_case_id":{"type":["string","null"],"format":"uuid"},"hold_status":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"patient_id":{"type":"string"},"clinician_id":{"type":"string","format":"uuid"},"external_id":{"type":["string","null"],"maxLength":255},"metadata":{"type":["string","null"],"maxLength":255},"is_chargeable":{"type":["boolean","null"]},"is_video_consult_required":{"type":["boolean","null"]},"is_test":{"type":["boolean","null"]},"programs":{"type":"array","items":{"type":"string"}},"case_files":{"type":"array","items":{"type":"string","format":"uuid"}},"case_prescriptions":{"type":"array","items":{"type":"object","properties":{"refills":{"type":"integer","maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":"number","minimum":0,"maximum":9999999999},"directions":{"type":"string","maxLength":1000},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":"integer"},"dosespot_medication_id":{"type":"integer"},"partner_medication_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"},"dosespot_supply_ndc":{"type":"string"},"partner_compound_id":{"type":"string","format":"uuid"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]},"effective_date":{"type":["string","null"],"format":"date"},"order":{"type":["integer","null"],"minimum":1},"is_insurance_check_needed":{"type":["boolean","null"]}}}},"case_offerings":{"type":"array","items":{"type":"object","properties":{"offering_id":{"type":"string","format":"uuid"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"is_additional_approval_needed":{"type":["boolean","null"]},"order":{"type":["integer","null"],"minimum":1}}}},"case_services":{"type":"array","items":{"type":"object","properties":{"partner_service_id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":["string","null"]},"clinical_notes":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":["boolean","null"]},"send_pdf_file_automatically":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"service_type":{"type":"string"},"order":{"type":["integer","null"],"minimum":1}}}},"tags":{"type":["array","null"],"items":{"type":"object","properties":{"tag_id":{"type":["string","null"],"format":"uuid"}}}},"case_questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":["boolean","null"]},"is_critical":{"type":["boolean","null"]},"display_in_pdf":{"type":["boolean","null"]},"displayed_options":{"type":["array","null"],"items":{"type":"string"}}},"required":["question","answer","type"]}},"diseases":{"type":["array","null"],"items":{"type":"object","properties":{"disease_id":{"type":["string","null"],"format":"uuid"}}}}},"required":["patient_id"],"title":"PostCaseRequest"}}}} ``` ## The PostCaseServiceRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseServiceRequest":{"type":"object","properties":{"partner_service_id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":["string","null"]},"clinical_notes":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":["boolean","null"]},"send_pdf_file_automatically":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"service_type":{"type":"string"},"order":{"type":["integer","null"],"minimum":1}},"title":"PostCaseServiceRequest"}}}} ``` ## The PostCaseStatusCancelledRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseStatusCancelledRequest":{"type":"object","properties":{"reason":{"type":["string","null"]}},"title":"PostCaseStatusCancelledRequest"}}}} ``` ## The PostCaseSupportRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCaseSupportRequest":{"type":"object","properties":{"reason":{"type":"string"}},"required":["reason"],"title":"PostCaseSupportRequest"}}}} ``` ## The PostClinicianEventRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostClinicianEventRequest":{"type":"object","properties":{"event":{"type":"string","enum":["unlock-phi","custom"]},"old":{"type":["string","null"]},"new":{"type":["string","null"]}},"required":["event"],"title":"PostClinicianEventRequest"}}}} ``` ## The PostCompoundRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostCompoundRequest":{"type":"object","properties":{"title":{"type":"string","maxLength":105},"name":{"type":"string","maxLength":105},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":["integer","null"]},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"quantity":{"type":"string","maxLength":11},"directions":{"type":"string","maxLength":1000},"days_supply":{"type":["integer","null"],"minimum":0,"maximum":365},"refills":{"type":"integer","minimum":0,"maximum":99},"allow_substitutions":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"clinical_note":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"order":{"type":"integer","minimum":1},"metadata":{"type":["string","null"],"maxLength":800},"effective_date":{"type":["integer","null"],"minimum":0,"maximum":999},"is_controlled_substance":{"type":["boolean","null"]},"schedule":{"type":["integer","null"],"minimum":1},"diseases":{"type":["array","null"],"items":{"type":"object","properties":{"disease_id":{"type":["string","null"],"format":"uuid"}}}}},"required":["title","dispense_unit_id","quantity","directions","refills"],"title":"PostCompoundRequest"}}}} ``` ## The PostEncounterPrescriptionRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostEncounterPrescriptionRequest":{"type":"object","properties":{"refills":{"type":"integer","description":"Payload;","maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":"number","minimum":0,"maximum":9999999999},"directions":{"type":"string","maxLength":1000},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":["integer","null"]},"dosespot_medication_id":{"type":"integer"},"partner_medication_id":{"type":"string","format":"uuid"},"partner_compound_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"},"offering_id":{"type":"string","format":"uuid"},"dosespot_supply_ndc":{"type":"string"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]}},"title":"PostEncounterPrescriptionRequest"}}}} ``` ## The PostEncounterReassingRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostEncounterReassingRequest":{"type":"object","properties":{"clinician_id":{"type":"string","format":"uuid","description":"Payload;"},"reason":{"type":"string"}},"required":["clinician_id","reason"],"title":"PostEncounterReassingRequest"}}}} ``` ## The PostEncounterRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostEncounterRequest":{"type":"object","properties":{"reference_case_id":{"type":["string","null"],"format":"uuid"},"hold_status":{"type":["boolean","null"]},"is_video_consult_required":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"patient_id":{"type":"string"},"clinician_id":{"type":"string","format":"uuid"},"metadata":{"type":["string","null"],"maxLength":255},"is_chargeable":{"type":["boolean","null"]},"programs":{"type":"array","items":{"type":"string"}},"case_files":{"type":"array","items":{"type":"string","format":"uuid"}},"case_questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":["boolean","null"]},"is_critical":{"type":["boolean","null"]},"display_in_pdf":{"type":["boolean","null"]},"displayed_options":{"type":["array","null"],"items":{"type":"string"}}},"required":["question","answer","type"]}},"case_prescriptions":{"type":"array","items":{"type":"object","properties":{"refills":{"type":"integer","maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":"number","minimum":0,"maximum":9999999999},"directions":{"type":"string","maxLength":1000},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":"integer"},"dosespot_medication_id":{"type":"integer"},"partner_medication_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"},"dosespot_supply_ndc":{"type":"string"},"partner_compound_id":{"type":"string","format":"uuid"},"offering_id":{"type":"string","format":"uuid"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]},"effective_date":{"type":["string","null"],"format":"date"},"is_insurance_check_needed":{"type":["boolean","null"]}}}},"case_services":{"type":"array","items":{"type":"object","properties":{"partner_service_id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":["string","null"]},"clinical_notes":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"send_pdf_file_automatically":{"type":["boolean","null"]},"service_type":{"type":["string","null"]}}}},"diseases":{"type":["array","null"],"items":{"type":"object","properties":{"disease_id":{"type":["string","null"],"format":"uuid"}}}},"tags":{"type":["array","null"],"items":{"type":"object","properties":{"tag_id":{"type":["string","null"],"format":"uuid"}}}}},"required":["patient_id"],"title":"PostEncounterRequest"}}}} ``` ## The PostEncounterStatusRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostEncounterStatusRequest":{"type":"object","properties":{"status":{"type":"string","description":"Payload;","enum":["approved","completed","support","processing","waiting","assigned","cancelled","resubmit"]},"reason":{"type":"string"},"clinician_id":{"type":"string","format":"uuid"}},"required":["status","clinician_id"],"title":"PostEncounterStatusRequest"}}}} ``` ## The PostFileRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostFileRequest":{"type":"object","properties":{"file":{"type":"string","format":"binary","contentMediaType":"application/octet-stream"},"type":{"type":["string","null"]},"name":{"type":["string","null"],"maxLength":255},"notify":{"type":["boolean","null"]},"case_id":{"type":["string","null"],"format":"uuid"}},"required":["file"],"title":"PostFileRequest"}}}} ``` ## The PostPartnerAuthRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPartnerAuthRequest":{"type":"object","properties":{"client_id":{"type":["string","null"],"format":"uuid","description":"Nullable, not required: a client may instead send these as an\n`Authorization: Basic base64(client_id:client_secret)` header, the OAuth2\nRFC's other standard transport - AuthController::resolveClientCredentials()\nfalls back to it, and league/oauth2-server (via Passport) already validates\nwhichever transport is actually used regardless of this exists() check;"},"client_secret":{"type":["string","null"]},"grant_type":{"type":"string","enum":["client_credentials"]},"scope":{"type":"string"}},"required":["grant_type","scope"],"title":"PostPartnerAuthRequest"}}}} ``` ## The PostPartnerCaseNoteRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPartnerCaseNoteRequest":{"type":"object","properties":{"text":{"type":"string","maxLength":1000},"type":{"$ref":"#/components/schemas/CaseNoteType"}},"required":["text"],"title":"PostPartnerCaseNoteRequest"},"CaseNoteType":{"type":"string","enum":["clinical_note","communication","phone_video_memo","prescription_approval"],"title":"CaseNoteType"}}}} ``` ## The PostPartnerPatientPasscodeRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPartnerPatientPasscodeRequest":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"],"title":"PostPartnerPatientPasscodeRequest"}}}} ``` ## The PostPartnerPatientPasscodeVerifyRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPartnerPatientPasscodeVerifyRequest":{"type":"object","properties":{"verification_code":{"type":"string"},"email":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"}},"required":["verification_code","email"],"title":"PostPartnerPatientPasscodeVerifyRequest"}}}} ``` ## The PostPartnerVoucherRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPartnerVoucherRequest":{"type":"object","properties":{"patient_id":{"type":["string","null"],"format":"uuid"},"questionnaire_id":{"type":["string","null"],"format":"uuid"},"hold_status":{"type":["boolean","null"]},"demo":{"type":["boolean","null"]},"expires_at":{"type":["string","null"],"format":"date-time"},"prefilled_questions":{"type":["array","null"],"items":{"type":"object","properties":{"question_id":{"type":["string","null"],"format":"uuid"},"question":{"type":["string","null"]},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":["boolean","null"]},"is_critical":{"type":["boolean","null"]},"description":{"type":["string","null"]},"label":{"type":["string","null"],"maxLength":50},"displayed_options":{"type":["array","null"],"items":{"type":"string"}},"metadata":{"type":["string","null"]},"should_skip":{"type":["boolean","null"]}},"required":["answer","type"]}},"case_services":{"type":["array","null"],"items":{"type":"object","properties":{"partner_service_id":{"type":"string","format":"uuid"}},"required":["partner_service_id"]}},"case_prescriptions":{"type":["array","null"],"items":{"type":"object","properties":{"partner_medication_id":{"type":"string","format":"uuid"},"partner_compound_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"}}}},"offerings":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]}},"diseases":{"type":["array","null"],"items":{"type":"object","properties":{"disease_id":{"type":["string","null"],"format":"uuid"}}}}},"title":"PostPartnerVoucherRequest"}}}} ``` ## The PostPatientDataRequestRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPatientDataRequestRequest":{"type":"object","properties":{"patient_id":{"type":"string","format":"uuid"},"patient_email":{"type":"string"}},"title":"PostPatientDataRequestRequest"}}}} ``` ## The PostPatientMessageRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPatientMessageRequest":{"type":"object","properties":{"notified_model_type":{"type":"string","description":"Notification payload;"},"notified_model_id":{"type":["string","null"],"format":"uuid"},"files":{"type":"array","description":"Payload;","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}},"title":"PostPatientMessageRequest"}}}} ``` ## The PostPatientRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostPatientRequest":{"type":"object","properties":{"partner_id":{"type":["string","null"],"format":"uuid"},"is_live":{"type":["boolean","null"]},"prefix":{"type":["string","null"],"maxLength":10},"first_name":{"type":"string","maxLength":35},"middle_name":{"type":["string","null"],"maxLength":35},"last_name":{"type":"string","maxLength":35},"external_id":{"type":["string","null"],"maxLength":255},"metadata":{"type":["string","null"],"maxLength":255},"driver_license_id":{"type":["string","null"],"format":"uuid"},"email":{"type":"string","format":"email","maxLength":80},"gender":{"type":"integer"},"phone_type":{"type":"integer","enum":["2","4"]},"weight":{"type":["number","null"],"minimum":0,"maximum":999},"height":{"type":["number","null"],"minimum":0,"maximum":300},"current_medications":{"type":["string","null"]},"medical_conditions":{"type":["string","null"]},"allergies":{"type":["string","null"]},"pregnancy":{"type":["boolean","null"]},"blood_pressure":{"type":["string","null"],"maxLength":255},"body_temperature":{"type":["number","null"],"minimum":0,"maximum":100},"oxygen_saturation":{"type":["integer","null"],"minimum":0,"maximum":100},"special_necessities":{"type":["string","null"]},"ssn":{"type":["string","null"],"maxLength":11},"intro_video_id":{"type":["string","null"],"format":"uuid"},"is_email_enabled":{"type":["boolean","null"]},"is_sms_enabled":{"type":["boolean","null"]},"shopify_customer_id":{"type":"string","maxLength":255},"woocommerce_customer_id":{"type":"string","maxLength":255},"address":{"type":"object","properties":{"address":{"type":"string","maxLength":35},"address2":{"type":["string","null"],"maxLength":35},"zip_code":{"type":"string"},"city_id":{"type":"string","description":"TODO: remove this once city_id support is dropped."},"city_name":{"type":"string","maxLength":35},"state_name":{"type":"string"}},"required":["address","zip_code"]},"metafields":{"type":["array","null"],"items":{"type":"object","properties":{"scope":{"type":"string","maxLength":255},"key":{"type":"string","maxLength":255},"value":{"type":"string","maxLength":255},"type":{"type":["string","null"],"enum":["string","number","boolean"],"maxLength":255},"title":{"type":["string","null"],"maxLength":255}},"required":["key","value"]}}},"required":["first_name","last_name","email","gender","phone_type","address"],"title":"PostPatientRequest"}}}} ``` ## The PostVoucherPatientCaseRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PostVoucherPatientCaseRequest":{"type":"object","properties":{"preferred_pharmacy_id":{"type":["integer","null"]},"questionnaire_id":{"type":"string","format":"uuid"},"completion_time":{"type":"string","pattern":"^((?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$)"},"patient":{"type":"object","properties":{"prefix":{"type":["string","null"],"description":"00:00:00 pattern\npatient rules","maxLength":10},"first_name":{"type":"string","maxLength":35},"middle_name":{"type":["string","null"],"maxLength":35},"last_name":{"type":"string","maxLength":35},"metadata":{"type":["string","null"],"maxLength":255},"driver_license_id":{"type":["string","null"],"format":"uuid"},"email":{"type":"string","format":"email","maxLength":80},"gender":{"type":"integer"},"phone_type":{"type":"integer","enum":["2","4"]},"weight":{"type":["number","null"],"minimum":0,"maximum":999},"height":{"type":["number","null"],"minimum":0,"maximum":300},"current_medications":{"type":["string","null"]},"medical_conditions":{"type":["string","null"]},"allergies":{"type":["string","null"]},"pregnancy":{"type":["boolean","null"]},"is_sms_enabled":{"type":["boolean","null"]},"is_email_enabled":{"type":["boolean","null"]},"blood_pressure":{"type":["string","null"],"maxLength":255},"body_temperature":{"type":["number","null"],"minimum":0,"maximum":100},"oxygen_saturation":{"type":["integer","null"],"minimum":0,"maximum":100},"special_necessities":{"type":["string","null"]},"ssn":{"type":["string","null"],"maxLength":11},"intro_video_id":{"type":["string","null"],"format":"uuid"},"address":{"type":"object","properties":{"address":{"type":"string","maxLength":35},"address2":{"type":["string","null"],"maxLength":35},"zip_code":{"type":"string"},"city_name":{"type":"string","maxLength":35},"state_name":{"type":"string"}},"required":["address","zip_code"]}},"required":["first_name","last_name","email","gender","phone_type"]},"case":{"type":"object","properties":{"clinician_id":{"type":"string","format":"uuid","description":"case rules"},"metadata":{"type":["string","null"],"maxLength":255},"is_video_consult_required":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"case_questions":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"},"type":{"type":"string"},"important":{"type":["boolean","null"]},"is_critical":{"type":["boolean","null"]},"display_in_pdf":{"type":["boolean","null"]}},"required":["question","answer","type"]}},"case_files":{"type":"array","items":{"type":"string","format":"uuid"}},"case_prescriptions":{"type":"array","items":{"type":"object","properties":{"refills":{"type":"integer","maximum":99},"days_supply":{"type":["integer","null"],"maximum":365},"quantity":{"type":"number","minimum":0,"maximum":9999999999},"directions":{"type":"string","maxLength":1000},"dispense_unit_id":{"type":"integer"},"pharmacy_id":{"type":"integer"},"dosespot_medication_id":{"type":"integer"},"partner_medication_id":{"type":"string","format":"uuid"},"partner_compound_id":{"type":"string","format":"uuid"},"offering_id":{"type":"string","format":"uuid"},"partner_supply_id":{"type":"string","format":"uuid"},"supplydosespot_supply_ndc_ndc":{"type":"integer"},"pharmacy_notes":{"type":["string","null"],"maxLength":210},"no_substitutions":{"type":"boolean"},"is_additional_approval_needed":{"type":["boolean","null"]},"effective_date":{"type":["string","null"],"format":"date"},"is_insurance_check_needed":{"type":["boolean","null"]}}}},"case_services":{"type":"array","items":{"type":"object","properties":{"partner_service_id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":["string","null"]},"clinical_notes":{"type":["string","null"]},"thank_you_note":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":["boolean","null"]},"send_pdf_file_automatically":{"type":["boolean","null"]},"is_additional_approval_needed":{"type":["boolean","null"]},"service_type":{"type":["string","null"]}}}},"diseases":{"type":["array","null"],"items":{"type":"object","properties":{"disease_id":{"type":["string","null"],"format":"uuid"}}}},"tags":{"type":["array","null"],"items":{"type":"object","properties":{"tag_id":{"type":["string","null"],"format":"uuid"}}}}}}},"required":["questionnaire_id","completion_time","patient","case"],"title":"PostVoucherPatientCaseRequest"}}}} ``` ## The PracticeAreaResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"}}}} ``` ## The PrefilledQuestionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PrefilledQuestionResource":{"type":"object","properties":{"question_id":{"type":["string","null"]},"question":{"type":["string","null"]},"answer":{"type":["string","null"]},"type":{"type":["string","null"]},"important":{"type":["string","null"]},"is_critical":{"type":["string","null"]},"description":{"type":["string","null"]},"label":{"type":["string","null"]},"displayed_options":{"type":["string","null"]},"metadata":{"type":["string","null"]},"should_skip":{"type":["string","null"]}},"required":["question_id","question","answer","type","important","is_critical","description","label","displayed_options","metadata","should_skip"],"title":"PrefilledQuestionResource"}}}} ``` ## The PricingTierResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"PricingTierResource":{"type":"object","properties":{"id":{"type":"string"},"partner_id":{"type":"string"},"threshold":{"type":"integer"},"discount":{"type":"string"},"discount_type":{"type":"string"},"description":{"type":["string","null"]},"is_active":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"partner":{"type":"object","description":"Circular reference to App.Http.Resources.PartnerResource flattened to avoid an unbounded self-referential schema; see components.schemas.App.Http.Resources.PartnerResource for the full shape."}},"required":["id","partner_id","threshold","discount","discount_type","description","is_active","created_at","updated_at","deleted_at"],"title":"PricingTierResource"}}}} ``` ## The QuestionOptionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionOptionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_question_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"value":{"type":"string"},"order":{"type":"string"},"is_important":{"type":"string"},"is_critical":{"type":"string"},"is_show_additional_field":{"type":"string"},"icon_type":{"type":"string"},"icon":{"anyOf":[{"$ref":"#/components/schemas/App.Http.Resources.FileResource"},{"type":"string"}]},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"review":{"description":"Relationships; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"}},"required":["id","partner_questionnaire_question_id","active","title","value","order","is_important","is_critical","is_show_additional_field","icon_type","icon","replicated_from_id","created_at","updated_at","deleted_at"],"title":"QuestionOptionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"}}}} ``` ## The QuestionResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"placeholder":{"type":"string"},"is_important":{"type":"string"},"is_critical":{"type":"string"},"is_optional":{"type":"string"},"is_visible":{"type":"string"},"display_in_pdf":{"type":"string"},"has_next_button":{"type":"string"},"has_back_button":{"type":"string"},"mapped_to_field":{"type":"string"},"feed_ads":{"type":"string"},"type":{"type":"string"},"file_type":{"type":"string"},"order":{"type":"string"},"default_value":{"type":"string"},"is_pending_review":{"type":"string"},"rule_type":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"hold_status":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"options":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to QuestionOptionResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionOptionResource for the full shape."}},"rules":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to QuestionRuleResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionRuleResource for the full shape."}},"review":{"description":"When loaded; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"},"files":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}}},"required":["id","partner_questionnaire_id","active","title","description","label","placeholder","is_important","is_critical","is_optional","is_visible","display_in_pdf","has_next_button","has_back_button","mapped_to_field","feed_ads","type","file_type","order","default_value","is_pending_review","rule_type","replicated_from_id","created_at","updated_at","deleted_at","hold_status","is_additional_approval_needed"],"title":"QuestionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"}}}} ``` ## The QuestionRuleRequirementResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionRuleRequirementResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_question_rule_id":{"type":"string"},"active":{"type":"string"},"based_on":{"type":"string"},"required_question_id":{"type":"string"},"required_answer":{"type":"string"},"conditional_answer":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"review":{"description":"Relationships; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"}},"required":["id","partner_questionnaire_question_rule_id","active","based_on","required_question_id","required_answer","conditional_answer","replicated_from_id","created_at","updated_at","deleted_at"],"title":"QuestionRuleRequirementResource"}}}} ``` ## The QuestionRuleResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionRuleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_question_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"requirements":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to QuestionRuleRequirementResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionRuleRequirementResource for the full shape."}},"review":{"description":"When loaded; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"}},"required":["id","partner_questionnaire_question_id","active","title","type","replicated_from_id","created_at","updated_at","deleted_at"],"title":"QuestionRuleResource"}}}} ``` ## The QuestionnaireOfferingResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionnaireOfferingResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_id":{"type":"string"},"active":{"type":"string"},"offering_id":{"type":"string"},"rule_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"offering":{"description":"Appended; Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape.","type":"object"},"rules":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to QuestionnaireOfferingRuleResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingRuleResource for the full shape."}},"review":{"description":"When loaded; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"}},"required":["id","partner_questionnaire_id","active","offering_id","rule_type","created_at","updated_at","deleted_at"],"title":"QuestionnaireOfferingResource"}}}} ``` ## The QuestionnaireOfferingRuleRequirementResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionnaireOfferingRuleRequirementResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_offering_rule_id":{"type":"string"},"active":{"type":"string"},"based_on":{"type":"string"},"required_question_id":{"type":"string"},"required_answer":{"type":"string"},"conditional_answer":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"review":{"description":"Relationships; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"}},"required":["id","partner_questionnaire_offering_rule_id","active","based_on","required_question_id","required_answer","conditional_answer","created_at","updated_at","deleted_at"],"title":"QuestionnaireOfferingRuleRequirementResource"}}}} ``` ## The QuestionnaireOfferingRuleResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionnaireOfferingRuleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_questionnaire_offering_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"requirements":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to QuestionnaireOfferingRuleRequirementResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingRuleRequirementResource for the full shape."}},"review":{"description":"When loaded; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"}},"required":["id","partner_questionnaire_offering_id","active","title","type","created_at","updated_at","deleted_at"],"title":"QuestionnaireOfferingRuleResource"}}}} ``` ## The QuestionnaireProgressResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionnaireProgressResource":{"type":"object","additionalProperties":{},"title":"QuestionnaireProgressResource"}}}} ``` ## The QuestionnaireResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"QuestionnaireResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"specialty_id":{"type":"string"},"active":{"type":"string"},"name":{"type":"string"},"intro_title":{"type":"string"},"intro_description":{"type":"string"},"terms_of_service":{"type":"string"},"redirect_url":{"type":"string"},"redirect_title":{"type":"string"},"has_pharmacy":{"type":"string"},"is_weight_asked":{"type":"string"},"is_height_asked":{"type":"string"},"is_body_temperature_asked":{"type":"string"},"is_oxygen_saturation_asked":{"type":"string"},"ask_blood_pressure":{"type":"string"},"is_pending_review":{"type":"string"},"is_condensed_question":{"type":"string"},"is_show_welcome":{"type":"string"},"is_show_user":{"type":"string"},"is_show_thanks":{"type":"string"},"payment_type":{"type":"string"},"payment_account_id":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"questions_lang":{"type":"string"},"questions":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to QuestionResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionResource for the full shape."}},"offerings":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to QuestionnaireOfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingResource for the full shape."}},"review":{"description":"When loaded; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"},"payment_account":{"description":"When loaded;","anyOf":[{"$ref":"#/components/schemas/PaymentAccountResource"},{"type":"object","properties":{"id":{"type":"null"},"partner_id":{"type":"null"},"is_chargeable":{"type":"boolean"},"name":{"type":"string","const":"MDI Default"},"public_key":{"type":"string"},"created_at":{"type":"null"},"updated_at":{"type":"null"},"deleted_at":{"type":"null"}},"required":["id","partner_id","is_chargeable","name","public_key","created_at","updated_at","deleted_at"]}]}},"required":["id","partner_id","specialty_id","active","name","intro_title","intro_description","terms_of_service","redirect_url","redirect_title","has_pharmacy","is_weight_asked","is_height_asked","is_body_temperature_asked","is_oxygen_saturation_asked","ask_blood_pressure","is_pending_review","is_condensed_question","is_show_welcome","is_show_user","is_show_thanks","payment_type","payment_account_id","replicated_from_id","created_at","updated_at","deleted_at","questions_lang"],"title":"QuestionnaireResource"},"PaymentAccountResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"name":{"type":"string"},"public_key":{"type":"string"},"is_chargeable":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","partner_id","name","public_key","is_chargeable","created_at","updated_at","deleted_at"],"title":"PaymentAccountResource"}}}} ``` ## The ReviewResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"ReviewResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":["string","null"]},"model_type":{"type":"string"},"model_id":{"type":"string"},"parent_model_type":{"type":["string","null"]},"parent_model_id":{"type":["string","null"]},"action":{"type":"string"},"reviewed_at":{"type":["string","null"]},"reviewed_notes":{"type":["string","null"]},"status":{"type":["string","null"]},"applied_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"payload":{"type":"array","items":{}},"requester":{"type":"string","description":"Relationships;"},"reviewer":{"type":"string"},"user":{"type":"string","description":"Appended;"},"partner":{"type":"object","description":"Circular reference to App.Http.Resources.PartnerResource flattened to avoid an unbounded self-referential schema; see components.schemas.App.Http.Resources.PartnerResource for the full shape."},"model":{"description":"Partner\nRelationships;","anyOf":[{"type":"object","description":"Circular reference to QuestionnaireOfferingRuleRequirementResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingRuleRequirementResource for the full shape."},{"type":"object","description":"Circular reference to QuestionnaireOfferingRuleResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingRuleResource for the full shape."},{"type":"object","description":"Circular reference to QuestionnaireOfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingResource for the full shape."},{"type":"object","description":"Circular reference to QuestionRuleRequirementResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionRuleRequirementResource for the full shape."},{"type":"object","description":"Circular reference to QuestionRuleResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionRuleResource for the full shape."},{"type":"object","description":"Circular reference to QuestionOptionResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionOptionResource for the full shape."},{"type":"object","description":"Circular reference to QuestionResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionResource for the full shape."},{"type":"object","description":"Circular reference to QuestionnaireResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireResource for the full shape."},{"type":"object","description":"Circular reference to OfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.OfferingResource for the full shape."},{"type":"object","description":"Circular reference to App.Http.Resources.PartnerResource flattened to avoid an unbounded self-referential schema; see components.schemas.App.Http.Resources.PartnerResource for the full shape."}]}},"required":["id","partner_id","model_type","model_id","parent_model_type","parent_model_id","action","reviewed_at","reviewed_notes","status","applied_at","created_at","updated_at","deleted_at","payload"],"title":"ReviewResource"}}}} ``` ## The RoleResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"RoleResource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"RoleResource"}}}} ``` ## The SearchPatientRequest object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"SearchPatientRequest":{"type":"object","properties":{"partner_id":{"type":["string","null"],"format":"uuid"},"email":{"type":"string","format":"email"},"external_id":{"type":["string","null"],"maxLength":255},"search":{"type":"string"},"is_live":{"type":["boolean","null"]},"is_sandbox":{"type":["boolean","null"]},"page":{"type":["integer","null"]},"per_page":{"type":["integer","null"],"minimum":1,"maximum":1000}},"title":"SearchPatientRequest"}}}} ``` ## The ServiceResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"ServiceResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","title","service_type","description","additional_note","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","created_at","updated_at","deleted_at"],"title":"ServiceResource"}}}} ``` ## The SlackResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"SlackResource":{"type":"object","properties":{"success":{"type":"string","description":"Attributes;"},"slack_channel_id":{"type":["string","null"]},"error":{"type":["string","null"]}},"required":["success","slack_channel_id","error"],"title":"SlackResource"}}}} ``` ## The SpecialtyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"SpecialtyResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"is_public":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"model_type":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"specialty_id":{"type":"string"},"priority":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["model_type","model_id","specialty_id","priority","created_at","updated_at","deleted_at"]},"clinicians":{"type":"array","items":{"$ref":"#/components/schemas/ModelSpecialtyResource"}},"medications":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to MedicationResource flattened to avoid an unbounded self-referential schema; see components.schemas.MedicationResource for the full shape."}},"compounds":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to CompoundResource flattened to avoid an unbounded self-referential schema; see components.schemas.CompoundResource for the full shape."}},"services":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/ServiceResource"}},"supplies":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to SupplyResource flattened to avoid an unbounded self-referential schema; see components.schemas.SupplyResource for the full shape."}},"questionnaires":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to QuestionnaireResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireResource for the full shape."}}},"required":["id","title","is_public","created_at","updated_at","deleted_at"],"title":"SpecialtyResource"},"ModelSpecialtyResource":{"type":"object","properties":{"model_type":{"type":"string","description":"Attributes;"},"model_id":{"type":"string"},"specialty_id":{"type":"string"},"priority":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"]},"model":{"description":"Append;","$ref":"#/components/schemas/ModelSpecialty"}},"required":["model_type","model_id","specialty_id","priority","created_at","updated_at","deleted_at","model"],"title":"ModelSpecialtyResource"},"ModelSpecialty":{"type":"object","properties":{"model_type":{"type":"string"},"model_id":{"type":"string"},"specialty_id":{"type":"string"},"is_auto_replicate":{"type":"string"},"priority":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"]}},"required":["model_type","model_id","specialty_id","is_auto_replicate","priority","created_at","updated_at","deleted_at"],"title":"ModelSpecialty"},"ServiceResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"title":{"type":"string"},"service_type":{"type":"string"},"description":{"type":"string"},"additional_note":{"type":["string","null"]},"pharmacy_fax_number":{"type":["string","null"]},"include_drivers_license":{"type":"string"},"send_pdf_file_automatically":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","title","service_type","description","additional_note","pharmacy_fax_number","include_drivers_license","send_pdf_file_automatically","created_at","updated_at","deleted_at"],"title":"ServiceResource"}}}} ``` ## The StateResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"}}}} ``` ## The SupplyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"SupplyResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"specialty_id":{"type":"string"},"active":{"type":"string"},"title":{"type":"string"},"refills":{"type":"string"},"quantity":{"type":"string"},"days_supply":{"type":"string"},"directions":{"type":"string"},"name":{"type":"string"},"ndc":{"type":"string"},"effective_date":{"type":"string"},"dispense_unit":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"pharmacy_name":{"type":"string"},"force_pharmacy":{"type":"string"},"is_important":{"type":"string"},"dosespot_supply_id":{"type":"string"},"is_obsolete":{"type":"string"},"upc":{"type":"string"},"otc":{"type":"string"},"clinical_note":{"type":"string"},"pharmacy_notes":{"type":"string"},"thank_you_note":{"type":"string"},"order":{"type":"string"},"metadata":{"type":"string"},"upcharge":{"type":"string"},"offering_cost":{"type":"string"},"clinician_extra_fee":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"review":{"type":"object","description":"Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape."},"tags":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":["id","partner_id","specialty_id","active","title","refills","quantity","days_supply","directions","name","ndc","effective_date","dispense_unit","dispense_unit_id","is_additional_approval_needed","pharmacy_id","pharmacy_name","force_pharmacy","is_important","dosespot_supply_id","is_obsolete","upc","otc","clinical_note","pharmacy_notes","thank_you_note","order","metadata","upcharge","offering_cost","clinician_extra_fee","replicated_from_id","created_at","updated_at","deleted_at"],"title":"SupplyResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"}}}} ``` ## The SupportStaffResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"SupportStaffResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"photo_id":{"type":["string","null"]},"active":{"type":"string"},"timezone_id":{"type":["string","null"]},"personal_phone_number":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"full_name":{"type":"string","description":"Appended Attributes;"},"is_online":{"type":"string"},"can_unlock_phi":{"type":"string"},"permissions":{"type":"array","description":"Relationships;","items":{"$ref":"#/components/schemas/App.Http.Resources.PermissionResource"}},"photo":{"description":"When loaded;","$ref":"#/components/schemas/App.Http.Resources.FileResource"},"roles":{"type":"array","description":"When loaded;","items":{"$ref":"#/components/schemas/App.Http.Resources.RoleResource"}},"pivot":{"type":"object","description":"When loaded;\nPivot Attributes (Partner);","properties":{"clinician_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"can_unlock_phi":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["clinician_id","partner_id","can_unlock_phi","created_at","updated_at","deleted_at"]}},"required":["id","first_name","last_name","email","photo_id","active","timezone_id","personal_phone_number","created_at","updated_at","deleted_at","full_name","is_online","can_unlock_phi","photo"],"title":"SupportStaffResource"},"App.Http.Resources.PermissionResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"permission_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["permission_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.PermissionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"},"App.Http.Resources.RoleResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot Attributes (User);","properties":{"role_id":{"type":"string","description":"When loaded;"},"model_id":{"type":"string"},"model_type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["role_id","model_id","model_type","created_at","updated_at"]}},"required":["id","name","created_at","updated_at"],"title":"App.Http.Resources.RoleResource"}}}} ``` ## The TagResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"}}}} ``` ## The TaxonomyResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"TaxonomyResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"parent_taxonomy_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"fields":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.TagResource"}}},"required":[null,"value"]},{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/DiseaseResource"}}},"required":[null,"value"]},{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.StateResource"}}},"required":[null,"value"]},{"type":"object","properties":{"":{},"value":{"type":"array","items":{"$ref":"#/components/schemas/FaqResource"}}},"required":[null,"value"]},{}]}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"pivot":{"type":"object","description":"Pivot;","properties":{"taxonomy_id":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"},"applied_fields":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"}},"required":["taxonomy_id","model_type","model_id","applied_fields","created_at","updated_at","deleted_at"]},"taxonomies":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to TaxonomyResource flattened to avoid an unbounded self-referential schema; see components.schemas.TaxonomyResource for the full shape."}},"taxonomy_children":{"type":"array","items":{"type":"object","description":"Circular reference to TaxonomyResource flattened to avoid an unbounded self-referential schema; see components.schemas.TaxonomyResource for the full shape."}}},"required":["id","parent_taxonomy_id","type","name","description","color","fields","created_at","updated_at","deleted_at"],"title":"TaxonomyResource"},"App.Http.Resources.TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"auto_detach_status":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"notes":{"type":"string","description":"Appended Attributes;"},"pivot":{"type":"object","description":"Pivot Attributes (Model Tag);","properties":{"tag_id":{"type":"string","description":"When loaded;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"notes":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["tag_id","model_type","model_id","notes","created_at","updated_at"]}},"required":["id","name","key","description","color","type","removable_role","auto_detach_status","created_at","updated_at","deleted_at","notes"],"title":"App.Http.Resources.TagResource"},"DiseaseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"disease_id":{"type":"string"},"icd":{"type":"string"},"description":{"type":"string"},"dosespot_id":{"type":["integer","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"is_primary":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Compound);","properties":{"disease_id":{"type":"string","description":"When loaded;"},"partner_compound_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["disease_id","partner_compound_id","created_at","updated_at"]}},"required":["id","disease_id","icd","description","dosespot_id","created_at","updated_at","deleted_at"],"title":"DiseaseResource"},"App.Http.Resources.StateResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"country_id":{"type":"string"},"is_av_flow":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"expires_at":{"type":"string","description":"Appended Attributes;"},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"epcs_support":{"type":"string"},"license_number":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Clinician);","properties":{"state_id":{"type":"string","description":"When loaded;"},"clinician_id":{"type":"string"},"expires_at":{"type":"string"},"license_number":{"type":"string"},"is_sync":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["state_id","clinician_id","expires_at","license_number","is_sync","created_at","updated_at"]},"country":{"description":"Relationships;","$ref":"#/components/schemas/App.Http.Resources.CountryResource"}},"required":["id","name","abbreviation","country_id","is_av_flow","created_at","updated_at","deleted_at","expires_at","is_expired","is_sync","epcs_support","license_number"],"title":"App.Http.Resources.StateResource"},"App.Http.Resources.CountryResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"abbreviation":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","name","abbreviation","created_at","updated_at","deleted_at"],"title":"App.Http.Resources.CountryResource"},"FaqResource":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"questions":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/FaqQuestionResource"}},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}]},"files":{"type":"array","items":{"$ref":"#/components/schemas/App.Http.Resources.FileResource"}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","key","title","description","questions","created_at","updated_at","deleted_at"],"title":"FaqResource"},"FaqQuestionResource":{"type":"object","properties":{"question":{},"answer":{}},"required":["question","answer"],"title":"FaqQuestionResource"},"App.Http.Resources.FileResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"App.Http.Resources.FileResource"}}}} ``` ## The TempPartnerMedicationResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"TempPartnerMedicationResource":{"type":"object","properties":{"partner_medication_id":{"type":"string"},"effective_date":{"type":"string"},"allow_substitutions":{"type":"string"},"dosespot_rxcui":{"type":"string"},"is_insurance_check_needed":{"type":"string"},"dispensable_drug_id":{"type":"string"},"active":{"type":"string"},"ndc":{"type":"string"},"days_supply":{"type":"string"},"refills":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"strength":{"type":"string"},"directions":{"type":"string"},"quantity":{"type":"string"},"dispense_unit":{"type":"string"},"dispense_unit_id":{"type":"string"},"is_additional_approval_needed":{"type":"string"},"pharmacy_id":{"type":"string"},"pharmacy_name":{"type":"string"},"pharmacy_notes":{"type":"string"},"order":{"type":"string"},"metadata":{"type":"string"},"thank_you_note":{"type":"string"},"clinical_note":{"type":"string"}},"required":["partner_medication_id","effective_date","allow_substitutions","dosespot_rxcui","is_insurance_check_needed","dispensable_drug_id","active","ndc","days_supply","refills","name","title","strength","directions","quantity","dispense_unit","dispense_unit_id","is_additional_approval_needed","pharmacy_id","pharmacy_name","pharmacy_notes","order","metadata","thank_you_note","clinical_note"],"title":"TempPartnerMedicationResource"}}}} ``` ## The VoucherResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"VoucherResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"status":{"type":"string","enum":["other","pending","in_progress","expired","completed"]},"partner_id":{"type":"string"},"case_id":{"type":"string"},"partner_questionnaire_id":{"type":"string"},"environment_id":{"type":"string"},"expires_at":{"type":"string"},"payload":{"type":"string"},"demo":{"type":"string"},"pharmacy_id":{"type":"string"},"pharmacy_name":{"type":"string"},"prefilled_questions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PrefilledQuestionResource"}},"metadata":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"partner_voucher_id":{"type":"string","description":"compatibility attributes;"},"expired":{"type":"string"},"questionnaire_progress":{"$ref":"#/components/schemas/QuestionnaireProgressResource"},"is_expired":{"type":"string","description":"Appended Attributes;"},"onboarding_url":{"type":"string"},"partner":{"$ref":"#/components/schemas/PatientAppPartnerResource"},"patient":{"description":"When loaded;","$ref":"#/components/schemas/PatientResource"},"questionnaire":{"description":"it comes from the controller;","$ref":"#/components/schemas/QuestionnaireResource"},"environment":{"$ref":"#/components/schemas/EnvironmentResource"},"payment":{"$ref":"#/components/schemas/PaymentResource"}},"required":["id","status","partner_id","case_id","partner_questionnaire_id","environment_id","expires_at","payload","demo","pharmacy_id","pharmacy_name","prefilled_questions","metadata","created_at","updated_at","deleted_at","partner_voucher_id","expired","questionnaire_progress","is_expired","onboarding_url"],"title":"VoucherResource"},"PrefilledQuestionResource":{"type":"object","properties":{"question_id":{"type":["string","null"]},"question":{"type":["string","null"]},"answer":{"type":["string","null"]},"type":{"type":["string","null"]},"important":{"type":["string","null"]},"is_critical":{"type":["string","null"]},"description":{"type":["string","null"]},"label":{"type":["string","null"]},"displayed_options":{"type":["string","null"]},"metadata":{"type":["string","null"]},"should_skip":{"type":["string","null"]}},"required":["question_id","question","answer","type","important","is_critical","description","label","displayed_options","metadata","should_skip"],"title":"PrefilledQuestionResource"},"QuestionnaireProgressResource":{"type":"object","additionalProperties":{},"title":"QuestionnaireProgressResource"},"PatientAppPartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"name":{"type":"string"},"customer_support_email":{"type":"string"},"business_model":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"image":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"customization":{"type":"string"},"vouched_integration_type":{"type":"string"},"is_patient_identity_verified":{"type":"string"},"custom_theme":{"type":"string"},"custom_style":{"type":"string"},"integration_type":{"type":"string"},"patient_portal_config_page":{"type":"string"},"custom_domains":{"type":"array","items":{"$ref":"#/components/schemas/CustomDomainResource"}}},"required":["partner_id","name","customer_support_email","business_model","enable_av_flow","is_auto_dl_flow","is_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_sending_tracking_number_enabled","operation_country","image","customization","vouched_integration_type","is_patient_identity_verified","custom_theme","custom_style","integration_type","patient_portal_config_page","custom_domains"],"title":"PatientAppPartnerResource"},"CountryResource":{"type":"object","properties":{"country_id":{"type":"string"},"name":{"type":"string"},"abbreviation":{"type":"string"}},"required":["country_id","name","abbreviation"],"title":"CountryResource"},"FileResource":{"type":"object","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"case_id":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}}},"required":["file_id","path","name","type","mime_type","url","url_thumbnail","metadata","created_at","updated_at"],"title":"FileResource"},"TagResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"notes":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"description":{"type":["string","null"]},"color":{"type":"string"},"type":{"type":"string"},"removable_role":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["id","notes","name","key","description","color","type","removable_role","created_at","updated_at"],"title":"TagResource"},"CustomDomainResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes"},"custom_domain":{"type":"string"}},"required":["id","custom_domain"],"title":"CustomDomainResource"},"PatientResource":{"type":"object","properties":{"patient_id":{"type":"string"},"partner_id":{"type":"string"},"prefix":{"type":["string","null"]},"first_name":{"type":"string"},"middle_name":{"type":["string","null"]},"last_name":{"type":"string"},"external_id":{"type":["string","null"]},"metadata":{"type":["string","null"]},"email":{"type":"string"},"weight":{"type":"string"},"blood_pressure":{"type":"string"},"body_temperature":{"type":"string"},"oxygen_saturation":{"type":"string"},"special_necessities":{"type":"string"},"height":{"type":"string"},"date_of_birth":{"type":"string"},"gender":{"type":"integer"},"gender_label":{"type":"string"},"active":{"type":"string"},"phone_number":{"type":["string","null"]},"phone_type":{"type":"string"},"current_medications":{"type":"string"},"medical_conditions":{"type":"string"},"allergies":{"type":"string"},"pregnancy":{"type":"string"},"ssn":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"is_live":{"type":"string"},"exam_id":{"type":"string"},"recent_encounter_id":{"type":["string","null"]},"important_offering_case_id":{"type":["string","null"]},"clinician_id":{"type":["string","null"]},"dosespot":{"type":"string"},"clinician":{"$ref":"#/components/schemas/ClinicianResource"},"partner":{"$ref":"#/components/schemas/PartnerResource"},"driver_license":{"$ref":"#/components/schemas/DriverLicenseResource"},"address":{"$ref":"#/components/schemas/AddressResource"},"auth_link":{"type":"string"},"intro_video":{"$ref":"#/components/schemas/FileResource"},"patient_auth":{"anyOf":[{"type":"object","properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"},"expires_in":{"type":"string"},"token_type":{"type":"string"}},"required":["access_token","refresh_token","expires_in","token_type"]},{"type":"object","properties":{"access_token":{"type":"null"},"refresh_token":{"type":"null"},"expires_in":{"type":"null"},"token_type":{"type":"null"}},"required":["access_token","refresh_token","expires_in","token_type"]}]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResource"}},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"is_sms_enabled":{"type":"string"},"is_email_enabled":{"type":"string"},"shopify_customer_id":{"type":"string"},"woocommerce_customer_id":{"type":"string"},"original_patient_id":{"type":["string","null"]},"status":{"type":["string","null"]}},"required":["patient_id","partner_id","prefix","first_name","middle_name","last_name","external_id","metadata","email","weight","blood_pressure","body_temperature","oxygen_saturation","special_necessities","height","date_of_birth","gender","gender_label","active","phone_number","phone_type","current_medications","medical_conditions","allergies","pregnancy","ssn","created_at","is_live","exam_id","recent_encounter_id","important_offering_case_id","clinician_id","dosespot","partner","driver_license","address","intro_video","tags","metafields","is_sms_enabled","is_email_enabled","shopify_customer_id","woocommerce_customer_id","original_patient_id","status"],"title":"PatientResource"},"ClinicianResource":{"type":"object","properties":{"clinician_id":{"type":"string"},"is_online":{"type":"string"},"specialty":{"type":["string","null"]},"full_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"suffix":{"type":["string","null"]},"email":{"type":"string"},"date_of_birth":{"type":["string","null"]},"phone_number":{"type":"string","const":"(629) 777-5752"},"phone_type":{"type":["string","null"]},"fax_number":{"type":["string","null"]},"profile_url":{"type":["string","null"]},"active":{"type":"string"},"managed_by_partner":{"type":"string"},"case_assignment_availability":{"type":"string"},"is_video_call_available":{"type":"boolean"},"is_message_availability":{"type":"string"},"photo":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicenseResource"}},"practice_areas":{"type":"array","items":{"$ref":"#/components/schemas/PracticeAreaResource"}},"signature":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"npdb":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"w9form_file":{"anyOf":[{"$ref":"#/components/schemas/FileResource"},{"type":"null"}]},"address":{"$ref":"#/components/schemas/AddressResource"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/PartnerResource"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleResource"}},"dosespot":{"type":"string"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionResource"}},"bio_details":{"type":["string","null"]},"is_out_of_office":{"type":"string"},"out_of_office_at":{"type":["string","null"]},"out_of_office_return_at":{"type":["string","null"]},"out_of_office_message":{"type":["string","null"]},"automatic_sync_message":{"type":["string","null"]},"automatic_sync_video_file":{"$ref":"#/components/schemas/FileResource"},"thank_you_video_file":{"$ref":"#/components/schemas/FileResource"},"metafields":{"type":"array","items":{"$ref":"#/components/schemas/MetafieldResource"}},"epcs_requested":{"anyOf":[{"type":"string"},{"type":"null"},{"type":"boolean"}]},"epcs_status":{"type":["string","null"]}},"required":["clinician_id","is_online","specialty","full_name","first_name","last_name","suffix","email","date_of_birth","phone_number","phone_type","fax_number","profile_url","active","managed_by_partner","case_assignment_availability","is_video_call_available","is_message_availability","photo","bio_details","is_out_of_office","out_of_office_at","out_of_office_return_at","out_of_office_message","automatic_sync_message","automatic_sync_video_file","thank_you_video_file","metafields","epcs_requested","epcs_status"],"title":"ClinicianResource"},"LicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"clinician_id":{"type":"string"},"state_id":{"type":["string","null"]},"type":{"type":"string"},"value":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"state":{"description":"Relationships;","$ref":"#/components/schemas/StateResource"},"license_id":{"type":"string","description":"keep compatibility;"}},"required":["id","clinician_id","state_id","type","value","created_at","updated_at","deleted_at","license_id"],"title":"LicenseResource"},"StateResource":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"},"state_id":{"type":"string"},"is_sync":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryResource"},"is_av_flow":{"type":"string"}},"required":["name","abbreviation","state_id","is_sync","country","is_av_flow"],"title":"StateResource"},"PracticeAreaResource":{"type":"object","properties":{"expires_at":{"type":["string","null"]},"is_expired":{"type":"string"},"is_sync":{"type":"string"},"license_number":{"type":"string"},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["expires_at","is_expired","is_sync","license_number","state"],"title":"PracticeAreaResource"},"AddressResource":{"type":"object","properties":{"address":{"type":"string"},"address2":{"type":["string","null"]},"address_id":{"type":"string"},"zip_code":{"type":"string"},"city_name":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/StateResource"}},"required":["address","address2","address_id","zip_code","city_name","state"],"title":"AddressResource"},"PartnerResource":{"type":"object","properties":{"partner_id":{"type":"string"},"notification_priority":{"type":["string","null"]},"notification_schedule":{"type":["integer","null"]},"is_patient_identity_verified":{"type":"string"},"name":{"type":"string"},"support_message_capability":{"type":["string","null"]},"patient_message_capability":{"type":["string","null"]},"provides_medications":{"type":"string"},"partner_notes":{"type":["string","null"]},"operations_support_email":{"type":["string","null"]},"escalation_support_email":{"type":["string","null"]},"customer_support_email":{"type":["string","null"]},"operation_country":{"$ref":"#/components/schemas/CountryResource"},"can_unlock_phi":{"type":"string"},"enable_av_flow":{"type":"string"},"is_auto_dl_flow":{"type":"string"},"is_review_required":{"type":"string"},"is_global_statistics_enabled":{"type":"string"},"is_patient_allowed_choose_notification_inbox":{"type":"string"},"is_ai_auto_summary_enabled":{"type":"string"},"is_sending_tracking_number_enabled":{"type":"string"},"enable_icd_bmi":{"type":"string"},"reassignment_interval":{"type":"integer"},"enable_automatic_sync_flow":{"type":"string"},"force_hold_status":{"type":"string"},"force_is_additional_approval_needed":{"type":"string"},"business_model":{"type":"string"},"customization":{"type":"string"},"thank_you_note_header":{"type":["string","null"]},"thank_you_note_footer":{"type":["string","null"]},"vouched_integration_type":{"type":"string"},"vouched_integration_charge":{"type":"string"},"text_message_integration_type":{"type":"string"},"text_message_integration_charge":{"type":"string"},"clinician_due_sync_case":{"type":"string"},"clinician_due_async_case":{"type":"string"},"clinician_due_sync_followup_encounter":{"type":"string"},"clinician_due_async_followup_encounter":{"type":"string"},"parent_partner_id":{"type":["string","null"]},"integration_type":{"type":["string","null"]},"onboarding_status":{"type":["string","null"]},"onboarding_progress":{"type":["string","null"]},"is_auto_patient_status_enabled":{"type":"string"},"image":{"type":["object","null"],"description":"It's called \"logo\" in other resource;","properties":{"file_id":{"type":"string"},"path":{"type":"string"},"name":{"type":"string"},"mime_type":{"type":"string"},"url":{"type":"string"},"url_thumbnail":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"metadata":{"type":["array","null"],"items":{}}},"required":["file_id","path","name","mime_type","url","url_thumbnail","created_at","metadata"]}},"required":["partner_id","notification_priority","notification_schedule","is_patient_identity_verified","name","customer_support_email","operation_country","enable_av_flow","is_auto_dl_flow","is_review_required","is_global_statistics_enabled","is_patient_allowed_choose_notification_inbox","is_ai_auto_summary_enabled","is_sending_tracking_number_enabled","enable_icd_bmi","reassignment_interval","enable_automatic_sync_flow","force_hold_status","force_is_additional_approval_needed","customization","vouched_integration_type","parent_partner_id","integration_type","onboarding_status","onboarding_progress","is_auto_patient_status_enabled","image"],"title":"PartnerResource"},"RoleResource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"RoleResource"},"PermissionResource":{"type":"object","properties":{"name":{"type":"string","description":"Attributes;"}},"required":["name"],"title":"PermissionResource"},"MetafieldResource":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"model_type":{"type":"string"},"model_id":{"type":"string"},"key":{"type":"string"},"value":{"type":["string","null"]},"scope":{"type":"string"},"type":{"type":["string","null"]},"title":{"type":["string","null"]},"metadata":{"type":["string","null"]},"emailed_at":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","model_type","model_id","key","value","scope","type","title","metadata","emailed_at","created_at","updated_at","deleted_at"]},{"type":"array","items":{"type":"string"},"minItems":0,"maxItems":0,"additionalItems":false}],"title":"MetafieldResource"},"DriverLicenseResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"name":{"type":"string"},"type":{"type":["string","null"]},"mime_type":{"type":"string"},"path":{"type":"string"},"metadata":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"},"url":{"type":"string","description":"Appended Attributes;"},"url_thumbnail":{"type":"string"},"pivot":{"type":"object","description":"Pivot Attributes (Partner);","properties":{"file_id":{"type":"string","description":"When loaded;"},"partner_id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["file_id","partner_id","title","type","created_at","updated_at"]},"file_id":{"type":"string","description":"Keep compatibility;"}},"required":["id","name","type","mime_type","path","metadata","created_at","updated_at","deleted_at","url","url_thumbnail","file_id"],"title":"DriverLicenseResource"},"QuestionnaireResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"specialty_id":{"type":"string"},"active":{"type":"string"},"name":{"type":"string"},"intro_title":{"type":"string"},"intro_description":{"type":"string"},"terms_of_service":{"type":"string"},"redirect_url":{"type":"string"},"redirect_title":{"type":"string"},"has_pharmacy":{"type":"string"},"is_weight_asked":{"type":"string"},"is_height_asked":{"type":"string"},"is_body_temperature_asked":{"type":"string"},"is_oxygen_saturation_asked":{"type":"string"},"ask_blood_pressure":{"type":"string"},"is_pending_review":{"type":"string"},"is_condensed_question":{"type":"string"},"is_show_welcome":{"type":"string"},"is_show_user":{"type":"string"},"is_show_thanks":{"type":"string"},"payment_type":{"type":"string"},"payment_account_id":{"type":"string"},"replicated_from_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"questions_lang":{"type":"string"},"questions":{"type":"array","description":"Relationships;","items":{"type":"object","description":"Circular reference to QuestionResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionResource for the full shape."}},"offerings":{"type":"array","description":"When loaded;","items":{"type":"object","description":"Circular reference to QuestionnaireOfferingResource flattened to avoid an unbounded self-referential schema; see components.schemas.QuestionnaireOfferingResource for the full shape."}},"review":{"description":"When loaded; Circular reference to ReviewResource flattened to avoid an unbounded self-referential schema; see components.schemas.ReviewResource for the full shape.","type":"object"},"payment_account":{"description":"When loaded;","anyOf":[{"$ref":"#/components/schemas/PaymentAccountResource"},{"type":"object","properties":{"id":{"type":"null"},"partner_id":{"type":"null"},"is_chargeable":{"type":"boolean"},"name":{"type":"string","const":"MDI Default"},"public_key":{"type":"string"},"created_at":{"type":"null"},"updated_at":{"type":"null"},"deleted_at":{"type":"null"}},"required":["id","partner_id","is_chargeable","name","public_key","created_at","updated_at","deleted_at"]}]}},"required":["id","partner_id","specialty_id","active","name","intro_title","intro_description","terms_of_service","redirect_url","redirect_title","has_pharmacy","is_weight_asked","is_height_asked","is_body_temperature_asked","is_oxygen_saturation_asked","ask_blood_pressure","is_pending_review","is_condensed_question","is_show_welcome","is_show_user","is_show_thanks","payment_type","payment_account_id","replicated_from_id","created_at","updated_at","deleted_at","questions_lang"],"title":"QuestionnaireResource"},"PaymentAccountResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"partner_id":{"type":"string"},"name":{"type":"string"},"public_key":{"type":"string"},"is_chargeable":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","partner_id","name","public_key","is_chargeable","created_at","updated_at","deleted_at"],"title":"PaymentAccountResource"},"EnvironmentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"identifier":{"type":"string"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","identifier","created_at","updated_at","deleted_at"],"title":"EnvironmentResource"},"PaymentResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"status":{"type":"string"},"total":{"type":"number"},"partner_id":{"type":"string"},"patient_id":{"type":["string","null"]},"partner_questionnaire_id":{"type":["string","null"]},"partner_voucher_id":{"type":["string","null"]},"response":{"type":["array","null"],"items":{}},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","status","total","partner_id","patient_id","partner_questionnaire_id","partner_voucher_id","response","created_at","updated_at","deleted_at"],"title":"PaymentResource"}}}} ``` ## The WebhookResource object ```json {"openapi":"3.1.0","info":{"title":"MD Integrations","version":"1.0.0"},"components":{"schemas":{"WebhookResource":{"type":"object","properties":{"id":{"type":"string","description":"Attributes;"},"queue":{"type":"string"},"payload":{"type":"string"},"status":{"type":"string"},"dispatch":{"type":"string"},"attempt":{"type":"integer"},"sqs":{"type":["string","null"]},"response":{"type":["array","null"],"items":{}},"delay_seconds":{"type":"integer"},"partner_environment_id":{"type":["string","null"]},"environment":{"type":["string","null"]},"partner_id":{"type":["string","null"]},"model_type":{"type":["string","null"]},"model_id":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["id","queue","payload","status","dispatch","attempt","sqs","response","delay_seconds","partner_environment_id","environment","partner_id","model_type","model_id","created_at","updated_at","deleted_at"],"title":"WebhookResource"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.mdintegrations.com/partner-api-reference/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.