{"openapi":"3.0.0","info":{"title":"NexHealth API","description":"> **⚠️ Edge version — use at your own risk.** Endpoints in v3.1.0 are actively iterating and may change without notice. Access is restricted to specific partner institutions; contact NexHealth before integrating against this version.\n\nWelcome to the developer hub and documentation for NexHealth API. This section of guide describes the operations, response parameters, request parameters, and parameter constraints related to User API. The term Operations refer to functions or methods. The operations are included in requests and send to the web server. Each operation performs a different action or a query on database.","termsOfService":"https://www.nexhealth.com/terms-of-service","contact":{"name":"NexHealth","email":"info@nexhealth.com"},"license":{"name":"NexHealth License 1.0","url":"https://www.nexhealth.com/privacy"},"version":"v3.1.0"},"security":[{"Authorization":[]}],"tags":[{"name":"Form Responses","description":"Operations about Form Responses"},{"name":"Adjustments","description":"Adjustments resources"},{"name":"Adjustment Types","description":"Adjustment types used to create adjustment"},{"name":"Appointment Types","description":"Defines booking parameters for services offerred by the practice"},{"name":"Appointments","description":"A booking on the Practice's calendar"},{"name":"Authenticates","description":"Authentication endpoints for NexHealth resources"},{"name":"Available Slots","description":"Available start date/times for an appointment"},{"name":"Balances","description":"Guarantor and Insurance Balances resources"},{"name":"Charges","description":"Charges resources"},{"name":"Claims","description":"Claims resources"},{"name":"Clinical Notes","description":"Clinical notes are the official documentation of a patient's clinical encounter or care interaction"},{"name":"Documents","description":"A documents resource"},{"name":"Document Types","description":"A document types resource"},{"name":"Fee Schedules","description":"A fee schedules resource"},{"name":"Form Schemas","description":"Patient intake form schemas configured for a location"},{"name":"Institutions","description":"An organization containing at least one location is refered to as Institution"},{"name":"Insurance","description":"An insurance resource"},{"name":"Locations","description":"A singular Practice/clinic/office"},{"name":"Medical History","description":"A medical history resource"},{"name":"Nex Staff","description":"NexHealth staff users"},{"name":"Onboardings","description":"An Onboarding resource"},{"name":"Operatories","description":"A chair or room that can be booked"},{"name":"Patients","description":"A patients resource"},{"name":"Patient Alerts","description":"Short communication contents to Patients requiring a response"},{"name":"Patient Documents","description":"A patient documents resource"},{"name":"Patient Recalls","description":"Notifications used for encouraging patients to book follow-up appointments with providers"},{"name":"Payments","description":"Payments resources to view and create payments"},{"name":"Payment Plans","description":"Payment plans resource"},{"name":"Payment Types","description":"Payments types used to create payments"},{"name":"Procedure Code Categories","description":"Categories grouping the procedure codes of the data source"},{"name":"Procedure Codes","description":"Catalog of billable procedure codes available on the data source"},{"name":"Procedures","description":"A procedures resource"},{"name":"Providers","description":"A providers resource"},{"name":"Recall Types","description":"A recall notification type"},{"name":"Sync Config","description":"A sync configuration resource"},{"name":"Sync Status","description":"Status of a NexHealth EHR synchronization service"},{"name":"Treatment Plans","description":"A treatment plans resource"},{"name":"Webhook Endpoints","description":"Save and configure API user endpoints for use with webhooks"},{"name":"Webhook Subscriptions","description":"Configure webhook subscriptions to receive event based hooks"},{"name":"Working Hours","description":"Configure working hours for providers"}],"paths":{"/adjustments":{"get":{"summary":"View adjustments","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"provider_id","description":"Filter by provider","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"guarantor_id","description":"Filter by guarantor","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"claim_id","description":"Filter by claim","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"charge_id","description":"Filter by charge","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Adjustments updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"adjusted_since","description":"Adjustments with adjusted_at after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"include_deleted","description":"Include deleted adjustments","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * adjusted_at\n  * -adjusted_at\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Adjustment_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Adjustments"],"operationId":"getAdjustments"},"post":{"summary":"Create adjustment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postAdjustments"}}},"required":true},"responses":{"202":{"description":"Create adjustment"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Adjustments"],"operationId":"postAdjustments"}},"/adjustments/{id}":{"get":{"summary":"View adjustment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","guarantor","claim","charge","adjustment_type"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_AdjustmentWithIncludes_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Adjustments"],"operationId":"getAdjustmentsId"}},"/appointment_types":{"get":{"summary":"View appointment types","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Id of the associated location,required when appointment types are location specific and when including sub-resources","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["descriptors"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentTypeWithResources_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointment Types"],"operationId":"getAppointmentTypes"},"post":{"summary":"Create an appointment type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postAppointmentTypes"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointment Types"],"operationId":"postAppointmentTypes"}},"/appointment_types/{id}":{"patch":{"summary":"Edit an appointment type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchAppointmentTypesId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointment Types"],"operationId":"patchAppointmentTypesId"},"get":{"summary":"View an appointment type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Id of the associated location,required when appointment types are location specific and when including sub-resources","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["descriptors"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentTypeWithResources_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointment Types"],"operationId":"getAppointmentTypesId"},"delete":{"summary":"Delete an appointment type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Id of the associated location, required when appointment types are location specific","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointment Types"],"operationId":"deleteAppointmentTypesId"}},"/appointment_types/{id}/appointment_descriptors":{"get":{"summary":"View appointment type appointment descriptors","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Id of the associated location, required when appointment types are location specific","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"descriptor_type","description":"Query by descriptor type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_EhrApptDescriptor_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointment Types"],"operationId":"getAppointmentTypesIdAppointmentDescriptors"}},"/appointments/{id}":{"get":{"summary":"View appointment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Id of the appointment","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","guarantor","descriptors","booking_details","procedures","operatory","appointment_type"],"default":"patient"}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Appointment_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointments"],"operationId":"getAppointmentsId"},"patch":{"summary":"Edit Appointment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Id of the appointment","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchAppointmentsId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentResponse_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointments"],"operationId":"patchAppointmentsId"}},"/appointments/{id}/appointment_descriptors":{"get":{"summary":"View appointment descriptors","parameters":[{"in":"path","name":"id","description":"Id of the appointment","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"descriptor_type","description":"Query by descriptor type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_EmrApptDescriptor_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointments"],"operationId":"getAppointmentsIdAppointmentDescriptors"}},"/appointments":{"get":{"summary":"View appointments","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":false,"example":1,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"start","description":"A parseable date string defining the earliest returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000","required":true,"example":"2024-04-01T00:00:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"end","description":"A parseable date string defining the last returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000","required":true,"example":"2024-04-30T23:59:59Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"timezone","description":"Timezone for the appointment clinic","required":false,"example":"America/New_York","schema":{"type":"string"}},{"in":"query","name":"cancelled","description":"Filter by cancelled status.","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"unavailable","description":"Unavailable appointments are used to block availability on a schedule, specify to set the filter","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"nex_only","description":"Only show appointments booked via NexHealth API","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"updated_since","description":"Query appointments whose records have updated since the specified datetime in ISO8601 format. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDT00:00:00+0000","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"appointment_type_id","description":"Get appointments for a specific appointment type","required":false,"example":27,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"foreign_id","description":"Unique appointment id from the EHR","required":false,"example":"94","schema":{"type":"string"}},{"in":"query","name":"created_by","description":"Query appointments that were created by a specific user","required":false,"example":197,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"confirmed","description":"Is appointment confirmed","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"patient_ids[]","description":"Get appointments for specific patients (up to 25 ids)","required":false,"example":[2897],"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"provider_ids[]","description":"Query appointments that are booked with the specified providers only","required":false,"example":[104],"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"operatory_ids[]","description":"Query appointments that are booked in the specified operatories only","required":false,"example":[181],"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["descriptors"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentWithDescriptors_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointments"],"operationId":"getAppointments"},"post":{"summary":"Create appointment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postAppointments"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentResponse_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Appointments"],"operationId":"postAppointments"}},"/authenticates":{"post":{"summary":"Retrieve bearer token","responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AuthorizationResponse_Response"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Authenticates"],"operationId":"postAuthenticates"}},"/charges":{"get":{"summary":"View charges","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"provider_id","description":"Filter by provider","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"procedure_id","description":"Filter by procedure","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"guarantor_id","description":"Filter by guarantor","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Charges updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"charged_since","description":"Charges with charged_at after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"include_deleted","description":"Include deleted charges","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * charged_at\n  * -charged_at\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["claim_payouts"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeWithClaimPayouts_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Charges"],"operationId":"getCharges"}},"/charges/{id}":{"get":{"summary":"View charge","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","procedure","guarantor","claims","claim_payouts","totals"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Charge_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Charges"],"operationId":"getChargesId"}},"/document_types":{"get":{"summary":"View document types","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"active","description":"Filter active/not active","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_DocumentType_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Document Types"],"operationId":"getDocumentTypes"}},"/document_types/{id}":{"get":{"summary":"View document type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"The NexHealth ID of the document type","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_DocumentType_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Document Types"],"operationId":"getDocumentTypesId"}},"/institutions":{"get":{"summary":"View institutions","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Institution_Collection_Response"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Institutions"],"operationId":"getInstitutions"}},"/institutions/{id}":{"get":{"summary":"View institution","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"The NexHealth id of the institution","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Institution_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Institutions"],"operationId":"getInstitutionsId"}},"/insurance_plans":{"get":{"summary":"View insurance plans","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"updated_since","description":"Insurance plans updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"payer_id","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","required":false,"schema":{"type":"string"}},{"in":"query","name":"group_num","description":"Group number","required":false,"schema":{"type":"string"}},{"in":"query","name":"include_deleted","description":"Include deleted insurance plans","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"getInsurancePlans"},"post":{"summary":"Create insurance plan","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postInsurancePlans"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"postInsurancePlans"}},"/insurance_plans/{id}":{"get":{"summary":"View insurance plan","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Id of the insurance plan","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient_coverages","subscribers","fee_schedule"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"getInsurancePlansId"}},"/locations":{"get":{"summary":"View locations","description":"This endpoint returns the institutions accessible to the caller, each with its nested list of locations. Pass subdomain to scope the response to a single institution.","parameters":[{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":false,"schema":{"type":"string"}},{"in":"query","name":"inactive","description":"Filter by inactive status","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"foreign_id","description":"Find location by the integrated system Id","required":false,"example":"1","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_InstitutionBasicWithLocations_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Locations"],"operationId":"getLocations"}},"/locations/{id}":{"get":{"summary":"View location","parameters":[{"in":"path","name":"id","description":"The NexHealth location id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Entities_Location_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Locations"],"operationId":"getLocationsId"}},"/locations/{id}/appointment_descriptors":{"get":{"summary":"View location appointment descriptors","parameters":[{"in":"path","name":"id","description":"The NexHealth location id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"descriptor_type","description":"Query by descriptor type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_EmrApptDescriptor_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Locations"],"operationId":"getLocationsIdAppointmentDescriptors"}},"/medical_history/items":{"get":{"summary":"View medical history items","description":"Returns a list of medical history items (allergies, conditions, or medications) for the given location.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"category","description":"Category of medical history items to return (allergies, conditions, medications)","required":true,"schema":{"type":"string","enum":["allergies","conditions","medications"]}},{"in":"query","name":"search_term","description":"Filter items whose name matches the search string","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_Item_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Medical History"],"operationId":"getMedicalHistoryItems"}},"/medical_history/patient_items":{"get":{"summary":"View patient medical history items","description":"Returns a list of patient-specific medical history items (allergies, conditions, or medications) for the given patient.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Patient ID to return items for","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"category","description":"Category of patient items to return (allergies, conditions, medications)","required":true,"schema":{"type":"string","enum":["allergies","conditions","medications"]}},{"in":"query","name":"active","description":"Filter active or inactive items","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_PatientItem_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Medical History"],"operationId":"getMedicalHistoryPatientItems"},"post":{"summary":"Create or update patient medical history items","description":"Batch creates, updates, or deactivates patient-specific medical history items...","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postMedicalHistoryPatientItems"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_PatientItem_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Medical History"],"operationId":"postMedicalHistoryPatientItems"}},"/nex_staff":{"get":{"summary":"View nex staff","parameters":[{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"page","description":"Page number. Starts with page 1","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"in":"query","name":"per_page","description":"Number of results to return per page. Defaults is 5 per page and Max 300 per page","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"inactive","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"location_ids[]","description":"Locations the staff member has access to","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Staff_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Nex Staff"],"operationId":"getNexStaff"}},"/operatories":{"get":{"summary":"View operatories","description":"This endpoint returns the operatories for the specified location, narrowed down by the optional filters configured.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"search_name","description":"Optional name search filter","required":false,"example":"op1","schema":{"type":"string"}},{"in":"query","name":"foreign_id","description":"Query by EHR Id","required":false,"example":"1","schema":{"type":"string"}},{"in":"query","name":"updated_since","description":"Query operatories whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["appointment_types","appt_categories"],"default":"appt_categories"}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryWithResources_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Operatories"],"operationId":"getOperatories"}},"/operatories/{id}":{"get":{"summary":"View operatory","parameters":[{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"The NexHealth id of the operatories","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["appointment_types","appt_categories"],"default":"appt_categories"}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryWithResources_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Operatories"],"operationId":"getOperatoriesId"}},"/patients":{"get":{"summary":"View patients","description":"This endpoint returns a list of patients based on the optional filters configured.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * id\n  * -id\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string","default":"id"}},{"in":"query","name":"name","description":"Filter by patient name","required":false,"example":"John Smith","schema":{"type":"string"}},{"in":"query","name":"email","description":"Filter by patient email","required":false,"example":"john.smith@example.com","schema":{"type":"string"}},{"in":"query","name":"phone_number","description":"Filter by patient phone number","required":false,"example":"5163042196","schema":{"type":"string"}},{"in":"query","name":"date_of_birth","description":"Filter by patient date of birth. Must be a parseable date string, recommended format is YYYY-MM-DD","required":false,"example":"1964-05-03","schema":{"type":"string","format":"date"}},{"in":"query","name":"inactive","description":"Filter by inactive status. When true, returns only inactive patients. When false, returns only active patients. When not specified, does not filter","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"foreign_id","description":"Filter by the unique patient id from the EHR","required":false,"example":"100437","schema":{"type":"string"}},{"in":"query","name":"updated_since","description":"Only return patients updated at or after the specified date/time. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"new_patient","description":"Filter patients by new_patient status. When true, returns only new patients with an upcoming appointment. When false, returns only non-new patients. When not specified, returns both regular patients and new patients with upcoming appointments. Patients with the attribute new_patient=true are patients that do not fully exist in the EHR so cannot be used to book appointments. When the patient record is officially created (and read by us) in the EHR, record associations will be created and any new_patient records are deleted.","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"non_patient","description":"Specify if you want to filter non_patients. In case of true: return only non_patients. In case of false: Result does not include non_patients. In case of null: do not set filter/return any","required":false,"example":false,"schema":{"type":"boolean"}},{"in":"query","name":"forms_syncable","description":"Specify if you want to filter to patients that can have forms inserted into their patient file. In case of true: Return only patients that can have forms inserted into their patient file. In case of false or nil: do not filter","required":false,"example":true,"schema":{"type":"boolean"}},{"in":"query","name":"location_strict","description":"Only returns patients belonging to the specified location, rather than searching across the EHR system","required":false,"example":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_PatientWithEhrPreferences_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patients"],"operationId":"getPatients"},"post":{"summary":"Create patient","description":"This endpoint creates a new patient or returns an existing patient if return_existing_if_match is true. Phone numbers are written to typed fields in the integrated system, but many systems report the main number back as an untyped primary number — see the cell_phone_number and preferred_phone_number response fields for how that is surfaced.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postPatients"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_PatientDetailed_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patients"],"operationId":"postPatients"}},"/patients/{id}":{"get":{"summary":"View patient","description":"This endpoint returns a single patient. You must provide a valid patient NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["upcoming_appts","last_visited_appointment","children","guarantor","procedures","insurance_coverages","adjustments","charges","payments","patient_alerts","provider"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_PatientDetailed_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patients"],"operationId":"getPatientsId"},"patch":{"summary":"Update patient","description":"Updates a patient record and enqueues a patients.update sync command. All fields are optional — only provided fields are updated. Returns 422 if the patient has not been synced to the EHR (no foreign_id). Phone numbers are written to typed fields in the integrated system, but many systems report the main number back as an untyped primary number — see the cell_phone_number and preferred_phone_number response fields for how that is surfaced.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchPatientsId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_PatientDetailed_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patients"],"operationId":"patchPatientsId"}},"/patients/{id}/documents":{"get":{"summary":"View patient documents","parameters":[{"in":"path","name":"id","description":"Id of the patient","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientDocument_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Documents"],"operationId":"getPatientsIdDocuments"},"post":{"summary":"Create patient document","parameters":[{"in":"path","name":"id","description":"Id of the patient","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file being uploaded. The name of this file will be used when inserting the file into the EHRs filesystem","type":"string","format":"binary"},"document_type_id":{"description":"The id of the document type to assign to the uploaded document","type":"integer","format":"int32"}},"required":["file"]}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientDocument_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Documents"],"operationId":"postPatientsIdDocuments"}},"/patients/{id}/alerts":{"post":{"summary":"Create patient alert","parameters":[{"in":"path","name":"id","description":"Id of the patient","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postPatientsIdAlerts"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Alerts"],"operationId":"postPatientsIdAlerts"},"get":{"summary":"View patient alerts","parameters":[{"in":"path","name":"id","description":"Id of the patient","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include_disabled","description":"Include disabled patient alerts if true","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Alerts"],"operationId":"getPatientsIdAlerts"}},"/patients/{id}/alerts/{alert_id}":{"get":{"summary":"View patient alert","parameters":[{"in":"path","name":"id","description":"Id of the patient","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Alerts"],"operationId":"getPatientsIdAlertsAlertId"},"patch":{"summary":"Edit patient alert","parameters":[{"in":"path","name":"id","description":"Id of the patient","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"alert_id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchPatientsIdAlertsAlertId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Alerts"],"operationId":"patchPatientsIdAlertsAlertId"}},"/patient_recalls":{"get":{"summary":"View patient recalls","description":"This endpoint returns the patient recalls for the specified location, narrowed down by the optional filters configured.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"recall_id","description":"Filter by the id of the associated recall type","required":false,"example":1,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by the id of the associated patient","required":false,"example":1,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"foreign_id","description":"Filter by the EHR id of the recall","required":false,"example":"1","schema":{"type":"string"}},{"in":"query","name":"updated_since","description":"Return records updated since the specified date/time in ISO8601 format","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"due_after","description":"Return recalls due on or after the specified date/time in ISO8601 format","required":false,"example":"2024-08-01T00:00:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * date_due\n  * -date_due\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecall_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Recalls"],"operationId":"getPatientRecalls"}},"/patient_recalls/{id}":{"get":{"summary":"View patient recall","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecall_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patient Recalls"],"operationId":"getPatientRecallsId"}},"/payment_plans":{"get":{"summary":"View payment plans","parameters":[{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"guarantor_id","description":"Filter by guarantor","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Filter for payment plans updated since a specific time","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PaymentPlan_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payment Plans"],"operationId":"getPaymentPlans"}},"/payment_plans/{id}":{"get":{"summary":"View payment plan","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","guarantor"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PaymentPlanDetailed_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payment Plans"],"operationId":"getPaymentPlansId"}},"/payments":{"get":{"summary":"View payments","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by the id of the associated patient","required":false,"example":3,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"provider_id","description":"Filter by the id of the associated provider","required":false,"example":15,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"guarantor_id","description":"Filter by the id of the associated guarantor","required":false,"example":5,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"charge_id","description":"Filter by the id of the associated charge","required":false,"example":1111,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"claim_id","description":"Filter by the id of the associated claim","required":false,"example":2222,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"transaction_id","description":"Filter by transaction id","required":false,"example":"NHP:JXZEQ1234","schema":{"type":"string"}},{"in":"query","name":"updated_since","description":"Filter for payments updated since a specific time (UTC)","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"paid_since","description":"Payments with paid_at after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"include_deleted","description":"Include deleted payments","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * paid_at\n  * -paid_at\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Payment_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payments"],"operationId":"getPayments"},"post":{"summary":"Create payment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postPayments"}}},"required":true},"responses":{"202":{"description":"Create payment"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payments"],"operationId":"postPayments"}},"/payments/{id}":{"get":{"summary":"View payment","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","guarantor","claim","charge","payment_plan","payment_type"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_PaymentWithIncludes_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payments"],"operationId":"getPaymentsId"}},"/procedures":{"get":{"summary":"View procedures","description":"This endpoint returns a list of procedures.\n You can filter by provider_id, patient_id, appointment_id, started_after, started_before, ended_after, ended_before or\n updated_since. You must provide at least one filter.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Filter for specific location","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"provider_id","description":"Filter for specific provider","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter for specific patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"appointment_id","description":"Filter for specific appointment","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Procedures updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"started_after","description":"Filter for procedures with start_date after a specific date (including the date)","required":false,"schema":{"type":"string","format":"date"}},{"in":"query","name":"started_before","description":"Filter for procedures with start_date before a specific date (including the date)","required":false,"schema":{"type":"string","format":"date"}},{"in":"query","name":"ended_after","description":"Filter for procedures with end_date after a specific date (including the date)","required":false,"schema":{"type":"string","format":"date"}},{"in":"query","name":"ended_before","description":"Filter for procedures with end_date before a specific date (including the date)","required":false,"schema":{"type":"string","format":"date"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Procedure_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedures"],"operationId":"getProcedures"}},"/procedures/{id}":{"get":{"summary":"View procedure","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Procedure_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedures"],"operationId":"getProceduresId"}},"/providers":{"get":{"summary":"View providers","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Only return providers associated with the specified Location Id","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"foreign_id","description":"Unique appointment id from the EHR","required":false,"schema":{"type":"string"}},{"in":"query","name":"requestable","description":"Only return providers who are bookable via NexHealth online booking at the specified location_id","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"inactive","description":"Filter result set based on inactive status, defaults to false if not specified","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"updated_since","description":"Query providers whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["locations","availabilities","appointment_types"],"default":"locations"}}},{"in":"query","name":"ids[]","description":"NexHealth IDs","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProviderWithResources_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Providers"],"operationId":"getProviders"}},"/providers/{id}":{"get":{"summary":"View provider","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"The NexHealth id of the Provider","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["locations","availabilities","appointment_types"],"default":"locations"}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProviderWithResources_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Providers"],"operationId":"getProvidersId"}},"/recall_types":{"get":{"summary":"View recall types","parameters":[{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"foreign_id","description":"Filter by EHR id","required":false,"schema":{"type":"string"}},{"in":"query","name":"updated_since","description":"Return records updated since the specified date/time in ISO8601 format","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_RecallType_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Recall Types"],"operationId":"getRecallTypes"}},"/recall_types/{id}":{"get":{"summary":"View recall type","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_RecallType_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Recall Types"],"operationId":"getRecallTypesId"}},"/sync_status":{"get":{"summary":"View sync statuses","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":false,"schema":{"type":"string"}},{"in":"query","name":"read_status","description":"Filter by read status","required":false,"schema":{"type":"string","enum":["green","red"]}},{"in":"query","name":"write_status","description":"Filter by write status","required":false,"schema":{"type":"string","enum":["green","red"]}},{"in":"query","name":"location_ids[]","description":"Return the status of sync services running on the specified locations","required":false,"explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_SyncStatus_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Sync Status"],"operationId":"getSyncStatus"}},"/webhook_endpoints":{"get":{"summary":"View webhook endpoints","parameters":[{"in":"query","name":"active","description":"Return only active or inactive endpoints","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_WebhookEndpoint_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Endpoints"],"operationId":"getWebhookEndpoints"},"post":{"summary":"Create webhook endpoint","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postWebhookEndpoints"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_WebhookEndpoint_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Endpoints"],"operationId":"postWebhookEndpoints"}},"/webhook_endpoints/{id}":{"patch":{"summary":"Edit webhook endpoint","parameters":[{"in":"path","name":"id","description":"Webhook Endpoint id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchWebhookEndpointsId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_WebhookEndpoint_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Endpoints"],"operationId":"patchWebhookEndpointsId"},"delete":{"summary":"Delete webhook endpoint","parameters":[{"in":"path","name":"id","description":"Webhook Endpoint id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Successful"},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Endpoints"],"operationId":"deleteWebhookEndpointsId"}},"/webhook_endpoints/{id}/webhook_subscriptions":{"get":{"summary":"View webhook subscriptions","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Webhook Endpoint id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":false,"schema":{"type":"string"}},{"in":"query","name":"resource_type","description":"Filter by subscribed resource","required":false,"schema":{"type":"string","enum":["Adjustment","AdjustmentType","Appointment","Charge","Claim","Document","FeeSchedule","FormResponse","FormSchema","Insurance","MedicalHistory","Message","Onboarding","Patient","PatientInsuranceCoverage","Payment","PaymentType","Procedure","ProcedureCode","Provider","SyncStatus","TreatmentPlan","WorkingHour"]}},{"in":"query","name":"event","description":"Filter by event name","required":false,"schema":{"type":"string","enum":["adjustment_created","adjustment_updated","adjustment_deleted","adjustment_insertion","adjustment_type_created","adjustment_type_updated","appointment_insertion","appointment_created","appointment_updated","appointment_requested","charge_created","charge_updated","charge_deleted","claim_created","claim_updated","claim_deleted","document_insertion","fee_schedule_created","fee_schedule_updated","form_response_insertion","form_schema_created","form_schema_deleted","insurance_plan_insertion","insurance_coverage_insertion","insurance_coverage_deleted","medical_history_item_created","medical_history_item_updated","medical_history_patient_items_updated","message_created","message_updated","onboarding_created","onboarding_updated","onboarding_availability_ready","patient_created","patient_updated","patient_insertion","patient_update","patient_insurance_created","patient_insurance_updated","payment_created","payment_updated","payment_deleted","payment_insertion","payment_type_created","payment_type_updated","procedure_created","procedure_updated","procedure_code_created","procedure_code_updated","procedure_code_deleted","provider_created","provider_updated","sync_status_read_change","sync_status_write_change","treatment_plan_created","treatment_plan_updated","treatment_plan_deleted","working_hour_created","working_hour_updated"]}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_WebhookSubscription_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Subscriptions"],"operationId":"getWebhookEndpointsIdWebhookSubscriptions"},"post":{"summary":"Create webhook subscription","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Webhook Endpoint id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution. For the following resources we don't require a subdomain: Onboarding","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postWebhookEndpointsIdWebhookSubscriptions"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_WebhookSubscription_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Subscriptions"],"operationId":"postWebhookEndpointsIdWebhookSubscriptions"}},"/webhook_endpoints/{id}/webhook_subscriptions/{subscription_id}":{"patch":{"summary":"Edit webhook subscription","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Webhook Endpoint id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"subscription_id","description":"Webhook Subscription id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchWebhookEndpointsIdWebhookSubscriptionsSubscriptionId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_WebhookSubscription_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Subscriptions"],"operationId":"patchWebhookEndpointsIdWebhookSubscriptionsSubscriptionId"},"delete":{"summary":"Delete webhook subscription","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Webhook Endpoint id","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"subscription_id","description":"Webhook Subscription id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Successful"},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Webhook Subscriptions"],"operationId":"deleteWebhookEndpointsIdWebhookSubscriptionsSubscriptionId"}},"/adjustment_types":{"get":{"summary":"View adjustment types","description":"This endpoint returns the adjustment types configured in the integrated system for the specified location","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Adjustment types updated after the specified time (UTC)","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"active","description":"Filter active/not active","required":false,"example":true,"schema":{"type":"boolean","default":true}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentType_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Adjustment Types"],"operationId":"getAdjustmentTypes"}},"/adjustment_types/{id}":{"get":{"summary":"View adjustment type","description":"This endpoint returns a single adjustment type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentType_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Adjustment Types"],"operationId":"getAdjustmentTypesId"}},"/available_slots":{"get":{"summary":"View available slots","description":"This endpoint returns the bookable slots for the requested locations over the given date range, computed from provider availabilities and existing appointments. At least one of pids or appointment_type_id must be provided.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"start_date","description":"Date string you want results to start at, format YYYY-MM-DD","required":true,"example":"2024-04-15","schema":{"type":"string","format":"date"}},{"in":"query","name":"days","description":"Number of days to include, counting the start date. For best performance, this value should not exceed 14 days.","required":true,"example":7,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"appointment_type_id","description":"Specify an appointment type to filter returned slots and set slot_length to appointment_type.minutes","required":false,"example":27,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"working_hour_label_id","description":"Filter by specific working hour label","required":false,"example":11,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"working_hour_source","description":"Filter by source of working hours","required":false,"example":"manual","schema":{"type":"string","enum":["manual","synced"]}},{"in":"query","name":"slot_length","description":"Manually specify slot length in minutes. Defaults to 15 minutes","required":false,"example":30,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"slot_interval","description":"Manually specify the time in minutes between returned slot start times when a contiguous opening exists longer than the slot_length","required":false,"example":15,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"overlapping_operatory_slots","description":"Return all available slots for operatories at a given time instead of returning only the first found. Default is false","required":false,"example":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"only_active_providers","description":"Only return availabilities for active providers, omitting slots for providers marked as inactive. Default is false","required":false,"example":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"appointments_per_timeslot","description":"Number of appointments (default:1, max:5) that can be booked in a single slot. Only supported for eClinicalWorks and NextGen.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":5,"default":1}},{"in":"query","name":"lids[]","description":"Array of Location Ids","required":true,"example":[1],"explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"pids[]","description":"Array of Provider Ids","required":false,"example":[83],"explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"operatory_ids[]","description":"Specify this if booking is mapped to operatory in this location","required":false,"example":[54],"explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_AvailableSlotResponse_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Available Slots"],"operationId":"getAvailableSlots"}},"/clinical_notes":{"get":{"summary":"View clinical notes","description":"This endpoint returns the clinical notes for the specified location. At least one of the patient_id, procedure_id, entered_before, entered_after, or updated_since filters must be provided. Results are cursor-paginated.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by the id of the associated patient","required":false,"example":115,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"procedure_id","description":"Filter by procedure, only return clinical notes that are associated with the procedure ID. This association only exists in certain EHRs and for certain types of notes","required":false,"example":116,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"entered_before","description":"Only return clinical notes that were created on or before the provided datetime","required":false,"example":"2024-04-30T23:59:59Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"entered_after","description":"Only return clinical notes that were created on or after the provided datetime","required":false,"example":"2024-04-01T00:00:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"updated_since","description":"Only return clinical notes updated after the specified time (UTC)","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_ClinicalNote_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Clinical Notes"],"operationId":"getClinicalNotes"}},"/fee_schedule_procedures":{"get":{"summary":"View fee schedule procedures","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"fee_schedule_id","description":"Filter by fee schedule id","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Fee schedules updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Fee Schedules"],"operationId":"getFeeScheduleProcedures"}},"/fee_schedules":{"get":{"summary":"View fee schedules","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Fee schedules updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"active","description":"Filter active/not active","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FeeSchedule_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Fee Schedules"],"operationId":"getFeeSchedules"}},"/fee_schedules/{id}":{"get":{"summary":"View fee schedule","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["procedure_fees"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FeeSchedule_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Fee Schedules"],"operationId":"getFeeSchedulesId"}},"/guarantor_balances":{"get":{"summary":"View guarantor balances","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"guarantor_id","description":"Filter by guarantor","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Guarantor guarantor balances updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"show_zero_balances","description":"Show guarantor balances with zero total balance","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Balances"],"operationId":"getGuarantorBalances"}},"/guarantor_balances/{id}":{"get":{"summary":"View guarantor balance","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["guarantor"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_GuarantorBalanceDetailed_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Balances"],"operationId":"getGuarantorBalancesId"}},"/insurance_balances":{"get":{"summary":"View insurance balances","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"guarantor_id","description":"Filter by guarantor","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Insurance balances updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_InsuranceBalance_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Balances"],"operationId":"getInsuranceBalances"}},"/insurance_balances/{id}":{"get":{"summary":"View insurance balance","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_InsuranceBalance_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Balances"],"operationId":"getInsuranceBalancesId"}},"/claims":{"get":{"summary":"View claims","description":"This endpoint returns a list of insurance claims for a location. You can filter by patient_id, guarantor_id, provider_id, updated_since or date_of_service, and must provide at least one of these filters. location_id is always required, but does not satisfy the at-least-one-filter requirement on its own. Soft-deleted claims are excluded unless include_deleted is true.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"patient_id","description":"The ID of the patient associated with the claim","required":false,"example":162,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"guarantor_id","description":"The ID of the guarantor associated with the claim","required":false,"example":1001,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"provider_id","description":"The ID of the provider associated with the claim","required":false,"example":84,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Claims updated at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"date_of_service","description":"Claims whose date of service exactly matches the specified date","required":false,"example":"2024-04-12","schema":{"type":"string","format":"date"}},{"in":"query","name":"include_deleted","description":"Include soft-deleted claims in the results","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Insurance_ClaimBasicWithDelete_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Claims"],"operationId":"getClaims"}},"/claims/{id}":{"get":{"summary":"View claim","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","guarantor","charges","charge_payouts"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Insurance_Claim_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Claims"],"operationId":"getClaimsId"}},"/insurance_coverages":{"get":{"summary":"View insurance coverages","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"updated_since","description":"Insurance coverages updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"active","description":"Filter active/inactive insurance coverages","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"getInsuranceCoverages"},"post":{"summary":"Create insurance coverage","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postInsuranceCoverages"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"postInsuranceCoverages"}},"/insurance_coverages/{id}":{"get":{"summary":"View insurance coverage","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Insurance coverage ID","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"getInsuranceCoveragesId"},"delete":{"summary":"Delete insurance coverage","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Insurance coverage ID","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"deleteInsuranceCoveragesId"}},"/onboardings":{"get":{"summary":"View onboardings","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Filter by subdomain. Ensure the subdomain used is returned by the API in a previous query.","required":false,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter by status","required":false,"schema":{"type":"string","enum":["in_progress","complete","failed"]}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * created_at\n  * -created_at\n  * status\n  * -status\n  * subdomain\n  * -subdomain\n","required":false,"schema":{"type":"string","default":"-created_at"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Api_Onboarding_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Onboardings"],"operationId":"getOnboardings"},"post":{"summary":"Create onboarding","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postOnboardings"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Api_Onboarding_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Onboardings"],"operationId":"postOnboardings"}},"/onboardings/{hashid}":{"get":{"summary":"View onboarding","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"hashid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Api_Onboarding_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Onboardings"],"operationId":"getOnboardingsHashid"}},"/payment_types":{"get":{"summary":"View payment types","description":"This endpoint returns the payment types configured in the integrated system for the specified location","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Payment types updated after the specified time (UTC)","required":false,"example":"2024-04-12T10:30:00Z","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"active","description":"Filter active/not active","required":false,"example":true,"schema":{"type":"boolean","default":true}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentType_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payment Types"],"operationId":"getPaymentTypes"}},"/payment_types/{id}":{"get":{"summary":"View payment type","description":"This endpoint returns a single payment type","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentType_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Payment Types"],"operationId":"getPaymentTypesId"}},"/treatment_plans":{"get":{"summary":"View treatment plans","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"location_id","description":"Filter by location","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"status","description":"Filter by status","required":false,"schema":{"type":"string","enum":["not_applicable","proposed","accepted","rejected","completed"]}},{"in":"query","name":"updated_since","description":"Treatment plans updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"include_deleted","description":"Include deleted treatment plans","required":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_TreatmentPlan_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Treatment Plans"],"operationId":"getTreatmentPlans"}},"/treatment_plans/{id}":{"get":{"summary":"View treatment plan","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_TreatmentPlan_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Treatment Plans"],"operationId":"getTreatmentPlansId"}},"/working_hour_labels":{"get":{"summary":"View working hour labels","description":"This endpoint returns a list of Working Hour Labels, narrowed down by the optional filters configured.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Id of the associated location. Returns labels tied to the location as well as institution-wide labels available to it","required":false,"example":3,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"search_name","description":"Filter working hour labels by search term","required":false,"example":"New patient","schema":{"type":"string"}},{"in":"query","name":"active","description":"Filter by active status.","required":false,"example":true,"schema":{"type":"boolean"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourLabel_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Working Hours"],"operationId":"getWorkingHourLabels"}},"/working_hours":{"post":{"summary":"Create working hour","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postWorkingHours"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHour_Response"}}}},"400":{"description":"Bad Request","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Working Hours"],"operationId":"postWorkingHours"},"get":{"summary":"View working hours","description":"This endpoint returns the working hours for the specified location, narrowed down by the optional filters configured.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}},{"in":"query","name":"provider_id","description":"Filter for specific provider","required":false,"example":7,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"operatory_id","description":"Filter for specific operatory","required":false,"example":149,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"label_id","description":"Filter by specific label","required":false,"example":11,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"source","description":"Filter by source of working hour","required":false,"example":"manual","schema":{"type":"string","enum":["manual","synced"]}},{"in":"query","name":"active","description":"Filter active/not active","required":false,"example":true,"schema":{"type":"boolean","default":true}},{"in":"query","name":"ignore_past_dates","description":"Filter out working hours configured for specific dates in the past","required":false,"example":false,"schema":{"type":"boolean","default":false}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["appointment_types"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHour_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Working Hours"],"operationId":"getWorkingHours"}},"/working_hours/{id}":{"get":{"summary":"View working hour","description":"This endpoint returns a single working hour.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Id of the working hour","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["appointment_types"]}}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHour_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Working Hours"],"operationId":"getWorkingHoursId"},"patch":{"summary":"Edit working hour","description":"This endpoint updates an existing working hour. At most one of days, specific_date, or custom_recurrence can be provided. The appointment_types field is included in the response only when appointment_type_ids or appointment_category_ids were part of the update. Passing an empty appointment_type_ids array removes all appointment types from the working hour; omitting the key leaves them unchanged.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Id of the working hour","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchWorkingHoursId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHour_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Working Hours"],"operationId":"patchWorkingHoursId"},"delete":{"summary":"Delete working hour","description":"This endpoint deletes a working hour.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Id of the working hour","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Working Hours"],"operationId":"deleteWorkingHoursId"}},"/form_responses":{"get":{"summary":"View form responses","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter responses by patient ID.","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormResponse_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Responses"],"operationId":"getFormResponses"},"post":{"summary":"Create a form response","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postFormResponses"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormResponseDetail_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Responses"],"operationId":"postFormResponses"}},"/form_responses/{id}":{"get":{"summary":"View a form response","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormResponseDetail_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Responses"],"operationId":"getFormResponsesId"}},"/form_schemas":{"get":{"summary":"List form schemas for a location","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormSchema_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Schemas"],"operationId":"getFormSchemas"}},"/form_schemas/{uuid}":{"get":{"summary":"View a specific form schema","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"uuid","required":true,"schema":{"type":"string"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormSchemaDetail_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Schemas"],"operationId":"getFormSchemasUuid"}},"/procedure_code_categories":{"get":{"summary":"View procedure code categories","description":"Returns a list of procedure code categories for the location.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedure Code Categories"],"operationId":"getProcedureCodeCategories"}},"/procedure_code_categories/{id}":{"get":{"summary":"View procedure code category","description":"Returns a single procedure code category.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"The NexHealth id of the procedure code category","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedure Code Categories"],"operationId":"getProcedureCodeCategoriesId"}},"/procedure_codes":{"get":{"summary":"View procedure codes","description":"Returns a list of procedure codes for the location. Optionally filter by updated_since.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Procedure codes updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCode_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedure Codes"],"operationId":"getProcedureCodes"}}},"servers":[{"url":"https://nexhealth.info"}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"API_V2_Entities_Ledger_Adjustment_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Adjustment"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Ledger_Adjustment_Collection_Response model"},"API_V2_Entities_Ledger_Adjustment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"value":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the procedure that this item is for"},"date":{"type":"string","format":"date","example":"2020-06-05","description":"The date of this line item as it appears in the EHR"},"notes":{"type":"string","description":"Notes attached to this item"},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"procedure":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"},"directionality":{"type":"string","enum":["credit","debit"],"example":"credit","description":"The direction that this item's value applies to the patient's overall balance.\n\nWith respect to the patient, adjustments can subtract from the overall balance (credits) or add to the overall balance (debits).\n"}}},"API_V2_Entities_Price":{"type":"object","properties":{"amount":{"type":"string","example":"62.00","description":"The currency value, in whole units (e.g. dollars)"},"currency":{"type":"string","example":"USD","description":"The ISO currency code"}}},"API_V2_Entities_PatientBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"preferred_locale":{"type":"string","example":"es","description":"The patient's preferred language setting used for displaying NexHealth forms and communications","nullable":true},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"}}},"API_V2_Entities_Provider":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"display_name":{"type":"string","example":"John Smith","description":"Display name"},"npi":{"type":"string","example":"1912507500","description":"National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system."},"tin":{"type":"string","example":"078051120","description":"Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system."},"state_license":{"type":"string","example":"R219935","description":"State license number. May be null if the practice did not enter it into the integrated system."},"specialty_code":{"type":"string","example":"363L00000X","description":"Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system."}}},"API_V2_Entities_Procedure":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":11,"description":"Procedure id"},"location_id":{"type":"integer","format":"int32","example":21,"description":"Location id","nullable":true},"patient_id":{"type":"integer","format":"int32","example":162,"description":"Patient id","nullable":true},"provider_id":{"type":"integer","format":"int32","example":84,"description":"Provider id","nullable":true},"appointment_id":{"type":"integer","format":"int64","example":283,"description":"Appointment id. Null when the procedure is not attached to an appointment","nullable":true},"code":{"type":"string","example":"D6100","description":"Procedure code","nullable":true},"name":{"type":"string","example":"Implant Removal","description":"Procedure name","nullable":true},"status":{"type":"string","enum":["planned","scheduled","completed","inactive","referred"],"example":"referred","description":"Procedure status","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure update date in UTC"},"body_site":{"$ref":"#/components/schemas/API_V2_Entities_ProcedureBodySite"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"start_date":{"type":"string","format":"date","example":"2022-06-24","description":"Start date for procedure","nullable":true},"end_date":{"type":"string","format":"date","example":"2022-06-24","description":"End date for procedure","nullable":true}}},"API_V2_Entities_ProcedureBodySite":{"type":"object","properties":{"tooth":{"type":"array","items":{"type":"string"},"example":["3","14"],"description":"Tooth identifier strings, typically tooth numbers"},"surface":{"type":"string","example":"MOD","description":"Tooth surface codes"}}},"API_Errors_BadRequest":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_BadRequest model"},"API_Errors_Unauthorized":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_Unauthorized model"},"API_Errors_Forbidden":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_Forbidden model"},"API_Errors_InternalServerError":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_InternalServerError model"},"API_V2_Entities_Ledger_Adjustment_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Adjustment"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Ledger_Adjustment_Response model"},"API_V20240412_Entities_Ledger_Adjustment_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Adjustment"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_Adjustment_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_Adjustment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC","nullable":true},"adjustment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"adjusted_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date adjustment was made","nullable":true},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this adjustment","nullable":true},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this adjustment","nullable":true},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this adjustment","nullable":true},"adjustment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the adjustment type for this adjustment","nullable":true}}},"postAdjustments":{"type":"object","properties":{"adjustment":{"type":"object","description":"Adjustment details","properties":{"patient_id":{"type":"integer","format":"int32","description":"NexHealth Patient ID","example":1},"amount":{"type":"number","format":"double","description":"Adjustment amount in decimal dollars","example":138},"currency":{"type":"string","description":"Currency","default":"USD"},"adjustment_type_id":{"type":"integer","format":"int32","description":"ID of the adjustment type.","example":1234},"transaction_id":{"type":"string","description":"The transaction ID of the adjustment with a prefix identifying the API originator this ID will be used to identify the adjustment created in the EHR. Max length is 50 characters.","example":"API:123456"},"adjusted_at":{"type":"string","format":"date-time","description":"Adjustment datetime","example":"2024-05-20T21:00:00+00:00"},"charge_splits":{"type":"object","description":"Charge splits hash with NexHealth charge IDs and corresponding amounts in decimal dollars","default":{},"example":{"charge_id_1":"37.50","charge_id_2":"100.50"}},"provider_splits":{"type":"object","description":"Provider splits hash with NexHealth provider IDs and corresponding amounts in decimal dollars","default":{},"example":{"provider_id_1":"37.50","provider_id_2":"100.50"}},"notes":{"type":"string","description":"Notes that will be saved into the EHR. note: some EHRs may truncate overlong notes","example":"Adding taxes"}},"required":["patient_id","amount","transaction_id"]}},"required":["adjustment"],"description":"Create adjustment"},"API_V20240412_Entities_Ledger_AdjustmentWithIncludes_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentWithIncludes"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_AdjustmentWithIncludes_Response model"},"API_V20240412_Entities_Ledger_AdjustmentWithIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC","nullable":true},"adjustment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"adjusted_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date adjustment was made","nullable":true},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this adjustment","nullable":true},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this adjustment","nullable":true},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this adjustment","nullable":true},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"claim":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Insurance_ClaimBasic"},"charge":{"$ref":"#/components/schemas/API_V2_Entities_Patient_Ledger_Charge"},"adjustment_type":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentType"},"adjustment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the adjustment type for this adjustment","nullable":true}}},"API_V2_Entities_Ledger_Insurance_ClaimBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Insurance Claim id"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id"},"patient_id":{"type":"integer","format":"int32","example":1002,"description":"Patient id"},"provider_id":{"type":"integer","format":"int32","example":101,"description":"Provider id"},"guarantor_id":{"type":"integer","format":"int32","example":1001,"description":"User id of the patient's responsible party"},"subscription_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the patient's insurance subscription"},"status":{"type":"string","enum":["draft","sent","received","approved","paid","rejected","canceled"],"example":"sent","description":"Insurance Claim status"},"finalized_at":{"type":"string","format":"date-time","example":"2024-06-10T15:16:57.000Z","description":"Time in UTC when claim was closed"},"sent_at":{"type":"string","format":"date-time","example":"2024-06-03T11:23:12.000Z","description":"Time in UTC when claim was sent"},"note":{"type":"string","example":"Claim was sent to the insurance company","description":"Note associated with the claim"},"payment_estimate_total":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off_estimate_total":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off_total":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"}}},"API_V2_Entities_Patient_Ledger_Charge":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made"},"procedure_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the procedure associated with this charge"},"claim_ids":{"type":"array","items":{"type":"integer","format":"int64"},"example":[2222,3333],"description":"Insurance claim IDs associated with this charge"},"payment_estimate_total":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off_estimate_total":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off_total":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V20240412_Entities_Ledger_AdjustmentType":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"name":{"type":"string","example":"Cash","description":"The name of the payment type"},"active":{"type":"boolean","example":true,"description":"Whether the adjustment type is currently active"},"action":{"type":"string","enum":["credit","debit","unknown"],"example":"credit","description":"Indicates if this type will credit or debit the adjustment. Unknown option is for EHRs which doesn't support the concept"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Adjustment Type update date in UTC"}}},"API_V31_Entities_Ledger_Adjustment_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Adjustment"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Ledger_Adjustment_Collection_Response_WithCursor model"},"API_V31_Entities_Ledger_Adjustment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"},"adjustment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"adjusted_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date adjustment was made"},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment"},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment"},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment"},"adjustment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the adjustment type for this payment"}}},"API_V31_Entities_Ledger_AdjustmentWithIncludes_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_AdjustmentWithIncludes"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Ledger_AdjustmentWithIncludes_Response model"},"API_V31_Entities_Ledger_AdjustmentWithIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"},"adjustment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"adjusted_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date adjustment was made"},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment"},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment"},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment"},"adjustment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the adjustment type for this payment"},"patient":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V31_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"claim":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Insurance_ClaimBasic"},"charge":{"$ref":"#/components/schemas/API_V2_Entities_Patient_Ledger_Charge"},"adjustment_type":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentType"}}},"API_V31_Entities_PatientBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","description":"Last time the resource was refreshed with data from the data source"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"cell_phone_number":{"type":"string","example":"5163042196","description":"Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number — which is how most systems report it back after a write — this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number."},"preferred_phone_number":{"type":"string","example":"5163042196","description":"The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only — write one of the typed phone number fields to change it."},"guarantor_id":{"type":"integer","format":"int32","description":"User id of this patient's responsible party"},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type"},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users"},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"},"gender":{"type":"string","example":"Female","description":"Gender from biographical data"},"new_patient":{"type":"boolean","example":false,"description":"Whether the patient is new"},"non_patient":{"type":"boolean","example":true,"description":"Whether this is a non-patient user record"},"date_of_birth":{"type":"string","example":"1964-05-03","description":"Date of birth in YYYY-MM-DD format"},"premedication":{"type":"string","description":"Premedication notes"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"}}},"API_V2_Entities_PatientAddress":{"type":"object","properties":{"line_1":{"type":"string","example":"333 Bush Street","description":"Address line 1","nullable":true},"line_2":{"type":"string","example":"Apt 4B","description":"Address line 2","nullable":true},"postal_code":{"type":"string","example":"20814","description":"Zip code","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"region":{"type":"string","example":"NY","description":"State","nullable":true}}},"API_V31_Entities_Provider":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","description":"Last time the resource was refreshed with data from the data source"},"phone_number":{"type":"string","example":"5163042196","description":"Primary phone number"},"cell_phone_number":{"type":"string","example":"","description":"Cell phone number"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"display_name":{"type":"string","example":"John Smith","description":"Display name"},"npi":{"type":"string","example":"1912507500","description":"National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system."},"tin":{"type":"string","example":"078051120","description":"Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system."},"state_license":{"type":"string","example":"R219935","description":"State license number. May be null if the practice did not enter it into the integrated system."},"specialty_code":{"type":"string","example":"363L00000X","description":"Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system."}}},"API_V2_Entities_AppointmentTypeWithResources_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeWithResources"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_AppointmentTypeWithResources_Collection_Response model"},"API_V2_Entities_AppointmentTypeWithResources":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Appointment type Id"},"name":{"type":"string","example":"Medical","description":"Appointment type name. Unique string identifier"},"parent_type":{"type":"string","example":"Institution","description":"Parent type for appointment type. Defines the belongs to relationship with either Institution or Location"},"parent_id":{"type":"integer","format":"int32","example":1,"description":"Identifies the specific resource the appointment type belongs to (see parent_type)"},"minutes":{"type":"integer","format":"int32","example":15,"description":"Default duration of appointments of this appointment type"},"bookable_online":{"type":"boolean","example":false,"description":"True if this appointment type should be bookable via the NexHealth online booking page"},"descriptors":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_EmrApptDescriptor"},"description":"EHR descriptors"}}},"API_V2_Entities_EmrApptDescriptor":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1822,"description":"Descriptor id"},"descriptor_type":{"type":"string","example":"Procedure Code","description":"The type of descriptor"},"name":{"type":"string","example":"EHR Descriptor Name","description":"The name of descriptor"},"code":{"type":"string","example":"EHR Descriptor Code","description":"The code of descriptor"},"location_id":{"type":"integer","format":"int32","example":13,"description":"The location this object belongs to"},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system"},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"data":{"type":"object","example":{},"description":"The configuration object, structure depends on the underlying EHR"},"active":{"type":"boolean","example":true,"description":"Is descriptor active?"},"last_sync_time":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"Last Sync time in UTC"},"created_at":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"The datetime the descriptor was created in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"The datetime the descriptor was last updated in UTC"}}},"API_Errors_NotFound":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_NotFound model"},"postAppointmentTypes":{"type":"object","properties":{"location_id":{"type":"integer","format":"int32","description":"Id of the associated location, required when appointment types are location specific"},"appointment_type":{"type":"object","properties":{"name":{"type":"string","description":"Appointment type name. Unique string identifier"},"minutes":{"type":"integer","format":"int32","description":"The length of time this appointment type takes up, increments of 5 minutes recommended"},"parent_type":{"type":"string","description":"Parent model to scope appointment types to, defaults to Institution","enum":["Institution","Location"]},"parent_id":{"type":"integer","format":"int32","description":"Id of the parent model of the associated appointment type, required if parent_type is Location"},"bookable_online":{"type":"boolean","description":"Set to True if this appointment type should be bookable via the NexHealth online booking page"},"ehr_appt_descriptor_ids":{"type":"array","description":"Array of EHR appointment descriptor ids","items":{"type":"integer","format":"int32"}}}}},"required":["appointment_type"],"description":"Create an appointment type"},"API_V2_Entities_AppointmentTypeBasic_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_AppointmentTypeBasic_Response model"},"API_V2_Entities_AppointmentTypeBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Appointment type Id"},"name":{"type":"string","example":"Medical","description":"Appointment type name. Unique string identifier"},"parent_type":{"type":"string","example":"Institution","description":"Parent type for appointment type. Defines the belongs to relationship with either Institution or Location"},"parent_id":{"type":"integer","format":"int32","example":1,"description":"Identifies the specific resource the appointment type belongs to (see parent_type)"},"minutes":{"type":"integer","format":"int32","example":15,"description":"Default duration of appointments of this appointment type"},"bookable_online":{"type":"boolean","example":false,"description":"True if this appointment type should be bookable via the NexHealth online booking page"}}},"patchAppointmentTypesId":{"type":"object","properties":{"location_id":{"type":"integer","format":"int32","description":"Id of the associated location, required when appointment types are location specific"},"appointment_type":{"type":"object","properties":{"name":{"type":"string","description":"Appointment type name. Unique string identifier"},"minutes":{"type":"integer","format":"int32","description":"The length of time this appointment type takes up, increments of 5 minutes recommended"},"parent_type":{"type":"string","description":"Parent model to scope appointment types to, defaults to Institution","enum":["Institution","Location"]},"parent_id":{"type":"integer","format":"int32","description":"Id of the parent model of the associated appointment type, required if parent_type is Location"},"bookable_online":{"type":"boolean","description":"Set to True if this appointment type should be bookable via the NexHealth online booking page"},"ehr_appt_descriptor_ids":{"type":"array","description":"Array of EHR appointment descriptor ids","items":{"type":"integer","format":"int32"}}}}},"required":["appointment_type"],"description":"Edit an appointment type"},"API_V2_Entities_AppointmentTypeWithResources_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeWithResources"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_AppointmentTypeWithResources_Response model"},"API_V2_Entities_EmrApptDescriptor_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_EmrApptDescriptor"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_EmrApptDescriptor_Collection_Response model"},"API_V31_Entities_AppointmentTypeWithResources_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentTypeWithResources"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_AppointmentTypeWithResources_Collection_Response model"},"API_V31_Entities_AppointmentTypeWithResources":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Appointment type Id"},"name":{"type":"string","example":"Medical","description":"Appointment type name. Unique string identifier"},"parent_type":{"type":"string","example":"Institution","description":"Parent type for appointment type. Defines the belongs to relationship with either Institution or Location"},"parent_id":{"type":"integer","format":"int32","example":1,"description":"Identifies the specific resource the appointment type belongs to (see parent_type)"},"minutes":{"type":"integer","format":"int32","example":15,"description":"Default duration of appointments of this appointment type"},"bookable_online":{"type":"boolean","example":false,"description":"True if this appointment type should be bookable via the NexHealth online booking page"},"descriptors":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_EhrApptDescriptor"},"description":"EHR descriptors"}}},"API_V31_Entities_EhrApptDescriptor":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1822,"description":"Descriptor id"},"descriptor_type":{"type":"string","example":"Procedure Code","description":"The type of descriptor"},"name":{"type":"string","example":"EHR Descriptor Name","description":"The name of descriptor"},"code":{"type":"string","example":"EHR Descriptor Code","description":"The code of descriptor"},"location_id":{"type":"integer","format":"int32","example":13,"description":"The location this object belongs to"},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system"},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"data":{"type":"object","example":{},"description":"The configuration object, structure depends on the underlying EHR"},"active":{"type":"boolean","example":true,"description":"Is descriptor active?"},"last_sync_time":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"Last Sync time in UTC"},"created_at":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"The datetime the descriptor was created in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"The datetime the descriptor was last updated in UTC"}}},"API_V31_Entities_AppointmentTypeWithResources_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentTypeWithResources"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_AppointmentTypeWithResources_Response model"},"API_V31_Entities_EhrApptDescriptor_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_EhrApptDescriptor"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_EhrApptDescriptor_Collection_Response model"},"API_V2_Entities_Appointment_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_Appointment"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Appointment_Response model"},"API_V2_Entities_Appointment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"patient_id":{"type":"integer","format":"int32","example":2897,"description":"Appointment patient id","nullable":true},"provider_id":{"type":"integer","format":"int32","example":104,"description":"Provider id","nullable":true},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name","nullable":true},"start_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled start time in UTC"},"confirmed":{"type":"boolean","example":true,"description":"Appointment confirmation status","nullable":true},"patient_missed":{"type":"boolean","example":false,"description":"Did the patient no show? Not supported by all integrations","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment last updation time in UTC"},"note":{"type":"string","example":"Patient has been having a cough for 3 days","description":"Appointment note","nullable":true},"end_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled end time in UTC"},"unavailable":{"type":"boolean","example":false,"description":"Is this appointment a scheduling block (blocks off the schedule)","nullable":true},"cancelled":{"type":"boolean","example":false,"description":"Is this appointment cancelled?"},"timezone":{"type":"string","example":"America/New_York","description":"Appointment timezone"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"appointment_type_id":{"type":"integer","format":"int32","example":27,"description":"Nexhealth appointment_type id, 0 if not set","nullable":true},"checkin_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time the patient checked in at in UTC. Not supported by all integrations","nullable":true},"location_id":{"type":"integer","format":"int32","example":1,"description":"Appointment location id","nullable":true},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"misc":{"type":"object","example":{"is_booked_on_nexhealth":true},"description":"Miscellaneous information for the appointment. The is_booked_on_nexhealth key indicates whether the appointment was booked through NexHealth","nullable":true},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last Sync time in UTC","nullable":true},"patient_confirmed":{"type":"boolean","example":false,"description":"Is this appointment confirmed by the patient (as opposed to the office)?","nullable":true},"created_by_user_id":{"type":"integer","format":"int32","example":197,"description":"Id of the user who booked the appointment","nullable":true},"is_guardian":{"type":"boolean","example":false,"description":"Was the appointment booked by a guardian?","nullable":true},"patient_confirmed_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of patient_confirmation in UTC","nullable":true},"cancelled_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled","nullable":true},"is_new_clients_patient":{"type":"boolean","example":false,"description":"Is this a new patient at this practice?","nullable":true},"confirmed_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of appointment confirmation by the office in UTC","nullable":true},"sooner_if_possible":{"type":"boolean","example":false,"description":"Does patient want an earlier time?","nullable":true},"operatory_id":{"type":"integer","format":"int64","example":181,"description":"Operatory id for the appointment","nullable":true},"checked_out":{"type":"boolean","example":false,"description":"Has the patient checked out? Not supported by all integrations","nullable":true},"checked_out_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of check out in UTC","nullable":true},"referrer":{"type":"string","example":"http://mypractice.com/book","description":"Optional field to store URI origin of the booking","nullable":true},"is_past_patient":{"type":"boolean","example":true,"description":"Does this patient have prior appointments?","nullable":true},"timezone_offset":{"type":"string","example":"-4:00","description":"Timezone offset string"},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientWithGuarantor"},"operatory":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryBasic"},"appointment_type":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"},"description":"Procedures assigned to the appointment"},"descriptors":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_EmrApptDescriptor"},"description":"EHR descriptors"},"booking_details":{"$ref":"#/components/schemas/API_V2_Entities_Appointment_OnlineBookingDetail"}}},"API_V2_Entities_PatientWithGuarantor":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"preferred_locale":{"type":"string","example":"es","description":"The patient's preferred language setting used for displaying NexHealth forms and communications","nullable":true},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_User"}}},"API_V2_Entities_User":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true}}},"API_V2_Entities_OperatoryBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"Operatories Id"},"name":{"type":"string","example":"op1","description":"Name of the operatory from the integrated system"},"foreign_id":{"type":"string","example":"1","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique identifier for the integrated system"},"location_id":{"type":"integer","format":"int32","example":4,"description":"Location ID relevant to the Operatory","nullable":true},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-17T19:23:49.176Z","description":"Last time the resource was refreshed with data from the data source in UTC","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Operatories created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Operatories last updation time in UTC"},"display_name":{"type":"string","example":"op1","description":"Optional custom display name","nullable":true},"active":{"type":"boolean","example":true,"description":"Is operatory active?"},"bookable_online":{"type":"boolean","example":true,"description":"Operatory is active for online booking?"}}},"API_V2_Entities_Appointment_OnlineBookingDetail":{"type":"object","properties":{"booked_via_nexhealth_generated_link":{"type":"boolean","example":true,"description":"True if the appointment was booked from a link generated by a NexHealth template or campaign"},"campaign_type":{"type":"string","enum":["cancelled_recall","continuing_care_recall","manual","missed_recall","recall","google_booking"],"example":"recall","description":"Indicates whether this appointment was booked from a NexHealth template, campaign, or google booking link"},"campaign_id":{"type":"string","example":"1","description":"Indicates the ID of the template or campaign that included the online booking link the user clicked on"},"campaign_medium":{"type":"string","enum":["email","sms"],"example":"sms","description":"Indicates which medium contained the online booking link the user clicked on"},"booked_via_one_click":{"type":"boolean","example":false,"description":"True if the appointment was booked by a NexHealth one-click booking link"}}},"patchAppointmentsId":{"type":"object","properties":{"appt":{"type":"object","description":"Appointment detail object","properties":{"confirmed":{"type":"boolean","description":"Denotes the office has confirmed the appt, update this to write back confirm status","example":true},"cancelled":{"type":"boolean","description":"Denotes the office has cancelled the appt, update this to write back cancel status","example":false},"checkin_at":{"type":"string","format":"date-time","description":"Denotes the office has checked in the appt at this time, update this to write back checked in status. Must be a parseable date/time string, recommended format is YYYY-MM-DDThh:mm:ss+0000","example":"2024-04-15T14:55:00Z"},"start_time":{"type":"string","format":"date-time","description":"Appointment start time. Must be a parseable date/time string. Recommended format is YYYY-MM-DDThh:mm:ss+0000.","example":"2024-04-15T15:00:00Z"},"end_time":{"type":"string","format":"date-time","description":"Appointment end time. Must be a parseable date/time string. Recommended format is YYYY-MM-DDThh:mm:ss+0000.","example":"2024-04-15T15:30:00Z"},"operatory_id":{"type":"integer","format":"int32","description":"The operatory for this appointment","example":181},"note":{"type":"string","description":"A note that will be written to the EHR","example":"Patient has been having a cough for 3 days"}}}},"required":["appt"],"description":"Edit Appointment"},"API_V2_Entities_AppointmentResponse_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentResponse"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_AppointmentResponse_Response model"},"API_V2_Entities_AppointmentResponse":{"type":"object","properties":{"appt":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentWithoutIncludes"},"stripe_client_secret":{"type":"string"}}},"API_V2_Entities_AppointmentWithoutIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"patient_id":{"type":"integer","format":"int32","example":2897,"description":"Appointment patient id","nullable":true},"provider_id":{"type":"integer","format":"int32","example":104,"description":"Provider id","nullable":true},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name","nullable":true},"start_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled start time in UTC"},"confirmed":{"type":"boolean","example":true,"description":"Appointment confirmation status","nullable":true},"patient_missed":{"type":"boolean","example":false,"description":"Did the patient no show? Not supported by all integrations","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment last updation time in UTC"},"note":{"type":"string","example":"Patient has been having a cough for 3 days","description":"Appointment note","nullable":true},"end_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled end time in UTC"},"unavailable":{"type":"boolean","example":false,"description":"Is this appointment a scheduling block (blocks off the schedule)","nullable":true},"cancelled":{"type":"boolean","example":false,"description":"Is this appointment cancelled?"},"timezone":{"type":"string","example":"America/New_York","description":"Appointment timezone"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"appointment_type_id":{"type":"integer","format":"int32","example":27,"description":"Nexhealth appointment_type id, 0 if not set","nullable":true},"checkin_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time the patient checked in at in UTC. Not supported by all integrations","nullable":true},"location_id":{"type":"integer","format":"int32","example":1,"description":"Appointment location id","nullable":true},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"misc":{"type":"object","example":{"is_booked_on_nexhealth":true},"description":"Miscellaneous information for the appointment. The is_booked_on_nexhealth key indicates whether the appointment was booked through NexHealth","nullable":true},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last Sync time in UTC","nullable":true},"patient_confirmed":{"type":"boolean","example":false,"description":"Is this appointment confirmed by the patient (as opposed to the office)?","nullable":true},"created_by_user_id":{"type":"integer","format":"int32","example":197,"description":"Id of the user who booked the appointment","nullable":true},"is_guardian":{"type":"boolean","example":false,"description":"Was the appointment booked by a guardian?","nullable":true},"patient_confirmed_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of patient_confirmation in UTC","nullable":true},"cancelled_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled","nullable":true},"is_new_clients_patient":{"type":"boolean","example":false,"description":"Is this a new patient at this practice?","nullable":true},"confirmed_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of appointment confirmation by the office in UTC","nullable":true},"sooner_if_possible":{"type":"boolean","example":false,"description":"Does patient want an earlier time?","nullable":true},"operatory_id":{"type":"integer","format":"int64","example":181,"description":"Operatory id for the appointment","nullable":true},"checked_out":{"type":"boolean","example":false,"description":"Has the patient checked out? Not supported by all integrations","nullable":true},"checked_out_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Time of check out in UTC","nullable":true},"referrer":{"type":"string","example":"http://mypractice.com/book","description":"Optional field to store URI origin of the booking","nullable":true},"is_past_patient":{"type":"boolean","example":true,"description":"Does this patient have prior appointments?","nullable":true},"timezone_offset":{"type":"string","example":"-4:00","description":"Timezone offset string"}}},"API_V31_Entities_Appointment_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Appointment"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Appointment_Response model"},"API_V31_Entities_Appointment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"patient_id":{"type":"integer","format":"int32","example":2897,"description":"Appointment patient id"},"provider_id":{"type":"integer","format":"int32","example":104,"description":"Provider id"},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name"},"start_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled start time in UTC"},"confirmed":{"type":"boolean","example":true,"description":"Appointment confirmation status"},"patient_missed":{"type":"boolean","example":false,"description":"Did the patient no show? Not supported by all integrations"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment last updation time in UTC"},"note":{"type":"string","example":"Patient has been having a cough for 3 days","description":" Appointment note"},"end_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled end time in UTC"},"unavailable":{"type":"boolean","example":false,"description":"Is this appointment a scheduling block (blocks off the schedule)"},"cancelled":{"type":"boolean","example":false,"description":"Is this appointment cancelled?"},"timezone":{"type":"string","example":"America/New_York","description":"Appointment timezone"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"appointment_type_id":{"type":"integer","format":"int32","example":0,"description":"Nexhealth appointment_type id, 0 if not set"},"checkin_at":{"type":"string","format":"date-time","description":"Time the patient checked in at in UTC. Not supported by all integrations"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Appointment location id"},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system"},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"misc":{"type":"object","example":{"is_booked_on_nexhealth":true},"description":"Miscellaneous information for the appointment"},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last Sync time in UTC"},"patient_confirmed":{"type":"integer","format":"int32","example":0,"description":"Is this appointment confirmed by the patient (as opposed to the office)?"},"created_by_user_id":{"type":"integer","format":"int32","example":197,"description":"Id of the user who booked the appointment"},"patient_confirmed_at":{"type":"string","format":"date-time","description":"Time of patient_confirmation in UTC"},"cancelled_at":{"type":"string","format":"date-time","description":"Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled"},"confirmed_at":{"type":"string","format":"date-time","description":"Time of appointment confirmation by the office in UTC"},"sooner_if_possible":{"type":"boolean","description":"Does patient want an earlier time?"},"operatory_id":{"type":"integer","format":"int64","example":181,"description":"Operatory id for the appointment"},"checked_out":{"type":"boolean","example":false,"description":"Has the patient checked out? Not supported by all integrations"},"checked_out_at":{"type":"string","format":"date-time","description":"Time of check out in UTC"},"is_past_patient":{"type":"boolean","example":true,"description":"Does this patient have prior appointments?"},"timezone_offset":{"type":"string","example":"-4:00","description":"Timezone offset string"},"descriptors":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_EmrApptDescriptor"},"description":"EHR descriptors"},"patient":{"$ref":"#/components/schemas/API_V31_Entities_PatientWithGuarantor"},"operatory":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryBasic"},"appointment_type":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"},"description":"Procedures assigned to the appointment"},"booking_details":{"$ref":"#/components/schemas/API_V2_Entities_Appointment_OnlineBookingDetail"}}},"API_V31_Entities_EmrApptDescriptor":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1822,"description":"Descriptor id"},"descriptor_type":{"type":"string","example":"Procedure Code","description":"The type of descriptor"},"name":{"type":"string","example":"Emr Descriptor Name","description":"The name of descriptor"},"code":{"type":"string","example":"Emr Descriptor Code","description":"The code of descriptor"},"location_id":{"type":"integer","format":"int32","example":13,"description":"The location this object belongs to"},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system"},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"data":{"type":"object","example":{},"description":"The configuration object, structure depends on the underlying EMR"},"active":{"type":"boolean","example":true,"description":"Is descriptor active?"},"last_sync_time":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"Last Sync time in UTC"},"created_at":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"The datetime the descriptor was created in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2021-05-21T16:23:03.046Z","description":"The datetime the descriptor was last updated in UTC"}}},"API_V31_Entities_PatientWithGuarantor":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","description":"Last time the resource was refreshed with data from the data source"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"cell_phone_number":{"type":"string","example":"5163042196","description":"Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number — which is how most systems report it back after a write — this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number."},"preferred_phone_number":{"type":"string","example":"5163042196","description":"The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only — write one of the typed phone number fields to change it."},"guarantor_id":{"type":"integer","format":"int32","description":"User id of this patient's responsible party"},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type"},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users"},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"},"gender":{"type":"string","example":"Female","description":"Gender from biographical data"},"new_patient":{"type":"boolean","example":false,"description":"Whether the patient is new"},"non_patient":{"type":"boolean","example":true,"description":"Whether this is a non-patient user record"},"date_of_birth":{"type":"string","example":"1964-05-03","description":"Date of birth in YYYY-MM-DD format"},"premedication":{"type":"string","description":"Premedication notes"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"}}},"API_V31_Entities_AppointmentResponse_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentResponse"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_AppointmentResponse_Response model"},"API_V31_Entities_AppointmentResponse":{"type":"object","properties":{"appt":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentWithoutIncludes"}}},"API_V31_Entities_AppointmentWithoutIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"patient_id":{"type":"integer","format":"int32","example":2897,"description":"Appointment patient id"},"provider_id":{"type":"integer","format":"int32","example":104,"description":"Provider id"},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name"},"start_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled start time in UTC"},"confirmed":{"type":"boolean","example":true,"description":"Appointment confirmation status"},"patient_missed":{"type":"boolean","example":false,"description":"Did the patient no show? Not supported by all integrations"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment last updation time in UTC"},"note":{"type":"string","example":"Patient has been having a cough for 3 days","description":" Appointment note"},"end_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled end time in UTC"},"unavailable":{"type":"boolean","example":false,"description":"Is this appointment a scheduling block (blocks off the schedule)"},"cancelled":{"type":"boolean","example":false,"description":"Is this appointment cancelled?"},"timezone":{"type":"string","example":"America/New_York","description":"Appointment timezone"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"appointment_type_id":{"type":"integer","format":"int32","example":0,"description":"Nexhealth appointment_type id, 0 if not set"},"checkin_at":{"type":"string","format":"date-time","description":"Time the patient checked in at in UTC. Not supported by all integrations"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Appointment location id"},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system"},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"misc":{"type":"object","example":{"is_booked_on_nexhealth":true},"description":"Miscellaneous information for the appointment"},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last Sync time in UTC"},"patient_confirmed":{"type":"integer","format":"int32","example":0,"description":"Is this appointment confirmed by the patient (as opposed to the office)?"},"created_by_user_id":{"type":"integer","format":"int32","example":197,"description":"Id of the user who booked the appointment"},"patient_confirmed_at":{"type":"string","format":"date-time","description":"Time of patient_confirmation in UTC"},"cancelled_at":{"type":"string","format":"date-time","description":"Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled"},"confirmed_at":{"type":"string","format":"date-time","description":"Time of appointment confirmation by the office in UTC"},"sooner_if_possible":{"type":"boolean","description":"Does patient want an earlier time?"},"operatory_id":{"type":"integer","format":"int64","example":181,"description":"Operatory id for the appointment"},"checked_out":{"type":"boolean","example":false,"description":"Has the patient checked out? Not supported by all integrations"},"checked_out_at":{"type":"string","format":"date-time","description":"Time of check out in UTC"},"is_past_patient":{"type":"boolean","example":true,"description":"Does this patient have prior appointments?"},"timezone_offset":{"type":"string","example":"-4:00","description":"Timezone offset string"}}},"API_V2_Entities_Appointment_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Appointment"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Appointment_Collection_Response model"},"postAppointments":{"type":"object","properties":{"appointments_per_timeslot":{"type":"integer","format":"int32","minimum":1,"maximum":5,"default":1},"appt":{"type":"object","description":"Appointment detail object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Id of an existing patient. Omit and supply the `patient` object instead to create a new patient."},"provider_id":{"type":"integer","format":"int32","description":"Provider id"},"operatory_id":{"type":"integer","format":"int32","description":"Required if bookings are mapped to operatories for this location"},"start_time":{"type":"string","format":"date-time","description":"Appointment start time. Must be a parseable date/time string, recommended format is YYYY-MM-DDThh:mm:ss+0000"},"end_time":{"type":"string","format":"date-time","description":"Appointment end time. Must be a parseable date/time string. Recommended format is YYYY-MM-DDThh:mm:ss+0000."},"appointment_type_id":{"type":"integer","format":"int32","description":"The appointment type for this appointment"},"note":{"type":"string","description":"A note that will be written to the EHR. 128 character limit."},"unavailable":{"type":"boolean","description":"Denote this block of time as unavailable on the schedule, don't specify a patient with this"},"patient":{"type":"object","description":"Patient details. Supply this (without a patient_id) to create a new patient for the appointment.","properties":{"first_name":{"type":"string","description":"Patients first name"},"last_name":{"type":"string","description":"Patients last name"},"middle_name":{"type":"string","description":"Patient middle name"},"email":{"type":"string","description":"Patient email"},"bio":{"type":"object","description":"Patient Bio","properties":{"date_of_birth":{"type":"string","format":"date","description":"Patient date of birth. Must be a parseable date string, recommended formats is YYYY-MM-DD"},"gender":{"type":"string","description":"Patient gender. Gender will be  default to Female if not provided","enum":["Male","Female","Other"]},"phone_number":{"type":"string","description":"Patient phone number"},"cell_phone_number":{"type":"string","description":"Patient cell phone number"},"home_phone_number":{"type":"string","description":"Patient home phone number"},"address_line_1":{"type":"string","description":"Patient street address"},"address_line_2":{"type":"string","description":"Patient street address line 2"},"city":{"type":"string","description":"Patient city"},"state":{"type":"string","description":"Patient state"},"zip_code":{"type":"string","description":"Patient zip code"}},"required":["date_of_birth"]}},"required":["first_name","last_name","bio"]},"descriptor_ids":{"type":"array","description":"Associate descriptors with this appointment, which will also be synchronized on insertion","items":{"type":"integer","format":"int32"}}},"required":["provider_id","start_time"]}},"required":["appt"],"description":"Create appointment"},"API_V2_Entities_AppointmentWithoutIncludes_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentWithoutIncludes"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V2_Entities_AppointmentWithoutIncludes_Collection_Response_WithCursor model"},"API_V31_Entities_AppointmentWithDescriptors_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_AppointmentWithDescriptors"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_AppointmentWithDescriptors_Collection_Response_WithCursor model"},"API_V31_Entities_AppointmentWithDescriptors":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"patient_id":{"type":"integer","format":"int32","example":2897,"description":"Appointment patient id"},"provider_id":{"type":"integer","format":"int32","example":104,"description":"Provider id"},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name"},"start_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled start time in UTC"},"confirmed":{"type":"boolean","example":true,"description":"Appointment confirmation status"},"patient_missed":{"type":"boolean","example":false,"description":"Did the patient no show? Not supported by all integrations"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment last updation time in UTC"},"note":{"type":"string","example":"Patient has been having a cough for 3 days","description":" Appointment note"},"end_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Appointment scheduled end time in UTC"},"unavailable":{"type":"boolean","example":false,"description":"Is this appointment a scheduling block (blocks off the schedule)"},"cancelled":{"type":"boolean","example":false,"description":"Is this appointment cancelled?"},"timezone":{"type":"string","example":"America/New_York","description":"Appointment timezone"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"appointment_type_id":{"type":"integer","format":"int32","example":0,"description":"Nexhealth appointment_type id, 0 if not set"},"checkin_at":{"type":"string","format":"date-time","description":"Time the patient checked in at in UTC. Not supported by all integrations"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Appointment location id"},"foreign_id":{"type":"string","example":"94","description":"Unique identifier of this resource from the integrated system"},"foreign_id_type":{"type":"string","example":"msg-dentrix-DataSource-100","description":"Unique identifier for the integrated system itself"},"misc":{"type":"object","example":{"is_booked_on_nexhealth":true},"description":"Miscellaneous information for the appointment"},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last Sync time in UTC"},"patient_confirmed":{"type":"integer","format":"int32","example":0,"description":"Is this appointment confirmed by the patient (as opposed to the office)?"},"created_by_user_id":{"type":"integer","format":"int32","example":197,"description":"Id of the user who booked the appointment"},"patient_confirmed_at":{"type":"string","format":"date-time","description":"Time of patient_confirmation in UTC"},"cancelled_at":{"type":"string","format":"date-time","description":"Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled"},"confirmed_at":{"type":"string","format":"date-time","description":"Time of appointment confirmation by the office in UTC"},"sooner_if_possible":{"type":"boolean","description":"Does patient want an earlier time?"},"operatory_id":{"type":"integer","format":"int64","example":181,"description":"Operatory id for the appointment"},"checked_out":{"type":"boolean","example":false,"description":"Has the patient checked out? Not supported by all integrations"},"checked_out_at":{"type":"string","format":"date-time","description":"Time of check out in UTC"},"is_past_patient":{"type":"boolean","example":true,"description":"Does this patient have prior appointments?"},"timezone_offset":{"type":"string","example":"-4:00","description":"Timezone offset string"},"descriptors":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_EmrApptDescriptor"},"description":"EHR descriptors"}}},"API_V2_Entities_AuthorizationResponse_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_AuthorizationResponse"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_AuthorizationResponse_Response model"},"API_V2_Entities_AuthorizationResponse":{"type":"object","properties":{"token":{"type":"string","example":"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwic2NwIjoiYXBpX3VzZXIiLCJleHAiOjE2MjgwMDM2NDMsImlhdCI6MTYyODAwMzYzMywianRpIjoiYTEzYzdlZTAtNmMwOC00YTE5LWExYzAtN2ZkMjNlNDJiZDEzIn0.zu8rJk6F4ZRzkflWPK0ykxRNsJR9A6IZiU9kxcsdxn4","description":"Use this bearer token to access protected routes"}}},"API_V2_Entities_Ledger_Charge_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Charge"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Ledger_Charge_Collection_Response model"},"API_V2_Entities_Ledger_Charge":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"value":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the procedure that this item is for"},"date":{"type":"string","format":"date","example":"2020-06-05","description":"The date of this line item as it appears in the EHR"},"notes":{"type":"string","description":"Notes attached to this item"},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"procedure":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"}}},"API_V2_Entities_Ledger_Charge_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Charge"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Ledger_Charge_Response model"},"API_V20240412_Entities_Ledger_ChargeWithClaimPayouts_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeWithClaimPayouts"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_ChargeWithClaimPayouts_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_ChargeWithClaimPayouts":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge","nullable":true},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted","nullable":true},"claim_payouts":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Insurance_ClaimPayout"},"description":"Claim payouts for this charge"}}},"API_V20240412_Entities_Ledger_Insurance_ClaimPayout":{"type":"object","properties":{"amount_billed_to_insurance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"allowed_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"fee_schedule_procedure_code":{"$ref":"#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCode"},"claim_id":{"type":"integer","format":"int64","example":1234,"description":"The claim id associated with this payout"}}},"API_V20240412_Entities_FeeScheduleProcedureCode":{"type":"object","properties":{"procedure_code_id":{"type":"string","example":"ab123456-11aa-99ff-a111-d1ee12345678","description":"The uuid of the procedure code associated with the fee schedule","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"code":{"type":"string","example":"D0120","description":"The code of the procedure associated with the fee schedule","nullable":true},"id":{"type":"integer","format":"int64","example":113,"description":"Fee Schedule Procedure Resource id"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The location id of the fee schedule","nullable":true},"fee_schedule_id":{"type":"integer","format":"int64","example":1234,"description":"The id of the fee schedule associated with the fee schedule procedure","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Fee Schedule Procedure update date in UTC"}}},"API_V20240412_Entities_Ledger_Charge_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Charge"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_Charge_Response model"},"API_V20240412_Entities_Ledger_Charge":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge","nullable":true},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted","nullable":true},"patient":{"$ref":"#/components/schemas/API_V20240412_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_User"},"procedure":{"$ref":"#/components/schemas/API_V20240412_Entities_Procedure"},"claim_payouts":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Insurance_ClaimPayout"},"description":"Claim payouts for this charge"},"claims":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Insurance_ClaimBasic"},"description":"Claims associated with this charge"},"totals":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeClaimTotals"}}},"API_V20240412_Entities_PatientBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"provider_id":{"type":"integer","format":"int32","example":23,"description":"User id of this patient's primary provider","nullable":true}}},"API_V20240412_Entities_Procedure":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":11,"description":"Procedure id"},"location_id":{"type":"integer","format":"int32","example":21,"description":"Location id","nullable":true},"patient_id":{"type":"integer","format":"int32","example":162,"description":"Patient id","nullable":true},"provider_id":{"type":"integer","format":"int32","example":84,"description":"Provider id","nullable":true},"appointment_id":{"type":"integer","format":"int64","example":283,"description":"Appointment id. Null when the procedure is not attached to an appointment","nullable":true},"code":{"type":"string","example":"D6100","description":"Procedure code","nullable":true},"name":{"type":"string","example":"Implant Removal","description":"Procedure name","nullable":true},"status":{"type":"string","enum":["planned","scheduled","completed","inactive","referred"],"example":"referred","description":"Procedure status","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure update date in UTC"},"body_site":{"$ref":"#/components/schemas/API_V2_Entities_ProcedureBodySite"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"start_date":{"type":"string","format":"date","example":"2022-06-24","description":"Start date for procedure","nullable":true},"end_date":{"type":"string","format":"date","example":"2022-06-24","description":"End date for procedure","nullable":true},"treatment_plan_ids":{"type":"array","items":{"type":"integer","format":"int64"},"example":[42,57],"description":"Treatment plan ids"}}},"API_V20240412_Entities_Ledger_Insurance_ClaimBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Claim id"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id. Null when the claim is not attached to a location","nullable":true},"patient_id":{"type":"integer","format":"int32","example":1002,"description":"Patient id. Null when the claim is not attached to a patient","nullable":true},"provider_id":{"type":"integer","format":"int32","example":101,"description":"Provider id. Null when the claim is not attached to a provider","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":1001,"description":"User id of the patient's responsible party. Null when the claim is not attached to a guarantor","nullable":true},"status":{"type":"string","enum":["draft","sent","received","canceled"],"example":"sent","description":"Claim status","nullable":true},"received_at":{"type":"string","format":"date-time","example":"2024-06-10T15:16:57.000Z","description":"Date and time in UTC when the claim was received from insurance","nullable":true},"sent_at":{"type":"string","format":"date-time","example":"2024-06-03T11:23:12.000Z","description":"Date and time in UTC when the claim was sent to insurance","nullable":true},"note":{"type":"string","example":"Claim was sent to the insurance company","description":"Claim notes","nullable":true},"primary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the primary insurance plan this claim was or will be sent to","nullable":true},"secondary_insurance_plan_id":{"type":"integer","format":"int64","example":10022,"description":"Id of the secondary insurance plan this claim was or will be sent to","nullable":true},"date_of_service":{"type":"string","format":"date","example":"2024-06-03","description":"The date in UTC when the procedures included in the claim occurred","nullable":true},"totals":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeClaimTotals"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Claim update date in UTC"}}},"API_V20240412_Entities_Ledger_ChargeClaimTotals":{"type":"object","properties":{"amount_billed_to_insurance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V31_Entities_Ledger_ChargeWithClaimPayouts_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeWithClaimPayouts"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Ledger_ChargeWithClaimPayouts_Collection_Response_WithCursor model"},"API_V31_Entities_Ledger_ChargeWithClaimPayouts":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge"},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted"},"claim_payouts":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Insurance_ClaimPayout"},"description":"Claim payouts for this charge"}}},"API_V31_Entities_Ledger_Insurance_ClaimPayout":{"type":"object","properties":{"amount_billed_to_insurance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"allowed_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"fee_schedule_procedure_code":{"$ref":"#/components/schemas/API_V31_Entities_FeeScheduleProcedureCode"},"claim_id":{"type":"integer","format":"int64","example":1234,"description":"The claim id associated with this payout"}}},"API_V31_Entities_FeeScheduleProcedureCode":{"type":"object","properties":{"procedure_code_id":{"type":"string","example":"ab123456-11aa-99ff-a111-d1ee12345678","description":"The uuid of the procedure code associated with the fee schedule"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"code":{"type":"string","example":"D0120","description":"The code of the procedure associated with the fee schedule"},"id":{"type":"integer","format":"int64","example":113,"description":"Fee Schedule Procedure Resource id"},"location_id":{"type":"integer","format":"int32","description":"The location id of the fee schedule"},"fee_schedule_id":{"type":"integer","format":"int64","example":1234,"description":"The id of the fee schedule associated with the fee schedule procedure"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Fee Schedule Procedure update date in UTC"}}},"API_V31_Entities_Ledger_Charge_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Charge"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Ledger_Charge_Response model"},"API_V31_Entities_Ledger_Charge":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge"},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted"},"patient":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V31_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"procedure":{"$ref":"#/components/schemas/API_V31_Entities_Procedure"},"claim_payouts":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Insurance_ClaimPayout"},"description":"Claim payouts for this charge"},"claims":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Insurance_ClaimBasic"},"description":"Claims associated with this charge"},"totals":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeClaimTotals"}}},"API_V31_Entities_Procedure":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":11,"description":"Procedure id"},"location_id":{"type":"integer","format":"int32","example":21,"description":"Location id"},"patient_id":{"type":"integer","format":"int32","example":162,"description":"Patient id"},"provider_id":{"type":"integer","format":"int32","example":84,"description":"Provider id"},"appointment_id":{"type":"integer","format":"int64","example":283,"description":"Appointment id"},"code":{"type":"string","example":"D6100","description":"Procedure code"},"name":{"type":"string","example":"Implant Removal","description":"Procedure name"},"status":{"type":"string","enum":["planned","scheduled","completed","inactive","referred"],"example":"referred","description":"Procedure status"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure update date in UTC"},"body_site":{"$ref":"#/components/schemas/API_V2_Entities_ProcedureBodySite"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"start_date":{"type":"string","format":"date","example":"2022-06-24","description":"Start date for procedure"},"end_date":{"type":"string","format":"date","example":"2022-06-24","description":"End date for procedure"},"treatment_plan_ids":{"type":"array","items":{"type":"integer","format":"int64"},"example":[42,57],"description":"Treatment plan ids"}}},"API_V31_Entities_Ledger_Insurance_ClaimBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Claim id"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id"},"patient_id":{"type":"integer","format":"int32","example":1002,"description":"Patient id"},"provider_id":{"type":"integer","format":"int32","example":101,"description":"Provider id"},"guarantor_id":{"type":"integer","format":"int32","example":1001,"description":"User id of the patient's responsible party"},"status":{"type":"string","enum":["draft","sent","received","canceled"],"example":"sent","description":"Claim status"},"received_at":{"type":"string","format":"date-time","example":"2024-06-10T15:16:57.000Z","description":"Date and time in UTC when the claim was received from insurance"},"sent_at":{"type":"string","format":"date-time","example":"2024-06-03T11:23:12.000Z","description":"Date and time in UTC when the claim was sent to insurance"},"note":{"type":"string","example":"Claim was sent to the insurance company","description":"Claim notes"},"primary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the primary insurance provider this claim was or will be sent to"},"secondary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the secondary insurance provider this claim was or will be sent to"},"date_of_service":{"type":"string","format":"date","example":"2024-06-03","description":"The date in UTC when the procedures included in the claim occured"},"totals":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeClaimTotals"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Claim update date in UTC"}}},"API_V31_Entities_Ledger_ChargeClaimTotals":{"type":"object","properties":{"amount_billed_to_insurance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V2_Entities_DocumentType_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_DocumentType"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_DocumentType_Collection_Response model"},"API_V2_Entities_DocumentType":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Document type id"},"name":{"type":"string","example":"Health History and Patient Forms","description":"The name of the document type"},"active":{"type":"boolean","example":true,"description":"Whether the document type is currently active in the EHR"}}},"API_V2_Entities_DocumentType_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_DocumentType"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_DocumentType_Response model"},"API_V31_Entities_DocumentType_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_DocumentType"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_DocumentType_Collection_Response model"},"API_V31_Entities_DocumentType":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Document type id"},"name":{"type":"string","example":"Health History and Patient Forms","description":"The name of the document type"},"active":{"type":"boolean","example":true,"description":"Whether the document type is currently active in the EHR"},"foreign_id":{"type":"string","example":"1","description":"Unique identifier of this resource from the integrated system","nullable":true}}},"API_V31_Entities_DocumentType_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_DocumentType"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_DocumentType_Response model"},"API_V2_Entities_Institution_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Institution"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Institution_Collection_Response model"},"API_V2_Entities_Institution":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"name":{"type":"string","example":"General Practice","description":"Name of the institution"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Institution created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Institution last updated time in UTC"},"subdomain":{"type":"string","example":"example-sandbox","description":"Data partitioned subdomain name"},"phone_number":{"type":"string","example":"2222222222","description":"Institution contact number"},"emrs":{"type":"array","items":{"type":"string"},"example":["dentrix","curve2"],"description":"Array of strings of EMRs used by this institution"},"country_code":{"type":"string","example":"US","description":"2- or 3-letter country code for country"},"appointment_types_location_scoped":{"type":"boolean","example":false,"description":"Does each location have its own appointment types?"},"is_sync_notifications":{"type":"boolean","example":true,"description":"Receive's emails when sync connection goes down"},"notify_insert_fails":{"type":"boolean","example":false,"description":"Receive's emails on appointment insert fail"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_LocationBasic"},"description":"Collection of locations"}}},"API_Entities_LocationBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":7,"description":"Location id"},"name":{"type":"string","example":"Default","description":"Location name"},"street_address":{"type":"string","example":"123 Law St","description":"Location street address"},"street_address_2":{"type":"string","example":"85335, North East","description":"Location street address 2"},"city":{"type":"string","example":"New York","description":"Location city"},"state":{"type":"string","example":"NY","description":"2 letter state code"},"zip_code":{"type":"string","example":"54700","description":"Patient zip code"},"phone_number":{"type":"string","example":"8888750851","description":"Practice phone number"},"email":{"type":"string","example":"defaultLocation@nexhealth.com","description":"Location email id"},"inactive":{"type":"boolean","example":false,"description":"Is this location not being actively used?"}}},"API_V2_Entities_Institution_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_Institution"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Institution_Response model"},"API_V31_Entities_Institution_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Institution"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Institution_Collection_Response model"},"API_V31_Entities_Institution":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"name":{"type":"string","example":"General Practice","description":"Name of the institution"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Institution created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Institution last updated time in UTC"},"subdomain":{"type":"string","example":"example-sandbox","description":"Data partitioned subdomain name"},"phone_number":{"type":"string","example":"2222222222","description":"Institution contact number"},"country_code":{"type":"string","example":"US","description":"2- or 3-letter country code for country"},"appointment_types_location_scoped":{"type":"boolean","example":false,"description":"Does each location have its own appointment types?"},"is_sync_notifications":{"type":"boolean","example":true,"description":"Receive's emails when sync connection goes down"},"notify_insert_fails":{"type":"boolean","example":false,"description":"Receive's emails on appointment insert fail"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_LocationBasic"},"description":"Collection of locations"},"ehrs":{"type":"array","items":{"type":"string"},"example":["dentrix","curve2"],"description":"Array of strings of EHRs used by this institution"}}},"API_V31_Entities_Institution_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Institution"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Institution_Response model"},"API_V2_Entities_Insurance_EhrPlanWithIncludes_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_EhrPlanWithIncludes"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Insurance_EhrPlanWithIncludes_Collection_Response model"},"API_V2_Entities_Insurance_EhrPlanWithIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"payer_id":{"type":"string","example":"87726","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","nullable":true},"name":{"type":"string","example":"United Healthcare","description":"Plan name","nullable":true},"address":{"type":"string","example":"123 Law St","description":"Street address","nullable":true},"address2":{"type":"string","example":"85335, North East","description":"Street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"2 letter country code","nullable":true},"group_num":{"type":"string","example":"12345","description":"Group number","nullable":true},"employer_name":{"type":"string","example":"Walmart","description":"Employer name","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Plan update date in UTC"},"patient_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverage"},"description":"List of patient coverages"},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"},"description":"List of individuals who hold subscriptions to this plan."}}},"API_V2_Entities_Insurance_PatientCoverage":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient","nullable":true},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies","nullable":true},"plan_id":{"type":"integer","format":"int64","example":18,"description":"The ID of the insurance plan this coverage subscribes to","nullable":true},"subscriber_num":{"type":"string","example":"123456789","description":"The subscriber's identification number for the plan","nullable":true},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"The date the coverage takes effect","nullable":true},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"The date the coverage expires","nullable":true}}},"API_V2_Entities_Insurance_Subscriber":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"The subscriber's id"},"name":{"type":"string","example":"John Smith","description":"The subscriber's full name"},"date_of_birth":{"type":"string","example":"1990-06-05","description":"The subscriber's date of birth in YYYY-MM-DD format","nullable":true}}},"API_V2_Entities_Insurance_EhrPlanWithIncludes_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_EhrPlanWithIncludes"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Insurance_EhrPlanWithIncludes_Response model"},"API_Entities_Insurance_EhrPlan_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_Insurance_EhrPlan"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_Entities_Insurance_EhrPlan_Collection_Response_WithCursor model"},"API_Entities_Insurance_EhrPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"payer_id":{"type":"string","example":"87726","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","nullable":true},"name":{"type":"string","example":"United Healthcare","description":"Plan name","nullable":true},"address":{"type":"string","example":"123 Law St","description":"Street address","nullable":true},"address2":{"type":"string","example":"85335, North East","description":"Street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"2 letter country code","nullable":true},"group_num":{"type":"string","example":"12345","description":"Group number","nullable":true},"employer_name":{"type":"string","example":"Walmart","description":"Employer name","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Plan update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true","nullable":true}}},"API_V20240412_Entities_Insurance_EhrPlanWithIncludes_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Insurance_EhrPlanWithIncludes"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Insurance_EhrPlanWithIncludes_Response model"},"API_V20240412_Entities_Insurance_EhrPlanWithIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"payer_id":{"type":"string","example":"87726","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","nullable":true},"name":{"type":"string","example":"United Healthcare","description":"Plan name","nullable":true},"address":{"type":"string","example":"123 Law St","description":"Street address","nullable":true},"address2":{"type":"string","example":"85335, North East","description":"Street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"2 letter country code","nullable":true},"group_num":{"type":"string","example":"12345","description":"Group number","nullable":true},"employer_name":{"type":"string","example":"Walmart","description":"Employer name","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Plan update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true","nullable":true},"patient_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverage"},"description":"List of patient coverages for this plan"},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"},"description":"List of individuals who hold subscriptions to this plan"},"fee_schedule":{"$ref":"#/components/schemas/API_Entities_FeeSchedule"}}},"API_Entities_FeeSchedule":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Fee schedule id"},"name":{"type":"string","example":"Cash","description":"The name of the fee schedule"},"active":{"type":"boolean","example":true,"description":"Indicates if the fee schedule is active","nullable":true},"location_id":{"type":"integer","format":"int32","example":21,"description":"The id of the location this fee schedule belongs to","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Fee Schedule update date in UTC"}}},"API_V31_Entities_Insurance_EhrPlan_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Insurance_EhrPlan_Collection_Response_WithCursor model"},"API_V31_Entities_Insurance_EhrPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"payer_id":{"type":"string","example":"87726","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","nullable":true},"name":{"type":"string","example":"United Healthcare","description":"Plan name","nullable":true},"address":{"type":"string","example":"123 Law St","description":"Street address","nullable":true},"address2":{"type":"string","example":"85335, North East","description":"Street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"2 letter country code","nullable":true},"group_num":{"type":"string","example":"12345","description":"Group number","nullable":true},"employer_name":{"type":"string","example":"Walmart","description":"Employer name","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Plan update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true","nullable":true},"patient_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverage"},"description":"List of patient coverages"},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"},"description":"List of individuals who hold subscriptions to this plan."},"fee_schedule":{"$ref":"#/components/schemas/API_Entities_FeeSchedule"},"annual_max_individual":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"benefit_year_renewal_month":{"type":"integer","format":"int32","example":1,"description":"Month (1-12) when the benefit year resets. Null if not provided by the EHR."}}},"postInsurancePlans":{"type":"object","properties":{"insurance_plan":{"type":"object","properties":{"name":{"type":"string","description":"Plan name"},"employer_name":{"type":"string","description":"Employer name"},"payer_id":{"type":"string","description":"Payer ID"},"address":{"type":"string","description":"Street address"},"address2":{"type":"string","description":"Street address 2"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"2 letter state code"},"zip_code":{"type":"string","description":"Zip code"},"country_code":{"type":"string","description":"2 letter country code"},"group_num":{"type":"string","description":"Group number"}},"required":["name","employer_name"]}},"required":["insurance_plan"],"description":"Create insurance plan"},"API_V31_Entities_Insurance_EhrPlan_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Insurance_EhrPlan_Response model"},"API_V2_Entities_InstitutionBasicWithLocations_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_InstitutionBasicWithLocations"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_InstitutionBasicWithLocations_Collection_Response model"},"API_V2_Entities_InstitutionBasicWithLocations":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Institution Id"},"name":{"type":"string","example":"General Practice - Dr. P. Sherman DDS","description":"Institution Name"},"subdomain":{"type":"string","example":"example-subdomain","description":"Institution subdomain"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Location"},"description":"List of locations belonging to the institution"}}},"API_V2_Entities_Location":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":7,"description":"Location id"},"name":{"type":"string","example":"Default","description":"Location name"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"street_address":{"type":"string","example":"123 Law St","description":"Location street address","nullable":true},"street_address_2":{"type":"string","example":"85335, North East","description":"Location street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"Location city","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Location zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"Location country code","nullable":true},"created_at":{"type":"string","example":"2020-06-05T20:16:57.007Z","description":"Location created time in UTC"},"updated_at":{"type":"string","example":"2020-06-05T20:16:57.007Z","description":"Location last updation time in UTC"},"latitude":{"type":"number","format":"float","example":37.7775028,"description":"Geolocated latitude determined by the address","nullable":true},"longitude":{"type":"number","format":"float","example":-122.3970603,"description":"Geolocated longitude determined by the address","nullable":true},"phone_number":{"type":"string","example":"8888750851","description":"Practice phone number","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Unique identifier for the integrated system"},"email":{"type":"string","example":"defaultLocation@nexhealth.com","description":"Location email id","nullable":true},"tz":{"type":"string","example":"America/Los_Angeles","description":"Timezone name"},"last_sync_time":{"type":"string","example":"2020-06-17T19:23:49.176Z","description":"Last time the resource was refreshed with data from the data source","nullable":true},"insert_appt_client":{"type":"boolean","example":true,"description":"True if appointments created at this location are inserted into the EHR"},"map_by_operatory":{"type":"boolean","example":true,"description":"True if this location uses and therefore requires an operatory to schedule appointments"},"set_availability_by_operatory":{"type":"boolean","example":false,"description":"True if the location has appointment types specific to an operatory, false if the appointment types are specific to a provider"},"inactive":{"type":"boolean","example":false,"description":"Is this location not being actively used?"},"specialty":{"$ref":"#/components/schemas/API_Entities_Specialty"}}},"API_Entities_Specialty":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Specialty id"},"name":{"type":"string","description":"Specialty name"}}},"API_Entities_Location_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_Entities_Location"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_Entities_Location_Response model"},"API_Entities_Location":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":7,"description":"Location id"},"name":{"type":"string","example":"Default","description":"Location name"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"street_address":{"type":"string","example":"123 Law St","description":"Location street address","nullable":true},"street_address_2":{"type":"string","example":"85335, North East","description":"Location street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"Location city","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Location zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"Location country code","nullable":true},"created_at":{"type":"string","example":"2020-06-05T20:16:57.007Z","description":"Location created time in UTC"},"updated_at":{"type":"string","example":"2020-06-05T20:16:57.007Z","description":"Location last updation time in UTC"},"latitude":{"type":"number","format":"float","example":37.7775028,"description":"Geolocated latitude determined by the address","nullable":true},"longitude":{"type":"number","format":"float","example":-122.3970603,"description":"Geolocated longitude determined by the address","nullable":true},"phone_number":{"type":"string","example":"8888750851","description":"Practice phone number","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Unique identifier for the integrated system"},"email":{"type":"string","example":"defaultLocation@nexhealth.com","description":"Location email id","nullable":true},"tz":{"type":"string","example":"America/Los_Angeles","description":"Timezone name"},"last_sync_time":{"type":"string","example":"2020-06-17T19:23:49.176Z","description":"Last time the resource was refreshed with data from the data source","nullable":true},"insert_appt_client":{"type":"boolean","example":true,"description":"True if appointments created at this location are inserted into the EHR"},"map_by_operatory":{"type":"boolean","example":true,"description":"True if this location uses and therefore requires an operatory to schedule appointments"},"set_availability_by_operatory":{"type":"boolean","example":false,"description":"True if the location has appointment types specific to an operatory, false if the appointment types are specific to a provider"},"inactive":{"type":"boolean","example":false,"description":"Is this location not being actively used?"},"specialty":{"$ref":"#/components/schemas/API_Entities_Specialty"}}},"API_V31_Entities_MedicalHistory_Item_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_Item"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_MedicalHistory_Item_Collection_Response_WithCursor model"},"API_V31_Entities_MedicalHistory_Item":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":415,"description":"Medical history item id"},"name":{"type":"string","example":"Aspirin","description":"Medical history item name"}}},"API_V31_Entities_MedicalHistory_PatientItem_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_PatientItem"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_MedicalHistory_PatientItem_Collection_Response model"},"API_V31_Entities_MedicalHistory_PatientItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":101,"description":"Patient medical history item id"},"item_id":{"type":"integer","format":"int64","example":55,"description":"ID of the referenced medical history item"},"item_name":{"type":"string","example":"Aspirin","description":"Medical history item name"},"note":{"type":"string","example":"Severe reaction","description":"Optional note about the patient item"},"active":{"type":"boolean","example":true,"description":"Whether the item is active"}}},"postMedicalHistoryPatientItems":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Patient ID"},"allergies":{"type":"array","description":"Allergy items to create or update","items":{"type":"object","properties":{"item_id":{"type":"integer","format":"int32","description":"Medical history allergy item ID"},"note":{"type":"string","description":"Optional note"},"active":{"type":"boolean","description":"Whether the item is active","default":true}},"required":["item_id"]}},"conditions":{"type":"array","description":"Condition items to create or update","items":{"type":"object","properties":{"item_id":{"type":"integer","format":"int32","description":"Medical history condition item ID"},"note":{"type":"string","description":"Optional note"},"active":{"type":"boolean","description":"Whether the item is active","default":true}},"required":["item_id"]}},"medications":{"type":"array","description":"Medication items to create or update","items":{"type":"object","properties":{"item_id":{"type":"integer","format":"int32","description":"Medical history medication item ID"},"note":{"type":"string","description":"Optional note"},"active":{"type":"boolean","description":"Whether the item is active","default":true}},"required":["item_id"]}}},"required":["patient_id"],"description":"Create or update patient medical history items"},"API_V2_Entities_Staff_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Staff"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Staff_Collection_Response model"},"API_V2_Entities_Staff":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Staff user id"},"email":{"type":"string","example":"staff@nexhealth.com","description":"Staff email"},"first_name":{"type":"string","example":"John","description":"Staff first name"},"last_name":{"type":"string","example":"Smith","description":"Staff last name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Staff created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:20:57.007Z","description":"Staff updated time in UTC"},"patientable":{"type":"boolean","example":false},"inst_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[1,2,3],"description":"Institution ids"},"unsubscribe_emails":{"type":"boolean","example":true},"inactive":{"type":"boolean","example":true},"unsubscribe_sms":{"type":"boolean","example":true},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[1,2,3],"description":"Location ids"}}},"API_V2_Entities_OperatoryWithResources_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryWithResources"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_OperatoryWithResources_Collection_Response model"},"API_V2_Entities_OperatoryWithResources":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"Operatories Id"},"name":{"type":"string","example":"op1","description":"Name of the operatory from the integrated system"},"foreign_id":{"type":"string","example":"1","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique identifier for the integrated system"},"location_id":{"type":"integer","format":"int32","example":4,"description":"Location ID relevant to the Operatory","nullable":true},"last_sync_time":{"type":"string","format":"date-time","example":"2020-06-17T19:23:49.176Z","description":"Last time the resource was refreshed with data from the data source in UTC","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Operatories created time in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Operatories last updation time in UTC"},"display_name":{"type":"string","example":"op1","description":"Optional custom display name","nullable":true},"active":{"type":"boolean","example":true,"description":"Is operatory active?"},"bookable_online":{"type":"boolean","example":true,"description":"Operatory is active for online booking?"},"appointment_types":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"description":"Collection of appointment types"}}},"API_V2_Entities_OperatoryWithResources_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryWithResources"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_OperatoryWithResources_Response model"},"API_V2_Entities_OperatoryWithResources_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryWithResources"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V2_Entities_OperatoryWithResources_Collection_Response_WithCursor model"},"API_V2_Entities_PatientsResponses_ListAll_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientsResponses_ListAll"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientsResponses_ListAll_Collection_Response model"},"API_V2_Entities_PatientsResponses_ListAll":{"type":"object","properties":{"patients":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientDetailedWithoutIncludes"}}}},"API_V2_Entities_PatientDetailedWithoutIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"preferred_locale":{"type":"string","example":"es","description":"The patient's preferred language setting used for displaying NexHealth forms and communications","nullable":true},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"},"upcoming_appts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Scheduled appointments for one year. Not included by default"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"},"description":"Procedures assigned to the patient. Not included by default"},"insurance_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverageForIndividual"},"description":"Insurance coverages"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_AdjustmentBasic"},"description":"Payment ledger adjustments"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_ChargeBasic"},"description":"Payment ledger charges"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_PaymentBasic"},"description":"Payment ledger payments"},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Appointments for patient within date range"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"}}},"API_V2_Entities_AppointmentBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"provider_id":{"type":"integer","format":"int32","example":102,"description":"Provider id"},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name"},"start_time":{"type":"string","format":"date-time","example":"2021-12-06T09:45:00.000Z","description":"Start time of the appointment in UTC"},"end_time":{"type":"string","format":"date-time","example":"2021-12-06T10:00:00.000Z","description":"End time of the appointment in UTC"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id"},"confirmed":{"type":"boolean","example":true,"description":"Is this appointment confirmed?"}}},"API_V2_Entities_Insurance_PatientCoverageForIndividual":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient","nullable":true},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies","nullable":true},"plan_id":{"type":"integer","format":"int64","example":18,"description":"The ID of the insurance plan this coverage subscribes to","nullable":true},"subscriber_num":{"type":"string","example":"123456789","description":"The subscriber's identification number for the plan","nullable":true},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"The date the coverage takes effect","nullable":true},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"The date the coverage expires","nullable":true},"plan":{"$ref":"#/components/schemas/API_Entities_Insurance_EhrPlan"},"subscriber":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"}}},"API_V2_Entities_Ledger_AdjustmentBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"value":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the procedure that this item is for"},"date":{"type":"string","format":"date","example":"2020-06-05","description":"The date of this line item as it appears in the EHR"},"notes":{"type":"string","description":"Notes attached to this item"},"directionality":{"type":"string","enum":["credit","debit"],"example":"credit","description":"The direction that this item's value applies to the patient's overall balance.\n\nWith respect to the patient, adjustments can subtract from the overall balance (credits) or add to the overall balance (debits).\n"}}},"API_V2_Entities_Ledger_ChargeBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"value":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the procedure that this item is for"},"date":{"type":"string","format":"date","example":"2020-06-05","description":"The date of this line item as it appears in the EHR"},"notes":{"type":"string","description":"Notes attached to this item"}}},"API_V2_Entities_Ledger_PaymentBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"value":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the procedure that this item is for"},"date":{"type":"string","format":"date","example":"2020-06-05","description":"The date of this line item as it appears in the EHR"},"notes":{"type":"string","description":"Notes attached to this item"}}},"postPatients":{"type":"object","properties":{"provider":{"type":"object","example":{"provider_id":12},"properties":{"provider_id":{"type":"integer","format":"int64","description":"Id of the provider with which to intake this new patient"}},"required":["provider_id"]},"patient":{"type":"object","properties":{"first_name":{"type":"string","description":"Patient first name"},"last_name":{"type":"string","description":"Patient last name"},"email":{"type":"string","description":"Patient email id. Must match regular expression /\\A([^@\\s]+)@((?:[-a-z0-9]\\.)[a-z]{2,})\\Z/"},"date_of_birth":{"type":"string","format":"date","description":"Patient date of birth. Must be a parseable date string, recommended format is YYYY-MM-DD"},"middle_name":{"type":"string","description":"Patient middle name"},"gender":{"type":"string","description":"Patient gender.","enum":["Male","Female","Other"]},"cell_phone_number":{"type":"string","description":"Patient cell phone number, written to the integrated system's cell/mobile phone field. Some integrated systems report the number back as an untyped primary number; the cell_phone_number response field falls back to that number, so the value stays visible after the write syncs."},"home_phone_number":{"type":"string","description":"Patient home phone number"},"work_phone_number":{"type":"string","description":"Patient work place phone number"},"work_phone_extension":{"type":"string","description":"Patient work phone extension"},"ssn":{"type":"string","description":"Patient social security number"},"address":{"type":"object","description":"Patient address","properties":{"line_1":{"type":"string","description":"Address line 1"},"line_2":{"type":"string","description":"Address line 2"},"city":{"type":"string","description":"City"},"region":{"type":"string","description":"State"},"postal_code":{"type":"string","description":"Zip code"}}}},"required":["first_name","last_name","email","date_of_birth"]},"return_existing_if_match":{"type":"boolean","description":"If true, return existing patient with matching information (200 OK) instead of raising an error. If false, raise an error when a patient with matching information already exists (400 Bad Request). Matching is based on date of birth and name.","default":false}},"required":["provider","patient"],"description":"Create patient"},"API_V2_Entities_PatientsResponses_Create_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_PatientsResponses_Create"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientsResponses_Create_Response model"},"API_V2_Entities_PatientsResponses_Create":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"}}},"API_V2_Entities_PatientDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_PatientDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientDetailed_Response model"},"API_V2_Entities_PatientDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"preferred_locale":{"type":"string","example":"es","description":"The patient's preferred language setting used for displaying NexHealth forms and communications","nullable":true},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"},"children":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_User"},"description":"Patient children"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_User"},"last_visited_appointment":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"upcoming_appts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Scheduled appointments for one year. Not included by default"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"},"description":"Procedures assigned to the patient. Not included by default"},"insurance_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverageForIndividual"},"description":"Insurance coverages"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_AdjustmentBasic"},"description":"Payment ledger adjustments"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_ChargeBasic"},"description":"Payment ledger charges"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_PaymentBasic"},"description":"Payment ledger payments"},"patient_alerts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert"},"description":"Patient Alerts"},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Appointments for patient within date range"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_User"}}},"API_V2_Entities_PatientAlert":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Patient Alert id"},"patient_id":{"type":"integer","format":"int32","example":101,"description":"Id of the associated patient"},"note":{"type":"string","example":"Patient is late on payment","description":"The note for the patient alert"},"disabled_at":{"type":"string","format":"date-time","example":"2024-02-05T20:16:57.007Z","description":"The time that the alert was disabled in UTC"},"created_at":{"type":"string","format":"date-time","example":"2023-11-11T10:11:01.007Z","description":"The time that the alert was created in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2024-01-14T14:11:01.007Z","description":"The time that the alert was last updated in UTC"}}},"API_V2_Entities_PatientDocument_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientDocument"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientDocument_Collection_Response model"},"API_V2_Entities_PatientDocument":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":18,"description":"Document id"},"filename":{"type":"string","example":"patient_document.pdf","description":"The filename of the uploaded document"},"type":{"type":"string","example":"application/pdf","description":"The type of the uploaded document"},"url":{"type":"string","example":"/documents/18/download","description":"A download URL for the document"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"The time that the document was first uploaded in UTC"},"document_type_id":{"type":"integer","format":"int32","example":1,"description":"The NexHealth ID of the document type"}}},"API_V2_Entities_PatientDocument_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_PatientDocument"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientDocument_Response model"},"postPatientsIdAlerts":{"type":"object","properties":{"patient_alert":{"type":"object","description":"Patient alert details","properties":{"note":{"type":"string","description":"The note for the patient alert"}},"required":["note"]}},"required":["patient_alert"],"description":"Create patient alert"},"API_V2_Entities_PatientAlert_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientAlert_Response model"},"API_V2_Entities_PatientAlert_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientAlert_Collection_Response model"},"patchPatientsIdAlertsAlertId":{"type":"object","properties":{"patient_alert":{"type":"object","description":"Patient Alert update","properties":{"disabled":{"type":"boolean","description":"Disable patient alert"}}}},"required":["patient_alert"],"description":"Edit patient alert"},"API_V20240412_Entities_PatientWithPrivacyAuthorization_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_PatientWithPrivacyAuthorization"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_PatientWithPrivacyAuthorization_Collection_Response_WithCursor model"},"API_V20240412_Entities_PatientWithPrivacyAuthorization":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"provider_id":{"type":"integer","format":"int32","example":23,"description":"User id of this patient's primary provider","nullable":true},"hipaa":{"$ref":"#/components/schemas/API_V2_Entities_PrivacyAuthorization"}}},"API_V2_Entities_PrivacyAuthorization":{"type":"object","properties":{"authorization":{"type":"boolean","example":true,"description":"Whether the patient has provided HIPAA authorization"},"authorization_date":{"type":"string","format":"date","example":"2023-03-22","description":"Date the patient provided HIPAA authorization"},"privacy":{"type":"boolean","example":true,"description":"Whether the patient has acknowledged HIPAA privacy notice"},"privacy_date":{"type":"string","format":"date","example":"2023-03-22","description":"Date the patient acknowledged HIPAA privacy notice"},"consent":{"type":"boolean","example":true,"description":"Whether the patient has provided HIPAA consent"},"consent_date":{"type":"string","format":"date","example":"2023-03-22","description":"Date the patient provided HIPAA consent"}}},"API_V20240412_Entities_PatientDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_PatientDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_PatientDetailed_Response model"},"API_V20240412_Entities_PatientDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":472,"description":"User id of this patient's responsible party","nullable":true},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type","nullable":true},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users","nullable":true},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system","nullable":true},"provider_id":{"type":"integer","format":"int32","example":23,"description":"User id of this patient's primary provider","nullable":true},"hipaa":{"$ref":"#/components/schemas/API_V2_Entities_PrivacyAuthorization"},"children":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_User"},"description":"Patient children"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_User"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_User"},"last_visited_appointment":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"upcoming_appts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Scheduled appointments for one year. Not included by default"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Procedure"},"description":"Procedures assigned to the patient. Not included by default"},"insurance_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverageForIndividual"},"description":"Active insurance coverages for the patient"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Adjustment"},"description":"Payment ledger adjustments"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeBasicWithDelete"},"description":"Payment ledger charges"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Payment"},"description":"Payment ledger payments"},"patient_alerts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert"},"description":"Patient alerts"},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Appointments for patient within date range"},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"}}},"API_V20240412_Entities_Ledger_ChargeBasicWithDelete":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge","nullable":true},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted","nullable":true}}},"API_V20240412_Entities_Ledger_Payment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC","nullable":true},"payment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"paid_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date payment was made","nullable":true},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment","nullable":true},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment","nullable":true},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment","nullable":true},"payment_plan_id":{"type":"integer","format":"int64","example":3,"description":"The ID of the payment plan associated with this payment","nullable":true},"insurance_plan_id":{"type":"integer","format":"int64","example":4,"description":"The ID of the insurance plan associated with this payment","nullable":true},"payment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the payment type for this payment","nullable":true}}},"API_V31_Entities_PatientWithEhrPreferences_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_PatientWithEhrPreferences"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_PatientWithEhrPreferences_Collection_Response_WithCursor model"},"API_V31_Entities_PatientWithEhrPreferences":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","description":"Last time the resource was refreshed with data from the data source"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"cell_phone_number":{"type":"string","example":"5163042196","description":"Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number — which is how most systems report it back after a write — this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number."},"preferred_phone_number":{"type":"string","example":"5163042196","description":"The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only — write one of the typed phone number fields to change it."},"guarantor_id":{"type":"integer","format":"int32","description":"User id of this patient's responsible party"},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type"},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users"},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"},"gender":{"type":"string","example":"Female","description":"Gender from biographical data"},"new_patient":{"type":"boolean","example":false,"description":"Whether the patient is new"},"non_patient":{"type":"boolean","example":true,"description":"Whether this is a non-patient user record"},"date_of_birth":{"type":"string","example":"1964-05-03","description":"Date of birth in YYYY-MM-DD format"},"premedication":{"type":"string","description":"Premedication notes"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"},"hipaa":{"$ref":"#/components/schemas/API_V2_Entities_PrivacyAuthorization"},"ehr_unsubscribe_sms":{"type":"boolean","example":false,"description":"Whether the patient is unsubscribed from SMS in the EHR"},"ehr_unsubscribe_emails":{"type":"boolean","example":false,"description":"Whether the patient is unsubscribed from emails in the EHR"},"preferred_location_id":{"type":"integer","format":"int32","description":"Patient's preferred location from the EHR"}}},"API_V31_Entities_PatientDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_PatientDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_PatientDetailed_Response model"},"API_V31_Entities_PatientDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","description":"Last time the resource was refreshed with data from the data source"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"cell_phone_number":{"type":"string","example":"5163042196","description":"Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number — which is how most systems report it back after a write — this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number."},"preferred_phone_number":{"type":"string","example":"5163042196","description":"The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only — write one of the typed phone number fields to change it."},"guarantor_id":{"type":"integer","format":"int32","description":"User id of this patient's responsible party"},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type"},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users"},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"},"gender":{"type":"string","example":"Female","description":"Gender from biographical data"},"new_patient":{"type":"boolean","example":false,"description":"Whether the patient is new"},"non_patient":{"type":"boolean","example":true,"description":"Whether this is a non-patient user record"},"date_of_birth":{"type":"string","example":"1964-05-03","description":"Date of birth in YYYY-MM-DD format"},"premedication":{"type":"string","description":"Premedication notes"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"},"hipaa":{"$ref":"#/components/schemas/API_V2_Entities_PrivacyAuthorization"},"ehr_unsubscribe_sms":{"type":"boolean","example":false,"description":"Whether the patient is unsubscribed from SMS in the EHR"},"ehr_unsubscribe_emails":{"type":"boolean","example":false,"description":"Whether the patient is unsubscribed from emails in the EHR"},"preferred_location_id":{"type":"integer","format":"int32","description":"Patient's preferred location from the EHR"},"children":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"description":"Patient children"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V31_Entities_Provider"},"last_visited_appointment":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"upcoming_appts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Scheduled appointments for one year. Not included by default"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Procedure"},"description":"Procedures assigned to the patient. Not included by default"},"insurance_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverageForIndividual"},"description":"Insurance coverages"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Adjustment"},"description":"Payment ledger adjustments"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeBasicWithDelete"},"description":"Payment ledger charges"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Payment"},"description":"Payment ledger payments"},"patient_alerts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert"},"description":"Patient Alerts"},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Appointments for patient within date range"},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"},"ssn":{"type":"string","description":"Patient social security number. Returned only when fetching a single patient; omitted from patient lists and from patient objects embedded in other resources."}}},"API_V31_Entities_Ledger_ChargeBasicWithDelete":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge"},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted"}}},"API_V31_Entities_Ledger_Payment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"},"payment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"paid_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date payment was made"},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment"},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment"},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment"},"payment_plan_id":{"type":"integer","format":"int64","example":3,"description":"The ID of the payment plan associated with this payment"},"insurance_plan_id":{"type":"integer","format":"int64","example":4,"description":"The ID of the insurance plan associated with this payment"},"payment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the payment type for this payment"}}},"patchPatientsId":{"type":"object","properties":{"patient":{"type":"object","properties":{"first_name":{"type":"string","description":"Patient first name"},"last_name":{"type":"string","description":"Patient last name"},"email":{"type":"string","description":"Patient email id. Must match regular expression /\\A([^@\\s]+)@((?:[-a-z0-9]\\.)[a-z]{2,})\\Z/"},"date_of_birth":{"type":"string","format":"date","description":"Patient date of birth. Must be a parseable date string, recommended format is YYYY-MM-DD"},"middle_name":{"type":"string","description":"Patient middle name"},"gender":{"type":"string","description":"Patient gender.","enum":["Male","Female","Other"]},"cell_phone_number":{"type":"string","description":"Patient cell phone number, written to the integrated system's cell/mobile phone field. Some integrated systems report the number back as an untyped primary number; the cell_phone_number response field falls back to that number, so the value stays visible after the write syncs."},"home_phone_number":{"type":"string","description":"Patient home phone number"},"work_phone_number":{"type":"string","description":"Patient work place phone number"},"work_phone_extension":{"type":"string","description":"Patient work phone extension"},"ssn":{"type":"string","description":"Patient social security number"},"address":{"type":"object","description":"Patient address","properties":{"line_1":{"type":"string","description":"Address line 1"},"line_2":{"type":"string","description":"Address line 2"},"city":{"type":"string","description":"City"},"region":{"type":"string","description":"State"},"postal_code":{"type":"string","description":"Zip code"}}}}}},"required":["patient"],"description":"Update patient"},"API_V2_Entities_PatientRecall_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecall"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientRecall_Collection_Response model"},"API_V2_Entities_PatientRecall":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Object identifier"},"appointment_id":{"type":"integer","format":"int64","example":1,"description":"Id of the associated appointment","nullable":true},"date_due":{"type":"string","format":"date","example":"2024-08-15","description":"Date the patient is due for this recall","nullable":true},"foreign_id":{"type":"string","example":"1","description":"EHR id"},"foreign_id_type":{"type":"string","example":"msg-mdland-Institution-3","description":"EHR type"},"recall_id":{"type":"integer","format":"int64","example":1,"description":"Id of the associated recall type","nullable":true},"recall_type":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecallType"},"patient_id":{"type":"integer","format":"int32","example":1,"description":"Id of the associated patient","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2019-09-13T15:11:28Z","description":"Timestamp of initial creation in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2019-09-13T15:11:28Z","description":"Timestamp of most recent change in UTC"}}},"API_V2_Entities_PatientRecallType":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"Object identifier"},"name":{"type":"string","example":"PROPHY","description":"Recall name"},"description":{"type":"string","example":"A recall description","description":"Recall description"},"interval_num":{"type":"integer","format":"int32","example":8,"description":"The length of the interval"},"interval_unit":{"type":"string","example":"M","description":"The interval unit"}}},"API_V2_Entities_PatientRecall_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecall"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PatientRecall_Response model"},"API_V2_Entities_PatientRecall_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecall"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V2_Entities_PatientRecall_Collection_Response_WithCursor model"},"API_V2_Entities_PaymentPlan_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PaymentPlan"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V2_Entities_PaymentPlan_Collection_Response_WithCursor model"},"API_V2_Entities_PaymentPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"patient_id":{"type":"integer","format":"int32","example":115,"description":"The ID of patient this plan is for"},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"The ID of the person paying for the plan"},"first_payment_due_date":{"type":"string","format":"date","example":"2020-06-05","description":"The date the first payment is due (this doesn’t include down payments)"},"created_date":{"type":"string","format":"date","example":"2020-06-05","description":"The date the payment plan was created"},"active":{"type":"boolean","description":"Indicates whether the payment plan has been closed, cleared, or deleted from the system"}}},"API_V2_Entities_PaymentPlanDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_PaymentPlanDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_PaymentPlanDetailed_Response model"},"API_V2_Entities_PaymentPlanDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"patient_id":{"type":"integer","format":"int32","example":115,"description":"The ID of patient this plan is for"},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"The ID of the person paying for the plan"},"first_payment_due_date":{"type":"string","format":"date","example":"2020-06-05","description":"The date the first payment is due (this doesn’t include down payments)"},"created_date":{"type":"string","format":"date","example":"2020-06-05","description":"The date the payment plan was created"},"active":{"type":"boolean","description":"Indicates whether the payment plan has been closed, cleared, or deleted from the system"},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"}}},"API_V2_Entities_Ledger_Payment_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Payment"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Ledger_Payment_Collection_Response model"},"API_V2_Entities_Ledger_Payment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"value":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the procedure that this item is for"},"date":{"type":"string","format":"date","example":"2020-06-05","description":"The date of this line item as it appears in the EHR"},"notes":{"type":"string","description":"Notes attached to this item"},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"procedure":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"}}},"API_V2_Entities_Ledger_Payment_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Payment"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Ledger_Payment_Response model"},"API_V20240412_Entities_Ledger_Payment_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Payment"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_Payment_Collection_Response_WithCursor model"},"postPayments":{"type":"object","properties":{"payment":{"type":"object","description":"Payment details","properties":{"patient_id":{"type":"integer","format":"int32","description":"NexHealth Patient ID","example":1},"amount":{"type":"number","format":"double","description":"Payment amount in decimal dollars.  Negative amounts represent payments which reduce the patient's balance","example":-138},"currency":{"type":"string","description":"Currency","default":"USD"},"payment_type_id":{"type":"integer","format":"int32","description":"ID of the payment type","example":10},"transaction_id":{"type":"string","description":"The transaction ID of the payment with a prefix identifying the API originator this ID will be used to identify the payment created in the EHR. Max length is 50 characters.","example":"API:123456"},"paid_at":{"type":"string","format":"date-time","description":"Payment datetime","example":"2024-05-20T21:00:00+00:00"},"charge_splits":{"type":"object","description":"Charge splits hash with NexHealth charge IDs and corresponding amounts in decimal dollars","example":{"charge_id_1":-37,"charge_id_2":-100}},"provider_splits":{"type":"object","description":"Provider splits hash with NexHealth provider IDs and corresponding amounts in decimal dollars","example":{"provider_id_1":-0.5,"provider_id_2":-0.5}},"notes":{"type":"string","description":"Notes that will be saved into the EHR. note: some EHRs may truncate overlong notes","example":"Prepayment for xrays"}},"required":["patient_id","amount","transaction_id"]}},"required":["payment"],"description":"Create payment"},"API_V20240412_Entities_Ledger_PaymentWithIncludes_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentWithIncludes"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_PaymentWithIncludes_Response model"},"API_V20240412_Entities_Ledger_PaymentWithIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item","nullable":true},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC","nullable":true},"payment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"paid_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date payment was made","nullable":true},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment","nullable":true},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment","nullable":true},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment","nullable":true},"payment_plan_id":{"type":"integer","format":"int64","example":3,"description":"The ID of the payment plan associated with this payment","nullable":true},"insurance_plan_id":{"type":"integer","format":"int64","example":4,"description":"The ID of the insurance plan associated with this payment","nullable":true},"patient":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_PatientBasic"},"claim":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Insurance_ClaimBasic"},"charge":{"$ref":"#/components/schemas/API_V2_Entities_Patient_Ledger_Charge"},"payment_plan":{"$ref":"#/components/schemas/API_V2_Entities_PaymentPlan"},"payment_type":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentType"},"payment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the payment type for this payment","nullable":true}}},"API_V20240412_Entities_Ledger_PaymentType":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"name":{"type":"string","example":"Cash","description":"The name of the payment type"},"active":{"type":"boolean","example":true,"description":"Whether the payment type is currently active"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Payment Type update date in UTC"}}},"API_V31_Entities_Ledger_Payment_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Payment"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Ledger_Payment_Collection_Response_WithCursor model"},"API_V31_Entities_Ledger_PaymentWithIncludes_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_PaymentWithIncludes"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Ledger_PaymentWithIncludes_Response model"},"API_V31_Entities_Ledger_PaymentWithIncludes":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"},"payment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"paid_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date payment was made"},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment"},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment"},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment"},"payment_plan_id":{"type":"integer","format":"int64","example":3,"description":"The ID of the payment plan associated with this payment"},"insurance_plan_id":{"type":"integer","format":"int64","example":4,"description":"The ID of the insurance plan associated with this payment"},"payment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the payment type for this payment"},"patient":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V31_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"claim":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Insurance_ClaimBasic"},"charge":{"$ref":"#/components/schemas/API_V2_Entities_Patient_Ledger_Charge"},"payment_plan":{"$ref":"#/components/schemas/API_V2_Entities_PaymentPlan"},"payment_type":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentType"}}},"API_V2_Entities_Procedure_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Procedure_Collection_Response model"},"API_V2_Entities_Procedure_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V2_Entities_Procedure_Collection_Response_WithCursor model"},"API_V20240412_Entities_Procedure_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Procedure"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Procedure_Response model"},"API_V31_Entities_Procedure_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Procedure"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Procedure_Collection_Response_WithCursor model"},"API_V31_Entities_Procedure_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Procedure"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Procedure_Response model"},"API_V20240412_Entities_ProviderWithResources_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_ProviderWithResources"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_ProviderWithResources_Collection_Response_WithCursor model"},"API_V20240412_Entities_ProviderWithResources":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"Amy.Ramos@nexhealth.com","description":"User email","nullable":true},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name","nullable":true},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last updation date in UTC"},"institution_id":{"type":"integer","format":"int32","example":105,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"100437","description":"Foreign Id is a unique identifier from the integrated system","nullable":true},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"bio":{"type":"object","example":{"city":"New York","state":"NY","gender":"Female","zip_code":"20814","new_patient":false,"non_patient":true,"phone_number":"5163042196","date_of_birth":"1964-05-03","address_line_1":"","address_line_2":"","street_address":"","cell_phone_number":"","home_phone_number":"","work_phone_number":""},"description":"Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","example":"2024-04-12T10:30:00Z","description":"The most recent time the resource's data changed meaningfully at the source","nullable":true},"display_name":{"type":"string","example":"John Smith","description":"Display name","nullable":true},"npi":{"type":"string","example":"1912507500","description":"National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system.","nullable":true},"tin":{"type":"string","example":"078051120","description":"Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system.","nullable":true},"state_license":{"type":"string","example":"R219935","description":"State license number. May be null if the practice did not enter it into the integrated system.","nullable":true},"specialty_code":{"type":"string","example":"363L00000X","description":"Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system.","nullable":true},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_Location"},"description":"Locations the provider is associated with"},"provider_requestables":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_ProviderRequestable"},"description":"List of locations this provider can be booked with at"},"availabilities":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourWithAppointmentTypes"},"description":"List of availabilities for the provider, each with its associated appointment types"}}},"API_V2_Entities_ProviderRequestable":{"type":"object","properties":{"location_id":{"type":"integer","format":"int32","example":4,"description":"Location id"}}},"API_V20240412_Entities_WorkingHourBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":12,"description":"Resource id"},"provider_id":{"type":"integer","format":"int32","example":7,"description":"Provider id","nullable":true},"location_id":{"type":"integer","format":"int32","example":3,"description":"Location id","nullable":true},"operatory_id":{"type":"integer","format":"int64","example":149,"description":"Operatory id","nullable":true},"begin_time":{"type":"string","example":"10:30","description":"Availability start time in the practices timezone"},"end_time":{"type":"string","example":"17:00","description":"Availability end time in the practices timezone"},"days":{"type":"array","items":{"type":"string"},"example":["Monday","Tuesday","Wednesday","Thursday","Friday"],"description":"Configured week days. Empty when the working hour is configured for a custom recurrence","nullable":true},"specific_date":{"type":"string","format":"date","example":"2022-11-03","description":"Configured specific date","nullable":true},"custom_recurrence":{"type":"object","example":{"num":3,"unit":"day","ref":"2022-11-03"},"description":"Configured custom recurrence, with the fields num (recurrence interval count), ref (starting date), and unit (day, week, or month)","nullable":true},"tz_offset":{"type":"string","example":"-0700","description":"UTC offset for the practice"},"active":{"type":"boolean","example":true,"description":"Is active?"},"source":{"type":"string","enum":["manual","synced"],"example":"synced","description":"Source of the working hour"},"label":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourLabel"}}},"API_V20240412_Entities_WorkingHourLabel":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"location_id":{"type":"integer","format":"int32","example":115,"description":"The location ID","nullable":true},"name":{"type":"string","example":"New patient appointments","description":"The name for working hour label"}}},"API_V20240412_Entities_WorkingHourWithAppointmentTypes":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":12,"description":"Resource id"},"provider_id":{"type":"integer","format":"int32","example":7,"description":"Provider id","nullable":true},"location_id":{"type":"integer","format":"int32","example":3,"description":"Location id","nullable":true},"operatory_id":{"type":"integer","format":"int64","example":149,"description":"Operatory id","nullable":true},"begin_time":{"type":"string","example":"10:30","description":"Availability start time in the practices timezone"},"end_time":{"type":"string","example":"17:00","description":"Availability end time in the practices timezone"},"days":{"type":"array","items":{"type":"string"},"example":["Monday","Tuesday","Wednesday","Thursday","Friday"],"description":"Configured week days. Empty when the working hour is configured for a custom recurrence","nullable":true},"specific_date":{"type":"string","format":"date","example":"2022-11-03","description":"Configured specific date","nullable":true},"custom_recurrence":{"type":"object","example":{"num":3,"unit":"day","ref":"2022-11-03"},"description":"Configured custom recurrence, with the fields num (recurrence interval count), ref (starting date), and unit (day, week, or month)","nullable":true},"tz_offset":{"type":"string","example":"-0700","description":"UTC offset for the practice"},"active":{"type":"boolean","example":true,"description":"Is active?"},"source":{"type":"string","enum":["manual","synced"],"example":"synced","description":"Source of the working hour"},"label":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourLabel"},"appointment_types":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"description":"Associated appointment types"}}},"API_V20240412_Entities_ProviderWithResources_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_ProviderWithResources"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_ProviderWithResources_Response model"},"API_V31_Entities_ProviderWithResources_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_ProviderWithResources"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_ProviderWithResources_Collection_Response_WithCursor model"},"API_V31_Entities_ProviderWithResources":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Foreign Id is a unique identifier from the integrated system"},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"last_sync_time":{"type":"string","format":"date-time","description":"Last time the resource was refreshed with data from the data source"},"phone_number":{"type":"string","example":"5163042196","description":"Primary phone number"},"cell_phone_number":{"type":"string","example":"","description":"Cell phone number"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"display_name":{"type":"string","example":"John Smith","description":"Display name"},"npi":{"type":"string","example":"1912507500","description":"National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system."},"tin":{"type":"string","example":"078051120","description":"Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system."},"state_license":{"type":"string","example":"R219935","description":"State license number. May be null if the practice did not enter it into the integrated system."},"specialty_code":{"type":"string","example":"363L00000X","description":"Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_Location"}},"provider_requestables":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_ProviderRequestable"},"description":"List of locations this provider can be booked with at"},"availabilities":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourWithAppointmentTypes"},"description":"List of availabilities for the provider"}}},"API_V31_Entities_ProviderWithResources_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_ProviderWithResources"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_ProviderWithResources_Response model"},"API_V2_Entities_RecallType_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_RecallType"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_RecallType_Collection_Response model"},"API_V2_Entities_RecallType":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"Object identifier"},"name":{"type":"string","example":"PROPHY","description":"Recall name"},"description":{"type":"string","example":"A recall description","description":"Recall description"},"foreign_id":{"type":"string","example":"1","description":"EHR id"},"foreign_id_type":{"type":"string","example":"msg-mdland-Institution-3","description":"EHR type"},"interval_num":{"type":"integer","format":"int32","example":8,"description":"The length of the interval"},"interval_unit":{"type":"string","example":"M","description":"The interval unit"},"location_id":{"type":"integer","format":"int32","example":1,"description":"The location id"},"created_at":{"type":"string","format":"date-time","example":"2019-09-13T15:11:28Z","description":"Timestamp of initial creation in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2019-09-13T15:11:28Z","description":"Timestamp of most recent change in UTC"}}},"API_V2_Entities_RecallType_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_RecallType"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_RecallType_Response model"},"API_V2_Entities_SyncStatus_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_SyncStatus"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_SyncStatus_Collection_Response model"},"API_V2_Entities_SyncStatus":{"type":"object","properties":{"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"sync_source_type":{"type":"string","example":"DataSource","description":"Source type"},"sync_source_name":{"type":"string","example":"My Source","description":"Source name"},"emr":{"$ref":"#/components/schemas/API_V2_Entities_Emr"},"read_status":{"type":"string","enum":["green","red"],"example":"green","description":"Status of the read service, where green means up, red means down"},"read_status_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last time NexHealth read data from the PMS, in UTC"},"write_status":{"type":"string","enum":["green","red"],"example":"red","description":"Status of the write service, where green means up, red means down"},"write_status_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last time NexHealth wrote data to the PMS, in UTC"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_LocationBasic"},"description":"Locations whose data this service is synchronizing with"}}},"API_V2_Entities_Emr":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":11,"description":"EMR id"},"name":{"type":"string","example":"dentrix","description":"EMR name"},"display_name":{"type":"string","example":"Dentrix","description":"EMR display name"},"type":{"type":"string","enum":["cloud","onprem"],"example":"onprem","description":"Type of EMR. Can be cloud or onprem."}}},"API_V31_Entities_SyncStatus_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_SyncStatus"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_SyncStatus_Collection_Response model"},"API_V31_Entities_SyncStatus":{"type":"object","properties":{"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id"},"sync_source_type":{"type":"string","example":"DataSource","description":"Source type"},"sync_source_name":{"type":"string","example":"My Source","description":"Source name"},"read_status":{"type":"string","enum":["green","red"],"example":"green","description":"Status of the read service, where green means up, red means down"},"read_status_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last time NexHealth read data from the PMS, in UTC"},"write_status":{"type":"string","enum":["green","red"],"example":"red","description":"Status of the write service, where green means up, red means down"},"write_status_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Last time NexHealth wrote data to the PMS, in UTC"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_LocationBasic"},"description":"Locations whose data this service is synchronizing with"},"ehr":{"$ref":"#/components/schemas/API_V31_Entities_Ehr"}}},"API_V31_Entities_Ehr":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":11,"description":"EHR id"},"name":{"type":"string","example":"dentrix","description":"EHR name"},"display_name":{"type":"string","example":"Dentrix","description":"EHR display name"},"type":{"type":"string","enum":["cloud","onprem"],"example":"onprem","description":"Type of EHR. Can be cloud or onprem."}}},"API_V2_Entities_WebhookEndpoint_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_WebhookEndpoint"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WebhookEndpoint_Collection_Response model"},"API_V2_Entities_WebhookEndpoint":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Endpoint id"},"target_url":{"type":"string","example":"http://localhost:8085/hook","description":"Endpoint url"},"secret_key":{"type":"string","example":"NArWk7gdI96Bdn","description":"Endpoint secret key"},"active":{"type":"boolean","example":true,"description":"True if endpoint is active"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Endpoint create date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Endpoint update date in UTC"}}},"postWebhookEndpoints":{"type":"object","properties":{"target_url":{"type":"string","description":"URL to send POST requests to in response to subscribed events. Must use HTTPS in production"},"active":{"type":"boolean","description":"Return only active or inactive endpoints"}},"required":["target_url"],"description":"Create webhook endpoint"},"API_V2_Entities_WebhookEndpoint_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_WebhookEndpoint"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WebhookEndpoint_Response model"},"patchWebhookEndpointsId":{"type":"object","properties":{"target_url":{"type":"string","description":"URL to send POST requests to in response to subscribed events. Must use HTTPS in production"},"active":{"type":"boolean","description":"Return only active or inactive endpoints"}},"description":"Edit webhook endpoint"},"API_V2_Entities_WebhookSubscription_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_WebhookSubscription"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WebhookSubscription_Collection_Response model"},"API_V2_Entities_WebhookSubscription":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Subscription id"},"webhook_endpoint_id":{"type":"integer","format":"int32","example":1,"description":"Webhook Endpoint id"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id. Null for subscriptions to resources not owned by an institution (currently: Onboarding)","nullable":true},"resource_type":{"type":"string","example":"Appointment","description":"Resource type"},"event":{"type":"string","example":"appointment_insertion","description":"Event type"},"active":{"type":"boolean","example":true,"description":"True if subscription is active"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Subscription create date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Subscription update date in UTC"}}},"postWebhookEndpointsIdWebhookSubscriptions":{"type":"object","properties":{"resource_type":{"type":"string","description":"The resource to subscribe to","enum":["Adjustment","AdjustmentType","Appointment","Charge","Claim","Document","FeeSchedule","FormResponse","FormSchema","Insurance","MedicalHistory","Message","Onboarding","Patient","PatientInsuranceCoverage","Payment","PaymentType","Procedure","ProcedureCode","Provider","SyncStatus","TreatmentPlan","WorkingHour"],"example":"Appointment"},"event":{"type":"string","description":"A valid event type to listen to for the defined resource","enum":["adjustment_created","adjustment_updated","adjustment_deleted","adjustment_insertion","adjustment_type_created","adjustment_type_updated","appointment_insertion","appointment_created","appointment_updated","appointment_requested","charge_created","charge_updated","charge_deleted","claim_created","claim_updated","claim_deleted","document_insertion","fee_schedule_created","fee_schedule_updated","form_response_insertion","form_schema_created","form_schema_deleted","insurance_plan_insertion","insurance_coverage_insertion","insurance_coverage_deleted","medical_history_item_created","medical_history_item_updated","medical_history_patient_items_updated","message_created","message_updated","onboarding_created","onboarding_updated","onboarding_availability_ready","patient_created","patient_updated","patient_insertion","patient_update","patient_insurance_created","patient_insurance_updated","payment_created","payment_updated","payment_deleted","payment_insertion","payment_type_created","payment_type_updated","procedure_created","procedure_updated","procedure_code_created","procedure_code_updated","procedure_code_deleted","provider_created","provider_updated","sync_status_read_change","sync_status_write_change","treatment_plan_created","treatment_plan_updated","treatment_plan_deleted","working_hour_created","working_hour_updated"],"example":"appointment_insertion"},"active":{"type":"boolean","default":true,"example":true},"version":{"type":"string","description":"API version to pin this subscription to. Webhook payloads delivered to this subscription use that version's entity contract. v3.0.0 and v20240412 are two names for the same version — either value is accepted, and the subscription is recorded under the canonical name v20240412. Returns 422 for unknown versions and for versions that do not offer the subscribed event.","example":"v3.1.0"}},"required":["resource_type","event","version"],"description":"Create webhook subscription"},"API_V2_Entities_WebhookSubscription_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V2_Entities_WebhookSubscription"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WebhookSubscription_Response model"},"patchWebhookEndpointsIdWebhookSubscriptionsSubscriptionId":{"type":"object","properties":{"new_endpoint_id":{"type":"integer","format":"int32","description":"New Endpoint id","example":1},"active":{"type":"boolean","example":true}},"description":"Edit webhook subscription"},"API_V31_Entities_WebhookSubscription_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_WebhookSubscription"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_WebhookSubscription_Collection_Response model"},"API_V31_Entities_WebhookSubscription":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1,"description":"Subscription id"},"webhook_endpoint_id":{"type":"integer","format":"int32","example":1,"description":"Webhook Endpoint id"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"Institution id. Null for subscriptions to resources not owned by an institution (currently: Onboarding)","nullable":true},"resource_type":{"type":"string","example":"Appointment","description":"Resource type"},"event":{"type":"string","example":"appointment_insertion","description":"Event type"},"active":{"type":"boolean","example":true,"description":"True if subscription is active"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Subscription create date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Subscription update date in UTC"},"version":{"type":"string","example":"v3.1.0","description":"API version this subscription is pinned to. Webhook payloads delivered to this subscription use the entity contract registered for this version. See the version lifecycle docs for what changes happen within a version label vs across versions."}}},"API_V31_Entities_WebhookSubscription_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_WebhookSubscription"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_WebhookSubscription_Response model"},"API_V20240412_Entities_Ledger_AdjustmentType_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentType"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_AdjustmentType_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_AdjustmentType_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_AdjustmentType"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_AdjustmentType_Response model"},"API_V20240412_Entities_AvailableSlotResponse_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_AvailableSlotResponse"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_AvailableSlotResponse_Collection_Response model"},"API_V20240412_Entities_AvailableSlotResponse":{"type":"object","properties":{"lid":{"type":"integer","format":"int32","example":1,"description":"Relevant location id"},"pid":{"type":"integer","format":"int32","example":83,"description":"Relevant providers id. Omitted when slots are not grouped by provider","nullable":true},"operatory_id":{"type":"integer","format":"int64","example":54,"description":"Relevant operatory id. Omitted when slots are not grouped by operatory","nullable":true},"slots":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_AvailableSlot"},"description":"Array of available start times"},"next_available_date":{"type":"string","format":"date","example":"2022-11-17","description":"The earliest date when a valid slot exists","nullable":true}}},"API_V20240412_Entities_AvailableSlot":{"type":"object","properties":{"time":{"type":"string","example":"2017-10-09T07:00:00.000-04:00","description":"Start time of the slot in the practices timezone"},"end_time":{"type":"string","example":"2017-10-09T07:30:00.000-04:00","description":"End time of the slot in the practices timezone"},"operatory_id":{"type":"integer","format":"int64","example":54,"description":"Operatory id for the slot. Omitted when the slot is not tied to an operatory"},"provider_id":{"type":"integer","format":"int32","example":83,"description":"Provider id for the slot, if available. Omitted when the slot is not tied to provider"},"working_hour_label_id":{"type":"integer","format":"int64","example":11,"description":"ID of working hour label of this slot","nullable":true}}},"API_V20240412_Entities_ClinicalNote_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_ClinicalNote"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_ClinicalNote_Collection_Response_WithCursor model"},"API_V20240412_Entities_ClinicalNote":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"patient_id":{"type":"integer","format":"int32","example":115,"description":"The patient ID of this clinical note","nullable":true},"procedure_id":{"type":"integer","format":"int64","example":116,"description":"The procedure ID attached to this clinical note","nullable":true},"entered_at":{"type":"string","format":"date-time","example":"2021-01-01T00:00:00Z","description":"The timestamp when the clinical note was entered","nullable":true},"content":{"type":"string","example":"Patient has a fever","description":"The content of the clinical note"},"signed":{"type":"boolean","example":true,"description":"Whether or not the clinical note has been signed by a provider. Not all EHRs support signing notes","nullable":true},"completed":{"type":"boolean","example":true,"description":"Whether or not the clinical note has been marked as completed. Some EHRs refer to this as \"locking\" the note and use this to prevent further modification. Not all EHRs support locking or completing notes","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Clinical Note update date in UTC"}}},"API_V20240412_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCode"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor model"},"API_V31_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FeeScheduleProcedureCode"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor model"},"API_Entities_FeeSchedule_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_Entities_FeeSchedule"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_Entities_FeeSchedule_Collection_Response_WithCursor model"},"API_V20240412_Entities_FeeSchedule_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_FeeSchedule"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_FeeSchedule_Response model"},"API_V20240412_Entities_FeeSchedule":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Fee schedule id"},"name":{"type":"string","example":"Cash","description":"The name of the fee schedule"},"active":{"type":"boolean","example":true,"description":"Indicates if the fee schedule is active","nullable":true},"location_id":{"type":"integer","format":"int32","example":21,"description":"The id of the location this fee schedule belongs to","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Fee Schedule update date in UTC"},"procedure_fees":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCodeBasic"},"description":"The procedure fees associated with this schedule"}}},"API_V20240412_Entities_FeeScheduleProcedureCodeBasic":{"type":"object","properties":{"procedure_code_id":{"type":"string","example":"ab123456-11aa-99ff-a111-d1ee12345678","description":"The uuid of the procedure code associated with the fee schedule","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"code":{"type":"string","example":"D0120","description":"The code of the procedure associated with the fee schedule","nullable":true}}},"API_V31_Entities_FeeSchedule_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FeeSchedule"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_FeeSchedule_Collection_Response_WithCursor model"},"API_V31_Entities_FeeSchedule":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"name":{"type":"string","example":"Cash","description":"The name of the fee schedule"},"active":{"type":"boolean","description":"Indicates if the fee schedule is active"},"location_id":{"type":"integer","format":"int32","description":"The location id of the fee schedule"},"updated_at":{"type":"string","example":"2020-06-05T20:16:57.007Z","description":"Fee Schedule update date in UTC"},"procedure_fees":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FeeScheduleProcedureCodeBasic"},"description":"The procedure fees associated with this schedule"}}},"API_V31_Entities_FeeScheduleProcedureCodeBasic":{"type":"object","properties":{"procedure_code_id":{"type":"string","example":"ab123456-11aa-99ff-a111-d1ee12345678","description":"The uuid of the procedure code associated with the fee schedule"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"code":{"type":"string","example":"D0120","description":"The code of the procedure associated with the fee schedule"}}},"API_V31_Entities_FeeSchedule_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_FeeSchedule"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_FeeSchedule_Response model"},"API_V20240412_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_GuarantorBalance"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_GuarantorBalance":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1","description":"EHR id"},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"The ID of the person responsible for paying this balance","nullable":true},"location_id":{"type":"integer","format":"int32","example":115,"description":"Guarantor accounts receivable location ID","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Guarantor Balance update date in UTC"},"write_off_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"guarantor_portion":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V20240412_Entities_Ledger_GuarantorBalanceDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_GuarantorBalanceDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_GuarantorBalanceDetailed_Response model"},"API_V20240412_Entities_Ledger_GuarantorBalanceDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1","description":"EHR id"},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"The ID of the person responsible for paying this balance","nullable":true},"location_id":{"type":"integer","format":"int32","example":115,"description":"Guarantor accounts receivable location ID","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Guarantor Balance update date in UTC"},"write_off_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"guarantor_portion":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"guarantor":{"$ref":"#/components/schemas/API_V20240412_Entities_PatientBasic"}}},"API_V31_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_GuarantorBalance"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Ledger_GuarantorBalance_Collection_Response_WithCursor model"},"API_V31_Entities_Ledger_GuarantorBalance":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1","description":"EHR id"},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"the ID of the person responsible for paying this balance "},"location_id":{"type":"integer","format":"int32","example":115,"description":"Guarantor accounts receivable location ID"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Guarantor Balance update date in UTC"},"write_off_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"guarantor_portion":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V31_Entities_Ledger_GuarantorBalanceDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_GuarantorBalanceDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Ledger_GuarantorBalanceDetailed_Response model"},"API_V31_Entities_Ledger_GuarantorBalanceDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1","description":"EHR id"},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"the ID of the person responsible for paying this balance "},"location_id":{"type":"integer","format":"int32","example":115,"description":"Guarantor accounts receivable location ID"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Guarantor Balance update date in UTC"},"write_off_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"guarantor_portion":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"total_balance_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"}}},"API_V20240412_Entities_Ledger_InsuranceBalance_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_InsuranceBalance"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_InsuranceBalance_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_InsuranceBalance":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Insurance balance id"},"patient_id":{"type":"integer","format":"int32","example":115,"description":"The ID of the patient this balance is assigned to","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":116,"description":"The ID of the person responsible for paying this balance","nullable":true},"location_id":{"type":"integer","format":"int32","example":21,"description":"The ID of the location this balance belongs to","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Balance update date in UTC"},"estimated_amount_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_amount_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_amount_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_amount_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V20240412_Entities_Ledger_InsuranceBalance_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_InsuranceBalance"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_InsuranceBalance_Response model"},"API_V31_Entities_Ledger_InsuranceBalance_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_InsuranceBalance"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Ledger_InsuranceBalance_Collection_Response_WithCursor model"},"API_V31_Entities_Ledger_InsuranceBalance":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"patient_id":{"type":"integer","format":"int32","example":115,"description":"the ID of the person whom this balance is assigned to "},"guarantor_id":{"type":"integer","format":"int32","example":115,"description":"the ID of the person responsible for paying this balance "},"location_id":{"type":"integer","format":"int32","example":115,"description":"Insurance accounts receivable location ID"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Balance update date in UTC"},"estimated_amount_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_amount_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_amount_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_amount_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_under_30":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_31_60":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_61_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"billed_amount_over_90":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V31_Entities_Ledger_InsuranceBalance_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_InsuranceBalance"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Ledger_InsuranceBalance_Response model"},"API_V20240412_Entities_Ledger_Insurance_ClaimBasicWithDelete_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Insurance_ClaimBasicWithDelete"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_Insurance_ClaimBasicWithDelete_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_Insurance_ClaimBasicWithDelete":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Claim id"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id. Null when the claim is not attached to a location","nullable":true},"patient_id":{"type":"integer","format":"int32","example":1002,"description":"Patient id. Null when the claim is not attached to a patient","nullable":true},"provider_id":{"type":"integer","format":"int32","example":101,"description":"Provider id. Null when the claim is not attached to a provider","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":1001,"description":"User id of the patient's responsible party. Null when the claim is not attached to a guarantor","nullable":true},"status":{"type":"string","enum":["draft","sent","received","canceled"],"example":"sent","description":"Claim status","nullable":true},"received_at":{"type":"string","format":"date-time","example":"2024-06-10T15:16:57.000Z","description":"Date and time in UTC when the claim was received from insurance","nullable":true},"sent_at":{"type":"string","format":"date-time","example":"2024-06-03T11:23:12.000Z","description":"Date and time in UTC when the claim was sent to insurance","nullable":true},"note":{"type":"string","example":"Claim was sent to the insurance company","description":"Claim notes","nullable":true},"primary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the primary insurance plan this claim was or will be sent to","nullable":true},"secondary_insurance_plan_id":{"type":"integer","format":"int64","example":10022,"description":"Id of the secondary insurance plan this claim was or will be sent to","nullable":true},"date_of_service":{"type":"string","format":"date","example":"2024-06-03","description":"The date in UTC when the procedures included in the claim occurred","nullable":true},"totals":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeClaimTotals"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Claim update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC date and time the claim was deleted. Null when the claim is not deleted. Deleted claims are only listed when include_deleted is true","nullable":true}}},"API_V20240412_Entities_Ledger_Insurance_Claim_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_Insurance_Claim"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_Insurance_Claim_Response model"},"API_V20240412_Entities_Ledger_Insurance_Claim":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Claim id"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id. Null when the claim is not attached to a location","nullable":true},"patient_id":{"type":"integer","format":"int32","example":1002,"description":"Patient id. Null when the claim is not attached to a patient","nullable":true},"provider_id":{"type":"integer","format":"int32","example":101,"description":"Provider id. Null when the claim is not attached to a provider","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":1001,"description":"User id of the patient's responsible party. Null when the claim is not attached to a guarantor","nullable":true},"status":{"type":"string","enum":["draft","sent","received","canceled"],"example":"sent","description":"Claim status","nullable":true},"received_at":{"type":"string","format":"date-time","example":"2024-06-10T15:16:57.000Z","description":"Date and time in UTC when the claim was received from insurance","nullable":true},"sent_at":{"type":"string","format":"date-time","example":"2024-06-03T11:23:12.000Z","description":"Date and time in UTC when the claim was sent to insurance","nullable":true},"note":{"type":"string","example":"Claim was sent to the insurance company","description":"Claim notes","nullable":true},"primary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the primary insurance plan this claim was or will be sent to","nullable":true},"secondary_insurance_plan_id":{"type":"integer","format":"int64","example":10022,"description":"Id of the secondary insurance plan this claim was or will be sent to","nullable":true},"date_of_service":{"type":"string","format":"date","example":"2024-06-03","description":"The date in UTC when the procedures included in the claim occurred","nullable":true},"totals":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeClaimTotals"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Claim update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC date and time the claim was deleted. Null when the claim is not deleted. Deleted claims are only listed when include_deleted is true","nullable":true},"patient":{"$ref":"#/components/schemas/API_V20240412_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V2_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V2_Entities_User"},"charge_payouts":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargePayout"},"description":"Billing details for each charge associated with this claim"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_ChargeBasic"},"description":"Charges associated with this claim"}}},"API_V20240412_Entities_Ledger_ChargePayout":{"type":"object","properties":{"amount_billed_to_insurance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"allowed_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"fee_schedule_procedure_code":{"$ref":"#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCode"},"charge_id":{"type":"integer","format":"int64","example":1234,"description":"The ID of the charge associated with this payout"}}},"API_V20240412_Entities_Ledger_ChargeBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for","nullable":true},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for","nullable":true},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for","nullable":true},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for","nullable":true},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge","nullable":true},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge","nullable":true},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made","nullable":true}}},"API_V31_Entities_Ledger_Insurance_Claim_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Insurance_Claim"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Ledger_Insurance_Claim_Response model"},"API_V31_Entities_Ledger_Insurance_Claim":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Claim id"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id"},"patient_id":{"type":"integer","format":"int32","example":1002,"description":"Patient id"},"provider_id":{"type":"integer","format":"int32","example":101,"description":"Provider id"},"guarantor_id":{"type":"integer","format":"int32","example":1001,"description":"User id of the patient's responsible party"},"status":{"type":"string","enum":["draft","sent","received","canceled"],"example":"sent","description":"Claim status"},"received_at":{"type":"string","format":"date-time","example":"2024-06-10T15:16:57.000Z","description":"Date and time in UTC when the claim was received from insurance"},"sent_at":{"type":"string","format":"date-time","example":"2024-06-03T11:23:12.000Z","description":"Date and time in UTC when the claim was sent to insurance"},"note":{"type":"string","example":"Claim was sent to the insurance company","description":"Claim notes"},"primary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the primary insurance provider this claim was or will be sent to"},"secondary_insurance_plan_id":{"type":"integer","format":"int64","example":10021,"description":"Id of the secondary insurance provider this claim was or will be sent to"},"date_of_service":{"type":"string","format":"date","example":"2024-06-03","description":"The date in UTC when the procedures included in the claim occured"},"totals":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeClaimTotals"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Claim update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC date and time the claim was deleted"},"patient":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V31_Entities_Provider"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"charge_payouts":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargePayout"},"description":"Billing details for each charge associated with this claim"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeBasic"},"description":"Charges associated with this claim"}}},"API_V31_Entities_Ledger_ChargePayout":{"type":"object","properties":{"amount_billed_to_insurance":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"estimated_insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_payment":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"write_off":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"allowed_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"fee_schedule_procedure_code":{"$ref":"#/components/schemas/API_V31_Entities_FeeScheduleProcedureCode"},"charge_id":{"type":"integer","format":"int64","example":1234,"description":"The ID of the charge associated with this payout"}}},"API_V31_Entities_Ledger_ChargeBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Unique identifier of this resource from the integrated system"},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge"},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made"}}},"API_V20240412_Entities_Insurance_PatientCoverage_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Insurance_PatientCoverage"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Insurance_PatientCoverage_Collection_Response_WithCursor model"},"API_V20240412_Entities_Insurance_PatientCoverage":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient","nullable":true},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies","nullable":true},"plan_id":{"type":"integer","format":"int64","example":18,"description":"The ID of the insurance plan this coverage subscribes to","nullable":true},"subscriber_num":{"type":"string","example":"123456789","description":"The subscriber's identification number for the plan","nullable":true},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"The date the coverage takes effect","nullable":true},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"The date the coverage expires","nullable":true},"insurance_type":{"type":"string","enum":["dental","medical","vision"],"example":"dental","description":"The type of the insurance plan","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Coverage update date in UTC. This is the most recent of the coverage and its subscription update dates, since the entity also exposes subscription fields"},"active":{"type":"boolean","example":true,"description":"Whether the insurance coverage is currently active","nullable":true}}},"API_V20240412_Entities_Insurance_PatientCoverageDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Insurance_PatientCoverageDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Insurance_PatientCoverageDetailed_Response model"},"API_V20240412_Entities_Insurance_PatientCoverageDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient","nullable":true},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies","nullable":true},"plan_id":{"type":"integer","format":"int64","example":18,"description":"The ID of the insurance plan this coverage subscribes to","nullable":true},"subscriber_num":{"type":"string","example":"123456789","description":"The subscriber's identification number for the plan","nullable":true},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"The date the coverage takes effect","nullable":true},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"The date the coverage expires","nullable":true},"insurance_type":{"type":"string","enum":["dental","medical","vision"],"example":"dental","description":"The type of the insurance plan","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Coverage update date in UTC. This is the most recent of the coverage and its subscription update dates, since the entity also exposes subscription fields"},"active":{"type":"boolean","example":true,"description":"Whether the insurance coverage is currently active","nullable":true},"subscriber":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"}}},"API_V31_Entities_Insurance_PatientCoverage_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_Insurance_PatientCoverage_Collection_Response_WithCursor model"},"API_V31_Entities_Insurance_PatientCoverage":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient"},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies"},"plan_id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"subscriber_num":{"type":"string","example":"123456789","description":"Subscriber number"},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"Effective date"},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"Expiration date"},"insurance_type":{"type":"string","enum":["dental","medical","vision"],"example":"dental","description":"The type of the insurance plan"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Coverage update date in UTC"},"active":{"type":"boolean","example":true,"description":"Whether the insurance coverage is currently active"},"subscriber":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"},"benefits_remaining":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"postInsuranceCoverages":{"type":"object","properties":{"insurance_plan_id":{"type":"integer","format":"int32","description":"ID of the insurance plan to enroll the patient in"},"patient_id":{"type":"integer","format":"int32","description":"ID of the patient receiving the insurance coverage"},"subscriber_id":{"type":"integer","format":"int32","description":"ID of the patient who holds the insurance policy. Exactly one of subscriber_id or insurance_subscription is required. Use this when the subscriber already has an active coverage for the same plan."},"subscription_relation":{"type":"string","description":"Relationship of the patient to the insurance subscriber (e.g. self, spouse, child)","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"default":"self"},"priority":{"type":"string","description":"Priority of this coverage when the patient has multiple plans (e.g. primary, secondary)","enum":["primary","secondary","supplemental"],"default":"primary"},"insurance_subscription":{"type":"object","description":"Subscription details for a new insurance subscription. Exactly one of subscriber_id or insurance_subscription is required. Use this when no existing subscription is on file and one needs to be created.","properties":{"subscriber_num":{"type":"string","description":"Subscriber member ID as it appears on the insurance card"},"effective_date":{"type":"string","format":"date","description":"Date the insurance coverage becomes effective (YYYY-MM-DD)"},"expiration_date":{"type":"string","format":"date","description":"Date the insurance coverage expires (YYYY-MM-DD)"}},"required":["subscriber_num"]}},"required":["insurance_plan_id","patient_id"],"description":"Create insurance coverage"},"API_V31_Entities_Insurance_PatientCoverage_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Insurance_PatientCoverage_Response model"},"API_V20240412_Entities_Api_Onboarding_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Api_Onboarding"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Api_Onboarding_Collection_Response_WithCursor model"},"API_V20240412_Entities_Api_Onboarding":{"type":"object","properties":{"id":{"type":"string","example":"y2wxl82zldm4","description":"The ID of the onboarding process."},"created_at":{"type":"string","format":"date-time","example":"2026-01-01T00:00:00Z","description":"The timestamp the onboarding url was created."},"subdomain":{"type":"string","example":"test-subdomain","description":"The subdomain of the institution this onboarding belongs to. Null until the onboarding has been matched to an institution (e.g. while a new institution is still being set up).","nullable":true},"url":{"type":"string","example":"https://app.nexhealth.com/onboardings/y2wxl82zldm4","description":"The link to send to practice staff to complete setup. Format varies by onboarding type. Expires at url_expires_at."},"url_expires_at":{"type":"string","format":"date-time","example":"2026-02-01T00:00:00Z","description":"When the url will expire and no longer be valid."},"status":{"type":"string","enum":["in_progress","complete","failed"],"example":"in_progress","description":"Current state of the onboarding. in_progress: the link has been created and setup is not finished; complete: setup finished (including installations completed manually by NexHealth); failed: the onboarding failed, was cancelled, or was disabled and will not proceed."},"booking_params":{"type":"object","example":{"location_id":105,"appointment_type_ids":[19,20]},"description":"Data collected during setup for online booking. Contains \"location_id\" (ID of the location selected during setup; may be serialized as an integer or numeric string) and \"appointment_type_ids\" (array of appointment type IDs), each present only after the corresponding setup step has run. Always null for installation-based onboardings. Before setup begins it is an empty object on the retrieve and create endpoints and null on the list endpoint.","nullable":true},"availability_ready_at":{"type":"string","format":"date-time","example":"2026-01-01T00:00:00Z","description":"When the onboarding location first became bookable. Null until availability is ready.","nullable":true}}},"API_V20240412_Entities_Api_Onboarding_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Api_Onboarding"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Api_Onboarding_Response model"},"postOnboardings":{"type":"object","properties":{"onboarding":{"type":"object","description":"Onboarding details","properties":{"institution_name":{"type":"string","description":"The institution's' name. Only include this if you are onboarding a new institution."},"institution_zip_code":{"type":"string","description":"The institution's zip code. Only include this if you do not already have Synchronizer access. If you omit it, practice staff will be asked to enter it during setup."},"institution_website":{"type":"string","description":"The institution's website URL. Only include this if you are onboarding a new institution. If you omit it, practice staff will be asked to enter it during setup."},"institution_email":{"type":"string","description":"The institution's primary email address. Only include this if you are onboarding a new institution. If you omit it, practice staff will be asked to enter it during setup."},"subdomain":{"type":"string","description":"The subdomain for the institution you want to add locations to. You need to include this when you want to add new locations to an existing institution. Ensure the subdomain used is returned by the API in a previous query."},"ehr_name":{"type":"string","description":"The name of the electronic health record (EHR) system where you want to install the Synchronizer.","enum":["athena","curve2","cloud9","denticon","dentrix","dentrixascend","drchrono","eaglesoft","ecw","modmed","nextgen","opendental"]}}}},"required":["onboarding"],"description":"Create onboarding"},"API_V20240412_Entities_Ledger_PaymentType_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentType"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_Ledger_PaymentType_Collection_Response_WithCursor model"},"API_V20240412_Entities_Ledger_PaymentType_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_Ledger_PaymentType"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_Ledger_PaymentType_Response model"},"API_V20240412_Entities_TreatmentPlan_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_TreatmentPlan"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_TreatmentPlan_Collection_Response_WithCursor model"},"API_V20240412_Entities_TreatmentPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":423,"description":"Resource id"},"name":{"type":"string","example":"Active treatment plan","description":"The name of the treatment plan","nullable":true},"patient_id":{"type":"integer","format":"int32","example":115,"description":"The ID of patient this treatment plan is for","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Treatment plan update date in UTC"},"status":{"type":"string","enum":["not_applicable","proposed","accepted","rejected","completed"],"example":"proposed","description":"Status of the treatment plan","nullable":true},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Procedure"},"description":"Procedures assigned to the treatment plan"}}},"API_V20240412_Entities_TreatmentPlan_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_TreatmentPlan"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_TreatmentPlan_Response model"},"API_V31_Entities_TreatmentPlan_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_TreatmentPlan"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_TreatmentPlan_Collection_Response_WithCursor model"},"API_V31_Entities_TreatmentPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":423,"description":"Resource id"},"name":{"type":"string","example":"Active treatment plan","description":"The name of the treatment plan"},"patient_id":{"type":"integer","format":"int32","example":115,"description":"The ID of patient this treatment plan is for"},"guarantor_id":{"type":"integer","format":"int64","example":116,"description":"The ID of the guarantor for this treatment plan"},"preparer_id":{"type":"integer","format":"int32","example":42,"description":"The ID of the user who prepared this treatment plan"},"status":{"type":"string","enum":["not_applicable","proposed","accepted","rejected","completed"],"example":"proposed","description":"Status of the treatment plan"},"note":{"type":"string","example":"Follow-up in 6 months","description":"Note on the treatment plan"},"treatment_plan_creation_date":{"type":"string","example":"01/01/2023","description":"Treatment plan creation date as reported by the integrated system"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Treatment plan creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Treatment plan update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2026-05-12T20:16:57.007Z","description":"Treatment plan deletion date in UTC; null for live plans"},"foreign_id":{"type":"string","example":"12345678","description":"The ID of this treatment plan in the integrated EHR system. This value is assigned by the EHR and may change; do not use it as a stable foreign key."},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Treatment_TreatmentPlanProcedure"},"description":"Procedures assigned to the treatment plan"}}},"API_V31_Entities_Treatment_TreatmentPlanProcedure":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":11,"description":"Procedure id"},"location_id":{"type":"integer","format":"int32","example":21,"description":"Location id","nullable":true},"patient_id":{"type":"integer","format":"int32","example":162,"description":"Patient id","nullable":true},"provider_id":{"type":"integer","format":"int32","example":84,"description":"Provider id","nullable":true},"appointment_id":{"type":"integer","format":"int64","example":283,"description":"Appointment id. Null when the procedure is not attached to an appointment","nullable":true},"code":{"type":"string","example":"D6100","description":"Procedure code","nullable":true},"name":{"type":"string","example":"Implant Removal","description":"Procedure name","nullable":true},"status":{"type":"string","enum":["planned","scheduled","completed","inactive","referred"],"example":"referred","description":"Procedure status","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure update date in UTC"},"body_site":{"$ref":"#/components/schemas/API_V2_Entities_ProcedureBodySite"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"start_date":{"type":"string","format":"date","example":"2022-06-24","description":"Start date for procedure","nullable":true},"end_date":{"type":"string","format":"date","example":"2022-06-24","description":"End date for procedure","nullable":true},"foreign_id":{"type":"string","example":"12345","description":"The ID of this procedure in the integrated EHR system. This value is assigned by the EHR and may change; do not use it as a stable foreign key."},"estimates":{"$ref":"#/components/schemas/API_V31_Entities_Treatment_ProcedureCostEstimate"}}},"API_V31_Entities_Treatment_ProcedureCostEstimate":{"type":"object","properties":{"patient_fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"patient_amount_estimate":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"discount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"insurance_estimates":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Treatment_InsuranceEstimate"},"description":"Insurance contribution estimates ranked by coverage order (rank: 1 = primary, rank: 2 = secondary). Entries with no estimate value are omitted."}}},"API_V31_Entities_Treatment_InsuranceEstimate":{"type":"object","properties":{"rank":{"type":"integer","format":"int32","example":1,"description":"Coverage rank (1 = primary, 2 = secondary)."},"amount":{"type":"string","example":"120.00","description":"Estimated insurance contribution, in major currency units."},"currency":{"type":"string","example":"USD","description":"ISO 4217 currency code."}}},"API_V31_Entities_TreatmentPlan_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_TreatmentPlan"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_TreatmentPlan_Response model"},"API_V20240412_Entities_WorkingHourLabel_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourLabel"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_WorkingHourLabel_Collection_Response_WithCursor model"},"postWorkingHours":{"type":"object","properties":{"working_hour":{"type":"object","description":"Configure only one of days, specific_date or custom_recurrence","properties":{"provider_id":{"type":"integer","format":"int32","description":"Id of the provider","example":7},"begin_time":{"type":"string","description":"At what time working hour starts. Format is HH:MM","example":"09:00"},"end_time":{"type":"string","description":"At what time working hour ends. Format is HH:MM","example":"16:00"},"operatory_id":{"type":"integer","format":"int32","description":"Id of the operatory","example":149},"appointment_type_ids":{"type":"array","description":"Associate appointment types with this working hour","example":[27],"items":{"type":"integer","format":"int32"}},"days":{"type":"array","description":"Configure days of the week for this working hour","example":["Monday","Wednesday"],"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"specific_date":{"type":"string","format":"date","description":"Configure a specific date for this working hour","example":"2024-11-03"},"custom_recurrence":{"type":"object","description":"Configure custom recurrence","properties":{"num":{"type":"integer","format":"int32","description":"Unit count","example":3},"ref":{"type":"string","format":"date","description":"Starting date","example":"2024-11-03"},"unit":{"type":"string","description":"Every # days/weeks/months","enum":["","day","week","month"],"example":"week"}},"required":["num","ref","unit"]},"active":{"type":"boolean","description":"Is this working hour active?","default":true,"example":true}},"required":["provider_id","begin_time","end_time"]}},"required":["working_hour"],"description":"Create working hour"},"API_V20240412_Entities_WorkingHourBasic_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourBasic"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_WorkingHourBasic_Response model"},"API_V20240412_Entities_WorkingHour_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHour"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V20240412_Entities_WorkingHour_Collection_Response_WithCursor model"},"API_V20240412_Entities_WorkingHour":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":12,"description":"Resource id"},"provider_id":{"type":"integer","format":"int32","example":7,"description":"Provider id","nullable":true},"location_id":{"type":"integer","format":"int32","example":3,"description":"Location id","nullable":true},"operatory_id":{"type":"integer","format":"int64","example":149,"description":"Operatory id","nullable":true},"begin_time":{"type":"string","example":"10:30","description":"Availability start time in the practices timezone"},"end_time":{"type":"string","example":"17:00","description":"Availability end time in the practices timezone"},"days":{"type":"array","items":{"type":"string"},"example":["Monday","Tuesday","Wednesday","Thursday","Friday"],"description":"Configured week days. Empty when the working hour is configured for a custom recurrence","nullable":true},"specific_date":{"type":"string","format":"date","example":"2022-11-03","description":"Configured specific date","nullable":true},"custom_recurrence":{"type":"object","example":{"num":3,"unit":"day","ref":"2022-11-03"},"description":"Configured custom recurrence, with the fields num (recurrence interval count), ref (starting date), and unit (day, week, or month)","nullable":true},"tz_offset":{"type":"string","example":"-0700","description":"UTC offset for the practice"},"active":{"type":"boolean","example":true,"description":"Is active?"},"source":{"type":"string","enum":["manual","synced"],"example":"synced","description":"Source of the working hour"},"label":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHourLabel"},"appointment_types":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"description":"Associated appointment types"}}},"API_V20240412_Entities_WorkingHour_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V20240412_Entities_WorkingHour"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V20240412_Entities_WorkingHour_Response model"},"patchWorkingHoursId":{"type":"object","properties":{"working_hour":{"type":"object","properties":{"provider_id":{"type":"integer","format":"int32","description":"Id of the provider","example":7},"begin_time":{"type":"string","description":"What time working hour starts in UTC. Format is HH:MM","example":"09:00"},"end_time":{"type":"string","description":"What time working hour ends in UTC. Format is HH:MM","example":"16:00"},"operatory_id":{"type":"integer","format":"int32","description":"Id of the operatory","example":149},"appointment_type_ids":{"type":"array","description":"Associate appointment types with this working hour. Pass an empty array to remove all appointment types; omit the key to leave them unchanged","example":[27],"items":{"type":"integer","format":"int32"}},"days":{"type":"array","description":"Configure days of the week for this working hour","example":["Monday","Wednesday"],"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"specific_date":{"type":"string","format":"date","description":"Configure specific date for this working hour","example":"2024-11-03"},"custom_recurrence":{"type":"object","description":"Configure custom recurrence","properties":{"num":{"type":"integer","format":"int32","description":"Unit count","example":3},"ref":{"type":"string","format":"date","description":"Starting date","example":"2024-11-03"},"unit":{"type":"string","description":"Every # days/weeks/months","enum":["day","week","month"],"example":"week"}},"required":["num","ref","unit"]},"active":{"type":"boolean","description":"Is this working hour active?","example":true}}}},"required":["working_hour"],"description":"Edit working hour"},"API_V31_Entities_FormResponse_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FormResponse"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_FormResponse_Collection_Response_WithCursor model"},"API_V31_Entities_FormResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"The form response ID"},"location_id":{"type":"integer","format":"int64","example":1,"description":"The ID of the location where the form was submitted"},"patient_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the patient who submitted the form"},"created_at":{"type":"string","example":"2024-04-12T00:00:00Z","description":"Timestamp when the form response was created"}}},"API_V31_Entities_FormResponseDetail_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_FormResponseDetail"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_FormResponseDetail_Response model"},"API_V31_Entities_FormResponseDetail":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"The form response ID"},"location_id":{"type":"integer","format":"int64","example":1,"description":"The ID of the location where the form was submitted"},"patient_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the patient who submitted the form"},"created_at":{"type":"string","example":"2024-04-12T00:00:00Z","description":"Timestamp when the form response was created"},"form_schema_id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"UUID of the form schema used for this response"}}},"postFormResponses":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"ID of the patient submitting the form.","example":42},"form_schema_id":{"type":"string","description":"UUID of the form schema (PDFWS::Document) used for this submission.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"patient_submitted_data":{"type":"object","description":"Raw Form.io submission data keyed by field name.","example":{"firstName":"Jane","lastName":"Doe"}}},"required":["patient_id","form_schema_id","patient_submitted_data"],"description":"Create a form response"},"API_V31_Entities_FormSchema_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FormSchema"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_FormSchema_Collection_Response_WithCursor model"},"API_V31_Entities_FormSchema":{"type":"object","properties":{"id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"The form schema ID"},"title":{"type":"string","example":"Patient Health History","description":"The title of the form"},"form_slug":{"type":"string","example":"patient-health-history","description":"Stable identifier for this form across versions, derived from the filename"},"deleted_at":{"type":"string","format":"date-time","example":"2026-05-12T20:16:57.007Z","description":"Form schema deletion date in UTC; null for active forms"},"foreign_id":{"type":"string","example":"1","description":"The ID of this form in the practice management system","nullable":true}}},"API_V31_Entities_FormSchemaDetail_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_FormSchemaDetail"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_FormSchemaDetail_Response model"},"API_V31_Entities_FormSchemaDetail":{"type":"object","properties":{"id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"The form schema ID"},"title":{"type":"string","example":"Patient Health History","description":"The title of the form"},"form_slug":{"type":"string","example":"patient-health-history","description":"Stable identifier for this form across versions, derived from the filename"},"deleted_at":{"type":"string","format":"date-time","example":"2026-05-12T20:16:57.007Z","description":"Form schema deletion date in UTC; null for active forms"},"foreign_id":{"type":"string","example":"1","description":"The ID of this form in the practice management system","nullable":true},"formio_schema":{"type":"object","example":{"display":"form","components":[]},"description":"The full Form.io JSON schema for the form"},"newest_version_id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"UUID of the newest version of this form"}}},"API_V31_Entities_ProcedureCodeCategory_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_ProcedureCodeCategory_Collection_Response_WithCursor model"},"API_V31_Entities_ProcedureCodeCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":7,"description":"Resource id"},"foreign_id":{"type":"string","example":"19","description":"Unique identifier of this resource from the integrated system","nullable":true},"name":{"type":"string","example":"Diagnostic","description":"The procedure code category name"}}},"API_V31_Entities_ProcedureCodeCategory_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_ProcedureCodeCategory_Response model"},"API_V31_Entities_ProcedureCode_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCode"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_ProcedureCode_Collection_Response_WithCursor model"},"API_V31_Entities_ProcedureCode":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":423,"description":"Resource id"},"code":{"type":"string","example":"D0150","description":"The procedure code abbreviation"},"description":{"type":"string","example":"Comprehensive Oral Evaluation","description":"The procedure code description"},"location_id":{"type":"integer","format":"int32","example":123,"description":"The location this procedure code belongs to. Null indicates an institution-wide procedure code."},"ada_code":{"type":"string","example":"D0120","description":"ADA CDT code for the procedure (e.g. D0120). Null if not set."},"abbreviation":{"type":"string","example":"EXAM","description":"Short display name used in scheduling views. Null if not set."},"procedure_code_category_id":{"type":"integer","format":"int64","example":7,"description":"ID of the associated procedure code category. Null if uncategorized."},"procedure_code_category_name":{"type":"string","example":"Diagnostic","description":"Name of the associated procedure code category. Null if uncategorized."},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure code last updated date in UTC"}}}}}}