{"openapi":"3.0.0","info":{"title":"NexHealth API v2.2.2 (Deprecated)","description":"> **⚠️ Deprecated.** v2.2.2 is the legacy version of the NexHealth API and is deprecated; new development should target v3.0.0 (also known by its original date-based name v20240412). Our migration guide walks through every breaking change: https://docs.nexhealth.com/v20240412/docs/api-v2-to-v20240412-migration-guide\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":"v2"},"security":[{"Authorization":[]}],"tags":[{"name":"Accounts Receivable","description":"Guarantor and Insurance Accounts Receivable"},{"name":"Adjustments","description":"Adjustments resources"},{"name":"Appointment Types","description":"Defines booking parameters for services offerred by the practice"},{"name":"Appointments","description":"A booking on the Practice's calendar"},{"name":"Appointment Slots","description":"Valid start date/times for an appointment"},{"name":"Authenticates","description":"Authentication endpoints for NexHealth resources"},{"name":"Availabilities","description":"Configure availabilities for providers"},{"name":"Charges","description":"Charges resources"},{"name":"Documents","description":"A documents resource"},{"name":"Document Types","description":"A document types resource"},{"name":"Institutions","description":"An organization containing at least one location is refered to as Institution"},{"name":"Insurance Plans","description":"An insurance plans resource"},{"name":"Locations","description":"A singular Practice/clinic/office"},{"name":"Nex Staff","description":"NexHealth staff users"},{"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":"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":"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"}],"paths":{"/adjustments":{"get":{"summary":"View adjustments","description":"This endpoint is deprecated and always returns an empty collection; use the same endpoint in v3.0.0 (v20240412) to retrieve adjustment data.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"int64"}},{"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":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","procedure"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Adjustment_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":["Adjustments"],"operationId":"getAdjustments"}},"/adjustments/{id}":{"get":{"summary":"View adjustment","description":"This endpoint is deprecated and always returns a 404 error; use the same endpoint in v3.0.0 (v20240412) to retrieve adjustment data.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","provider","procedure"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Adjustment_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":["Adjustments"],"operationId":"getAdjustmentsId"}},"/appointment_types":{"get":{"summary":"View appointment types","description":"This endpoint returns appointment types for the institution specified by the subdomain parameter, or for a specific location within it when appointment types are location specific. location_id is required in that case, and is also required when requesting sub-resources via include[].","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeWithResources_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":["Appointment Types"],"operationId":"getAppointmentTypes"},"post":{"summary":"Create an appointment type","description":"This endpoint creates an appointment type under the institution specified by the subdomain parameter, or a specific location within it when appointment types are location specific; location_id is required in that case.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic_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":["Appointment Types"],"operationId":"postAppointmentTypes"}},"/appointment_types/{id}":{"patch":{"summary":"Edit an appointment type","description":"This endpoint updates the appointment type identified by id, within the institution specified by the subdomain parameter or a specific location within it; location_id is required in that case. Only the fields included in the request body are changed.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic_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":["Appointment Types"],"operationId":"patchAppointmentTypesId"},"get":{"summary":"View an appointment type","description":"This endpoint returns the appointment type for a specific id under the institution specified by the subdomain parameter, or under a specific location within it when appointment types are location specific; location_id is required in that case, and is also required when requesting sub-resources via include[].","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeWithResources_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":["Appointment Types"],"operationId":"getAppointmentTypesId"},"delete":{"summary":"Delete an appointment type","description":"This endpoint permanently deletes the appointment type for a specific id under the institution specified by the subdomain parameter, or under a specific location within it when appointment types are location specific; location_id is required in that case. Appointments that reference this appointment type are not deleted — their appointment_type association is cleared.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic_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":["Appointment Types"],"operationId":"deleteAppointmentTypesId"}},"/appointment_types/{id}/appointment_descriptors":{"get":{"summary":"View appointment type appointment descriptors","description":"This endpoint returns the EMR appointment descriptors linked to the appointment type for a specific id, under the institution specified by the subdomain parameter or a specific location within it when appointment types are location specific; location_id is required in that case. descriptor_type is an optional filter, and when location_id is present the results are also limited to that location.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/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":["Appointment Types"],"operationId":"getAppointmentTypesIdAppointmentDescriptors"}},"/appointments/{id}":{"get":{"summary":"View appointment","description":"This endpoint returns the appointment for a specific id under the institution specified by the subdomain parameter. Related resources can be included via include[]; patient is included by default.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Appointment_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":"getAppointmentsId"},"patch":{"summary":"Edit Appointment","description":"This endpoint updates the confirmed and/or cancelled status of the appointment for a specific id under the institution specified by the subdomain parameter. Setting confirmed or cancelled to true requests a write-back to the EHR when the location EMR supports it. Cancelled appointments cannot be updated.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentResponse_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":"patchAppointmentsId"}},"/appointments/{id}/appointment_descriptors":{"get":{"summary":"View appointment descriptors","description":"This endpoint returns the EMR appointment descriptors for a specific appointment id under the institution specified by the subdomain parameter. descriptor_type is an optional filter.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns appointments overlapping with the given start/end time window for the location specified by location_id under the institution specified by the subdomain parameter. Related resources can be included via include[]; patient is included by default. Deleted appointments are always excluded from the results.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"A parseable date string defining the earliest returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000","required":true,"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,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"timezone","description":"Timezone for the appointment clinic","required":false,"schema":{"type":"string"}},{"in":"query","name":"cancelled","description":"Is appointment cancelled","required":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,"schema":{"type":"boolean"}},{"in":"query","name":"nex_only","description":"Only show appointments booked via NexHealth API","required":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,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"appointment_type_id","description":"Get appointments for a specific appointment type","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":"patient_id","description":"Get appointments for a specific patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"created_by","description":"Query appointments that were created by a specific user","required":false,"schema":{"type":"integer","format":"int32"}},{"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":"provider_ids[]","description":"Query appointments that are booked with the specified providers only","required":false,"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,"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":["patient","guarantor","descriptors","booking_details","procedures","operatory","appointment_type"],"default":"patient"}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Appointment_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":"getAppointments"},"post":{"summary":"Create appointment","description":"This endpoint books an appointment for the given patient with the given provider at the specified location. When `is_guardian` is true, the booking is made by a guardian and a patient object with the dependent's details must be provided. Set `unavailable` to true to create a block instead of a patient appointment.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"notify_patient","description":"Send NexHealth appointment created notifications to patient","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postAppointments"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentResponse_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":"postAppointments"}},"/appointment_slots":{"get":{"summary":"View appointment slots","description":"This endpoint returns available appointment slots for the given providers at the given locations over the specified date range.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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,"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,"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,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"slot_length","description":"Manually specify slot length in minutes. Defaults to 15 minutes","required":false,"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,"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,"schema":{"type":"boolean","default":false}},{"in":"query","name":"lids[]","description":"Array of Location Ids","required":true,"explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"in":"query","name":"pids[]","description":"Array of Provider Ids","required":true,"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,"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_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":["Appointment Slots"],"operationId":"getAppointmentSlots"}},"/authenticates":{"post":{"summary":"Retrieve bearer token","description":"This endpoint exchanges an API key for a JWT bearer token to authenticate subsequent requests.","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","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}}]}},"/availabilities":{"post":{"summary":"Create availability","description":"This endpoint creates a new availability for the given provider at the specified location; exactly one of `days`, `specific_date`, or `custom_recurrence` must be provided.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/postAvailabilities"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_WorkingHourBasic_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":["Availabilities"],"operationId":"postAvailabilities"},"get":{"summary":"View availabilities","description":"This endpoint returns availabilities for the specified location, optionally filtered by `provider_id`, `operatory_id`, `active` status, or `ignore_past_dates`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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":"provider_id","description":"Filter for specific provider","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"operatory_id","description":"Filter for specific operatory","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"active","description":"Filter active/not active","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","name":"ignore_past_dates","description":"Filter out availabilities configured for specific dates in the past","required":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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_WorkingHour_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":["Availabilities"],"operationId":"getAvailabilities"}},"/availabilities/{id}":{"get":{"summary":"View availability","description":"This endpoint returns a single availability by its NexHealth ID, optionally including the associated `appointment_types`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"in":"path","name":"id","description":"Id of the availability","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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_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":["Availabilities"],"operationId":"getAvailabilitiesId"},"patch":{"summary":"Edit availability","description":"This endpoint updates an existing availability by its NexHealth ID; at most one of `days`, `specific_date`, or `custom_recurrence` may be provided.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"in":"path","name":"id","description":"Id of the availability","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/patchAvailabilitiesId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_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":["Availabilities"],"operationId":"patchAvailabilitiesId"},"delete":{"summary":"Delete availability","description":"This endpoint permanently deletes an availability by its NexHealth ID and returns 204 No Content.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"in":"path","name":"id","description":"Id of the availability","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/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":["Availabilities"],"operationId":"deleteAvailabilitiesId"}},"/charges":{"get":{"summary":"View charges","description":"This endpoint is deprecated and always returns an empty collection; use the same endpoint in v3.0.0 (v20240412) to retrieve charge data.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","procedure"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Charge_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":["Charges"],"operationId":"getCharges"}},"/charges/{id}":{"get":{"summary":"View charge","description":"This endpoint is deprecated and always returns a 404; use the same endpoint in v3.0.0 (v20240412) to retrieve charge data.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","provider","procedure"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Charge_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":["Charges"],"operationId":"getChargesId"}},"/document_types":{"get":{"summary":"View document types","description":"This endpoint returns document types for the specified location, optionally filtered by `active` status (defaults to active only).","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_DocumentType_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":["Document Types"],"operationId":"getDocumentTypes"}},"/document_types/{id}":{"get":{"summary":"View document type","description":"This endpoint returns a single document type by its NexHealth ID for the specified location.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_DocumentType_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":["Document Types"],"operationId":"getDocumentTypesId"}},"/institutions":{"get":{"summary":"View institutions","description":"This endpoint returns all institutions accessible to the authenticated API user.","responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Institution_Collection_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":["Institutions"],"operationId":"getInstitutions","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}}]}},"/institutions/{id}":{"get":{"summary":"View institution","description":"This endpoint returns a single institution by its NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"in":"path","name":"id","description":"The NexHealth id of the institution","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Institution_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":["Institutions"],"operationId":"getInstitutionsId"}},"/insurance_plans":{"get":{"summary":"View insurance plans","description":"This endpoint returns insurance plans for the institution, optionally filtered by `payer_id` or `group_num`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient_coverages","subscribers"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_EhrPlanWithIncludes_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":["Insurance Plans"],"operationId":"getInsurancePlans"}},"/insurance_plans/{id}":{"get":{"summary":"View insurance plan","description":"This endpoint returns a single insurance plan by its NexHealth ID, optionally including `patient_coverages` or `subscribers`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_EhrPlanWithIncludes_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":["Insurance Plans"],"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":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns a single location by its NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns EHR appointment descriptors associated with the given location, optionally filtered by `descriptor_type`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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"}},"/nex_staff":{"get":{"summary":"View nex staff","description":"This endpoint returns NexHealth staff members for the institution, optionally filtered by `inactive` status or `location_ids`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"v2"}},{"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":"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":"search_name","description":"Optional name search filter","required":false,"schema":{"type":"string"}},{"in":"query","name":"foreign_id","description":"Query by EHR Id","required":false,"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,"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_OperatoryWithResources_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":["Operatories"],"operationId":"getOperatories"}},"/operatories/{id}":{"get":{"summary":"View operatory","description":"This endpoint returns a single operatory by its NexHealth ID, optionally including `appointment_types` or `appt_categories`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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 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":"v2"}},{"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":"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":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * name\n  * -name\n  * created_at\n  * -created_at\n","required":false,"schema":{"type":"string","default":"name"}},{"in":"query","name":"appointment_date_start","description":"Include appointments starting from this date","required":false,"schema":{"type":"string","format":"date"}},{"in":"query","name":"appointment_date_end","description":"Include appointments up to this date","required":false,"schema":{"type":"string","format":"date"}},{"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":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["upcoming_appts","procedures","insurance_coverages","adjustments","charges","payments","address"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientsResponses_ListAll_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":["Patients"],"operationId":"getPatients"},"post":{"summary":"Create patient","description":"This endpoint creates a new patient for the given provider at the specified location; the patient is not synced to the EHR until an appointment is booked for them.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientsResponses_Create_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":"postPatients"}},"/patients/{id}":{"get":{"summary":"View patient","description":"This endpoint returns a single patient by its NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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[]","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","provider","procedures","insurance_coverages","adjustments","charges","payments","patient_alerts","address"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_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"}},"/patients/{id}/documents":{"get":{"summary":"View patient documents","description":"This endpoint returns all documents associated with the given patient, ordered by creation date.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint uploads a document for the given patient; the file's name is used when inserting the document into the EHR's filesystem, while the optional `name` param is for NexHealth display purposes only.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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}/insurance_coverages":{"get":{"summary":"View patient insurance coverages","description":"This endpoint returns active insurance coverages for the given patient.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverageForIndividual_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":["Patients"],"operationId":"getPatientsIdInsuranceCoverages"}},"/patients/{id}/alerts":{"post":{"summary":"Create patient alert","description":"This endpoint creates a new patient alert for the given patient with a required `note`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns patient alerts for the given patient, optionally including disabled alerts by passing `include_disabled: true`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns a single patient alert by its NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint updates a patient alert; setting `disabled: true` disables the alert, but re-enabling a disabled alert is not supported and returns a 400 error.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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, including the recall type and interval for each patient. A patient recall is a reminder healthcare and dental practices send to patients when it's time to come back in for a follow-up visit, check-up, or preventive care appointment.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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 recall_id","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by patient_id","required":false,"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"}},{"in":"query","name":"due_after","description":"Return recalls due after specified date/time in ISO8601 format","required":false,"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_PatientRecall_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 Recalls"],"operationId":"getPatientRecalls"}},"/patient_recalls/{id}":{"get":{"summary":"View patient recall","description":"This endpoint returns a single active patient recall by its NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns payment plans for the specified location; at least one of `guarantor_id`, `patient_id`, or `updated_since` must be provided.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns a single payment plan by its NexHealth ID, with optional sideloading of the associated `patient` and `guarantor`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint is deprecated and no longer returns any payments — it always responds with an empty collection. Use the same endpoint in v20240412 (v3.0.0) instead to access payment data. See https://docs.nexhealth.com/v20240412/reference/payments for the updated docs.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"int64"}},{"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":"include[]","description":"Resources to be included in the response","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["patient","provider","procedure"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Payment_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":["Payments"],"operationId":"getPayments"}},"/payments/{id}":{"get":{"summary":"View payment","description":"This endpoint is deprecated and no longer returns any payment — it always responds with a 404 error. Use the same endpoint in v20240412 (v3.0.0) instead to access payment data. See https://docs.nexhealth.com/v20240412/reference/payments for the updated docs.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":["patient","provider","procedure"]}}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Ledger_Payment_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":["Payments"],"operationId":"getPaymentsId"}},"/procedures":{"get":{"summary":"View procedures","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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_after","description":"Filter for procedures updated after a specific time","required":false,"schema":{"type":"string","format":"date-time"}},{"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}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_Procedure_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":["Procedures"],"operationId":"getProcedures"}},"/providers":{"get":{"summary":"View providers","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_ProviderWithResources_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":["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":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_ProviderWithResources_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":["Providers"],"operationId":"getProvidersId"}},"/recall_types":{"get":{"summary":"View recall types","description":"This endpoint returns recall types for the specified location, optionally filtered by `foreign_id` or `updated_since`.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint returns a single active recall type by its NexHealth ID.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"v2"}},{"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/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_Entities_SyncStatus_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":["Sync Status"],"operationId":"getSyncStatus"}},"/webhook_endpoints":{"get":{"summary":"View webhook endpoints","description":"This endpoint returns all webhook endpoints for the authenticated API user, optionally filtered by `active` status.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint creates a new webhook endpoint for the authenticated API user; `target_url` must use HTTPS in production.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}}],"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","description":"This endpoint updates a webhook endpoint belonging to the authenticated API user; `target_url` must use HTTPS in production.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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","description":"This endpoint permanently deletes a webhook endpoint belonging to the authenticated API user and returns 204 No Content.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v2"}},{"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":"v2"}},{"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":true,"schema":{"type":"string"}},{"in":"query","name":"resource_type","description":"Filter by subscribed resource","required":false,"schema":{"type":"string","enum":["Appointment","Document","FormResponse","Patient","PatientInsuranceCoverage","Procedure","ProcedureCode","SyncStatus"]}},{"in":"query","name":"event","description":"Filter by event name","required":false,"schema":{"type":"string","enum":["appointment_insertion","appointment_created","appointment_updated","appointment_requested","document_insertion","form_response_insertion","patient_created","patient_updated","patient_insurance_created","patient_insurance_updated","procedure_created","procedure_updated","procedure_code_created","procedure_code_updated","procedure_code_deleted","sync_status_read_change","sync_status_write_change"]}}],"responses":{"200":{"description":"Successful","content":{"application/vnd.Nexhealth+json;version=2":{"schema":{"$ref":"#/components/schemas/API_V2_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":"v2"}},{"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":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_V2_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":"v2"}},{"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"}}],"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_V2_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":"v2"}},{"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"}}},"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_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"},"emr_appt_descriptor_ids":{"type":"array","description":"Array of EMR 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"},"emr_appt_descriptor_ids":{"type":"array","description":"Array of EMR 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_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"},"cancelled":{"type":"boolean","description":"Denotes the office has cancelled the appt, update this to write back cancel status"}}}},"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_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":{"appt":{"type":"object","description":"Appointment detail object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Id of the patient, unless booking is being done by a guardian in which case use the guardian's patient id","example":2897},"provider_id":{"type":"integer","format":"int32","description":"Provider id","example":104},"operatory_id":{"type":"integer","format":"int32","description":"Required if bookings are mapped to operatories for this location","example":181},"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"},"appointment_type_id":{"type":"integer","format":"int32","description":"The appointment type for this appointment","example":27},"note":{"type":"string","description":"A note that will be written to the EHR. 128 character limit.","example":"Patient has been having a cough for 3 days"},"unavailable":{"type":"boolean","description":"Denote this block of time as unavailable on the schedule, don't specify a patient_id with this","example":false},"is_guardian":{"type":"boolean","description":"Flag to denote this booking is being made by the patient's guardian. If true, patient object must be provided","example":false},"is_new_clients_patient":{"type":"boolean","description":"Indicates the booking is for a new patient","example":false},"referrer":{"type":"string","description":"Optionally capture the URL where the booking was made","example":"http://mypractice.com/book"},"patient":{"type":"object","description":"Patient details required when is_guardian is true","properties":{"first_name":{"type":"string","description":"Patient's first name","example":"John"},"last_name":{"type":"string","description":"Patient's last name","example":"Smith"},"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 format is YYYY-MM-DD","example":"2015-05-03"},"gender":{"type":"string","description":"Patient gender. Gender will default to Female if not provided","enum":["Male","Female","Other"],"example":"Female"}},"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","example":[12,13],"items":{"type":"integer","format":"int32"}}},"required":["patient_id","provider_id","start_time"]}},"required":["appt"],"description":"Create appointment"},"API_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_Entities_AvailableSlotResponse"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_Entities_AvailableSlotResponse_Collection_Response model"},"API_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_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_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"}}},"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"}}},"postAvailabilities":{"type":"object","properties":{"availability":{"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 availability starts. Format is HH:MM","example":"09:00"},"end_time":{"type":"string","description":"At what time availability 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 availability","example":[27],"items":{"type":"integer","format":"int32"}},"days":{"type":"array","description":"Configure days of the week for this availability","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 availability","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 availability active?","default":true,"example":true}},"required":["provider_id","begin_time","end_time"]}},"required":["availability"],"description":"Create availability"},"API_V2_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_V2_Entities_WorkingHourBasic"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WorkingHourBasic_Response model"},"API_V2_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?"},"synced":{"type":"boolean","example":true,"description":"True if the availability is synced with the EHR, false otherwise"}}},"API_V2_Entities_WorkingHour_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_WorkingHour"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WorkingHour_Collection_Response model"},"API_V2_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?"},"synced":{"type":"boolean","example":true,"description":"True if the availability is synced with the EHR, false otherwise"},"appointment_types":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"description":"Associated appointment types"}}},"API_V2_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_V2_Entities_WorkingHour"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_WorkingHour_Response model"},"patchAvailabilitiesId":{"type":"object","properties":{"availability":{"type":"object","properties":{"provider_id":{"type":"integer","format":"int32","description":"Id of the provider","example":7},"begin_time":{"type":"string","description":"What time availability starts in UTC. Format is HH:MM","example":"09:00"},"end_time":{"type":"string","description":"What time availability 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 availability. 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 availability","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 availability","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 availability active?","example":true}}}},"required":["availability"],"description":"Edit availability"},"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_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_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_V2_Entities_LocationBasic"},"description":"Collection of locations"}}},"API_V2_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_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_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_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_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_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_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"}}},"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}}},"postPatients":{"type":"object","properties":{"provider":{"type":"object","example":{"provider_id":12},"properties":{"provider_id":{"type":"integer","format":"int32","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","example":"John"},"last_name":{"type":"string","description":"Patient last name","example":"Smith"},"email":{"type":"string","description":"Patient email id. Must match regular expression /\\A([^@\\s]+)@((?:[-a-z0-9]\\.)[a-z]{2,})\\Z/","example":"john.smith@example.com"},"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 format is YYYY-MM-DD. Cannot be more than 130 years in the past or in the future","example":"1964-05-03"},"phone_number":{"type":"string","description":"Patient phone number","example":"5163042196"},"home_phone_number":{"type":"string","description":"Patient home phone number","example":"5163042197"},"cell_phone_number":{"type":"string","description":"Patient cell phone number","example":"5163042198"},"work_phone_number":{"type":"string","description":"Patient work place phone number","example":"5163042199"},"custom_contact_number":{"type":"string","description":"Patient custom contact phone number","example":"5163042200"},"gender":{"type":"string","description":"Patient gender. Gender will default to Female if not provided. This is to ensure compatibility with all EHRs. This will be updated when the patient visits the office and updates their info","enum":["Male","Female","Other"],"example":"Female"},"weight":{"type":"integer","format":"int32","description":"Patient weight in KG","example":70},"height":{"type":"integer","format":"int32","description":"Patient height in CM","example":175},"street_address":{"type":"string","description":"Patient full street address","example":"333 Bush Street"},"address_line_1":{"type":"string","description":"Patient street address line 1","example":"333 Bush Street"},"address_line_2":{"type":"string","description":"Patient street address line 2","example":"Apt 4B"},"city":{"type":"string","description":"Patient city","example":"New York"},"state":{"type":"string","description":"Patient living state","example":"NY"},"zip_code":{"type":"string","description":"Patient zip code","example":"20814"},"insurance_name":{"type":"string","description":"Insurance name","example":"Delta Dental of California"},"ssn":{"type":"string","description":"Patient SSN","example":"123-45-6789"},"race":{"type":"string","description":"Patient race","example":"White"}},"required":["date_of_birth","phone_number"]}},"required":["first_name","last_name","email","bio"]}},"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"},"API_V2_Entities_Insurance_PatientCoverageForIndividual_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_PatientCoverageForIndividual"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_Insurance_PatientCoverageForIndividual_Collection_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_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_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_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_ProviderWithResources_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_ProviderWithResources"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_Entities_ProviderWithResources_Collection_Response model"},"API_V2_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"},"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_V2_Entities_WorkingHourWithAppointmentTypes"},"description":"List of availabilities for the provider"}}},"API_V2_Entities_ProviderRequestable":{"type":"object","properties":{"location_id":{"type":"integer","format":"int32","example":4,"description":"Location id"}}},"API_V2_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?"},"synced":{"type":"boolean","example":true,"description":"True if the availability is synced with the EHR, false otherwise"},"appointment_types":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentTypeBasic"},"description":"Associated appointment types"}}},"API_V2_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_V2_Entities_ProviderWithResources"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V2_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_V2_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_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":["Appointment","Document","FormResponse","Patient","PatientInsuranceCoverage","Procedure","ProcedureCode","SyncStatus"],"example":"Appointment"},"event":{"type":"string","description":"A valid event type to listen to for the defined resource","enum":["appointment_insertion","appointment_created","appointment_updated","appointment_requested","document_insertion","form_response_insertion","patient_created","patient_updated","patient_insurance_created","patient_insurance_updated","procedure_created","procedure_updated","procedure_code_created","procedure_code_updated","procedure_code_deleted","sync_status_read_change","sync_status_write_change"],"example":"appointment_insertion"},"active":{"type":"boolean","default":true,"example":true}},"required":["resource_type","event"],"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"}}}}